Class OAuth2DeviceVerificationAuthenticationContext

java.lang.Object

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

All Implemented Interfaces:

OAuth2AuthenticationContext, Context

public final class OAuth2DeviceVerificationAuthenticationContext
extends Object
implements OAuth2AuthenticationContext

An OAuth2AuthenticationContext that holds an OAuth2DeviceVerificationAuthenticationToken and additional information and is used when determining if authorization consent is required.

Since:

7.0

See Also:

• OAuth2AuthenticationContext
• OAuth2DeviceVerificationAuthenticationToken
• OAuth2DeviceVerificationAuthenticationProvider.setAuthorizationConsentRequired(java.util.function.Predicate)

Nested Class Summary

Nested Classes

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

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.
OAuth2Authorization	getAuthorization()	Returns the authorization.
@Nullable OAuth2AuthorizationConsent	getAuthorizationConsent()	Returns the authorization consent.
RegisteredClient	getRegisteredClient()	Returns the registered client.
Set<String>	getRequestedScopes()	Returns the requested scopes.
boolean	hasKey(Object key)	Returns true if an attribute associated to the key exists, false otherwise.
static OAuth2DeviceVerificationAuthenticationContext.Builder	with(OAuth2DeviceVerificationAuthenticationToken authentication)	Constructs a new OAuth2DeviceVerificationAuthenticationContext.Builder with the provided OAuth2DeviceVerificationAuthenticationToken.

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

getRegisteredClient

public RegisteredClient getRegisteredClient()

Returns the registered client.

Returns:

the RegisteredClient

getAuthorization

public OAuth2Authorization getAuthorization()

Returns the authorization.

Returns:

the OAuth2Authorization

getAuthorizationConsent

public @Nullable OAuth2AuthorizationConsent getAuthorizationConsent()

Returns the authorization consent.

Returns:

the OAuth2AuthorizationConsent, or null if not available

getRequestedScopes

public Set<String> getRequestedScopes()

Returns the requested scopes.

Returns:

the requested scopes

with

public static OAuth2DeviceVerificationAuthenticationContext.Builder with(OAuth2DeviceVerificationAuthenticationToken authentication)

Constructs a new OAuth2DeviceVerificationAuthenticationContext.Builder with the provided OAuth2DeviceVerificationAuthenticationToken.

Parameters:

authentication - the OAuth2DeviceVerificationAuthenticationToken

Returns:

the OAuth2DeviceVerificationAuthenticationContext.Builder