org.springframework.security.oauth2.client.authentication

Class OAuth2AuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken

All Implemented Interfaces:

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

public class OAuth2AuthenticationToken
extends AbstractAuthenticationToken

An implementation of an AbstractAuthenticationToken that represents an OAuth 2.0 Authentication.

It associates an OAuth2User, ClientRegistration and an AccessToken. This Authentication is considered "authenticated" if the OAuth2User is provided in the respective constructor. This typically happens after the OAuth2UserService retrieves the end-user's (resource owner) attributes from the UserInfo Endpoint.

Since:

5.0

See Also:

OAuth2User, ClientRegistration, AccessToken, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthenticationToken(ClientRegistration clientRegistration, AccessToken accessToken)
OAuth2AuthenticationToken(OAuth2User principal, java.util.Collection<? extends GrantedAuthority> authorities, ClientRegistration clientRegistration, AccessToken accessToken)

Method Summary

Modifier and Type	Method and Description
AccessToken	getAccessToken()
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.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

OAuth2AuthenticationToken

public OAuth2AuthenticationToken(ClientRegistration clientRegistration,
                                 AccessToken accessToken)

OAuth2AuthenticationToken

public OAuth2AuthenticationToken(OAuth2User principal,
                                 java.util.Collection<? extends GrantedAuthority> authorities,
                                 ClientRegistration clientRegistration,
                                 AccessToken accessToken)

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

getAccessToken

public AccessToken getAccessToken()