com.sun.identity.sm

Class SMSException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.sun.identity.sm.SMSException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InvalidAttributeNameException, InvalidAttributeValueException, OrganizationAlreadyExistsException, SchemaException, ServiceAlreadyExistsException, ServiceConfigException, ServiceErrorException, ServiceNotFoundException

public class SMSException
extends Exception

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

Constructor Summary

Constructors

Constructor and 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

Modifier and Type	Method and 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

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.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.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.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.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