com.iplanet.am.sdk
Class AMException
java.lang.Object
|
+--java.lang.Throwable
|
+--java.lang.Exception
|
+--com.iplanet.am.sdk.AMException
- All Implemented Interfaces:
- java.io.Serializable
- Direct Known Subclasses:
- AMEntryExistsException, AMInvalidDNException, AMPostCallBackException, AMPreCallBackException
- public class AMException
- extends java.lang.Exception
The AMException
is thrown whenever an error is
is encountered while performing an operation on the data store.
- See Also:
- Serialized Form
Constructor Summary |
AMException(java.lang.String msg,
java.lang.String errorCode)
Constructs a new AMException with detailed message. |
AMException(java.lang.String msg,
java.lang.String errorCode,
java.lang.Object[] args)
Constructs a new AMException with detailed message. |
Method Summary |
java.lang.String |
getErrorCode()
Returns the error code. |
java.lang.String |
getLDAPErrorCode()
Method to obtain the LDAP error code. |
netscape.ldap.LDAPException |
getLDAPException()
Returns the root LDAPException of this
AMException , if any. |
java.lang.String |
getMessage()
Overrides the default getMessage() method of super class
Exception. |
java.lang.Object[] |
getMessageArgs()
Returns the arguments corresponding to the error code. |
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
AMException
public AMException(java.lang.String msg,
java.lang.String errorCode)
- Constructs a new
AMException
with detailed message.
- Parameters:
msg
- The detailed messageerroCode
- Matches the appropriate entry in
amProfile.properties
.
AMException
public AMException(java.lang.String msg,
java.lang.String errorCode,
java.lang.Object[] args)
- Constructs a new
AMException
with detailed message.
- Parameters:
msg
- The detailed message.errorCode
- Matches the appropriate entry in
amProfile.properties
.args
- arguments if the error message needs specific values to be
set.
getErrorCode
public java.lang.String getErrorCode()
- Returns the error code. This error code can be used with
the arguments to construct a localized message.
- Returns:
- the error code which can be used to map the message to
a user specific locale.
getMessageArgs
public java.lang.Object[] getMessageArgs()
- Returns the arguments corresponding to the error code.
- Returns:
- the arguments corresponding to the error code or null
if no arguments are need to construct the message.
getMessage
public java.lang.String getMessage()
- Overrides the default
getMessage()
method of super class
Exception.
- Overrides:
getMessage
in class java.lang.Throwable
- Returns:
- The error message string.
getLDAPErrorCode
public java.lang.String getLDAPErrorCode()
- Method to obtain the LDAP error code.
- Returns:
- The error code, which can be used to map the message to a
specific locale. Returns a null, if not an LDAP error.
getLDAPException
public netscape.ldap.LDAPException getLDAPException()
- Returns the root
LDAPException
of this
AMException
, if any.
- Returns:
- The
LDAPException
that caused this
AMException
. If null, it means no root
LDAPException
has been set.