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

Class OAuth2AuthorizationGrantAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

Direct Known Subclasses:

OAuth2AuthorizationCodeAuthenticationToken, OAuth2ClientCredentialsAuthenticationToken, OAuth2DeviceCodeAuthenticationToken, OAuth2RefreshTokenAuthenticationToken, OAuth2TokenExchangeAuthenticationToken

public class OAuth2AuthorizationGrantAuthenticationToken
extends AbstractAuthenticationToken

Base implementation of an Authentication representing an OAuth 2.0 Authorization Grant.

Since:

7.0

See Also:

• AbstractAuthenticationToken
• AuthorizationGrantType
• OAuth2ClientAuthenticationToken
• Section 1.3 Authorization Grant
• Serialized Form

Nested Class Summary

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

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

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

Authentication.Builder<B extends Authentication.Builder<B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OAuth2AuthorizationGrantAuthenticationToken(AuthorizationGrantType authorizationGrantType, Authentication clientPrincipal, Map<String,Object> additionalParameters)	Sub-class constructor.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAdditionalParameters()	Returns the additional parameters.
Object	getCredentials()	The credentials that prove the principal is correct.
AuthorizationGrantType	getGrantType()	Returns the authorization grant type.
Object	getPrincipal()	The identity of the principal being authenticated.

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

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

Methods inherited from class java.lang.Object

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

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

toBuilder

Methods inherited from interface java.security.Principal

implies

Constructor Details

OAuth2AuthorizationGrantAuthenticationToken

protected OAuth2AuthorizationGrantAuthenticationToken(AuthorizationGrantType authorizationGrantType,
 Authentication clientPrincipal,
 @Nullable
 Map<String,Object> additionalParameters)

Sub-class constructor.

Parameters:

authorizationGrantType - the authorization grant type

clientPrincipal - the authenticated client principal

additionalParameters - the additional parameters

Method Details

getGrantType

public AuthorizationGrantType getGrantType()

Returns the authorization grant type.

Returns:

the authorization grant type

getPrincipal

public Object getPrincipal()

Description copied from interface: Authentication

The identity of the principal being authenticated. In the case of an authentication request with username and password, this would be the username. Callers are expected to populate the principal for an authentication request.

The AuthenticationManager implementation will often return an Authentication containing richer information as the principal for use by the application. Many of the authentication providers will create a UserDetails object as the principal.

Returns:

the Principal being authenticated or the authenticated principal after authentication.

getCredentials

public Object getCredentials()

Description copied from interface: Authentication

The credentials that prove the principal is correct. This is usually a password, but could be anything relevant to the AuthenticationManager. Callers are expected to populate the credentials.

Returns:

the credentials that prove the identity of the Principal

getAdditionalParameters

public Map<String,Object> getAdditionalParameters()

Returns the additional parameters.

Returns:

the additional parameters