Package com.linecorp.armeria.server.auth.oauth2

Class OAuth2TokenIntrospectionAuthorizer

java.lang.Object

com.linecorp.armeria.server.auth.AbstractAuthorizerWithHandlers<OAuth2Token>

com.linecorp.armeria.server.auth.oauth2.OAuth2TokenIntrospectionAuthorizer

All Implemented Interfaces:

Authorizer<OAuth2Token>

@UnstableApi
public final class OAuth2TokenIntrospectionAuthorizer
extends AbstractAuthorizerWithHandlers<OAuth2Token>

Determines whether a given OAuth2Token is authorized for the service registered in using OAuth 2.0 Token Introspection. ctx can be used for storing authorization information about the request for use in business logic.

Method Summary

Modifier and Type	Method	Description
@Nullable String	accessTokenType()	Authorization type permitted by this authorizer.
CompletionStage<AuthorizationStatus>	authorizeAndSupplyHandlers(ServiceRequestContext ctx, @Nullable OAuth2Token data)	Authorizes the given data.
static OAuth2TokenIntrospectionAuthorizerBuilder	builder(WebClient introspectionEndpoint, String introspectionEndpointPath)	Returns a newly created OAuth2TokenIntrospectionAuthorizerBuilder.
AuthFailureHandler	failureHandler()	An instance of OAuth2AuthorizationFailureHandler.
Set<String>	permittedScope()	Scopes permitted by this authorizer.
@Nullable String	realm()	An HTTP Realm - a name designating the protected area.

Methods inherited from class com.linecorp.armeria.server.auth.AbstractAuthorizerWithHandlers

authorize

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

Method Details

builder

public static OAuth2TokenIntrospectionAuthorizerBuilder builder(WebClient introspectionEndpoint,
 String introspectionEndpointPath)

Returns a newly created OAuth2TokenIntrospectionAuthorizerBuilder.

Parameters:

introspectionEndpoint - A WebClient to facilitate the Token Introspection request. Must correspond to the Token Introspection endpoint of the OAuth 2.0 system.

introspectionEndpointPath - A URI path that corresponds to the Token Introspection endpoint of the OAuth 2.0 system.

permittedScope

public Set<String> permittedScope()

Scopes permitted by this authorizer. The authorizer will accept any scope if empty.

accessTokenType

@Nullable
public @Nullable String accessTokenType()

Authorization type permitted by this authorizer. The authorizer will accept any type if empty. One of the registered HTTP authentication schemes as per HTTP Authentication Scheme Registry.

realm

@Nullable
public @Nullable String realm()

An HTTP Realm - a name designating the protected area. OPTIONAL.

failureHandler

public AuthFailureHandler failureHandler()

An instance of OAuth2AuthorizationFailureHandler.

authorizeAndSupplyHandlers

public CompletionStage<AuthorizationStatus> authorizeAndSupplyHandlers(ServiceRequestContext ctx,
 @Nullable
 @Nullable OAuth2Token data)

Description copied from interface: Authorizer

Authorizes the given data.

Specified by:

authorizeAndSupplyHandlers in interface Authorizer<OAuth2Token>

Specified by:

authorizeAndSupplyHandlers in class AbstractAuthorizerWithHandlers<OAuth2Token>

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.