Package org.springframework.security.oauth2.server.resource.authentication

Class BearerTokenAuthentication

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

org.springframework.security.oauth2.server.resource.authentication.BearerTokenAuthentication

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

@Transient
public class BearerTokenAuthentication
extends AbstractOAuth2TokenAuthenticationToken<OAuth2AccessToken>

An Authentication token that represents a successful authentication as obtained through a bearer token.

Since:

5.2

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BearerTokenAuthentication.Builder<B extends BearerTokenAuthentication.Builder<B>>	A builder preserving the concrete Authentication type

Nested classes/interfaces inherited from class org.springframework.security.oauth2.server.resource.authentication.AbstractOAuth2TokenAuthenticationToken

AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<T extends OAuth2Token,B extends AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<T,B>>

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

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Constructor Summary

Constructors

Modifier	Constructor	Description
	BearerTokenAuthentication(OAuth2AuthenticatedPrincipal principal, OAuth2AccessToken credentials, Collection<? extends GrantedAuthority> authorities)	Constructs a BearerTokenAuthentication with the provided arguments
protected	BearerTokenAuthentication(BearerTokenAuthentication.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getTokenAttributes()	Returns the attributes of the access token.
BearerTokenAuthentication.Builder<?>	toBuilder()	Return an Authentication.Builder based on this instance.

Methods inherited from class org.springframework.security.oauth2.server.resource.authentication.AbstractOAuth2TokenAuthenticationToken

getCredentials, getPrincipal, getToken

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

BearerTokenAuthentication

public BearerTokenAuthentication(OAuth2AuthenticatedPrincipal principal,
 OAuth2AccessToken credentials,
 Collection<? extends GrantedAuthority> authorities)

Constructs a BearerTokenAuthentication with the provided arguments

Parameters:

principal - The OAuth 2.0 attributes

credentials - The verified token

authorities - The authorities associated with the given token

BearerTokenAuthentication

protected BearerTokenAuthentication(BearerTokenAuthentication.Builder<?> builder)

Method Details

getTokenAttributes

public Map<String,Object> getTokenAttributes()

Description copied from class: AbstractOAuth2TokenAuthenticationToken

Returns the attributes of the access token.

Specified by:

getTokenAttributes in class AbstractOAuth2TokenAuthenticationToken<OAuth2AccessToken>

Returns:

a Map of the attributes in the access token.

toBuilder

public BearerTokenAuthentication.Builder<?> toBuilder()

Description copied from interface: Authentication

Return an Authentication.Builder based on this instance. By default, returns a builder that builds a SimpleAuthentication.

Although a default method, all Authentication implementations should implement this. The reason is to ensure that the Authentication type is preserved when Authentication.Builder.build() is invoked. This is especially important in the event that your authentication implementation contains custom fields.

This isn't strictly necessary since it is recommended that applications code to the Authentication interface and that custom information is often contained in the Authentication.getPrincipal() value.

Returns:

an Authentication.Builder for building a new Authentication based on this instance