Class AbstractOAuth2TokenAuthenticationToken<T extends org.springframework.security.oauth2.core.OAuth2Token>

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

org.springframework.security.oauth2.server.resource.authentication.AbstractOAuth2TokenAuthenticationToken<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

BearerTokenAuthentication, JwtAuthenticationToken

public abstract class AbstractOAuth2TokenAuthenticationToken<T extends org.springframework.security.oauth2.core.OAuth2Token>
extends org.springframework.security.authentication.AbstractAuthenticationToken

Base class for AbstractAuthenticationToken implementations that expose common attributes between different OAuth 2.0 Access Token Formats.

For example, a Jwt could expose its claims via getTokenAttributes() or an "Introspected" OAuth 2.0 Access Token could expose the attributes of the Introspection Response via getTokenAttributes().

Since:

5.1

See Also:

• OAuth2AccessToken
• Jwt
• 2.2 Introspection Response
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<T extends org.springframework.security.oauth2.core.OAuth2Token, B extends AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<T,B>>	A builder for AbstractOAuth2TokenAuthenticationToken implementations

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

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

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

org.springframework.security.core.Authentication.Builder<B>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOAuth2TokenAuthenticationToken(AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<T,?> builder)
protected	AbstractOAuth2TokenAuthenticationToken(T token)	Sub-class constructor.
protected	AbstractOAuth2TokenAuthenticationToken(T token, Object principal, Object credentials, @Nullable Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)
protected	AbstractOAuth2TokenAuthenticationToken(T token, @Nullable Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)	Sub-class constructor.

Method Summary

Modifier and Type	Method	Description
Object	getCredentials()
Object	getPrincipal()
final T	getToken()	Get the token bound to this Authentication.
abstract Map<String,Object>	getTokenAttributes()	Returns the attributes of the access token.

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

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

Methods inherited from class Object

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

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

toBuilder

Methods inherited from interface Principal

implies

Constructor Details

AbstractOAuth2TokenAuthenticationToken

protected AbstractOAuth2TokenAuthenticationToken(T token)

Sub-class constructor.

AbstractOAuth2TokenAuthenticationToken

protected AbstractOAuth2TokenAuthenticationToken(T token,
 @Nullable Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

Sub-class constructor.

Parameters:

authorities - the authorities assigned to the Access Token, or null

AbstractOAuth2TokenAuthenticationToken

protected AbstractOAuth2TokenAuthenticationToken(T token,
 Object principal,
 Object credentials,
 @Nullable Collection<? extends org.springframework.security.core.GrantedAuthority> authorities)

AbstractOAuth2TokenAuthenticationToken

protected AbstractOAuth2TokenAuthenticationToken(AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<T,?> builder)

Method Details

getPrincipal

public Object getPrincipal()

getCredentials

public Object getCredentials()

getToken

public final T getToken()

Get the token bound to this Authentication.

getTokenAttributes

public abstract Map<String,Object> getTokenAttributes()

Returns the attributes of the access token.

Returns:

a Map of the attributes in the access token.