org.springframework.security.oauth2.server.authorization.token

Interface OAuth2TokenContext

All Superinterfaces:

Context

All Known Implementing Classes:

DefaultOAuth2TokenContext, JwtEncodingContext, OAuth2TokenClaimsContext

public interface OAuth2TokenContext
extends Context

A context that holds information (to be) associated to an OAuth 2.0 Token and is used by an OAuth2TokenGenerator and OAuth2TokenCustomizer.

Since:

0.1.0

See Also:

Context, OAuth2TokenGenerator, OAuth2TokenCustomizer

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OAuth2TokenContext.AbstractBuilder<T extends OAuth2TokenContext,B extends OAuth2TokenContext.AbstractBuilder<T,B>> Base builder for implementations of OAuth2TokenContext.

Method Summary

Modifier and Type	Method and Description
default OAuth2Authorization	getAuthorization() Returns the authorization.
default <T extends org.springframework.security.core.Authentication> T	getAuthorizationGrant() Returns the Authentication representing the authorization grant.
default org.springframework.security.oauth2.core.AuthorizationGrantType	getAuthorizationGrantType() Returns the authorization grant type.
default java.util.Set<java.lang.String>	getAuthorizedScopes() Returns the authorized scope(s).
default <T extends org.springframework.security.core.Authentication> T	getPrincipal() Returns the Authentication representing the Principal resource owner (or client).
default ProviderContext	getProviderContext() Returns the provider context.
default RegisteredClient	getRegisteredClient() Returns the registered client.
default OAuth2TokenType	getTokenType() Returns the token type.

Methods inherited from interface org.springframework.security.oauth2.core.context.Context

get, get, hasKey

Method Detail

getRegisteredClient

default RegisteredClient getRegisteredClient()

Returns the registered client.

Returns:

the RegisteredClient

getPrincipal

default <T extends org.springframework.security.core.Authentication> T getPrincipal()

Returns the Authentication representing the Principal resource owner (or client).

Type Parameters:

T - the type of the Authentication

Returns:

the Authentication representing the Principal resource owner (or client)

getProviderContext

default ProviderContext getProviderContext()

Returns the provider context.

Returns:

the ProviderContext

Since:

0.2.3

getAuthorization

@Nullable
default OAuth2Authorization getAuthorization()

Returns the authorization.

Returns:

the OAuth2Authorization, or null if not available

getAuthorizedScopes

default java.util.Set<java.lang.String> getAuthorizedScopes()

Returns the authorized scope(s).

Returns:

the authorized scope(s)

getTokenType

default OAuth2TokenType getTokenType()

Returns the token type.

Returns:

the OAuth2TokenType

getAuthorizationGrantType

default org.springframework.security.oauth2.core.AuthorizationGrantType getAuthorizationGrantType()

Returns the authorization grant type.

Returns:

the AuthorizationGrantType

getAuthorizationGrant

default <T extends org.springframework.security.core.Authentication> T getAuthorizationGrant()

Returns the Authentication representing the authorization grant.

Type Parameters:

T - the type of the Authentication

Returns:

the Authentication representing the authorization grant