com.auth0.guardian

Class GuardianException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.auth0.guardian.GuardianException

All Implemented Interfaces:

java.io.Serializable

public class GuardianException
extends java.lang.RuntimeException

Class that wraps server-side or app errors exclusively related to Guardian

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GuardianException(java.util.Map<java.lang.String,java.lang.Object> errorResponse)
GuardianException(java.lang.String detailMessage, java.lang.Throwable throwable)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorCode() Returns the `errorCode` value, if available.
boolean	isAlreadyEnrolled() Whether the error is caused by the user already having a confirmed enrollment
boolean	isEnrollmentNotFound() Whether the error is caused by the enrollment being invalid or not found on the server
boolean	isInvalidOTP() Whether the error is caused by the use of an invalid OTP code
boolean	isInvalidToken() Whether the error is caused by the use of an invalid token
boolean	isLoginTransactionNotFound() Whether the error is caused by the login transaction being invalid, expired or not found
boolean	isTransactionNotFound() Whether the error is caused by the transaction being invalid, expired or not found (e.g.
java.lang.String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GuardianException

public GuardianException(java.lang.String detailMessage,
                         java.lang.Throwable throwable)

GuardianException

public GuardianException(java.util.Map<java.lang.String,java.lang.Object> errorResponse)

Method Detail

getErrorCode

public java.lang.String getErrorCode()

Returns the `errorCode` value, if available.

Returns:

the error code, or null

isInvalidOTP

public boolean isInvalidOTP()

Whether the error is caused by the use of an invalid OTP code

Returns:

true if the error is caused by the use of an invalid OTP code

isInvalidToken

public boolean isInvalidToken()

Whether the error is caused by the use of an invalid token

Returns:

true if the error is caused by the use of an invalid token

isEnrollmentNotFound

public boolean isEnrollmentNotFound()

Whether the error is caused by the enrollment being invalid or not found on the server

Returns:

true if the error is caused by the enrollment being invalid or not found

isLoginTransactionNotFound

public boolean isLoginTransactionNotFound()

Whether the error is caused by the login transaction being invalid, expired or not found

Returns:

true if error is caused by the login transaction being invalid, expired or not found

isTransactionNotFound

public boolean isTransactionNotFound()

Whether the error is caused by the transaction being invalid, expired or not found (e.g. already confirmed)

Returns:

true if error is caused by the transaction being invalid, expired or not found

isAlreadyEnrolled

public boolean isAlreadyEnrolled()

Whether the error is caused by the user already having a confirmed enrollment

Returns:

true if error is caused by the user already having a confirmed enrollment

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Throwable