com.ibm.itim.remoteservices.exception
Class RemoteServicesException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.ibm.itim.remoteservices.exception.RemoteServicesException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
MultipleEntriesFoundException, MultiplePersonsFoundException, PersonAlreadyExistsException, ProviderConfigurationException

public class RemoteServicesException
extends java.lang.Exception

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

See Also:
Serialized Form

Field Summary
static java.lang.String ID_TAG
          Attribute name for the key that the message can be looked up by in a resource bundle
static java.lang.String MESSAGE_TAG
          The tag name of the root of the xml document
static java.lang.String TOKEN_ID_TAG
          Attribute name for the value of the token
static java.lang.String TOKEN_TAG
          The tag name for a message token.
 
Constructor Summary
RemoteServicesException(java.lang.String error)
          Constructor that accepts an error string.
RemoteServicesException(java.lang.String error, java.lang.Throwable orginalException)
          Constructor that accepts an error string and an original exception.
RemoteServicesException(java.lang.Throwable genericError)
          Constructors a remote services exception from a generic exception.
 
Method Summary
 void addErrorMessageArg(java.lang.String arg)
          Add an additional args to the error message.
 java.util.Collection getErrorMessageArgs()
          Get the additional args to the error message.
 java.lang.String getXMLFormattedMessage()
          Gets an error message xml formatted as:
 void printStackTrace()
          Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
 void printStackTrace(java.io.PrintStream ps)
          Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
 void printStackTrace(java.io.PrintWriter pw)
          Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
 void setErrorMessageArgs(java.util.Collection args)
          Set the additional args to the error message.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, getMessage, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MESSAGE_TAG

public static final java.lang.String MESSAGE_TAG
The tag name of the root of the xml document

TOKEN_TAG

public static final java.lang.String TOKEN_TAG
The tag name for a message token.

ID_TAG

public static final java.lang.String ID_TAG
Attribute name for the key that the message can be looked up by in a resource bundle

TOKEN_ID_TAG

public static final java.lang.String TOKEN_ID_TAG
Attribute name for the value of the token
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 error,
                               java.lang.Throwable orginalException)
Constructor that accepts an error string and an original exception.
Parameters:
error - Error string.

RemoteServicesException

public RemoteServicesException(java.lang.Throwable genericError)
Constructors a remote services exception from a generic exception.
Parameters:
error - Error string.
Method Detail

setErrorMessageArgs

public void setErrorMessageArgs(java.util.Collection args)
Set the additional args to the error message.

addErrorMessageArg

public void addErrorMessageArg(java.lang.String arg)
Add an additional args to the error message.

getErrorMessageArgs

public java.util.Collection getErrorMessageArgs()
Get the additional args to the error message.

getXMLFormattedMessage

public java.lang.String getXMLFormattedMessage()
Gets an error message xml formatted as:

printStackTrace

public void printStackTrace()
Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
Overrides:
printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream ps)
Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
Overrides:
printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter pw)
Prints out the stack trace, including the stack trace of the original exception (if there was a separate one).
Overrides:
printStackTrace in class java.lang.Throwable