Class OAuth2AccessTokenAuthenticationContext

java.lang.Object

org.springframework.security.oauth2.server.authorization.authentication.OAuth2AccessTokenAuthenticationContext

All Implemented Interfaces:

OAuth2AuthenticationContext, Context

public final class OAuth2AccessTokenAuthenticationContext
extends Object
implements OAuth2AuthenticationContext

An OAuth2AuthenticationContext that holds an OAuth2AccessTokenAuthenticationToken and additional information and is used when customizing the OAuth2AccessTokenResponse.

Since:

7.0

See Also:

• OAuth2AuthenticationContext
• OAuth2AccessTokenAuthenticationToken
• OAuth2AccessTokenResponse
• OAuth2AccessTokenResponseAuthenticationSuccessHandler.setAccessTokenResponseCustomizer(Consumer)

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface OAuth2AuthenticationContext

OAuth2AuthenticationContext.AbstractBuilder<T,B>

Method Summary

Modifier and Type	Method	Description
<V> @Nullable V	get(Object key)	Returns the value of the attribute associated to the key.
OAuth2AccessTokenResponse.Builder	getAccessTokenResponse()	Returns the access token response builder.
boolean	hasKey(Object key)	Returns true if an attribute associated to the key exists, false otherwise.
static OAuth2AccessTokenAuthenticationContext.Builder	with(OAuth2AccessTokenAuthenticationToken authentication)	Constructs a new OAuth2AccessTokenAuthenticationContext.Builder with the provided OAuth2AccessTokenAuthenticationToken.

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 OAuth2AuthenticationContext

getAuthentication

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

getAccessTokenResponse

public OAuth2AccessTokenResponse.Builder getAccessTokenResponse()

Returns the access token response builder.

Returns:

the OAuth2AccessTokenResponse.Builder

with

public static OAuth2AccessTokenAuthenticationContext.Builder with(OAuth2AccessTokenAuthenticationToken authentication)

Constructs a new OAuth2AccessTokenAuthenticationContext.Builder with the provided OAuth2AccessTokenAuthenticationToken.

Parameters:

authentication - the OAuth2AccessTokenAuthenticationToken

Returns:

the OAuth2AccessTokenAuthenticationContext.Builder