com.ibm.itim.apps
Class ITIMFailedLoginException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.security.GeneralSecurityException
                    |
                    +--javax.security.auth.login.LoginException
                          |
                          +--javax.security.auth.login.FailedLoginException
                                |
                                +--com.ibm.itim.apps.ITIMFailedLoginException

All Implemented Interfaces:

java.io.Serializable

public class ITIMFailedLoginException

extends javax.security.auth.login.FailedLoginException

This class identifies an authentication failure. The user has attempted to login to ITIM but failed to login with ITIM Account.

See Also:

Serialized Form

Field Summary

static java.lang.String	INVALID_ANSWERS Key for invalid answers
static java.lang.String	INVALID_ANSWERS_ATTEMPTS Key for invalid answers attempts.
static java.lang.String	INVALID_OLD_PASSWORD Key for invalid old password
static java.lang.String	INVALID_OLD_PASSWORD_ATTEMPTS Key for invalid old password attempts
static java.lang.String	INVALID_PASSWORD Key for invalid password
static java.lang.String	INVALID_PASSWORD_ATTEMPTS Key for invalid password attempts
static java.lang.String	NO_USER_ID Key for no user ID

Constructor Summary

ITIMFailedLoginException(java.lang.String msg)
Constructs with an error code

ITIMFailedLoginException(java.lang.String msg, java.lang.Object[] tokenValues)
Constructs with an error code and message tokens

Method Summary

java.lang.String	getLocalizedMessage() Returns an error message localized for java.util.Locale.getDefault().
java.lang.String	getMessage() Returns an error message localized for java.util.Locale.US.
java.lang.String	getMessage(java.util.Locale locale) Returns an error message localized for the given java.util.Locale.
java.lang.String	getMessageId() This method returns the message identifier for this exeception.
java.lang.Throwable	getThrowable() Deprecated.
java.lang.Object[]	getTokens() This method gets the Object[] of tokens which are used in the localized message.
java.lang.String	toXML() Returns a XML representation of this exception message and parameters that can be localized in the ITIM UI.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_ANSWERS

public static final java.lang.String INVALID_ANSWERS

Key for invalid answers

See Also:

Constant Field Values

INVALID_ANSWERS_ATTEMPTS

public static final java.lang.String INVALID_ANSWERS_ATTEMPTS

Key for invalid answers attempts.

See Also:

Constant Field Values

INVALID_OLD_PASSWORD_ATTEMPTS

public static final java.lang.String INVALID_OLD_PASSWORD_ATTEMPTS

Key for invalid old password attempts

See Also:

Constant Field Values

INVALID_OLD_PASSWORD

public static final java.lang.String INVALID_OLD_PASSWORD

Key for invalid old password

See Also:

Constant Field Values

INVALID_PASSWORD

public static final java.lang.String INVALID_PASSWORD

Key for invalid password

See Also:

Constant Field Values

INVALID_PASSWORD_ATTEMPTS

public static final java.lang.String INVALID_PASSWORD_ATTEMPTS

Key for invalid password attempts

See Also:

Constant Field Values

NO_USER_ID

public static final java.lang.String NO_USER_ID

Key for no user ID

See Also:

Constant Field Values

Constructor Detail

ITIMFailedLoginException

public ITIMFailedLoginException(java.lang.String msg)

Constructs with an error code

Parameters:

msg - string identifier of error message.

ITIMFailedLoginException

public ITIMFailedLoginException(java.lang.String msg,
                                java.lang.Object[] tokenValues)

Constructs with an error code and message tokens

Parameters:

msg - string identifier of error message.

tokenValues - Object[] containing string values for replaceable tokens in the message bundle string.

Method Detail

getMessageId

public java.lang.String getMessageId()

This method returns the message identifier for this exeception.

Returns:

the message identifier for this exception

getTokens

public java.lang.Object[] getTokens()

This method gets the Object[] of tokens which are used in the localized message.

Returns:

Object[] with message token values.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Returns an error message localized for java.util.Locale.getDefault().

Overrides:

getLocalizedMessage in class java.lang.Throwable

Returns:

formatted, internationalized error message using the message id and token values defined in an object of this class.

getMessage

public java.lang.String getMessage()

Returns an error message localized for java.util.Locale.US.

Overrides:

getMessage in class java.lang.Throwable

Returns:

formatted, internationalized error message using the message id and token values defined in an object of this class.

getMessage

public java.lang.String getMessage(java.util.Locale locale)

Returns an error message localized for the given java.util.Locale.

Parameters:

locale - a java.util.Locale for which to localize the message returned.

Returns:

a localized error message.

getThrowable

public java.lang.Throwable getThrowable()

Deprecated.

Accessor method for the nested throwable contained in this exception.

Returns:

the nested throwable object contained within this object.

toXML

public java.lang.String toXML()

Returns a XML representation of this exception message and parameters that can be localized in the ITIM UI.

Returns:

The formatted XML message.