Package org.springframework.security.authentication

Class RememberMeAuthenticationToken.Builder<B extends RememberMeAuthenticationToken.Builder<B>>

java.lang.Object

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

org.springframework.security.authentication.RememberMeAuthenticationToken.Builder<B>

All Implemented Interfaces:

Authentication.Builder<B>

Enclosing class:

RememberMeAuthenticationToken

public static class RememberMeAuthenticationToken.Builder<B extends RememberMeAuthenticationToken.Builder<B>>
extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>

A builder of RememberMeAuthenticationToken instances

Since:

7.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(RememberMeAuthenticationToken token)

Method Summary

Modifier and Type	Method	Description
RememberMeAuthenticationToken	build()	Build an Authentication instance
B	key(String key)	Use this key
B	principal(@Nullable Object principal)	Use this principal.

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

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

credentials

Constructor Details

Builder

protected Builder(RememberMeAuthenticationToken token)

Method Details

principal

public B principal(@Nullable Object principal)

Description copied from interface: Authentication.Builder

Use this principal.

Note that in many cases, the principal is strongly-typed. Implementations may choose to do a type check and are not necessarily expected to allow any object as a principal.

Implementations may choose to use this principal in combination with any principal from the pre-existing Authentication instance.

Parameters:

principal - the principal to use

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getPrincipal()

key

public B key(String key)

Use this key

Parameters:

key - the key to use

Returns:

the RememberMeAuthenticationToken.Builder for further configurations

build

public RememberMeAuthenticationToken build()

Description copied from interface: Authentication.Builder

Build an Authentication instance

Returns:

the Authentication instance