com.sun.identity.idm
Class  IdRepoException
java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--com.sun.identity.idm.IdRepoException
- All Implemented Interfaces: 
- com.sun.identity.common.L10NMessage, java.io.Serializable
- Direct Known Subclasses: 
- IdRepoUnsupportedOpException
- public class IdRepoException- extends java.lang.Exception- implements com.sun.identity.common.L10NMessage
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(java.lang.String msg)
 | 
| IdRepoException(java.lang.String msg,
                java.lang.String errorCode)
 | 
| IdRepoException(java.lang.String rbName,
                java.lang.String errorCode,
                java.lang.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 | 
|  java.lang.String | getErrorCode()Returns error code associated with this error message.
 | 
|  java.lang.String | getL10NMessage(java.util.Locale locale)Returns a localized error message
 | 
|  java.lang.String | getMessage()Returns the error message of this exception.
 | 
|  java.lang.Object[] | getMessageArgs()Returns arguments for formatting this error message.
 | 
|  java.lang.String | getResourceBundleName()Returns
 ResourceBundleName associated with this error
 message. | 
|  java.lang.String | toString()
 | 
 
| Methods inherited from class java.lang.Throwable | 
| fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace | 
 
| Methods inherited from class java.lang.Object | 
| equals, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
 
IdRepoException
public IdRepoException(java.lang.String msg)
- 
- Parameters:
- msg- The message provided by the object which is 
 throwing the exception
 
IdRepoException
public IdRepoException(java.lang.String msg,
                       java.lang.String errorCode)
IdRepoException
public IdRepoException(java.lang.String rbName,
                       java.lang.String errorCode,
                       java.lang.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.
 
getL10NMessage
public java.lang.String getL10NMessage(java.util.Locale locale)
- Returns a localized error message- 
- Specified by: 
- getL10NMessagein interface- com.sun.identity.common.L10NMessage
 
- 
- Parameters:
- locale- Uses the locale object to create the appropriate localized
 error message
- Returns:
- localized error message.
- See Also: 
- IdRepoException(String, String, Object[])
 
getResourceBundleName
public java.lang.String getResourceBundleName()
- Returns ResourceBundleName associated with this error
 message.
- 
- Specified by: 
- getResourceBundleNamein interface- com.sun.identity.common.L10NMessage
 
- 
- Returns:
- ResourceBundlename associated with this error
         message.
- See Also: 
- IdRepoException(String, String, Object[])
 
getErrorCode
public java.lang.String getErrorCode()
- Returns error code associated with this error message.- 
- Specified by: 
- getErrorCodein interface- com.sun.identity.common.L10NMessage
 
- 
- Returns:
- Error code associated with this error message.
- See Also: 
- IdRepoException(String, String, Object[])
 
getMessageArgs
public java.lang.Object[] getMessageArgs()
- Returns arguments for formatting this error message.- 
- Specified by: 
- getMessageArgsin interface- com.sun.identity.common.L10NMessage
 
- 
- Returns:
- arguments for formatting this error message.
 You need to use MessageFormatclass to format the message
 It can be null.
- See Also: 
- IdRepoException(String, String, Object[])
 
toString
public java.lang.String toString()
- 
- Overrides:
- toStringin class- java.lang.Throwable
 
getMessage
public java.lang.String getMessage()
- Returns the error message of this exception.- 
- Specified by: 
- getMessagein interface- com.sun.identity.common.L10NMessage
- Overrides:
- getMessagein class- java.lang.Throwable
 
- 
- Returns:
- String representing the error message
 
Copyright 2005 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.