public class AMException extends Exception
AMException
is thrown whenever an error is is encountered
while performing an operation on the data store.Constructor and Description |
---|
AMException(SSOToken token,
String errorCode)
Deprecated.
Convenience method (protected)
|
AMException(SSOToken token,
String errorCode,
UMSException ue)
Deprecated.
Constructs a new
AMException with detailed message. |
AMException(String msg,
String errorCode)
Deprecated.
Constructs a new
AMException with detailed message. |
AMException(String msg,
String errorCode,
Object[] args)
Deprecated.
Constructs a new
AMException with detailed message. |
AMException(String msg,
String errorCode,
Object[] args,
UMSException ue)
Deprecated.
Constructs a new
AMException with detailed message. |
AMException(String msg,
String errorCode,
UMSException ue)
Deprecated.
Constructs a new
AMException with detailed message. |
Modifier and Type | Method and Description |
---|---|
String |
getErrorCode()
Deprecated.
Returns the error code.
|
String |
getL10NMessage(Locale locale)
Deprecated.
Returns localized error message.
|
String |
getLDAPErrorCode()
Deprecated.
Method to obtain the LDAP error code.
|
com.sun.identity.shared.ldap.LDAPException |
getLDAPException()
Deprecated.
Returns the root
LDAPException of this
AMException , if any. |
String |
getMessage()
Deprecated.
Overrides the default
getMessage() method of super class
Exception. |
Object[] |
getMessageArgs()
Deprecated.
Returns the arguments corresponding to the error code.
|
String |
getResourceBundleName()
Deprecated.
Returns ResourceBundle Name associated with this exception
|
public AMException(String msg, String errorCode)
AMException
with detailed message.msg
- The detailed messageerrorCode
- Matches the appropriate entry in
amProfile.properties
.public AMException(SSOToken token, String errorCode)
public AMException(String msg, String errorCode, UMSException ue)
AMException
with detailed message.msg
- The detailed message.errorCode
- Matches the appropriate entry in
amProfile.properties
.ue
- if the root cause is a UMSException
.public AMException(SSOToken token, String errorCode, UMSException ue)
AMException
with detailed message.token
- a valid single sign on token of the user performing the
operation.errorCode
- Matches the appropriate entry in
amProfile.properties
.ue
- if the root cause is a UMSException
.public AMException(String msg, String errorCode, Object[] args)
AMException
with detailed message.msg
- The detailed message.errorCode
- Matches the appropriate entry in
amProfile.properties
.args
- arguments if the error message needs specific values to be
set.public AMException(String msg, String errorCode, Object[] args, UMSException ue)
AMException
with detailed message.msg
- The detailed messageerrorCode
- Matches the appropriate entry in
amProfile.properties
.args
- if the error message needs specific values to be set.ue
- if the root cause is a UMSException
.public String getErrorCode()
public Object[] getMessageArgs()
public String getMessage()
getMessage()
method of super class
Exception.getMessage
in class Throwable
public String getLDAPErrorCode()
public com.sun.identity.shared.ldap.LDAPException getLDAPException()
LDAPException
of this
AMException
, if any.LDAPException
that caused this
AMException
. If null, it means no root
LDAPException
has been set.public String getL10NMessage(Locale locale)
locale
- locale of the error message.public String getResourceBundleName()
Copyright © 2010-2014, ForgeRock All Rights Reserved.