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

Class JwtAuthenticationToken.Builder<B extends JwtAuthenticationToken.Builder<B>>

java.lang.Object

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

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

org.springframework.security.oauth2.server.resource.authentication.JwtAuthenticationToken.Builder<B>

All Implemented Interfaces:

Authentication.Builder<B>

Enclosing class:

JwtAuthenticationToken

public static class JwtAuthenticationToken.Builder<B extends JwtAuthenticationToken.Builder<B>>
extends AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<Jwt,B>

A builder for JwtAuthenticationToken instances

Since:

7.0

See Also:

• Authentication.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(JwtAuthenticationToken token)

Method Summary

Modifier and Type	Method	Description
JwtAuthenticationToken	build()	Build an Authentication instance
B	credentials(@Nullable Object credentials)	A synonym for token(Jwt)
B	name(String name)	The name to use.
B	principal(@Nullable Object principal)	A synonym for token(Jwt)
B	token(Jwt token)	Use this token as the token, principal, and credentials.

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

authenticated, authorities, details

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder(JwtAuthenticationToken token)

Method Details

principal

public B principal(@Nullable Object principal)

A synonym for token(Jwt)

Specified by:

principal in interface Authentication.Builder<B extends JwtAuthenticationToken.Builder<B>>

Overrides:

principal in class AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<Jwt,B extends JwtAuthenticationToken.Builder<B>>

Parameters:

principal - the principal to use

Returns:

the JwtAuthenticationToken.Builder for further configurations

See Also:

• Authentication.getPrincipal()

credentials

public B credentials(@Nullable Object credentials)

A synonym for token(Jwt)

Specified by:

credentials in interface Authentication.Builder<B extends JwtAuthenticationToken.Builder<B>>

Overrides:

credentials in class AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<Jwt,B extends JwtAuthenticationToken.Builder<B>>

Parameters:

credentials - the credentials to use

Returns:

the JwtAuthenticationToken.Builder for further configurations

See Also:

• Authentication.getCredentials()

token

public B token(Jwt token)

Use this token as the token, principal, and credentials. Also sets the name to JwtClaimAccessor.getSubject().

Overrides:

token in class AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<Jwt,B extends JwtAuthenticationToken.Builder<B>>

Parameters:

token - the token to use

Returns:

the JwtAuthenticationToken.Builder for further configurations

name

public B name(String name)

The name to use.

Parameters:

name - the name to use

Returns:

the JwtAuthenticationToken.Builder for further configurations

build

public JwtAuthenticationToken build()

Description copied from interface: Authentication.Builder

Build an Authentication instance

Returns:

the Authentication instance