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

Class AuthenticationFailureExceptionMapping

java.lang.Object
com.broadleafcommerce.auth.security.web.authentication.AuthenticationFailureExceptionMapping
public class AuthenticationFailureExceptionMapping extends Object
Class used for mapping an exception to a redirect URI.

  • Constructor Details

    • AuthenticationFailureExceptionMapping

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

  • Method Details

    • getException

      public Class<?> getException()
      The target exception when redirecting

    • 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