Package org.springframework.security.oauth2.client.authentication

Class OAuth2LoginAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.client.authentication.OAuth2LoginAuthenticationToken

All Implemented Interfaces:

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

public class OAuth2LoginAuthenticationToken
extends AbstractAuthenticationToken

An AbstractAuthenticationToken for OAuth 2.0 Login, which leverages the OAuth 2.0 Authorization Code Grant Flow.

Since:

5.0

See Also:

AbstractAuthenticationToken, OAuth2User, ClientRegistration, OAuth2AuthorizationExchange, OAuth2AccessToken, Section 4.1 Authorization Code Grant Flow, Serialized Form

Constructor Summary

Constructors

Constructor	Description
OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange)	This constructor should be used when the Authorization Request/Response is complete.
OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange, OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, OAuth2AccessToken accessToken)	This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed and OAuth 2.0 Login has been achieved.
OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration, OAuth2AuthorizationExchange authorizationExchange, OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, OAuth2AccessToken accessToken, OAuth2RefreshToken refreshToken)	This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed and OAuth 2.0 Login has been achieved.

Method Summary

Modifier and Type	Method	Description
OAuth2AccessToken	getAccessToken()	Returns the access token.
OAuth2AuthorizationExchange	getAuthorizationExchange()	Returns the authorization exchange.
ClientRegistration	getClientRegistration()	Returns the client registration.
java.lang.Object	getCredentials()	The credentials that prove the principal is correct.
OAuth2User	getPrincipal()	The identity of the principal being authenticated.
OAuth2RefreshToken	getRefreshToken()	Returns the refresh token.

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

OAuth2LoginAuthenticationToken

public OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration,
                                      OAuth2AuthorizationExchange authorizationExchange)

This constructor should be used when the Authorization Request/Response is complete.

Parameters:

clientRegistration - the client registration

authorizationExchange - the authorization exchange

OAuth2LoginAuthenticationToken

public OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration,
                                      OAuth2AuthorizationExchange authorizationExchange,
                                      OAuth2User principal,
                                      java.util.Collection<? extends GrantedAuthority> authorities,
                                      OAuth2AccessToken accessToken)

This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed and OAuth 2.0 Login has been achieved.

Parameters:

clientRegistration - the client registration

authorizationExchange - the authorization exchange

principal - the user Principal registered with the OAuth 2.0 Provider

authorities - the authorities granted to the user

accessToken - the access token credential

OAuth2LoginAuthenticationToken

public OAuth2LoginAuthenticationToken(ClientRegistration clientRegistration,
                                      OAuth2AuthorizationExchange authorizationExchange,
                                      OAuth2User principal,
                                      java.util.Collection<? extends GrantedAuthority> authorities,
                                      OAuth2AccessToken accessToken,
                                      @Nullable
                                      OAuth2RefreshToken refreshToken)

This constructor should be used when the Access Token Request/Response is complete, which indicates that the Authorization Code Grant flow has fully completed and OAuth 2.0 Login has been achieved.

Parameters:

clientRegistration - the client registration

authorizationExchange - the authorization exchange

principal - the user Principal registered with the OAuth 2.0 Provider

authorities - the authorities granted to the user

accessToken - the access token credential

refreshToken - the refresh token credential

Method Detail

getPrincipal

public OAuth2User 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()

Returns the client registration.

Returns:

the ClientRegistration

getAuthorizationExchange

public OAuth2AuthorizationExchange getAuthorizationExchange()

Returns the authorization exchange.

Returns:

the OAuth2AuthorizationExchange

getAccessToken

public OAuth2AccessToken getAccessToken()

Returns the access token.

Returns:

the OAuth2AccessToken

getRefreshToken

@Nullable
public OAuth2RefreshToken getRefreshToken()

Returns the refresh token.

Returns:

the OAuth2RefreshToken

Since:

5.1