Package org.springframework.security.oauth2.client.authentication

Class OAuth2AuthenticationToken.Builder<B extends OAuth2AuthenticationToken.Builder<B>>

java.lang.Object

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

org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken.Builder<B>

All Implemented Interfaces:

Authentication.Builder<B>

Enclosing class:

OAuth2AuthenticationToken

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

A builder of OAuth2AuthenticationToken instances

Since:

7.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(OAuth2AuthenticationToken token)

Method Summary

Modifier and Type	Method	Description
B	authorizedClientRegistrationId(String authorizedClientRegistrationId)	Use this ClientRegistration registrationId.
OAuth2AuthenticationToken	build()	Build an Authentication instance
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(OAuth2AuthenticationToken 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()

authorizedClientRegistrationId

public B authorizedClientRegistrationId(String authorizedClientRegistrationId)

Use this ClientRegistration registrationId.

Parameters:

authorizedClientRegistrationId - the registration id to use

Returns:

the OAuth2AuthenticationToken.Builder for further configurations

See Also:

• OAuth2AuthenticationToken.getAuthorizedClientRegistrationId()

build

public OAuth2AuthenticationToken build()

Description copied from interface: Authentication.Builder

Build an Authentication instance

Returns:

the Authentication instance