com.sun.identity.idm
Class IdRepoException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.sun.identity.idm.IdRepoException

Direct Known Subclasses:

IdRepoFatalException, IdRepoUnsupportedOpException

public class IdRepoException
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

IdRepoException()

IdRepoException(String msg)

IdRepoException(String msg, String errorCode)

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

Method Summary

String	getErrorCode() Returns error code associated with this error message.
String	getL10NMessage(Locale locale) Returns a localized error message
String	getLDAPErrorCode() Returns the LDAP error code associated with this 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.
void	setLDAPErrorCode(String errorCode) Replace the LDAP error code associated with this error message.
String	toString()

Constructor Detail

IdRepoException

public IdRepoException()

IdRepoException

public IdRepoException(String msg)

Parameters:

msg - The message provided by the object which is throwing the exception

IdRepoException

public IdRepoException(String msg,
                       String errorCode)

IdRepoException

public IdRepoException(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:

IdRepoException.IdRepoException(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:

IdRepoException.IdRepoException(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:

IdRepoException.IdRepoException(String, String, Object[])

getLDAPErrorCode

public String getLDAPErrorCode()

Returns the LDAP error code associated with this error message.

Returns:

Error code associated with this error message and null if not caused by LDAPException.

See Also:

IdRepoException.IdRepoException(String, String, Object[])

setLDAPErrorCode

public void setLDAPErrorCode(String errorCode)

Replace the LDAP error code associated with this error message.

See Also:

IdRepoException.IdRepoException(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:

IdRepoException.IdRepoException(String, String, Object[])

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