Package org.springframework.security.oauth2.client

Class RemoveAuthorizedClientOAuth2AuthorizationFailureHandler

java.lang.Object

org.springframework.security.oauth2.client.RemoveAuthorizedClientOAuth2AuthorizationFailureHandler

All Implemented Interfaces:

OAuth2AuthorizationFailureHandler

public class RemoveAuthorizedClientOAuth2AuthorizationFailureHandler
extends java.lang.Object
implements OAuth2AuthorizationFailureHandler

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

Since:

5.3

See Also:

OAuth2AuthorizedClient, OAuth2AuthorizedClientRepository, OAuth2AuthorizedClientService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RemoveAuthorizedClientOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover	Removes an OAuth2AuthorizedClient from an OAuth2AuthorizedClientRepository or OAuth2AuthorizedClientService.

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<java.lang.String>	DEFAULT_REMOVE_AUTHORIZED_CLIENT_ERROR_CODES	The default OAuth 2.0 error codes that will trigger removal of an OAuth2AuthorizedClient.

Constructor Summary

Constructors

Constructor	Description
RemoveAuthorizedClientOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover)	Constructs a RemoveAuthorizedClientOAuth2AuthorizationFailureHandler using the provided parameters.
RemoveAuthorizedClientOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover, java.util.Set<java.lang.String> removeAuthorizedClientErrorCodes)	Constructs a RemoveAuthorizedClientOAuth2AuthorizationFailureHandler using the provided parameters.

Method Summary

Modifier and Type	Method	Description
void	onAuthorizationFailure(OAuth2AuthorizationException authorizationException, Authentication principal, java.util.Map<java.lang.String,java.lang.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 Detail

DEFAULT_REMOVE_AUTHORIZED_CLIENT_ERROR_CODES

public static final java.util.Set<java.lang.String> DEFAULT_REMOVE_AUTHORIZED_CLIENT_ERROR_CODES

The default OAuth 2.0 error codes that will trigger removal of an OAuth2AuthorizedClient.

See Also:

OAuth2ErrorCodes

Constructor Detail

RemoveAuthorizedClientOAuth2AuthorizationFailureHandler

public RemoveAuthorizedClientOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover)

Constructs a RemoveAuthorizedClientOAuth2AuthorizationFailureHandler using the provided parameters.

Parameters:

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

RemoveAuthorizedClientOAuth2AuthorizationFailureHandler

public RemoveAuthorizedClientOAuth2AuthorizationFailureHandler(RemoveAuthorizedClientOAuth2AuthorizationFailureHandler.OAuth2AuthorizedClientRemover authorizedClientRemover,
                                                               java.util.Set<java.lang.String> removeAuthorizedClientErrorCodes)

Constructs a RemoveAuthorizedClientOAuth2AuthorizationFailureHandler using the provided parameters.

Parameters:

authorizedClientRemover - the RemoveAuthorizedClientOAuth2AuthorizationFailureHandler.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 Detail

onAuthorizationFailure

public void onAuthorizationFailure(OAuth2AuthorizationException authorizationException,
                                   Authentication principal,
                                   java.util.Map<java.lang.String,java.lang.Object> attributes)

Description copied from interface: OAuth2AuthorizationFailureHandler

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 OAuth2AuthorizationFailureHandler

Parameters:

authorizationException - the exception that contains details about what failed

principal - the Principal associated with the attempted authorization

attributes - an immutable Map of (optional) attributes present under certain conditions. For example, this might contain a javax.servlet.http.HttpServletRequest and javax.servlet.http.HttpServletResponse if the authorization was performed within the context of a javax.servlet.ServletContext.