Class OAuth2AuthorizationCodeRequestAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

Serializable, Principal, org.springframework.security.core.Authentication, org.springframework.security.core.CredentialsContainer

public class OAuth2AuthorizationCodeRequestAuthenticationToken
extends org.springframework.security.authentication.AbstractAuthenticationToken

An Authentication implementation for the OAuth 2.0 Authorization Request used in the Authorization Code Grant.

Since:

7.0

See Also:

• OAuth2AuthorizationCodeRequestAuthenticationProvider
• OAuth2AuthorizationConsentAuthenticationProvider
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.authentication.AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>

Nested classes/interfaces inherited from interface org.springframework.security.core.Authentication

org.springframework.security.core.Authentication.Builder<B>

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthorizationCodeRequestAuthenticationToken(String authorizationUri, String clientId, org.springframework.security.core.Authentication principal, @Nullable String redirectUri, @Nullable String state, @Nullable Set<String> scopes, @Nullable Map<String,Object> additionalParameters)	Constructs an OAuth2AuthorizationCodeRequestAuthenticationToken using the provided parameters.
OAuth2AuthorizationCodeRequestAuthenticationToken(String authorizationUri, String clientId, org.springframework.security.core.Authentication principal, OAuth2AuthorizationCode authorizationCode, @Nullable String redirectUri, @Nullable String state, @Nullable Set<String> scopes)	Constructs an OAuth2AuthorizationCodeRequestAuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalParameters()	Returns the additional parameters.
@Nullable OAuth2AuthorizationCode	getAuthorizationCode()	Returns the OAuth2AuthorizationCode.
String	getAuthorizationUri()	Returns the authorization URI.
String	getClientId()	Returns the client identifier.
Object	getCredentials()
Object	getPrincipal()
@Nullable String	getRedirectUri()	Returns the redirect uri.
Set<String>	getScopes()	Returns the requested (or authorized) scope(s).
@Nullable String	getState()	Returns the state.

Methods inherited from class org.springframework.security.authentication.AbstractAuthenticationToken

equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, isAuthenticated, setAuthenticated, setDetails, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.security.core.Authentication

toBuilder

Methods inherited from interface Principal

implies

Constructor Details

OAuth2AuthorizationCodeRequestAuthenticationToken

public OAuth2AuthorizationCodeRequestAuthenticationToken(String authorizationUri,
 String clientId,
 org.springframework.security.core.Authentication principal,
 @Nullable String redirectUri,
 @Nullable String state,
 @Nullable Set<String> scopes,
 @Nullable Map<String,Object> additionalParameters)

Constructs an OAuth2AuthorizationCodeRequestAuthenticationToken using the provided parameters.

Parameters:

authorizationUri - the authorization URI

clientId - the client identifier

principal - the Principal (Resource Owner)

redirectUri - the redirect uri

state - the state

scopes - the requested scope(s)

additionalParameters - the additional parameters

OAuth2AuthorizationCodeRequestAuthenticationToken

public OAuth2AuthorizationCodeRequestAuthenticationToken(String authorizationUri,
 String clientId,
 org.springframework.security.core.Authentication principal,
 OAuth2AuthorizationCode authorizationCode,
 @Nullable String redirectUri,
 @Nullable String state,
 @Nullable Set<String> scopes)

Constructs an OAuth2AuthorizationCodeRequestAuthenticationToken using the provided parameters.

Parameters:

authorizationUri - the authorization URI

clientId - the client identifier

principal - the Principal (Resource Owner)

authorizationCode - the OAuth2AuthorizationCode

redirectUri - the redirect uri

state - the state

scopes - the authorized scope(s)

Method Details

getAuthorizationCode

public @Nullable OAuth2AuthorizationCode getAuthorizationCode()

Returns the OAuth2AuthorizationCode.

Returns:

the OAuth2AuthorizationCode

getPrincipal

public Object getPrincipal()

getCredentials

public Object getCredentials()

getAuthorizationUri

public String getAuthorizationUri()

Returns the authorization URI.

Returns:

the authorization URI

getClientId

public String getClientId()

Returns the client identifier.

Returns:

the client identifier

getRedirectUri

public @Nullable String getRedirectUri()

Returns the redirect uri.

Returns:

the redirect uri

getState

public @Nullable String getState()

Returns the state.

Returns:

the state

getScopes

public Set<String> getScopes()

Returns the requested (or authorized) scope(s).

Returns:

the requested (or authorized) scope(s), or an empty Set if not available

getAdditionalParameters

public Map<String,Object> getAdditionalParameters()

Returns the additional parameters.

Returns:

the additional parameters, or an empty Map if not available