Package 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:

7.0

See Also:

• Context
• OAuth2TokenGenerator
• OAuth2TokenCustomizer

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DPOP_PROOF_KEY	The key used for the DPoP Proof Jwt (if available).

Method Summary

Modifier and Type	Method	Description
default OAuth2Authorization	getAuthorization()	Returns the authorization.
default <T extends Authentication> T	getAuthorizationGrant()	Returns the Authentication representing the authorization grant.
default AuthorizationGrantType	getAuthorizationGrantType()	Returns the authorization grant type.
default AuthorizationServerContext	getAuthorizationServerContext()	Returns the authorization server context.
default Set<String>	getAuthorizedScopes()	Returns the authorized scope(s).
default <T extends Authentication> T	getPrincipal()	Returns the Authentication representing the Principal resource owner (or client).
default RegisteredClient	getRegisteredClient()	Returns the registered client.
default OAuth2TokenType	getTokenType()	Returns the token type.

Methods inherited from interface org.springframework.security.oauth2.server.authorization.context.Context

get, get, hasKey

Field Details

DPOP_PROOF_KEY

static final String DPOP_PROOF_KEY

The key used for the DPoP Proof Jwt (if available).

Method Details

getRegisteredClient

default RegisteredClient getRegisteredClient()

Returns the registered client.

Returns:

the RegisteredClient

getPrincipal

default <T extends 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)

getAuthorizationServerContext

default AuthorizationServerContext getAuthorizationServerContext()

Returns the authorization server context.

Returns:

the AuthorizationServerContext

getAuthorization

@Nullable
default OAuth2Authorization getAuthorization()

Returns the authorization.

Returns:

the OAuth2Authorization, or null if not available

getAuthorizedScopes

default Set<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 AuthorizationGrantType getAuthorizationGrantType()

Returns the authorization grant type.

Returns:

the AuthorizationGrantType

getAuthorizationGrant

default <T extends 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