Package com.broadleafcommerce.auth.security.web.authentication

Class AuthenticationFailureExceptionMapping

java.lang.Object

com.broadleafcommerce.auth.security.web.authentication.AuthenticationFailureExceptionMapping

All Implemented Interfaces:

org.springframework.core.Ordered

Direct Known Subclasses:

OAuth2LoginSystemAuthenticationFailureExceptionMapping

public class AuthenticationFailureExceptionMapping
extends Object
implements org.springframework.core.Ordered

Class used for mapping an exception to a redirect URI.

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AuthenticationFailureExceptionMapping(Class<?> exception, @NonNull String redirectUrl)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Class<?>	getException()	The exception class that this mapping should be handling.
int	getOrder()
String	getRedirectUrl()	The redirect URL when the target exception happens.
protected String	getRootCauseException(Throwable exception)
int	hashCode()
boolean	shouldApply(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, org.springframework.security.core.AuthenticationException exception)	This is a method called by DefaultExceptionMappingAuthenticationFailureHandler to determine whether this failure mapping should apply for a particular request/exception flow.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AuthenticationFailureExceptionMapping

public AuthenticationFailureExceptionMapping(@Nullable
 Class<?> exception,
 @NonNull @NonNull
 @NonNull String redirectUrl)

Method Details

shouldApply

public boolean shouldApply(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 org.springframework.security.core.AuthenticationException exception)

This is a method called by DefaultExceptionMappingAuthenticationFailureHandler to determine whether this failure mapping should apply for a particular request/exception flow.

For backward compatibility, the default implementation of this method matches the logic used by DefaultExceptionMappingAuthenticationFailureHandler before this method existed.

Parameters:

request - the request passed to DefaultExceptionMappingAuthenticationFailureHandler.onAuthenticationFailure(HttpServletRequest, HttpServletResponse, AuthenticationException)

response - the response passed to DefaultExceptionMappingAuthenticationFailureHandler.onAuthenticationFailure(HttpServletRequest, HttpServletResponse, AuthenticationException)

exception - the exception passed to DefaultExceptionMappingAuthenticationFailureHandler.onAuthenticationFailure(HttpServletRequest, HttpServletResponse, AuthenticationException)

Returns:

true if this failure mapping should apply for the given inputs, false otherwise

Since:

AuthenticationServices 2.3.0, RT 2.3.0

getRootCauseException

protected String getRootCauseException(Throwable exception)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Returns:

relative bean order for this component

Since:

AuthenticationServices 2.3.0, RT 2.3.0

getException

@Nullable
public Class<?> getException()

The exception class that this mapping should be handling. This is primarily relevant in simple cases where just comparing exception types is enough to determine whether this mapping should apply. In cases where shouldApply(HttpServletRequest, HttpServletResponse, AuthenticationException) has been overridden with more complicated logic, this field may not be relevant, and therefore will be null.

getRedirectUrl

public String getRedirectUrl()

The redirect URL when the target exception happens.

Except in some special circumstances, the redirect URL should generally redirect to the login page with an "error=true" and "errorCode" param. For example:

    /login?error=true&errorCode=login.error.user-inactive
 

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object