Package com.sun.identity.authentication.spi

Class InvalidPasswordException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.security.GeneralSecurityException

javax.security.auth.login.LoginException

com.sun.identity.authentication.spi.AuthLoginException

com.sun.identity.authentication.spi.InvalidPasswordException

All Implemented Interfaces:

com.sun.identity.shared.locale.L10NMessage, Serializable

@SupportedAll
public class InvalidPasswordException
extends AuthLoginException

Exception that is thrown when the user-entered password token causes the authentication module to be authenticated to fail. Authentication module must throw this exception if it wishes to participate in user lock out due to too many password failure login feature. Prior to throwing this exception, the authentication module should set the userTokenId so that subsequent calls to getUserTokenId will return correct userTokenId that will be use to lock out the user.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidPasswordException(InvalidPasswordException e, boolean isDn)	Constructs an InvalidPasswordException object.
InvalidPasswordException(String message)	Constructs an InvalidPasswordException object.
InvalidPasswordException(String message, String tokenId)	Constructs an InvalidPasswordException object.
InvalidPasswordException(String message, String tokenId, boolean isDn)	Constructs an InvalidPasswordException object.
InvalidPasswordException(String rbName, String errCode, Object[] args)	Constructs an InvalidPasswordException object.
InvalidPasswordException(String rbName, String errorCode, Object[] args, String tokenId, boolean isDn, Throwable t)	Constructs an InvalidPasswordException object.
InvalidPasswordException(String rbName, String errorCode, Object[] args, String tokenId, Throwable t)	Constructs an InvalidPasswordException object.
InvalidPasswordException(Throwable t)	Constructs an InvalidPasswordException object.

Method Summary

Modifier and Type	Method	Description
String	getTokenId()	Returns the token ID.
String	getUsername()	Returns the username.

Methods inherited from class com.sun.identity.authentication.spi.AuthLoginException

getErrorCode, getL10NMessage, getMessage, getMessageArgs, getResourceBundleName

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

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

Constructor Detail

InvalidPasswordException

public InvalidPasswordException(String rbName,
                                String errCode,
                                Object[] args)

Constructs an InvalidPasswordException object.

Parameters:

rbName - Resource bundle name for the message.

errCode - Key to the message in resource bundle.

args - Arguments to the message.

InvalidPasswordException

public InvalidPasswordException(String message)

Constructs an InvalidPasswordException object.

Parameters:

message - English message for the exception.

InvalidPasswordException

public InvalidPasswordException(String message,
                                String tokenId)

Constructs an InvalidPasswordException object.

Parameters:

message - English message for the exception.

tokenId - The userId for which the exception occurred.

InvalidPasswordException

public InvalidPasswordException(String message,
                                String tokenId,
                                boolean isDn)

Constructs an InvalidPasswordException object.

Parameters:

message - English message for the exception.

tokenId - The userId for which the exception occurred.

isDn - whether the tokenId represents a DN or a username

InvalidPasswordException

public InvalidPasswordException(Throwable t)

Constructs an InvalidPasswordException object.

Parameters:

t - the root cause of the exception

InvalidPasswordException

public InvalidPasswordException(String rbName,
                                String errorCode,
                                Object[] args,
                                String tokenId,
                                Throwable t)

Constructs an InvalidPasswordException object.

Parameters:

rbName - Resource bundle name for the message.

errorCode - Key to the message in resource bundle.

args - Arguments to the message.

tokenId - userID for which the exception occurred.

t - The root cause of the exception.

InvalidPasswordException

public InvalidPasswordException(String rbName,
                                String errorCode,
                                Object[] args,
                                String tokenId,
                                boolean isDn,
                                Throwable t)

Constructs an InvalidPasswordException object.

Parameters:

rbName - Resource bundle name for the message.

errorCode - Key to the message in resource bundle.

args - Arguments to the message.

tokenId - userID for which the exception occurred.

isDn - whether the tokenId represents a DN or a username

t - The root cause of the exception.

InvalidPasswordException

public InvalidPasswordException(InvalidPasswordException e,
                                boolean isDn)

Constructs an InvalidPasswordException object.

Parameters:

e - an InvalidPasswordException

isDn - whether the tokenId contained in the parent exception is a DN

Method Detail

getTokenId

public String getTokenId()

Returns the token ID.

Returns:

the token ID.

getUsername

public String getUsername()

Returns the username.

Returns:

the username