com.ibm.itim.apps

Class ApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.itim.exception.ITIMException

com.ibm.itim.apps.ApplicationException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AuthenticationException, AuthorizationException, BulkException, InvalidPasswordException, PasswordRuleException, PasswordValidationFailuresException, SchemaViolationException

public class ApplicationException
extends ITIMException

This exception is thrown when application-level errors occur such as the violation of business rules. An ApplicationException is distinguished by its error code. A localized message describing the error code can be retrieved through the getMessage() method.

If the error causing an ApplicationException is provided in the constructor, then it will be inserted into the stack trace.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationException(java.lang.String errCode) Constructs an ApplicationException with an error code.
ApplicationException(java.lang.String errCode, java.lang.Object[] tokens) Constructs an ApplicationException with an error code and message tokens.
ApplicationException(java.lang.String errCode, java.lang.Object[] tokens, java.lang.Throwable cause) Constructs with an error code and the cause exception.
ApplicationException(java.lang.String errCode, java.lang.String exMsg) Constructs with an error code and an extra message string.
ApplicationException(java.lang.String errCode, java.lang.Throwable cause) Constructs with an error code and the cause exception.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorCode() Returns the error code.
java.lang.String	getExtraMessage() Returns the first token in the tokens array used to construct this ApplicationException, (i.e., tokens[0].toString()) or null if no tokens are present.

Methods inherited from class com.ibm.itim.exception.ITIMException

getLocalizedMessage, getMessage, getMessage, getMessageId, getThrowable, getTokens, normalize, printStackTrace, printStackTrace, printStackTrace, toXML

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationException

public ApplicationException(java.lang.String errCode)

Constructs an ApplicationException with an error code.

Parameters:

errCode - Code for the error.

ApplicationException

public ApplicationException(java.lang.String errCode,
                            java.lang.Object[] tokens)

Constructs an ApplicationException with an error code and message tokens.

Parameters:

errCode - Error code identifying the problem.

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

ApplicationException

public ApplicationException(java.lang.String errCode,
                            java.lang.String exMsg)

Constructs with an error code and an extra message string.

Parameters:

errCode - Error code identifying the problem.

exMsg - Additional information in a String.

ApplicationException

public ApplicationException(java.lang.String errCode,
                            java.lang.Throwable cause)

Constructs with an error code and the cause exception.

Parameters:

errCode - Error code identifying the problem.

cause - Throwable representing the exception causing this exception.

ApplicationException

public ApplicationException(java.lang.String errCode,
                            java.lang.Object[] tokens,
                            java.lang.Throwable cause)

Constructs with an error code and the cause exception.

Parameters:

errCode - Error code identifying the problem.

cause - Throwable representing the exception causing this exception.

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

Method Detail

getErrorCode

public java.lang.String getErrorCode()

Returns the error code.

Returns:

Error code identifying the problem.

getExtraMessage

public java.lang.String getExtraMessage()

Returns the first token in the tokens array used to construct this ApplicationException, (i.e., tokens[0].toString()) or null if no tokens are present.

Returns:

First token in tokens (i.e., tokens[0].toString()).