Package 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:

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

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

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

The Authentication associates an OAuth2User Principal to the identifier of the Authorized Client, which the End-User (Principal) granted authorization to so that it can access its protected resources at the UserInfo Endpoint.

Since:

5.0

See Also:

• AbstractAuthenticationToken
• OAuth2User
• OAuth2AuthorizedClient
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OAuth2AuthenticationToken.Builder<B extends OAuth2AuthenticationToken.Builder<B>>	A builder of OAuth2AuthenticationToken instances

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OAuth2AuthenticationToken(OAuth2AuthenticationToken.Builder<?> builder)
	OAuth2AuthenticationToken(org.springframework.security.oauth2.core.user.OAuth2User principal, Collection<? extends org.springframework.security.core.GrantedAuthority> authorities, String authorizedClientRegistrationId)	Constructs an OAuth2AuthenticationToken using the provided parameters.

Method Summary

Modifier and Type	Method	Description
String	getAuthorizedClientRegistrationId()	Returns the registration identifier of the Authorized Client.
Object	getCredentials()
org.springframework.security.oauth2.core.user.OAuth2User	getPrincipal()
OAuth2AuthenticationToken.Builder<?>	toBuilder()

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 Details

OAuth2AuthenticationToken

public OAuth2AuthenticationToken(org.springframework.security.oauth2.core.user.OAuth2User principal,
 Collection<? extends org.springframework.security.core.GrantedAuthority> authorities,
 String authorizedClientRegistrationId)

Constructs an OAuth2AuthenticationToken using the provided parameters.

Parameters:

principal - the user Principal registered with the OAuth 2.0 Provider

authorities - the authorities granted to the user

authorizedClientRegistrationId - the registration identifier of the Authorized Client

OAuth2AuthenticationToken

protected OAuth2AuthenticationToken(OAuth2AuthenticationToken.Builder<?> builder)

Method Details

getPrincipal

public org.springframework.security.oauth2.core.user.OAuth2User getPrincipal()

getCredentials

public Object getCredentials()

getAuthorizedClientRegistrationId

public String getAuthorizedClientRegistrationId()

Returns the registration identifier of the Authorized Client.

Returns:

the registration identifier of the Authorized Client.

toBuilder

public OAuth2AuthenticationToken.Builder<?> toBuilder()