org.springframework.security.oauth2.client.authentication

Class AuthorizationCodeAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.client.authentication.AuthorizationGrantAuthenticationToken

org.springframework.security.oauth2.client.authentication.AuthorizationCodeAuthenticationToken

All Implemented Interfaces:

java.io.Serializable, java.security.Principal, Authentication, CredentialsContainer

public class AuthorizationCodeAuthenticationToken
extends AuthorizationGrantAuthenticationToken

An implementation of an AuthorizationGrantAuthenticationToken that holds an authorization code grant credential for a specific client identified in getClientRegistration().

Since:

5.0

See Also:

AuthorizationGrantAuthenticationToken, ClientRegistration, AuthorizationRequest, AuthorizationResponse, Section 1.3.1 Authorization Code Grant, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration, AuthorizationRequest authorizationRequest, AuthorizationResponse authorizationResponse)

Method Summary

Modifier and Type	Method and Description
AuthorizationRequest	getAuthorizationRequest()
AuthorizationResponse	getAuthorizationResponse()
ClientRegistration	getClientRegistration()
java.lang.Object	getCredentials() The credentials that prove the principal is correct.
java.lang.Object	getPrincipal() The identity of the principal being authenticated.

Methods inherited from class org.springframework.security.oauth2.client.authentication.AuthorizationGrantAuthenticationToken

getGrantType

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 java.security.Principal

implies

Constructor Detail

AuthorizationCodeAuthenticationToken

public AuthorizationCodeAuthenticationToken(ClientRegistration clientRegistration,
                                            AuthorizationRequest authorizationRequest,
                                            AuthorizationResponse authorizationResponse)

Method Detail

getPrincipal

public java.lang.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 java.lang.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

getClientRegistration

public ClientRegistration getClientRegistration()

getAuthorizationRequest

public AuthorizationRequest getAuthorizationRequest()

getAuthorizationResponse

public AuthorizationResponse getAuthorizationResponse()