Package org.springframework.security.oauth2.client

Class RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler

java.lang.Object

org.springframework.security.oauth2.client.RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler

All Implemented Interfaces:

ReactiveOAuth2AuthorizationFailureHandler

public class RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler
extends Object
implements ReactiveOAuth2AuthorizationFailureHandler

A ReactiveOAuth2AuthorizationFailureHandler that removes an OAuth2AuthorizedClient when the OAuth2Error.getErrorCode() matches one of the configured OAuth 2.0 error codes.

Since:

5.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover	Removes an OAuth2AuthorizedClient from a ServerOAuth2AuthorizedClientRepository or ReactiveOAuth2AuthorizedClientService.

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	DEFAULT_REMOVE_AUTHORIZED_CLIENT_ERROR_CODES	The default OAuth 2.0 error codes that will trigger removal of the authorized client.

Constructor Summary

Constructors

Constructor	Description
RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover)	Constructs a RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler using the provided parameters.
RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover, Set<String> removeAuthorizedClientErrorCodes)	Constructs a RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler using the provided parameters.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<Void>	onAuthorizationFailure(org.springframework.security.oauth2.core.OAuth2AuthorizationException authorizationException, org.springframework.security.core.Authentication principal, Map<String,Object> attributes)	Called when an OAuth 2.0 Client fails to authorize (or re-authorize) via the authorization server or resource server.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_REMOVE_AUTHORIZED_CLIENT_ERROR_CODES

public static final Set<String> DEFAULT_REMOVE_AUTHORIZED_CLIENT_ERROR_CODES

The default OAuth 2.0 error codes that will trigger removal of the authorized client.

See Also:

• OAuth2ErrorCodes

Constructor Details

RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler

public RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover)

Constructs a RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler using the provided parameters.

Parameters:

authorizedClientRemover - the RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover used for removing an OAuth2AuthorizedClient if the error code is one of the DEFAULT_REMOVE_AUTHORIZED_CLIENT_ERROR_CODES.

RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler

public RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover,
 Set<String> removeAuthorizedClientErrorCodes)

Constructs a RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler using the provided parameters.

Parameters:

authorizedClientRemover - the RemoveAuthorizedClientReactiveOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover used for removing an OAuth2AuthorizedClient if the error code is one of the removeAuthorizedClientErrorCodes.

removeAuthorizedClientErrorCodes - the OAuth 2.0 error codes which will trigger removal of an authorized client.

See Also:

• OAuth2ErrorCodes

Method Details

onAuthorizationFailure

public reactor.core.publisher.Mono<Void> onAuthorizationFailure(org.springframework.security.oauth2.core.OAuth2AuthorizationException authorizationException,
 org.springframework.security.core.Authentication principal,
 Map<String,Object> attributes)

Description copied from interface: ReactiveOAuth2AuthorizationFailureHandler

Called when an OAuth 2.0 Client fails to authorize (or re-authorize) via the authorization server or resource server.

Specified by:

onAuthorizationFailure in interface ReactiveOAuth2AuthorizationFailureHandler

Parameters:

authorizationException - the exception that contains details about what failed

principal - the Principal that was attempted to be authorized

attributes - an immutable Map of extra optional attributes present under certain conditions. For example, this might contain a ServerWebExchange if the authorization was performed within the context of a ServerWebExchange.

Returns:

an empty Mono that completes after this handler has finished handling the event.