Package org.springframework.security.oauth2.server.authorization.client

Class RegisteredClient.Builder

java.lang.Object

org.springframework.security.oauth2.server.authorization.client.RegisteredClient.Builder

All Implemented Interfaces:

Serializable

Enclosing class:

RegisteredClient

public static class RegisteredClient.Builder
extends Object
implements Serializable

A builder for RegisteredClient.

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String id)
protected	Builder(RegisteredClient registeredClient)

Method Summary

Modifier and Type	Method	Description
RegisteredClient.Builder	authorizationGrantType(org.springframework.security.oauth2.core.AuthorizationGrantType authorizationGrantType)	Adds an authorization grant type the client may use.
RegisteredClient.Builder	authorizationGrantTypes(Consumer<Set<org.springframework.security.oauth2.core.AuthorizationGrantType>> authorizationGrantTypesConsumer)	A Consumer of the authorization grant type(s) allowing the ability to add, replace, or remove.
RegisteredClient	build()	Builds a new RegisteredClient.
RegisteredClient.Builder	clientAuthenticationMethod(org.springframework.security.oauth2.core.ClientAuthenticationMethod clientAuthenticationMethod)	Adds an authentication method the client may use when authenticating with the authorization server.
RegisteredClient.Builder	clientAuthenticationMethods(Consumer<Set<org.springframework.security.oauth2.core.ClientAuthenticationMethod>> clientAuthenticationMethodsConsumer)	A Consumer of the authentication method(s) allowing the ability to add, replace, or remove.
RegisteredClient.Builder	clientId(String clientId)	Sets the client identifier.
RegisteredClient.Builder	clientIdIssuedAt(Instant clientIdIssuedAt)	Sets the time at which the client identifier was issued.
RegisteredClient.Builder	clientName(String clientName)	Sets the client name.
RegisteredClient.Builder	clientSecret(String clientSecret)	Sets the client secret.
RegisteredClient.Builder	clientSecretExpiresAt(Instant clientSecretExpiresAt)	Sets the time at which the client secret expires or null if it does not expire.
RegisteredClient.Builder	clientSettings(ClientSettings clientSettings)	Sets the client configuration settings.
RegisteredClient.Builder	id(String id)	Sets the identifier for the registration.
RegisteredClient.Builder	postLogoutRedirectUri(String postLogoutRedirectUri)	Adds a post logout redirect URI the client may use for logout.
RegisteredClient.Builder	postLogoutRedirectUris(Consumer<Set<String>> postLogoutRedirectUrisConsumer)	A Consumer of the post logout redirect URI(s) allowing the ability to add, replace, or remove.
RegisteredClient.Builder	redirectUri(String redirectUri)	Adds a redirect URI the client may use in a redirect-based flow.
RegisteredClient.Builder	redirectUris(Consumer<Set<String>> redirectUrisConsumer)	A Consumer of the redirect URI(s) allowing the ability to add, replace, or remove.
RegisteredClient.Builder	scope(String scope)	Adds a scope the client may use.
RegisteredClient.Builder	scopes(Consumer<Set<String>> scopesConsumer)	A Consumer of the scope(s) allowing the ability to add, replace, or remove.
RegisteredClient.Builder	tokenSettings(TokenSettings tokenSettings)	Sets the token configuration settings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder(String id)

Builder

protected Builder(RegisteredClient registeredClient)

Method Details

id

public RegisteredClient.Builder id(String id)

Sets the identifier for the registration.

Parameters:

id - the identifier for the registration

Returns:

the RegisteredClient.Builder

clientId

public RegisteredClient.Builder clientId(String clientId)

Sets the client identifier.

Parameters:

clientId - the client identifier

Returns:

the RegisteredClient.Builder

clientIdIssuedAt

public RegisteredClient.Builder clientIdIssuedAt(Instant clientIdIssuedAt)

Sets the time at which the client identifier was issued.

Parameters:

clientIdIssuedAt - the time at which the client identifier was issued

Returns:

the RegisteredClient.Builder

clientSecret

public RegisteredClient.Builder clientSecret(String clientSecret)

Sets the client secret.

Parameters:

clientSecret - the client secret

Returns:

the RegisteredClient.Builder

clientSecretExpiresAt

public RegisteredClient.Builder clientSecretExpiresAt(Instant clientSecretExpiresAt)

Sets the time at which the client secret expires or null if it does not expire.

Parameters:

clientSecretExpiresAt - the time at which the client secret expires or null if it does not expire

Returns:

the RegisteredClient.Builder

clientName

public RegisteredClient.Builder clientName(String clientName)

Sets the client name.

Parameters:

clientName - the client name

Returns:

the RegisteredClient.Builder

clientAuthenticationMethod

public RegisteredClient.Builder clientAuthenticationMethod(org.springframework.security.oauth2.core.ClientAuthenticationMethod clientAuthenticationMethod)

Adds an authentication method the client may use when authenticating with the authorization server.

Parameters:

clientAuthenticationMethod - the authentication method

Returns:

the RegisteredClient.Builder

clientAuthenticationMethods

public RegisteredClient.Builder clientAuthenticationMethods(Consumer<Set<org.springframework.security.oauth2.core.ClientAuthenticationMethod>> clientAuthenticationMethodsConsumer)

A Consumer of the authentication method(s) allowing the ability to add, replace, or remove.

Parameters:

clientAuthenticationMethodsConsumer - a Consumer of the authentication method(s)

Returns:

the RegisteredClient.Builder

authorizationGrantType

public RegisteredClient.Builder authorizationGrantType(org.springframework.security.oauth2.core.AuthorizationGrantType authorizationGrantType)

Adds an authorization grant type the client may use.

Parameters:

authorizationGrantType - the authorization grant type

Returns:

the RegisteredClient.Builder

authorizationGrantTypes

public RegisteredClient.Builder authorizationGrantTypes(Consumer<Set<org.springframework.security.oauth2.core.AuthorizationGrantType>> authorizationGrantTypesConsumer)

A Consumer of the authorization grant type(s) allowing the ability to add, replace, or remove.

Parameters:

authorizationGrantTypesConsumer - a Consumer of the authorization grant type(s)

Returns:

the RegisteredClient.Builder

redirectUri

public RegisteredClient.Builder redirectUri(String redirectUri)

Adds a redirect URI the client may use in a redirect-based flow.

Parameters:

redirectUri - the redirect URI

Returns:

the RegisteredClient.Builder

redirectUris

public RegisteredClient.Builder redirectUris(Consumer<Set<String>> redirectUrisConsumer)

A Consumer of the redirect URI(s) allowing the ability to add, replace, or remove.

Parameters:

redirectUrisConsumer - a Consumer of the redirect URI(s)

Returns:

the RegisteredClient.Builder

postLogoutRedirectUri

public RegisteredClient.Builder postLogoutRedirectUri(String postLogoutRedirectUri)

Adds a post logout redirect URI the client may use for logout. The post_logout_redirect_uri parameter is used by the client when requesting that the End-User's User Agent be redirected to after a logout has been performed.

Parameters:

postLogoutRedirectUri - the post logout redirect URI

Returns:

the RegisteredClient.Builder

Since:

1.1

postLogoutRedirectUris

public RegisteredClient.Builder postLogoutRedirectUris(Consumer<Set<String>> postLogoutRedirectUrisConsumer)

A Consumer of the post logout redirect URI(s) allowing the ability to add, replace, or remove.

Parameters:

postLogoutRedirectUrisConsumer - a Consumer of the post logout redirect URI(s)

Returns:

the RegisteredClient.Builder

Since:

1.1

scope

public RegisteredClient.Builder scope(String scope)

Adds a scope the client may use.

Parameters:

scope - the scope

Returns:

the RegisteredClient.Builder

scopes

public RegisteredClient.Builder scopes(Consumer<Set<String>> scopesConsumer)

A Consumer of the scope(s) allowing the ability to add, replace, or remove.

Parameters:

scopesConsumer - a Consumer of the scope(s)

Returns:

the RegisteredClient.Builder

clientSettings

public RegisteredClient.Builder clientSettings(ClientSettings clientSettings)

Sets the client configuration settings.

Parameters:

clientSettings - the client configuration settings

Returns:

the RegisteredClient.Builder

tokenSettings

public RegisteredClient.Builder tokenSettings(TokenSettings tokenSettings)

Sets the token configuration settings.

Parameters:

tokenSettings - the token configuration settings

Returns:

the RegisteredClient.Builder

build

public RegisteredClient build()

Builds a new RegisteredClient.

Returns:

a RegisteredClient