com.ibm.itim.remoteservices.exception

Class RemoteServicesException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.ibm.itim.exception.ITIMException

com.ibm.itim.remoteservices.exception.RemoteServicesException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccountAlreadyExistsException, MalformedEntryException, MultipleEntriesFoundException, MultiplePersonsFoundException, PersonAlreadyExistsException, PersonFindException, ProviderConfigurationException

public class RemoteServicesException
extends ITIMException

Standard exception for remote services. Base class for all remote services exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RemoteServicesException(java.lang.String error) Constructor that accepts an error string.
RemoteServicesException(java.lang.String msgId, java.util.Collection<java.lang.String> tokensColl, java.lang.Throwable orginalException) Constructor that accepts a message ID, array of tokens and an original exception.
RemoteServicesException(java.lang.String msgId, java.lang.Object[] tokens) Constructor that accepts a message ID & array of tokens.
RemoteServicesException(java.lang.String msgId, java.lang.Object[] tokens, java.lang.Throwable orginalException) Constructor that accepts a message ID, array of tokens and an original exception.
RemoteServicesException(java.lang.String error, java.lang.Throwable orginalException) Constructor that accepts an error string / message ID and an original exception.
RemoteServicesException(java.lang.Throwable genericError) Constructors a remote services exception from a generic exception.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getErrorMessageArgs() Get the additional args to the error message.
java.lang.String	getXMLFormattedMessage() Gets the xml formatted error message.

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

RemoteServicesException

public RemoteServicesException(java.lang.String error)

Constructor that accepts an error string.

Parameters:

error - Error string.

RemoteServicesException

public RemoteServicesException(java.lang.String msgId,
                               java.lang.Object[] tokens)

Constructor that accepts a message ID & array of tokens.

Parameters:

msgId - message identifier used to lookup a corresponding error message from properties file.

tokens - values for replacable tokens used in the error message.

RemoteServicesException

public RemoteServicesException(java.lang.String error,
                               java.lang.Throwable orginalException)

Constructor that accepts an error string / message ID and an original exception.

Parameters:

error - Error string / message ID.

orginalException - originating exception or error.

RemoteServicesException

public RemoteServicesException(java.lang.String msgId,
                               java.lang.Object[] tokens,
                               java.lang.Throwable orginalException)

Constructor that accepts a message ID, array of tokens and an original exception.

Parameters:

msgId - message identifier used to lookup a corresponding error message from properties file.

tokens - values for replacable tokens used in the error message.

orginalException - originating exception or error.

RemoteServicesException

public RemoteServicesException(java.lang.String msgId,
                               java.util.Collection<java.lang.String> tokensColl,
                               java.lang.Throwable orginalException)

Constructor that accepts a message ID, array of tokens and an original exception.

Parameters:

msgId - message identifier used to lookup a corresponding error message from properties file.

tokensColl - Collection of token values for replacable tokens used in the error message. Collection objects must support toString() method.

orginalException - originating exception or error.

RemoteServicesException

public RemoteServicesException(java.lang.Throwable genericError)

Constructors a remote services exception from a generic exception.

Parameters:

genericError - originating generic exception.

Method Detail

getErrorMessageArgs

public java.util.Collection<java.lang.String> getErrorMessageArgs()

Get the additional args to the error message.

Returns:

Collection of message arguments (tokens), or null if no arguments for message. Collection objects must support toString() method.

getXMLFormattedMessage

public java.lang.String getXMLFormattedMessage()

Gets the xml formatted error message. Return value contains the message Id, and any Tokens, as passed when Exception object was created

To get the localized message corresponding to the message Id and tokens, call the toString method.

DTD definition of returned xml is:

Returns:

XML formatted error message