java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.sun.identity.sm.SMSException

All Implemented Interfaces:

com.sun.identity.shared.locale.L10NMessage, Serializable

Direct Known Subclasses:

InvalidAttributeNameException, InvalidAttributeValueException, OrganizationAlreadyExistsException, SchemaException, ServiceAlreadyExistsException, ServiceConfigException, ServiceErrorException, ServiceNotFoundException
```
@SupportedAll
public class SMSException
extends Exception
implements com.sun.identity.shared.locale.L10NMessage
```
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).

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`SMS_ADMIN_LIMIT_EXCEEDED`
`static String`	`SMS_AUTHENTICATION_ERROR`
`static String`	`SMS_INSUFFICIENT_ACCESS_RIGHTS`
`static String`	`SMS_LDAP_NOT_SUPPORTED`
`static String`	`SMS_LDAP_OPERATION_FAILED`
`static String`	`SMS_LDAP_REFERRAL_EXCEPTION`
`static String`	`SMS_LDAP_SERVER_BUSY`
`static String`	`SMS_NO_SUCH_OBJECT`
`static String`	`SMS_SERVER_DOWN`
`static String`	`SMS_TIME_LIMIT_EXCEEDED`
`static String`	`SMS_UNEXPECTED_LDAP_EXCEPTION`
`static String`	`SMS_UNKNOWN_EXCEPTION_OCCURRED`
`static String`	`SMS_XML_PARSER_EXCEPTION`
`static int`	`STATUS_ABORT`	Status to abort operation
`static int`	`STATUS_CONFIG_PROBLEM`	If the root LDAP exception is `INVALID_CREDENTIALS` or `REFERRAL` then this status is set
`static int`	`STATUS_LDAP_OP_FAILED`	If root LDAP cause is an LDAP exception with one of the following error codes then this status is set.
`static int`	`STATUS_NO_PERMISSION`	If the root LDAP cause is `INSUFFICIENT_ACCESS_RIGHTS`
`static int`	`STATUS_NONE`	No status code is set
`static int`	`STATUS_NOT_ALLOW`	the operation is not allowed.
`static int`	`STATUS_QUO_ANTE`	If root LDAP cause is `LDAP_PARTIAL_RESULTS` then this status is set
`static int`	`STATUS_REPEATEDLY_FAILED`	Repeated retry to data store failed
`static int`	`STATUS_RETRY`	Retry connection to data store
`static int`	`STATUS_UNKNOWN_EXCEPTION`	If root cause is other than any of those listed in other status codes

Constructor Summary

Constructors
Constructor	Description
`SMSException()`	Default constructor for `SMSException`
`SMSException(int status, String errorCode)`
`SMSException(int status, String exMessage, String errorCode)`
`SMSException(String msg)`
`SMSException(String msg, String errorCode)`
`SMSException(String rbName, String errorCode, 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(String rbName, String message, Throwable t, String errorCode)`	Constructs an `SMSException`.
`SMSException(String message, Throwable t, String errorCode)`	Constructs an `SMSException`.
`SMSException(Throwable t, String errorCode)`	Constructs an `SMSException`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getErrorCode()`	Returns error code associated with this error message.
`int`	`getExceptionCode()`	Returns the status code for this exception.
`String`	`getL10NMessage(Locale locale)`	Returns a localized error message
`String`	`getMessage()`	Returns the error message of this exception.
`Object[]`	`getMessageArgs()`	Returns arguments for formatting this error message.
`String`	`getResourceBundleName()`	Returns `ResourceBundle` Name associated with this error message.
`String`	`toString()`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SMS_LDAP_REFERRAL_EXCEPTION
```
public static final String SMS_LDAP_REFERRAL_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - SMS_TIME_LIMIT_EXCEEDED
```
public static final String SMS_TIME_LIMIT_EXCEEDED
```
    See Also:
    
    Constant Field Values
  - SMS_ADMIN_LIMIT_EXCEEDED
```
public static final String SMS_ADMIN_LIMIT_EXCEEDED
```
    See Also:
    
    Constant Field Values
  - SMS_INSUFFICIENT_ACCESS_RIGHTS
```
public static final String SMS_INSUFFICIENT_ACCESS_RIGHTS
```
    See Also:
    
    Constant Field Values
  - SMS_NO_SUCH_OBJECT
```
public static final String SMS_NO_SUCH_OBJECT
```
    See Also:
    
    Constant Field Values
  - SMS_LDAP_SERVER_BUSY
```
public static final String SMS_LDAP_SERVER_BUSY
```
    See Also:
    
    Constant Field Values
  - SMS_LDAP_NOT_SUPPORTED
```
public static final String SMS_LDAP_NOT_SUPPORTED
```
    See Also:
    
    Constant Field Values
  - SMS_SERVER_DOWN
```
public static final String SMS_SERVER_DOWN
```
    See Also:
    
    Constant Field Values
  - SMS_LDAP_OPERATION_FAILED
```
public static final String SMS_LDAP_OPERATION_FAILED
```
    See Also:
    
    Constant Field Values
  - SMS_UNEXPECTED_LDAP_EXCEPTION
```
public static final String SMS_UNEXPECTED_LDAP_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - SMS_UNKNOWN_EXCEPTION_OCCURRED
```
public static final String SMS_UNKNOWN_EXCEPTION_OCCURRED
```
    See Also:
    
    Constant Field Values
  - SMS_AUTHENTICATION_ERROR
```
public static final String SMS_AUTHENTICATION_ERROR
```
    See Also:
    
    Constant Field Values
  - SMS_XML_PARSER_EXCEPTION
```
public static final String SMS_XML_PARSER_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - STATUS_NONE
```
public static final int STATUS_NONE
```
    No status code is set
    
    See Also:
    
    Constant Field Values
  - STATUS_RETRY
```
public static final int STATUS_RETRY
```
    Retry connection to data store
    
    See Also:
    
    Constant Field Values
  - STATUS_REPEATEDLY_FAILED
```
public static final int STATUS_REPEATEDLY_FAILED
```
    Repeated retry to data store failed
    
    See Also:
    
    Constant Field Values
  - STATUS_ABORT
```
public static final int STATUS_ABORT
```
    Status to abort operation
    
    See Also:
    
    Constant Field Values
  - STATUS_QUO_ANTE
```
public static final int STATUS_QUO_ANTE
```
    If root LDAP cause is LDAP_PARTIAL_RESULTS then this status is set
    
    See Also:
    
    Constant Field Values
  - STATUS_LDAP_OP_FAILED
```
public static final int STATUS_LDAP_OP_FAILED
```
    If root LDAP cause is an LDAP exception with one of the following error codes then this status is set.
    
    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
    See Also:
    
    Constant Field Values
  - STATUS_CONFIG_PROBLEM
```
public static final int STATUS_CONFIG_PROBLEM
```
    If the root LDAP exception is INVALID_CREDENTIALS or REFERRAL then this status is set
    
    See Also:
    
    Constant Field Values
  - STATUS_UNKNOWN_EXCEPTION
```
public static final int STATUS_UNKNOWN_EXCEPTION
```
    If root cause is other than any of those listed in other status codes
    
    See Also:
    
    Constant Field Values
  - STATUS_NO_PERMISSION
```
public static final int STATUS_NO_PERMISSION
```
    If the root LDAP cause is INSUFFICIENT_ACCESS_RIGHTS
    
    See Also:
    
    Constant Field Values
  - STATUS_NOT_ALLOW
```
public static final int STATUS_NOT_ALLOW
```
    the operation is not allowed.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SMSException
```
public SMSException()
```
    Default constructor for SMSException
  - SMSException
```
public SMSException(int status,
                    String errorCode)
```
    Parameters:
    
    status - The exception status code.
    
    errorCode - Key to resource bundle.
  - SMSException
```
public SMSException(int status,
                    String exMessage,
                    String errorCode)
```
    Parameters:
    
    status - The Exception status code.
    
    exMessage - The message provided by the object which is throwing the exception
    
    errorCode - Key to resource bundle.
  - SMSException
```
public SMSException(String msg)
```
    Parameters:
    
    msg - The message provided by the object which is throwing the exception
  - SMSException
```
public SMSException(String msg,
                    String errorCode)
```
    Parameters:
    
    msg - The message provided by the object which is throwing the exception
    
    errorCode - Key to resource bundle.
  - SMSException
```
public SMSException(Throwable t,
                    String errorCode)
```
    Constructs an SMSException.
    
    Parameters:
    
    t - The Throwable object provided by the object which is throwing the exception
    
    errorCode - Key to resource bundle.
  - SMSException
```
public SMSException(String message,
                    Throwable t,
                    String errorCode)
```
    Constructs an SMSException.
    
    Parameters:
    
    message - exception message.
    
    t - The Throwable object provided by the object which is throwing the exception.
    
    errorCode - Key to resource bundle.
  - SMSException
```
public SMSException(String rbName,
                    String message,
                    Throwable t,
                    String errorCode)
```
    Constructs an SMSException.
    
    Parameters:
    
    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.
  - SMSException
```
public SMSException(String rbName,
                    String errorCode,
                    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. Instead this constructor provides Resource Bundle name and error code for correctly locating the error message. The default getMessage() will always return English messages only. This is in consistent with current JRE.
    
    Parameters:
    
    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
  - getL10NMessage
```
public String getL10NMessage(Locale locale)
```
    Returns a localized error message
    
    Parameters:
    
    locale - Uses the locale object to create the appropriate localized error message
    
    Returns:
    
    localized error message.
    
    See Also:
    
    SMSException(String, String, Object[])
  - getResourceBundleName
```
public String getResourceBundleName()
```
    Returns ResourceBundle Name associated with this error message.
    
    Returns:
    
    ResourceBundle name associated with this error message.
    
    See Also:
    
    SMSException(String, String, Object[])
  - getErrorCode
```
public String getErrorCode()
```
    Returns error code associated with this error message.
    
    Returns:
    
    Error code associated with this error message.
    
    See Also:
    
    SMSException(String, String, Object[])
  - getMessageArgs
```
public Object[] getMessageArgs()
```
    Returns arguments for formatting this error message.
    
    Returns:
    
    arguments for formatting this error message. You need to use MessageFormat class to format the message It can be null.
    
    See Also:
    
    SMSException(String, String, Object[])
  - getExceptionCode
```
public int getExceptionCode()
```
    Returns the status code for this exception.
    
    Returns:
    
    Integer representing the exception status code
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Throwable
  - getMessage
```
public String getMessage()
```
    Returns the error message of this exception.
    
    Overrides:
    
    getMessage in class Throwable
    
    Returns:
    
    String representing the error message

Class SMSException

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

SMS_LDAP_REFERRAL_EXCEPTION

SMS_TIME_LIMIT_EXCEEDED

SMS_ADMIN_LIMIT_EXCEEDED

SMS_INSUFFICIENT_ACCESS_RIGHTS

SMS_NO_SUCH_OBJECT

SMS_LDAP_SERVER_BUSY

SMS_LDAP_NOT_SUPPORTED

SMS_SERVER_DOWN

SMS_LDAP_OPERATION_FAILED

SMS_UNEXPECTED_LDAP_EXCEPTION

SMS_UNKNOWN_EXCEPTION_OCCURRED

SMS_AUTHENTICATION_ERROR

SMS_XML_PARSER_EXCEPTION

STATUS_NONE

STATUS_RETRY

STATUS_REPEATEDLY_FAILED

STATUS_ABORT

STATUS_QUO_ANTE

STATUS_LDAP_OP_FAILED

STATUS_CONFIG_PROBLEM

STATUS_UNKNOWN_EXCEPTION

STATUS_NO_PERMISSION

STATUS_NOT_ALLOW

Constructor Detail

SMSException

SMSException

SMSException

SMSException

SMSException

SMSException

SMSException

SMSException

SMSException

Method Detail

getL10NMessage

getResourceBundleName

getErrorCode

getMessageArgs

getExceptionCode

toString

getMessage