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.common.L10NMessage, java.io.Serializable

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

InvalidPasswordException(java.lang.String message)
Constructs an InvalidPasswordException object.

InvalidPasswordException(java.lang.String message, java.lang.String tokenId)
Constructs an InvalidPasswordException object.

InvalidPasswordException(java.lang.String rbName, java.lang.String errCode, java.lang.Object[] args)
Constructs an InvalidPasswordException object.

InvalidPasswordException(java.lang.String rbName, java.lang.String errorCode, java.lang.Object[] args, java.lang.String tokenId, java.lang.Throwable t)
Constructs an InvalidPasswordException object.

InvalidPasswordException(java.lang.Throwable t)
Constructs an InvalidPasswordException object.

Method Summary

java.lang.String

getTokenId() Returns the token ID.

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

getErrorCode, getL10NMessage, getMessage, getMessageArgs, getResourceBundleName, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidPasswordException

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

Constructs an InvalidPasswordException object.

Parameters:

rbName - Resource bundle name for the message.

args - Arguments to the message.

InvalidPasswordException

public InvalidPasswordException(java.lang.String message)

Constructs an InvalidPasswordException object.

Parameters:

message - English message for the exception.

InvalidPasswordException

public InvalidPasswordException(java.lang.String message,
                                java.lang.String tokenId)

Constructs an InvalidPasswordException object.

Parameters:

message - English message for the exception.

tokenId - The userId for which the exception occurred.

InvalidPasswordException

public InvalidPasswordException(java.lang.Throwable t)

Constructs an InvalidPasswordException object.

Parameters:

t - the root cause of the exception

InvalidPasswordException

public InvalidPasswordException(java.lang.String rbName,
                                java.lang.String errorCode,
                                java.lang.Object[] args,
                                java.lang.String tokenId,
                                java.lang.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.

Method Detail

getTokenId

public java.lang.String getTokenId()

Returns the token ID.

Returns:

the token ID.