com.ibm.itim.exception
Class ITIMException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.itim.exception.ITIMException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ApplicationException, IncompatibleRulesException, InvalidPasswordException, IterationsExceededException, ModelException, RemoteServicesException, WorkflowException

public abstract class ITIMException

extends java.lang.Exception

An Exception capable of accepting values for replaceable tokens, which may be used in MessageFormater to format "flexible" error desciptions

See Also:

Serialized Form

Method Summary

java.lang.String	getLocalizedMessage() Returns error message for the default locale.
java.lang.String	getMessage() Returns error message for Locale.US.
java.lang.String	getMessage(java.util.Locale locale) Returns a message localized for the given Locale.
java.lang.String	getMessageId() Returns the message identifier for this exeception.
java.lang.Throwable	getThrowable() Deprecated.
java.lang.Object[]	getTokens() Gets the Object[] of tokens which are used in the localized message.
static java.lang.String	normalize(java.lang.String s, boolean canonical) Normalizes the given string.
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

Method Detail

getMessageId

public java.lang.String getMessageId()

Returns the message identifier for this exeception.

Returns:

the message identifier for this exception

getTokens

public java.lang.Object[] getTokens()

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 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 error message for 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.

See Also:

Locale.US

getMessage

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

Returns a message localized for the given Locale.

Parameters:

locale - a Locale object representing the language into which to translate the ITIMException message.

Returns:

a localized message, or, in the absence of a ResourceBundle from which to translate, returns a message key.

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.

normalize

public static java.lang.String normalize(java.lang.String s,
                                         boolean canonical)

Normalizes the given string.