com.pingidentity.sdk.password

Class PasswordCredentialValidatorAuthnException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.pingidentity.sdk.password.PasswordValidationException

com.pingidentity.sdk.password.PasswordCredentialValidatorAuthnException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PasswordCredentialChallengeException, PasswordPolicyRequirementValidationException

public class PasswordCredentialValidatorAuthnException
extends PasswordValidationException

Runtime exception thrown when user authentication fails due to a problem related to invalid credentials or a condition on the server such as the account being locked.

The message should be a key that exists in a file in the <pf-root>/server/default/conf/language-packs/pingfederate-messages.properties to support localization and internationalization.

Since:

6.11

See Also:

PasswordCredentialValidator, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PasswordCredentialValidatorAuthnException(boolean isRecoverable, String messageKey) Create an instance for a user authentication error.
PasswordCredentialValidatorAuthnException(boolean isRecoverable, String messageKey, Throwable cause) Create an instance for a user authentication error.

Method Summary

Modifier and Type	Method and Description
String	getMessageKey() Accessor for the messageKey property.
boolean	isRecoverable() Accessor for the isRecoverable property.

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

PasswordCredentialValidatorAuthnException

public PasswordCredentialValidatorAuthnException(boolean isRecoverable,
                                                 String messageKey)

Create an instance for a user authentication error.

Parameters:

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

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

PasswordCredentialValidatorAuthnException

public PasswordCredentialValidatorAuthnException(boolean isRecoverable,
                                                 String messageKey,
                                                 Throwable cause)

Create an instance for a user authentication error.

Parameters:

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

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

cause - The cause of the exception, if any

Method Detail

isRecoverable

public boolean isRecoverable()

Accessor for the isRecoverable property.

Returns:

true if the user can fix the error themselves

getMessageKey

public String getMessageKey()

Accessor for the messageKey property.

Returns:

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