| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.sun.identity.sm.SMSException
The exception class whose instance is thrown if there is any error
 during the operation of objects of the com.sun.identity.sms
 package. This class maps the exception that occurred at a lower level to a
 high level error.  Using the exception status code
 getExceptionCode() the errors are categorized as a
 ABORT, RETRY, CONFIG_PROBLEM or
 LDAP_OP_FAILED (typically a bug).
| Field Summary | |
| static int | STATUS_ABORTStatus to abort operation | 
| static int | STATUS_CONFIG_PROBLEMIf the root LDAP exception is  INVALID_CREDENTIALS or REFERRAL then this status is set | 
| static int | STATUS_LDAP_OP_FAILEDIf root LDAP cause is an LDAP exception with one of the following error codes then this status is set. | 
| static int | STATUS_NO_PERMISSIONIf the root LDAP cause is  INSUFFICIENT_ACCESS_RIGHTS  | 
| static int | STATUS_NONENo status code is set | 
| static int | STATUS_QUO_ANTEIf root LDAP cause is LDAP_PARTIAL_RESULTS then this status is set | 
| static int | STATUS_REPEATEDLY_FAILEDRepeated retry to data store failed | 
| static int | STATUS_RETRYRetry connection to data store | 
| static int | STATUS_UNKNOWN_EXCEPTIONIf the root cause is other than any of those listed in other status codes | 
| Constructor Summary | |
| SMSException()Default constructor for  SMSException  | |
| SMSException(int status,
             java.lang.String errorCode) | |
| SMSException(int status,
             java.lang.String exMessage,
             java.lang.String errorCode) | |
| SMSException(java.lang.String msg) | |
| SMSException(java.lang.String msg,
             java.lang.String errorCode) | |
| SMSException(java.lang.String rbName,
             java.lang.String errorCode,
             java.lang.Object[] args)This constructor is used to pass the localized error message At this level, the locale of the caller is not known and it is not possible to throw localized error message at this level. | |
| SMSException(java.lang.String rbName,
             java.lang.String message,
             java.lang.Throwable t,
             java.lang.String errorCode)Constructs an SMSException. | |
| SMSException(java.lang.String message,
             java.lang.Throwable t,
             java.lang.String errorCode)Constructs an SMSException. | |
| SMSException(java.lang.Throwable t,
             java.lang.String errorCode)Constructs an SMSException. | |
| Method Summary | |
|  java.lang.String | getErrorCode()Returns error code associated with this error message. | 
|  int | getExceptionCode()Returns the status code for this exception. | 
|  java.lang.String | getL10NMessage(java.util.Locale locale)Returns a localized error message | 
|  java.lang.String | getMessage()Returns the error message of this exception. | 
|  java.lang.Object[] | getMessageArgs()Returns arguments for formatting this error message. | 
|  java.lang.String | getResourceBundleName()Returns ResourceBundleName associated with this error
 message. | 
|  java.lang.String | toString() | 
| Methods inherited from class java.lang.Throwable | 
| fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace | 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
public static int STATUS_NONE
public static int STATUS_RETRY
public static int STATUS_REPEATEDLY_FAILED
public static int STATUS_ABORT
public static int STATUS_QUO_ANTE
LDAP_PARTIAL_RESULTS  then this status is setpublic static int STATUS_LDAP_OP_FAILED
NO_SUCH_OBJECT OBJECT_CLASS_VIOLATION NAMING_VIOLATION CONSTRAINT_VIOLATION INVALID_DN_SYNTAX ENTRY_ALREADY_EXISTS ATTRIBUTE_OR_VALUE_EXISTS PROTOCOL_ERROR UNDEFINED_ATTRIBUTE_TYPE
public static int STATUS_CONFIG_PROBLEM
 INVALID_CREDENTIALS  or
   REFERRAL  then this status is setpublic static int STATUS_UNKNOWN_EXCEPTION
public static int STATUS_NO_PERMISSION
 INSUFFICIENT_ACCESS_RIGHTS | Constructor Detail | 
public SMSException()
 SMSException 
public SMSException(int status,
                    java.lang.String errorCode)
status - The exception status code.errorCode - Key to resource bundle.
public SMSException(int status,
                    java.lang.String exMessage,
                    java.lang.String errorCode)
status - The Exception status code.exMessage - The message provided by the object which is 
 throwing the exceptionerrorCode - Key to resource bundle.public SMSException(java.lang.String msg)
msg - The message provided by the object which is 
 throwing the exception
public SMSException(java.lang.String msg,
                    java.lang.String errorCode)
msg - The message provided by the object which is 
 throwing the exceptionerrorCode - Key to resource bundle.
public SMSException(java.lang.Throwable t,
                    java.lang.String errorCode)
SMSException.t - The Throwable object provided by the object 
        which is throwing the exceptionerrorCode - Key to resource bundle.
public SMSException(java.lang.String message,
                    java.lang.Throwable t,
                    java.lang.String errorCode)
SMSException.message - exception message.t - The Throwable object provided by the object 
        which is throwing the exception.errorCode - Key to resource bundle.
public SMSException(java.lang.String rbName,
                    java.lang.String message,
                    java.lang.Throwable t,
                    java.lang.String errorCode)
SMSException.rbName - Resource bundle Name to be used for getting 
               localized error message.message - exception message.t - The Throwable object provided by the object 
        which is throwing the exception.errorCode - Key to resource bundle.
public SMSException(java.lang.String rbName,
                    java.lang.String errorCode,
                    java.lang.Object[] args)
getMessage() will always return English messages only. This
 is in consistent with current JRE.rbName - Resource bundle Name to be used for getting 
               localized error message.errorCode - Key to resource bundle. You can use 
        ResourceBundle rb =
        ResourceBunde.getBundle(rbName,locale);
        String localizedStr = rb.getString(errorCode).args - arguments to message. If it is not present pass the as null.| Method Detail | 
public java.lang.String getL10NMessage(java.util.Locale locale)
getL10NMessage in interface com.sun.identity.common.L10NMessagelocale - Uses the locale object to create the appropriate localized
 error messageSMSException(String, String, Object[])public java.lang.String getResourceBundleName()
ResourceBundle Name associated with this error
 message.getResourceBundleName in interface com.sun.identity.common.L10NMessageResourceBundle name associated with this error
         message.SMSException(String, String, Object[])public java.lang.String getErrorCode()
getErrorCode in interface com.sun.identity.common.L10NMessageSMSException(String, String, Object[])public java.lang.Object[] getMessageArgs()
getMessageArgs in interface com.sun.identity.common.L10NMessageMessageFormat class to format the message
 It can be null.SMSException(String, String, Object[])public int getExceptionCode()
public java.lang.String toString()
toString in class java.lang.Throwablepublic java.lang.String getMessage()
getMessage in interface com.sun.identity.common.L10NMessagegetMessage in class java.lang.Throwable| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||