Class OAuth2TokenClaimsContext

java.lang.Object

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

All Implemented Interfaces:

Context, OAuth2TokenContext

public final class OAuth2TokenClaimsContext
extends Object
implements OAuth2TokenContext

An OAuth2TokenContext implementation that provides access to the claims of an OAuth 2.0 Token, allowing the ability to customize.

Since:

7.0

See Also:

• OAuth2TokenContext
• OAuth2TokenClaimsSet.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OAuth2TokenClaimsContext.Builder	A builder for OAuth2TokenClaimsContext.

Nested classes/interfaces inherited from interface OAuth2TokenContext

OAuth2TokenContext.AbstractBuilder<T,B>

Field Summary

Fields inherited from interface OAuth2TokenContext

DPOP_PROOF_KEY

Method Summary

Modifier and Type	Method	Description
<V> @Nullable V	get(Object key)	Returns the value of the attribute associated to the key.
OAuth2TokenClaimsSet.Builder	getClaims()	Returns the claims allowing the ability to add, replace, or remove.
boolean	hasKey(Object key)	Returns true if an attribute associated to the key exists, false otherwise.
static OAuth2TokenClaimsContext.Builder	with(OAuth2TokenClaimsSet.Builder claimsBuilder)	Constructs a new OAuth2TokenClaimsContext.Builder with the provided claims.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Context

get

Methods inherited from interface OAuth2TokenContext

getAuthorization, getAuthorizationGrant, getAuthorizationGrantType, getAuthorizationServerContext, getAuthorizedScopes, getPrincipal, getRegisteredClient, getTokenType

Method Details

get

public <V> @Nullable V get(Object key)

Description copied from interface: Context

Returns the value of the attribute associated to the key.

Specified by:

get in interface Context

Type Parameters:

V - the type of the value for the attribute

Parameters:

key - the key for the attribute

Returns:

the value of the attribute associated to the key, or null if not available

hasKey

public boolean hasKey(Object key)

Description copied from interface: Context

Returns true if an attribute associated to the key exists, false otherwise.

Specified by:

hasKey in interface Context

Parameters:

key - the key for the attribute

Returns:

true if an attribute associated to the key exists, false otherwise

getClaims

public OAuth2TokenClaimsSet.Builder getClaims()

Returns the claims allowing the ability to add, replace, or remove.

Returns:

the OAuth2TokenClaimsSet.Builder

with

public static OAuth2TokenClaimsContext.Builder with(OAuth2TokenClaimsSet.Builder claimsBuilder)

Constructs a new OAuth2TokenClaimsContext.Builder with the provided claims.

Parameters:

claimsBuilder - the claims to initialize the builder

Returns:

the OAuth2TokenClaimsContext.Builder