| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.iplanet.am.sdk.AMException
The AMException is thrown whenever an error is 
 is encountered while performing an operation on the data store.
| Constructor Summary | |
| AMException(SSOToken token,
            java.lang.String errorCode)Convenience method (protected) | |
| AMException(SSOToken token,
            java.lang.String errorCode,
            com.iplanet.ums.UMSException ue)Constructs a new AMExceptionwith detailed message. | |
| AMException(java.lang.String msg,
            java.lang.String errorCode)Constructs a new AMExceptionwith detailed message. | |
| AMException(java.lang.String msg,
            java.lang.String errorCode,
            java.lang.Object[] args)Constructs a new AMExceptionwith detailed message. | |
| AMException(java.lang.String msg,
            java.lang.String errorCode,
            java.lang.Object[] args,
            com.iplanet.ums.UMSException ue)Constructs a new AMExceptionwith detailed message. | |
| AMException(java.lang.String msg,
            java.lang.String errorCode,
            com.iplanet.ums.UMSException ue)Constructs a new AMExceptionwith detailed message. | |
| Method Summary | |
|  java.lang.String | getErrorCode()Returns the error code. | 
|  java.lang.String | getL10NMessage(java.util.Locale locale)Returns localized error message. | 
|  java.lang.String | getLDAPErrorCode()Method to obtain the LDAP error code. | 
|  netscape.ldap.LDAPException | getLDAPException()Returns the root LDAPExceptionof thisAMException, 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. | 
|  java.lang.String | getResourceBundleName()Returns ResourceBundle Name associated with this exception | 
| 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 | 
| Constructor Detail | 
public AMException(java.lang.String msg,
                   java.lang.String errorCode)
AMException with detailed message.msg - The detailed messageerroCode - Matches the appropriate entry in
        amProfile.properties.
public AMException(SSOToken token,
                   java.lang.String errorCode)
public AMException(java.lang.String msg,
                   java.lang.String errorCode,
                   com.iplanet.ums.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,
                   java.lang.String errorCode,
                   com.iplanet.ums.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(java.lang.String msg,
                   java.lang.String errorCode,
                   java.lang.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(java.lang.String msg,
                   java.lang.String errorCode,
                   java.lang.Object[] args,
                   com.iplanet.ums.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.| Method Detail | 
public java.lang.String getErrorCode()
getErrorCode in interface com.sun.identity.common.L10NMessagepublic java.lang.Object[] getMessageArgs()
getMessageArgs in interface com.sun.identity.common.L10NMessagepublic java.lang.String getMessage()
getMessage() method of super class
 Exception.getMessage in interface com.sun.identity.common.L10NMessagegetMessage in class java.lang.Throwablepublic java.lang.String getLDAPErrorCode()
public netscape.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 java.lang.String getL10NMessage(java.util.Locale locale)
getL10NMessage in interface com.sun.identity.common.L10NMessagelocale - locale of the error message.public java.lang.String getResourceBundleName()
getResourceBundleName in interface com.sun.identity.common.L10NMessage| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||