Package com.pingidentity.sdk.password

Class PasswordResetException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.pingidentity.sdk.password.PasswordResetException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PasswordPolicyRequirementResetException

public class PasswordResetException
extends RuntimeException

Runtime exception to indicate there was an error when attempting to reset the password for a user.

Since:

8.3

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PasswordResetException(boolean isRecoverable)	Create an instance for a password reset error.
PasswordResetException(boolean isRecoverable, String message)	Create an instance for a password reset error.
PasswordResetException(boolean isRecoverable, String messageKey, Throwable exception)	Create an instance for a password reset error.
PasswordResetException(boolean isRecoverable, Throwable exception)	Create an instance for a password reset error.

Method Summary

Modifier and Type	Method	Description
boolean	isRecoverable()

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PasswordResetException

public PasswordResetException(boolean isRecoverable)

Create an instance for a password reset error.

Parameters:

isRecoverable - whether the exception represents a condition that can be corrected by the user (e.g. password policy violated)

PasswordResetException

public PasswordResetException(boolean isRecoverable,
                              String message)

Create an instance for a password reset error.

Parameters:

isRecoverable - whether the exception represents a condition that can be corrected by the user (e.g. password policy violated)

PasswordResetException

public PasswordResetException(boolean isRecoverable,
                              Throwable exception)

Create an instance for a password reset error.

Parameters:

isRecoverable - Whether the exception represents a condition that can be corrected by the user (e.g. password policy violated)

exception - The cause of the exception, if any

PasswordResetException

public PasswordResetException(boolean isRecoverable,
                              String messageKey,
                              Throwable exception)

Create an instance for a password reset error.

Parameters:

isRecoverable - Whether the exception represents a condition that can be corrected by the user (e.g. password policy violated)

messageKey - The key for the localized message displayed to the user. Failing to find it shows the message "as is".

exception - The cause of the exception, if any

Method Detail

isRecoverable

public boolean isRecoverable()