Package org.springframework.security.oauth2.client

Class ReactiveOAuth2AuthorizedClientProviderBuilder

java.lang.Object

org.springframework.security.oauth2.client.ReactiveOAuth2AuthorizedClientProviderBuilder

public final class ReactiveOAuth2AuthorizedClientProviderBuilder
extends Object

A builder that builds a DelegatingReactiveOAuth2AuthorizedClientProvider composed of one or more ReactiveOAuth2AuthorizedClientProvider(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(ReactiveOAuth2AuthorizedClientProvider).

Since:

5.2

See Also:

• ReactiveOAuth2AuthorizedClientProvider
• AuthorizationCodeReactiveOAuth2AuthorizedClientProvider
• RefreshTokenReactiveOAuth2AuthorizedClientProvider
• ClientCredentialsReactiveOAuth2AuthorizedClientProvider
• PasswordReactiveOAuth2AuthorizedClientProvider
• DelegatingReactiveOAuth2AuthorizedClientProvider

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
ReactiveOAuth2AuthorizedClientProviderBuilder	authorizationCode()	Configures support for the authorization_code grant.
ReactiveOAuth2AuthorizedClientProvider	build()	Builds an instance of DelegatingReactiveOAuth2AuthorizedClientProvider composed of one or more ReactiveOAuth2AuthorizedClientProvider(s).
static ReactiveOAuth2AuthorizedClientProviderBuilder	builder()	Returns a new ReactiveOAuth2AuthorizedClientProviderBuilder for configuring the supported authorization grant(s).
ReactiveOAuth2AuthorizedClientProviderBuilder	clientCredentials()	Configures support for the client_credentials grant.
ReactiveOAuth2AuthorizedClientProviderBuilder	clientCredentials(Consumer<ReactiveOAuth2AuthorizedClientProviderBuilder.ClientCredentialsGrantBuilder> builderConsumer)	Configures support for the client_credentials grant.
ReactiveOAuth2AuthorizedClientProviderBuilder	password()	Configures support for the password grant.
ReactiveOAuth2AuthorizedClientProviderBuilder	password(Consumer<ReactiveOAuth2AuthorizedClientProviderBuilder.PasswordGrantBuilder> builderConsumer)	Configures support for the password grant.
ReactiveOAuth2AuthorizedClientProviderBuilder	provider(ReactiveOAuth2AuthorizedClientProvider provider)	Configures a ReactiveOAuth2AuthorizedClientProvider to be composed with the DelegatingReactiveOAuth2AuthorizedClientProvider.
ReactiveOAuth2AuthorizedClientProviderBuilder	refreshToken()	Configures support for the refresh_token grant.
ReactiveOAuth2AuthorizedClientProviderBuilder	refreshToken(Consumer<ReactiveOAuth2AuthorizedClientProviderBuilder.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 ReactiveOAuth2AuthorizedClientProviderBuilder builder()

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

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

provider

public ReactiveOAuth2AuthorizedClientProviderBuilder provider(ReactiveOAuth2AuthorizedClientProvider provider)

Configures a ReactiveOAuth2AuthorizedClientProvider to be composed with the DelegatingReactiveOAuth2AuthorizedClientProvider. This may be used for implementations of extension authorization grants.

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

authorizationCode

public ReactiveOAuth2AuthorizedClientProviderBuilder authorizationCode()

Configures support for the authorization_code grant.

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

refreshToken

public ReactiveOAuth2AuthorizedClientProviderBuilder refreshToken()

Configures support for the refresh_token grant.

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

refreshToken

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

Configures support for the refresh_token grant.

Parameters:

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

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

clientCredentials

public ReactiveOAuth2AuthorizedClientProviderBuilder clientCredentials()

Configures support for the client_credentials grant.

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

clientCredentials

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

Configures support for the client_credentials grant.

Parameters:

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

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

password

public ReactiveOAuth2AuthorizedClientProviderBuilder password()

Configures support for the password grant.

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

password

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

Configures support for the password grant.

Parameters:

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

Returns:

the ReactiveOAuth2AuthorizedClientProviderBuilder

build

public ReactiveOAuth2AuthorizedClientProvider build()

Builds an instance of DelegatingReactiveOAuth2AuthorizedClientProvider composed of one or more ReactiveOAuth2AuthorizedClientProvider(s).

Returns:

the DelegatingReactiveOAuth2AuthorizedClientProvider