AccessControlStrategy

All Known Implementing Classes:: AbstractAccessControlStrategy, AbstractGatewayAccessControlStrategy, ApiTokenManager.TokenAccessControl, SecurityZoneAccessControlStrategy, WebUiSession.CsrfWebUiSessionAccessControl, WebUiSession.WebUiSessionAccessControl

public interface AccessControlStrategy

Since:: 8.3.0

Field Summary

Fields

Modifier and Type

Field

Description

static final AccessControlStrategy

OPEN_ROUTE

A strategy that grants access to all requests.
Method Summary

Modifier and Type

Method

Description

static AccessControlStrategy

and(AccessControlStrategy... strategies)

RouteAccess

canAccess(RequestContext context)

Determines whether the request should be allowed to proceed.

default Optional<String>

getWwwAuthenticateHeader(RequestContext context)

Called when canAccess(RequestContext) returns RouteAccess.UNAUTHORIZED, to provide a WWW-Authenticate header to be included in the HTTP 401 response.

static AccessControlStrategy

or(Collection<AccessControlStrategy> strategies)

default void

validate(RouteMounterContext routeMounterContext)

Checks whether this strategy can be mounted to a Route in a given context.

Field Details
- OPEN_ROUTE
  
  static final AccessControlStrategy OPEN_ROUTE
  
  A strategy that grants access to all requests.
Method Details
- canAccess
  
  RouteAccess canAccess(RequestContext context)
  
  Determines whether the request should be allowed to proceed.
- getWwwAuthenticateHeader
  
  default Optional<String> getWwwAuthenticateHeader(RequestContext context)
  
  Called when canAccess(RequestContext) returns RouteAccess.UNAUTHORIZED, to provide a WWW-Authenticate header to be included in the HTTP 401 response.
- validate
  
  default void validate(RouteMounterContext routeMounterContext) throws RouteMounterValidationException
  
  Checks whether this strategy can be mounted to a Route in a given context.
  
  Parameters:
  
  routeMounterContext - the RouteMounterContext to validate
  
  Throws:
  
  RouteMounterValidationException - if validation fails
- and
  
  static AccessControlStrategy and(AccessControlStrategy... strategies)
- or
  
  static AccessControlStrategy or(Collection<AccessControlStrategy> strategies)