Interface AuthenticatorExceptionFactory

All Superinterfaces:
ExceptionFactory

public interface AuthenticatorExceptionFactory extends ExceptionFactory
An exception factory that can create exceptions unique to authenticators.
NOTE: It is an error to use this service in any other plugin type than an Authenticator.
Since:
6.6
  • Method Details

    • authenticationFailedException

      RuntimeException authenticationFailedException(String errorDetailMessage)
      Creates an exception that, if thrown, signals that authentication has failed and should be aborted. When authentication is performed as part of an OAuth- or HAAPI flow, this error will propagate to the client.
      Parameters:
      errorDetailMessage - the error detail message
      Returns:
      the created exception