com.ibm.itim.apps
Class ITIMCredentialExpiredException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.security.GeneralSecurityException
              javax.security.auth.login.LoginException
                  javax.security.auth.login.CredentialException
                      javax.security.auth.login.CredentialExpiredException
                          com.ibm.itim.apps.ITIMCredentialExpiredException

All Implemented Interfaces:

java.io.Serializable

public class ITIMCredentialExpiredException
extends javax.security.auth.login.CredentialExpiredException

This class identifies an authentication failure. The user has attempted to login to ITIM but the credential for the ITIM Account has expired.

See Also:

Serialized Form

Constructor Summary

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

ITIMCredentialExpiredException(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 for the default locale.
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 will get 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

Constructor Detail

ITIMCredentialExpiredException

public ITIMCredentialExpiredException(java.lang.String msg)

Constructs with an error code

Parameters:

msg - string identifier for the error message.

ITIMCredentialExpiredException

public ITIMCredentialExpiredException(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 will get 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 for the default locale.

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.