com.sun.identity.authentication.spi
Class InvalidPasswordException

com.sun.identity.authentication.spi.AuthLoginException
  |
  +--com.sun.identity.authentication.spi.InvalidPasswordException

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.


Constructor Summary
InvalidPasswordException(java.lang.String message)
          Constructor
InvalidPasswordException(java.lang.String message, java.lang.String tokenId)
          Constructor
InvalidPasswordException(java.lang.String rbName, java.lang.String errCode, java.lang.Object[] args)
           
InvalidPasswordException(java.lang.String rbName, java.lang.String errorCode, java.lang.Object[] args, java.lang.String tokenId, java.lang.Throwable t)
          Constructor
InvalidPasswordException(java.lang.Throwable t)
          Constructor
 
Method Summary
 java.lang.String getTokenId()
          returns the tokenID.
 
Methods inherited from class com.sun.identity.authentication.spi.AuthLoginException
getErrorCode, getL10NMessage, getMessage, getMessageArgs, getResourceBundleName, printStackTrace, printStackTrace, printStackTrace
 

Constructor Detail

InvalidPasswordException

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

InvalidPasswordException

public InvalidPasswordException(java.lang.String message)
Constructor
Parameters:
message - English message for the exception.

InvalidPasswordException

public InvalidPasswordException(java.lang.String message,
                                java.lang.String tokenId)
Constructor
Parameters:
message - English message for the exception.
tokenId - The userId for which the exception occurred.

InvalidPasswordException

public InvalidPasswordException(java.lang.Throwable t)
Constructor
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)
Constructor
Parameters:
rbName - Resource bundle name for the message.
errCode - 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 tokenID.