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 is HttpRequest.

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/AuthFailureHandlers.

Constructor Summary

Constructors

Constructor	Description
AbstractAuthorizerWithHandlers()

Method Summary

Modifier and Type	Method	Description
final CompletionStage<Boolean>	authorize(ServiceRequestContext ctx, T data)	Authorizes the given data.
abstract CompletionStage<AuthorizationStatus>	authorizeAndSupplyHandlers(ServiceRequestContext ctx, T data)	Authorizes the given data.

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

public final CompletionStage<Boolean> authorize(ServiceRequestContext ctx,
 T data)

Description copied from interface: Authorizer

Authorizes the given data.

Specified by:

authorize in interface Authorizer<T>

Returns:

a CompletionStage that will resolve to true if the request is authorized, or false 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 given data.

Specified by:

authorizeAndSupplyHandlers in interface Authorizer<T>

Parameters:

ctx - ServiceRequestContext of the request being authorized.

data - an actual authorization data, like HttpRequest, token extracted from it or null if such authorization data is missing.

Returns:

a CompletionStage that will resolve to AuthorizationStatus. If the future resolves exceptionally, the request will not be authorized.