Package org.springframework.security.oauth2.client

Class OAuth2AuthorizedClientProviderBuilder

java.lang.Object

org.springframework.security.oauth2.client.OAuth2AuthorizedClientProviderBuilder

public final class OAuth2AuthorizedClientProviderBuilder
extends Object

A builder that builds a DelegatingOAuth2AuthorizedClientProvider composed of one or more OAuth2AuthorizedClientProvider(s) that implement specific authorization grants. The supported authorization grants are authorization_code, refresh_token, client_credentials and password. In addition to the standard authorization grants, an implementation of an extension grant may be supplied via provider(OAuth2AuthorizedClientProvider).

Since:

5.2

See Also:

• OAuth2AuthorizedClientProvider
• AuthorizationCodeOAuth2AuthorizedClientProvider
• RefreshTokenOAuth2AuthorizedClientProvider
• ClientCredentialsOAuth2AuthorizedClientProvider
• PasswordOAuth2AuthorizedClientProvider
• DelegatingOAuth2AuthorizedClientProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	OAuth2AuthorizedClientProviderBuilder.AuthorizationCodeGrantBuilder	A builder for the authorization_code grant.
final class	OAuth2AuthorizedClientProviderBuilder.ClientCredentialsGrantBuilder	A builder for the client_credentials grant.
final class	OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder	A builder for the password grant.
final class	OAuth2AuthorizedClientProviderBuilder.RefreshTokenGrantBuilder	A builder for the refresh_token grant.

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizedClientProviderBuilder	authorizationCode()	Configures support for the authorization_code grant.
OAuth2AuthorizedClientProvider	build()	Builds an instance of DelegatingOAuth2AuthorizedClientProvider composed of one or more OAuth2AuthorizedClientProvider(s).
static OAuth2AuthorizedClientProviderBuilder	builder()	Returns a new OAuth2AuthorizedClientProviderBuilder for configuring the supported authorization grant(s).
OAuth2AuthorizedClientProviderBuilder	clientCredentials()	Configures support for the client_credentials grant.
OAuth2AuthorizedClientProviderBuilder	clientCredentials(Consumer<OAuth2AuthorizedClientProviderBuilder.ClientCredentialsGrantBuilder> builderConsumer)	Configures support for the client_credentials grant.
OAuth2AuthorizedClientProviderBuilder	password()	Configures support for the password grant.
OAuth2AuthorizedClientProviderBuilder	password(Consumer<OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder> builderConsumer)	Configures support for the password grant.
OAuth2AuthorizedClientProviderBuilder	provider(OAuth2AuthorizedClientProvider provider)	Configures an OAuth2AuthorizedClientProvider to be composed with the DelegatingOAuth2AuthorizedClientProvider.
OAuth2AuthorizedClientProviderBuilder	refreshToken()	Configures support for the refresh_token grant.
OAuth2AuthorizedClientProviderBuilder	refreshToken(Consumer<OAuth2AuthorizedClientProviderBuilder.RefreshTokenGrantBuilder> builderConsumer)	Configures support for the refresh_token grant.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static OAuth2AuthorizedClientProviderBuilder builder()

Returns a new OAuth2AuthorizedClientProviderBuilder for configuring the supported authorization grant(s).

Returns:

the OAuth2AuthorizedClientProviderBuilder

provider

public OAuth2AuthorizedClientProviderBuilder provider(OAuth2AuthorizedClientProvider provider)

Configures an OAuth2AuthorizedClientProvider to be composed with the DelegatingOAuth2AuthorizedClientProvider. This may be used for implementations of extension authorization grants.

Returns:

the OAuth2AuthorizedClientProviderBuilder

authorizationCode

public OAuth2AuthorizedClientProviderBuilder authorizationCode()

Configures support for the authorization_code grant.

Returns:

the OAuth2AuthorizedClientProviderBuilder

refreshToken

public OAuth2AuthorizedClientProviderBuilder refreshToken()

Configures support for the refresh_token grant.

Returns:

the OAuth2AuthorizedClientProviderBuilder

refreshToken

public OAuth2AuthorizedClientProviderBuilder refreshToken(Consumer<OAuth2AuthorizedClientProviderBuilder.RefreshTokenGrantBuilder> builderConsumer)

Configures support for the refresh_token grant.

Parameters:

builderConsumer - a Consumer of OAuth2AuthorizedClientProviderBuilder.RefreshTokenGrantBuilder used for further configuration

Returns:

the OAuth2AuthorizedClientProviderBuilder

clientCredentials

public OAuth2AuthorizedClientProviderBuilder clientCredentials()

Configures support for the client_credentials grant.

Returns:

the OAuth2AuthorizedClientProviderBuilder

clientCredentials

public OAuth2AuthorizedClientProviderBuilder clientCredentials(Consumer<OAuth2AuthorizedClientProviderBuilder.ClientCredentialsGrantBuilder> builderConsumer)

Configures support for the client_credentials grant.

Parameters:

builderConsumer - a Consumer of OAuth2AuthorizedClientProviderBuilder.ClientCredentialsGrantBuilder used for further configuration

Returns:

the OAuth2AuthorizedClientProviderBuilder

password

public OAuth2AuthorizedClientProviderBuilder password()

Configures support for the password grant.

Returns:

the OAuth2AuthorizedClientProviderBuilder

password

public OAuth2AuthorizedClientProviderBuilder password(Consumer<OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder> builderConsumer)

Configures support for the password grant.

Parameters:

builderConsumer - a Consumer of OAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder used for further configuration

Returns:

the OAuth2AuthorizedClientProviderBuilder

build

public OAuth2AuthorizedClientProvider build()

Builds an instance of DelegatingOAuth2AuthorizedClientProvider composed of one or more OAuth2AuthorizedClientProvider(s).

Returns:

the DelegatingOAuth2AuthorizedClientProvider