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

Class OAuth2AuthorizationConsentAuthenticationContext

java.lang.Object

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

All Implemented Interfaces:

OAuth2AuthenticationContext, Context

public final class OAuth2AuthorizationConsentAuthenticationContext
extends Object
implements OAuth2AuthenticationContext

An OAuth2AuthenticationContext that holds an OAuth2AuthorizationConsent.Builder and additional information and is used when customizing the building of the OAuth2AuthorizationConsent.

Since:

0.2.1

See Also:

• OAuth2AuthenticationContext
• OAuth2AuthorizationConsent
• OAuth2AuthorizationConsentAuthenticationProvider.setAuthorizationConsentCustomizer(Consumer)

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthenticationContext

OAuth2AuthenticationContext.AbstractBuilder<T extends OAuth2AuthenticationContext,B extends OAuth2AuthenticationContext.AbstractBuilder<T,B>>

Method Summary

Modifier and Type	Method	Description
<V> V	get(Object key)	Returns the value of the attribute associated to the key.
OAuth2Authorization	getAuthorization()	Returns the authorization.
OAuth2AuthorizationConsent.Builder	getAuthorizationConsent()	Returns the authorization consent builder.
org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest	getAuthorizationRequest()	Returns the authorization request.
RegisteredClient	getRegisteredClient()	Returns the registered client.
boolean	hasKey(Object key)	Returns true if an attribute associated to the key exists, false otherwise.
static OAuth2AuthorizationConsentAuthenticationContext.Builder	with(OAuth2AuthorizationConsentAuthenticationToken authentication)	Constructs a new OAuth2AuthorizationConsentAuthenticationContext.Builder with the provided OAuth2AuthorizationConsentAuthenticationToken.

Methods inherited from class java.lang.Object

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

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

get

Methods inherited from interface org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthenticationContext

getAuthentication

Method Details

get

@Nullable
public <V> 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

getAuthorizationConsent

public OAuth2AuthorizationConsent.Builder getAuthorizationConsent()

Returns the authorization consent builder.

Returns:

the OAuth2AuthorizationConsent.Builder

getRegisteredClient

public RegisteredClient getRegisteredClient()

Returns the registered client.

Returns:

the RegisteredClient

getAuthorization

public OAuth2Authorization getAuthorization()

Returns the authorization.

Returns:

the OAuth2Authorization

getAuthorizationRequest

public org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest getAuthorizationRequest()

Returns the authorization request.

Returns:

the OAuth2AuthorizationRequest

with

public static OAuth2AuthorizationConsentAuthenticationContext.Builder with(OAuth2AuthorizationConsentAuthenticationToken authentication)

Constructs a new OAuth2AuthorizationConsentAuthenticationContext.Builder with the provided OAuth2AuthorizationConsentAuthenticationToken.

Parameters:

authentication - the OAuth2AuthorizationConsentAuthenticationToken

Returns:

the OAuth2AuthorizationConsentAuthenticationContext.Builder