org.springframework.security.oauth2.client

Interface ReactiveOAuth2AuthorizedClientManager

All Known Implementing Classes:

AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager, DefaultReactiveOAuth2AuthorizedClientManager

public interface ReactiveOAuth2AuthorizedClientManager

Implementations of this interface are responsible for the overall management of Authorized Client(s).

The primary responsibilities include:

1. Authorizing (or re-authorizing) an OAuth 2.0 Client by leveraging a ReactiveOAuth2AuthorizedClientProvider(s).
2. Delegating the persistence of an OAuth2AuthorizedClient, typically using a ReactiveOAuth2AuthorizedClientService OR ServerOAuth2AuthorizedClientRepository.

Since:

5.2

See Also:

OAuth2AuthorizedClient, ReactiveOAuth2AuthorizedClientProvider, ReactiveOAuth2AuthorizedClientService, ServerOAuth2AuthorizedClientRepository

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<OAuth2AuthorizedClient>	authorize(OAuth2AuthorizeRequest authorizeRequest) Attempt to authorize or re-authorize (if required) the client identified by the provided clientRegistrationId.

Method Detail

authorize

reactor.core.publisher.Mono<OAuth2AuthorizedClient> authorize(OAuth2AuthorizeRequest authorizeRequest)

Attempt to authorize or re-authorize (if required) the client identified by the provided clientRegistrationId. Implementations must return an empty Mono if authorization is not supported for the specified client, e.g. the associated ReactiveOAuth2AuthorizedClientProvider(s) does not support the authorization grant type configured for the client.

In the case of re-authorization, implementations must return the provided authorized client if re-authorization is not supported for the client OR is not required, e.g. a refresh token is not available OR the access token is not expired.

Parameters:

authorizeRequest - the authorize request

Returns:

the OAuth2AuthorizedClient or an empty Mono if authorization is not supported for the specified client