Package org.keycloak.authentication

Class AuthenticationFlowException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.keycloak.authentication.AuthenticationFlowException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ForkFlowException

public class AuthenticationFlowException
extends RuntimeException

Throw this exception from an Authenticator, FormAuthenticator, or FormAction if you want to completely abort the flow.

Version:

$Revision: 1 $

Author:

Bill Burke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationFlowException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, AuthenticationFlowError error)
AuthenticationFlowException(String message, Throwable cause, AuthenticationFlowError error)
AuthenticationFlowException(String message, AuthenticationFlowError error)
AuthenticationFlowException(Throwable cause, AuthenticationFlowError error)
AuthenticationFlowException(List<AuthenticationFlowException> afeList)
AuthenticationFlowException(AuthenticationFlowError error)
AuthenticationFlowException(AuthenticationFlowError error, jakarta.ws.rs.core.Response response)
AuthenticationFlowException(AuthenticationFlowError error, String eventDetails, String userErrorMessage)

Method Summary

Modifier and Type	Method	Description
List<AuthenticationFlowException>	getAfeList()
AuthenticationFlowError	getError()
String	getEventDetails()
jakarta.ws.rs.core.Response	getResponse()
String	getUserErrorMessage()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationFlowException

public AuthenticationFlowException(AuthenticationFlowError error)

AuthenticationFlowException

public AuthenticationFlowException(AuthenticationFlowError error,
 String eventDetails,
 String userErrorMessage)

AuthenticationFlowException

public AuthenticationFlowException(AuthenticationFlowError error,
 jakarta.ws.rs.core.Response response)

AuthenticationFlowException

public AuthenticationFlowException(String message,
 AuthenticationFlowError error)

AuthenticationFlowException

public AuthenticationFlowException(String message,
 Throwable cause,
 AuthenticationFlowError error)

AuthenticationFlowException

public AuthenticationFlowException(Throwable cause,
 AuthenticationFlowError error)

AuthenticationFlowException

public AuthenticationFlowException(List<AuthenticationFlowException> afeList)

AuthenticationFlowException

public AuthenticationFlowException(String message,
 Throwable cause,
 boolean enableSuppression,
 boolean writableStackTrace,
 AuthenticationFlowError error)

Method Details

getError

public AuthenticationFlowError getError()

getResponse

public jakarta.ws.rs.core.Response getResponse()

getAfeList

public List<AuthenticationFlowException> getAfeList()

getEventDetails

public String getEventDetails()

getUserErrorMessage

public String getUserErrorMessage()