Class JwtAuthenticationToken

java.lang.Object

org.springframework.security.authentication.AbstractAuthenticationToken

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

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

All Implemented Interfaces:

Serializable, Principal, Authentication, CredentialsContainer

@Transient
public class JwtAuthenticationToken
extends AbstractOAuth2TokenAuthenticationToken<Jwt>

An implementation of an AbstractOAuth2TokenAuthenticationToken representing a Jwt Authentication.

Since:

5.1

See Also:

• AbstractOAuth2TokenAuthenticationToken
• Jwt
• Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class AbstractOAuth2TokenAuthenticationToken

AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<T,B>

Nested classes/interfaces inherited from class AbstractAuthenticationToken

AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>

Constructor Summary

Constructors

Modifier	Constructor	Description
	JwtAuthenticationToken(Jwt jwt)	Constructs a JwtAuthenticationToken using the provided parameters.
	JwtAuthenticationToken(Jwt jwt, Object principal, Collection<? extends GrantedAuthority> authorities)	Constructs a JwtAuthenticationToken using the provided parameters.
	JwtAuthenticationToken(Jwt jwt, Collection<? extends GrantedAuthority> authorities)	Constructs a JwtAuthenticationToken using the provided parameters.
	JwtAuthenticationToken(Jwt jwt, Collection<? extends GrantedAuthority> authorities, String name)	Constructs a JwtAuthenticationToken using the provided parameters.
protected	JwtAuthenticationToken(JwtAuthenticationToken.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
String	getName()	The principal name which is, by default, the Jwt's subject.
Map<String,Object>	getTokenAttributes()	Returns the attributes of the access token.
JwtAuthenticationToken.Builder<?>	toBuilder()	Return an Authentication.Builder based on this instance.

Methods inherited from class AbstractOAuth2TokenAuthenticationToken

getCredentials, getPrincipal, getToken

Methods inherited from class AbstractAuthenticationToken

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

Methods inherited from class Object

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

Methods inherited from interface Principal

implies

Constructor Details

JwtAuthenticationToken

public JwtAuthenticationToken(Jwt jwt)

Constructs a JwtAuthenticationToken using the provided parameters.

Parameters:

jwt - the JWT

JwtAuthenticationToken

public JwtAuthenticationToken(Jwt jwt,
 Collection<? extends GrantedAuthority> authorities)

Constructs a JwtAuthenticationToken using the provided parameters.

Parameters:

jwt - the JWT

authorities - the authorities assigned to the JWT

JwtAuthenticationToken

public JwtAuthenticationToken(Jwt jwt,
 Collection<? extends GrantedAuthority> authorities,
 String name)

Constructs a JwtAuthenticationToken using the provided parameters.

Parameters:

jwt - the JWT

authorities - the authorities assigned to the JWT

name - the principal name

JwtAuthenticationToken

protected JwtAuthenticationToken(JwtAuthenticationToken.Builder<?> builder)

JwtAuthenticationToken

public JwtAuthenticationToken(Jwt jwt,
 Object principal,
 Collection<? extends GrantedAuthority> authorities)

Constructs a JwtAuthenticationToken using the provided parameters.

Parameters:

jwt - the JWT

principal - the principal

authorities - the authorities assigned to the JWT

Since:

7.1

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<Jwt>

Returns:

a Map of the attributes in the access token.

getName

public String getName()

The principal name which is, by default, the Jwt's subject. Returns empty string if the subject claim is absent.

Specified by:

getName in interface Principal

Overrides:

getName in class AbstractAuthenticationToken

toBuilder

public JwtAuthenticationToken.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