Package org.springframework.security.authentication

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

java.lang.Object

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

Type Parameters:

B -

All Implemented Interfaces:

Authentication.Builder<B>

Direct Known Subclasses:

AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder, CasAuthenticationToken.Builder, CasServiceTicketAuthenticationToken.Builder, OAuth2AuthenticationToken.Builder, OneTimeTokenAuthentication.Builder, PreAuthenticatedAuthenticationToken.Builder, RememberMeAuthenticationToken.Builder, Saml2AssertionAuthentication.Builder, TestingAuthenticationToken.Builder, UsernamePasswordAuthenticationToken.Builder, WebAuthnAuthentication.Builder

Enclosing class:

AbstractAuthenticationToken

protected abstract static class AbstractAuthenticationToken.AbstractAuthenticationBuilder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>
extends Object
implements Authentication.Builder<B>

A common abstract implementation of Authentication.Builder. It implements the builder methods that correspond to the Authentication methods that AbstractAuthenticationToken implements

Since:

7.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAuthenticationBuilder(AbstractAuthenticationToken token)

Method Summary

Modifier and Type	Method	Description
B	authenticated(boolean authenticated)	Mark this authentication as authenticated or not
B	authorities(Consumer<Collection<GrantedAuthority>> authorities)	Mutate the authorities with this Consumer.
B	details(@Nullable Object details)	Use this details object.

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

build, credentials, principal

Constructor Details

AbstractAuthenticationBuilder

protected AbstractAuthenticationBuilder(AbstractAuthenticationToken token)

Method Details

authenticated

public B authenticated(boolean authenticated)

Description copied from interface: Authentication.Builder

Mark this authentication as authenticated or not

Specified by:

authenticated in interface Authentication.Builder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Parameters:

authenticated - whether this is an authenticated Authentication instance

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.isAuthenticated()

details

public B details(@Nullable Object details)

Description copied from interface: Authentication.Builder

Use this details object.

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

Specified by:

details in interface Authentication.Builder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Parameters:

details - the details to use

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getDetails()

authorities

public B authorities(Consumer<Collection<GrantedAuthority>> authorities)

Description copied from interface: Authentication.Builder

Mutate the authorities with this Consumer.

Note that since a non-empty set of authorities implies an Authentication is authenticated, this method also marks the authentication as Authentication.Builder.authenticated(boolean) by default.

Specified by:

authorities in interface Authentication.Builder<B extends AbstractAuthenticationToken.AbstractAuthenticationBuilder<B>>

Parameters:

authorities - a consumer that receives the full set of authorities

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getAuthorities()