com.sun.identity.um
Class UMException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.sun.identity.um.UMException
All Implemented Interfaces:
java.io.Serializable

public class UMException
extends java.lang.Exception

The UMException is thrown whenever an error is is encountered while performing an operation on the data store.

See Also:
Serialized Form

Constructor Summary
UMException(java.lang.String msg, java.lang.String errorCode)
          Constructs a new UMException with detailed message.
UMException(java.lang.String msg, java.lang.String errorCode, AMException ue)
          Constructs a new UMException with detailed message.
UMException(java.lang.String msg, java.lang.String errorCode, java.lang.Object[] args)
          Constructs a new UMException with detailed message.
UMException(java.lang.String msg, java.lang.String errorCode, java.lang.Object[] args, AMException ue)
          Constructs a new UMException with detailed message.
 
Method Summary
 java.lang.String getErrorCode()
          Method to obtain the error code.
 java.lang.String getLDAPErrorCode()
          Method to obtain the LDAP error code.
 java.lang.String getMessage()
          Overriding the default getMessage() method of super class Exception
 java.lang.Object[] getMessageArgs()
          Method to obtain the arguments corresponding to the error code.
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UMException

public UMException(java.lang.String msg,
                   java.lang.String errorCode)
Constructs a new UMException with detailed message.
Parameters:
msg - The detailed message
erroCode - Matches the appropriate entry in amProfile.properties

UMException

public UMException(java.lang.String msg,
                   java.lang.String errorCode,
                   AMException ue)
Constructs a new UMException with detailed message.
Parameters:
msg - The detailed message
erroCode - Matches the appropriate entry in amProfile.properties
AMException - - if the rootCasue is a AMException

UMException

public UMException(java.lang.String msg,
                   java.lang.String errorCode,
                   java.lang.Object[] args)
Constructs a new UMException with detailed message.
Parameters:
msg - The detailed message
erroCode - Matches the appropriate entry in amProfile.properties
Object[] - args, if the error message needs specific values to be set

UMException

public UMException(java.lang.String msg,
                   java.lang.String errorCode,
                   java.lang.Object[] args,
                   AMException ue)
Constructs a new UMException with detailed message.
Parameters:
msg - The detailed message
erroCode - Matches the appropriate entry in amProfile.properties
Object[] - args, if the error message needs specific values to be set
UMSException - - if the rootCasue is a UMSException
Method Detail

getErrorCode

public java.lang.String getErrorCode()
Method to obtain the error code. This error code can be used with the arguments to construct a localized message.
Returns:
the error code which can be used to map the message to a user specific locale.

getMessageArgs

public java.lang.Object[] getMessageArgs()
Method to obtain the arguments corresponding to the error code.
Returns:
the arguments corresponding to the error code or null if no arguments are need to construct the message

getMessage

public java.lang.String getMessage()
Overriding the default getMessage() method of super class Exception
Overrides:
getMessage in class java.lang.Throwable
Returns:
The error message string

getLDAPErrorCode

public java.lang.String getLDAPErrorCode()
Method to obtain the LDAP error code.
Returns:
The error code, which can be used to map the message to a specific locale. returns a null, if not an LDAP error