public class IdRepoException extends Exception
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).Constructor and Description |
---|
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.
|
IdRepoException(String rbName,
String errorCode,
String ldapErrCode,
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.
|
Modifier and Type | Method and Description |
---|---|
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() |
public IdRepoException()
public IdRepoException(String msg)
msg
- The message provided by the object which is throwing the
exceptionpublic IdRepoException(String msg, String errorCode)
public IdRepoException(String rbName, String errorCode, String ldapErrCode, 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)
.ldapErrCode
- ldap error codeargs
- arguments to message. If it is not present pass the as null.public IdRepoException(String rbName, String errorCode, 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.public String getL10NMessage(Locale locale)
locale
- Uses the locale object to create the appropriate localized
error messageIdRepoException.IdRepoException(String, String, Object[])
public String getResourceBundleName()
ResourceBundle
Name associated with this error
message.ResourceBundle
name associated with this error
message.IdRepoException.IdRepoException(String, String, Object[])
public String getErrorCode()
IdRepoException.IdRepoException(String, String, Object[])
public String getLDAPErrorCode()
LDAPException
.IdRepoException.IdRepoException(String, String, Object[])
public void setLDAPErrorCode(String errorCode)
public Object[] getMessageArgs()
MessageFormat
class to format the message It can
be null.IdRepoException.IdRepoException(String, String, Object[])
public String getMessage()
getMessage
in class Throwable
Copyright © 2010-2013, ForgeRock All Rights Reserved.