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

Class BearerTokenAuthentication.Builder<B extends BearerTokenAuthentication.Builder<B>>

java.lang.Object

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

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

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

All Implemented Interfaces:

Authentication.Builder<B>

Enclosing class:

BearerTokenAuthentication

public static class BearerTokenAuthentication.Builder<B extends BearerTokenAuthentication.Builder<B>>
extends AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<OAuth2AccessToken,B>

A builder preserving the concrete Authentication type

Since:

7.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(BearerTokenAuthentication token)

Method Summary

Modifier and Type	Method	Description
BearerTokenAuthentication	build()	Build an Authentication instance
B	credentials(@Nullable Object token)	A synonym for token(OAuth2AccessToken)
B	principal(@Nullable Object principal)	Use this principal.
B	token(OAuth2AccessToken token)	Use this token.

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

Method Details

principal

public B principal(@Nullable Object principal)

Use this principal. Must be of type OAuth2AuthenticatedPrincipal

Specified by:

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

Overrides:

principal in class AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<OAuth2AccessToken,B extends BearerTokenAuthentication.Builder<B>>

Parameters:

principal - the principal to use

Returns:

the BearerTokenAuthentication.Builder for further configurations

See Also:

• Authentication.getPrincipal()

credentials

public B credentials(@Nullable Object token)

A synonym for token(OAuth2AccessToken)

Specified by:

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

Overrides:

credentials in class AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<OAuth2AccessToken,B extends BearerTokenAuthentication.Builder<B>>

Parameters:

token - the token to use

Returns:

the BearerTokenAuthentication.Builder for further configurations

See Also:

• Authentication.getCredentials()

token

public B token(OAuth2AccessToken token)

Use this token. Must have a OAuth2AccessToken.getTokenType() as OAuth2AccessToken.TokenType.BEARER.

Overrides:

token in class AbstractOAuth2TokenAuthenticationToken.AbstractOAuth2TokenAuthenticationBuilder<OAuth2AccessToken,B extends BearerTokenAuthentication.Builder<B>>

Parameters:

token - the token to use

Returns:

the BearerTokenAuthentication.Builder for further configurations

build

public BearerTokenAuthentication build()

Build an Authentication instance

Returns:

the Authentication instance