Package com.linecorp.armeria.server.auth
Class AbstractAuthorizerWithHandlers<T>
java.lang.Object
com.linecorp.armeria.server.auth.AbstractAuthorizerWithHandlers<T>
- Type Parameters:
T
- a type of authorization data. This typically isHttpRequest
.
- All Implemented Interfaces:
Authorizer<T>
- Direct Known Subclasses:
OAuth2TokenIntrospectionAuthorizer
@UnstableApi public abstract class AbstractAuthorizerWithHandlers<T> extends Object implements Authorizer<T>
Provides base implementation for an
Authorizer
that defines custom
AuthSuccessHandler
/AuthFailureHandler
s.-
Constructor Summary
Constructors Constructor Description AbstractAuthorizerWithHandlers()
-
Method Summary
Modifier and Type Method Description CompletionStage<Boolean>
authorize(ServiceRequestContext ctx, T data)
Authorizes the givendata
.abstract CompletionStage<AuthorizationStatus>
authorizeAndSupplyHandlers(ServiceRequestContext ctx, T data)
Authorizes the givendata
.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.linecorp.armeria.server.auth.Authorizer
orElse
-
Constructor Details
-
AbstractAuthorizerWithHandlers
public AbstractAuthorizerWithHandlers()
-
-
Method Details
-
authorize
Description copied from interface:Authorizer
Authorizes the givendata
.- Specified by:
authorize
in interfaceAuthorizer<T>
- Returns:
- a
CompletionStage
that will resolve totrue
if the request is authorized, orfalse
otherwise. If the future resolves exceptionally, the request will not be authorized.
-
authorizeAndSupplyHandlers
public abstract CompletionStage<AuthorizationStatus> authorizeAndSupplyHandlers(ServiceRequestContext ctx, @Nullable T data)Description copied from interface:Authorizer
Authorizes the givendata
.- Specified by:
authorizeAndSupplyHandlers
in interfaceAuthorizer<T>
- Parameters:
ctx
-ServiceRequestContext
of the request being authorized.data
- an actual authorization data, likeHttpRequest
, token extracted from it ornull
if such authorization data is missing.- Returns:
- a
CompletionStage
that will resolve toAuthorizationStatus
. If the future resolves exceptionally, the request will not be authorized.
-