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

Class OAuth2AuthorizationCodeRequestAuthenticationContext

java.lang.Object

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

All Implemented Interfaces:

OAuth2AuthenticationContext, Context

public final class OAuth2AuthorizationCodeRequestAuthenticationContext
extends Object
implements OAuth2AuthenticationContext

An OAuth2AuthenticationContext that holds an OAuth2AuthorizationCodeRequestAuthenticationToken and additional information and is used when validating the OAuth 2.0 Authorization Request parameters, as well as, determining if authorization consent is required.

Since:

0.4.0

See Also:

• OAuth2AuthenticationContext
• OAuth2AuthorizationCodeRequestAuthenticationToken
• OAuth2AuthorizationCodeRequestAuthenticationProvider.setAuthenticationValidator(Consumer)
• OAuth2AuthorizationCodeRequestAuthenticationProvider.setAuthorizationConsentRequired(Predicate)

Nested Class Summary

Nested Classes

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

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.
OAuth2AuthorizationConsent	getAuthorizationConsent()	Returns the authorization consent.
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 OAuth2AuthorizationCodeRequestAuthenticationContext.Builder	with(OAuth2AuthorizationCodeRequestAuthenticationToken authentication)	Constructs a new OAuth2AuthorizationCodeRequestAuthenticationContext.Builder with the provided OAuth2AuthorizationCodeRequestAuthenticationToken.

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

getRegisteredClient

public RegisteredClient getRegisteredClient()

Returns the registered client.

Returns:

the RegisteredClient

getAuthorizationRequest

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

Returns the authorization request.

Returns:

the OAuth2AuthorizationRequest

Since:

1.3

getAuthorizationConsent

@Nullable
public OAuth2AuthorizationConsent getAuthorizationConsent()

Returns the authorization consent.

Returns:

the OAuth2AuthorizationConsent

Since:

1.3

with

public static OAuth2AuthorizationCodeRequestAuthenticationContext.Builder with(OAuth2AuthorizationCodeRequestAuthenticationToken authentication)

Constructs a new OAuth2AuthorizationCodeRequestAuthenticationContext.Builder with the provided OAuth2AuthorizationCodeRequestAuthenticationToken.

Parameters:

authentication - the OAuth2AuthorizationCodeRequestAuthenticationToken

Returns:

the OAuth2AuthorizationCodeRequestAuthenticationContext.Builder