Package com.pingidentity.sdk.password

Class PasswordCredentialChallengeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.pingidentity.sdk.password.PasswordValidationException

com.pingidentity.sdk.password.PasswordCredentialValidatorAuthnException

com.pingidentity.sdk.password.PasswordCredentialChallengeException

All Implemented Interfaces:

Serializable

public class PasswordCredentialChallengeException
extends PasswordCredentialValidatorAuthnException

Runtime exception thrown when the server used for authentication needs to prompt the user to answer a challenge question. This is used by servers using multi-factor authentication, such as RADIUS.

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:

7.1

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PasswordCredentialChallengeException(boolean isRecoverable, String messageKey)	Create an instance for a user authentication challenge.
PasswordCredentialChallengeException(boolean isRecoverable, String messageKey, String username, Object state)	Create an instance for a user authentication challenge.
PasswordCredentialChallengeException(boolean isRecoverable, String messageKey, Throwable cause)	Create an instance for a user authentication challenge.

Method Summary

Modifier and Type	Method	Description
Object	getState()	Get the preserved state
String	getUsername()	Get the username name of the user attempting to sign in

Methods inherited from class com.pingidentity.sdk.password.PasswordCredentialValidatorAuthnException

getAuditErrorMessage, getErrorSource, getMessage, getMessageKey, isRecoverable

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

PasswordCredentialChallengeException

public PasswordCredentialChallengeException(boolean isRecoverable,
                                            String messageKey)

Create an instance for a user authentication challenge.

Parameters:

isRecoverable - whether the exception represents a condition that can be corrected by the user, should be true in most cases

messageKey - the key for the localized message displayed to the user

PasswordCredentialChallengeException

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

Create an instance for a user authentication challenge.

Parameters:

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

messageKey - the key for the localized message displayed to the user

cause - the cause of the exception, if any

PasswordCredentialChallengeException

public PasswordCredentialChallengeException(boolean isRecoverable,
                                            String messageKey,
                                            String username,
                                            Object state)

Create an instance for a user authentication challenge.

Parameters:

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

messageKey - the key for the localized message displayed to the user

username - username name of the user attempting to sign in

state - an opaque object containing state used to preserve state during a 2-Factor authentication.

Since:

8.0

Method Detail

getState

public Object getState()

Get the preserved state

Returns:

getUsername

public String getUsername()

Get the username name of the user attempting to sign in

Returns: