Class AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager
- All Implemented Interfaces:
ReactiveOAuth2AuthorizedClientManager
ReactiveOAuth2AuthorizedClientManager
that is capable of
operating outside of the context of a ServerWebExchange
, e.g. in a
scheduled/background thread and/or in the service-tier.
(When operating within the context of a ServerWebExchange
, use
DefaultReactiveOAuth2AuthorizedClientManager
instead.)
This is a reactive equivalent of
AuthorizedClientServiceOAuth2AuthorizedClientManager
.
Authorized Client Persistence
This client manager utilizes a ReactiveOAuth2AuthorizedClientService
to persist
OAuth2AuthorizedClient
s.
By default, when an authorization attempt succeeds, the OAuth2AuthorizedClient
will be saved in the authorized client service. This functionality can be changed by
configuring a custom ReactiveOAuth2AuthorizationSuccessHandler
via
setAuthorizationSuccessHandler(ReactiveOAuth2AuthorizationSuccessHandler)
.
By default, when an authorization attempt fails due to an
"invalid_grant" error,
the previously saved OAuth2AuthorizedClient
will be removed from the authorized
client service. (The
"invalid_grant" error
generally occurs when a refresh token that is no longer valid is used to retrieve a new
access token.) This functionality can be changed by configuring a custom
ReactiveOAuth2AuthorizationFailureHandler
via
setAuthorizationFailureHandler(ReactiveOAuth2AuthorizationFailureHandler)
.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
The default implementation of thecontextAttributesMapper
. -
Constructor Summary
ConstructorDescriptionAuthorizedClientServiceReactiveOAuth2AuthorizedClientManager
(ReactiveClientRegistrationRepository clientRegistrationRepository, ReactiveOAuth2AuthorizedClientService authorizedClientService) Constructs anAuthorizedClientServiceReactiveOAuth2AuthorizedClientManager
using the provided parameters. -
Method Summary
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<OAuth2AuthorizedClient>
authorize
(OAuth2AuthorizeRequest authorizeRequest) Attempt to authorize or re-authorize (if required) theclient
identified by the providedclientRegistrationId
.void
setAuthorizationFailureHandler
(ReactiveOAuth2AuthorizationFailureHandler authorizationFailureHandler) Sets the handler that handles authorization failures.void
setAuthorizationSuccessHandler
(ReactiveOAuth2AuthorizationSuccessHandler authorizationSuccessHandler) Sets the handler that handles successful authorizations.void
setAuthorizedClientProvider
(ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider) Sets theReactiveOAuth2AuthorizedClientProvider
used for authorizing (or re-authorizing) an OAuth 2.0 Client.void
setContextAttributesMapper
(Function<OAuth2AuthorizeRequest, reactor.core.publisher.Mono<Map<String, Object>>> contextAttributesMapper) Sets theFunction
used for mapping attribute(s) from theOAuth2AuthorizeRequest
to aMap
of attributes to be associated to theauthorization context
.
-
Constructor Details
-
AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager
public AuthorizedClientServiceReactiveOAuth2AuthorizedClientManager(ReactiveClientRegistrationRepository clientRegistrationRepository, ReactiveOAuth2AuthorizedClientService authorizedClientService) Constructs anAuthorizedClientServiceReactiveOAuth2AuthorizedClientManager
using the provided parameters.- Parameters:
clientRegistrationRepository
- the repository of client registrationsauthorizedClientService
- the authorized client service
-
-
Method Details
-
authorize
public reactor.core.publisher.Mono<OAuth2AuthorizedClient> authorize(OAuth2AuthorizeRequest authorizeRequest) Description copied from interface:ReactiveOAuth2AuthorizedClientManager
Attempt to authorize or re-authorize (if required) theclient
identified by the providedclientRegistrationId
. Implementations must return an emptyMono
if authorization is not supported for the specified client, e.g. the associatedReactiveOAuth2AuthorizedClientProvider
(s) does not support theauthorization 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. arefresh token
is not available OR theaccess token
is not expired.- Specified by:
authorize
in interfaceReactiveOAuth2AuthorizedClientManager
- Parameters:
authorizeRequest
- the authorize request- Returns:
- the
OAuth2AuthorizedClient
or an emptyMono
if authorization is not supported for the specified client
-
setAuthorizedClientProvider
public void setAuthorizedClientProvider(ReactiveOAuth2AuthorizedClientProvider authorizedClientProvider) Sets theReactiveOAuth2AuthorizedClientProvider
used for authorizing (or re-authorizing) an OAuth 2.0 Client.- Parameters:
authorizedClientProvider
- theReactiveOAuth2AuthorizedClientProvider
used for authorizing (or re-authorizing) an OAuth 2.0 Client
-
setContextAttributesMapper
public void setContextAttributesMapper(Function<OAuth2AuthorizeRequest, reactor.core.publisher.Mono<Map<String, Object>>> contextAttributesMapper) Sets theFunction
used for mapping attribute(s) from theOAuth2AuthorizeRequest
to aMap
of attributes to be associated to theauthorization context
.- Parameters:
contextAttributesMapper
- theFunction
used for supplying theMap
of attributes to theauthorization context
-
setAuthorizationSuccessHandler
public void setAuthorizationSuccessHandler(ReactiveOAuth2AuthorizationSuccessHandler authorizationSuccessHandler) Sets the handler that handles successful authorizations. The default savesOAuth2AuthorizedClient
s in theReactiveOAuth2AuthorizedClientService
.- Parameters:
authorizationSuccessHandler
- the handler that handles successful authorizations.- Since:
- 5.3
-
setAuthorizationFailureHandler
public void setAuthorizationFailureHandler(ReactiveOAuth2AuthorizationFailureHandler authorizationFailureHandler) Sets the handler that handles authorization failures.A
RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler
is used by default.- Parameters:
authorizationFailureHandler
- the handler that handles authorization failures.- Since:
- 5.3
- See Also:
-