Package org.springframework.security.core

Interface Authentication.Builder<B extends Authentication.Builder<B>>

All Known Implementing Classes:

AbstractAuthenticationToken.AbstractAuthenticationBuilder, AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder, BearerTokenAuthentication.Builder, CasAuthenticationToken.Builder, CasServiceTicketAuthenticationToken.Builder, JaasAuthenticationToken.Builder, JwtAuthenticationToken.Builder, OAuth2AuthenticationToken.Builder, OneTimeTokenAuthentication.Builder, PreAuthenticatedAuthenticationToken.Builder, RememberMeAuthenticationToken.Builder, Saml2AssertionAuthentication.Builder, TestingAuthenticationToken.Builder, UsernamePasswordAuthenticationToken.Builder, WebAuthnAuthentication.Builder

Enclosing interface:

Authentication

public static interface Authentication.Builder<B extends Authentication.Builder<B>>

A builder based on a given Authentication instance

Since:

7.0

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.
Authentication	build()	Build an Authentication instance
default B	credentials(@Nullable Object credentials)	Use this credential.
B	details(@Nullable Object details)	Use this details object.
B	principal(@Nullable Object principal)	Use this principal.

Method Details

authorities

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

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 authenticated(boolean) by default.

Parameters:

authorities - a consumer that receives the full set of authorities

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getAuthorities()

credentials

default B credentials(@Nullable Object credentials)

Use this credential.

Note that since some credentials are insecure to store, this method is implemented as unsupported by default. Only implement or use this method if you support secure storage of the credential or if your implementation also implements CredentialsContainer and the credentials are thereby erased.

Parameters:

credentials - the credentials to use

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getCredentials()

details

B details(@Nullable Object details)

Use this details object.

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

Parameters:

details - the details to use

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.getDetails()

principal

B principal(@Nullable Object principal)

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()

authenticated

B authenticated(boolean authenticated)

Mark this authentication as authenticated or not

Parameters:

authenticated - whether this is an authenticated Authentication instance

Returns:

the Authentication.Builder for additional configuration

See Also:

• Authentication.isAuthenticated()

build

Authentication build()

Build an Authentication instance

Returns:

the Authentication instance