com.ibm.websphere.wim.exception
Class WIMException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.websphere.wim.exception.WIMException
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
NetworkConfigSyncException, SubscriberCriticalException, SubscriberException, WIMApplicationException, WIMSystemException

public class WIMException
extends java.lang.Exception

Base class representing a virtual member manager exception. This can be extended to create component specific exceptions.
This class extends Exception class from JDK 1.4 to take advantage of exception chaining. Exception chaining related methods inherited from Exception classes are getCause() and initCause(Throwable).
This class also contains some additional methods which can be used to set/get the roor error code, root error message, and root error source for the exception. These values represent the error generated by the underlying repository.

See Also:
Serialized Form

Field Summary
static int SUCCESS
          Return code for success.
 
Constructor Summary
WIMException()
          Default Constructor
WIMException(java.util.logging.Level severity, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String message)
          Creates the WIMException.
WIMException(java.lang.String message, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String message, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.Object[] params)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.Object[] params, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.Object[] params, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.Object[] params, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.Object[] params, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.Object[] params, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.Object[] params)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.Object[] params, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.Object[] params, java.util.logging.Level severity, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.Object[] params, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.Object[] params, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.Object[] params, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String message, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.String className, java.lang.String methodName)
          Creates the WIMException.
WIMException(java.lang.String inputMessageKey, java.lang.String inputMessageBundle, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String message, java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String className, java.lang.String methodName, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.String message, java.lang.Throwable cause)
          Creates the WIMException.
WIMException(java.lang.Throwable cause)
          Creates the WIMException.
 
Method Summary
 java.lang.String getLocalizedMessage()
          Creates a localized description of this Throwable.
 java.lang.String getLocalizedMessage(java.util.Locale l)
          Returns the error message string of this throwable object in the specified locale.
 java.lang.String getMessage()
          Returns the error message string of this throwable object.
 java.lang.String getMessage(java.util.Locale l)
          Returns the error message string of this throwable object in the specified locale.
 java.lang.String getMessageBundle()
          Return the Message Bundle.
 java.lang.String getMessageKey()
          Return the message key.
 java.lang.Object[] getMessageParams()
          Return the message parameters.
 java.lang.String getRootError()
          Return the root error code, root error message and root error source in a string format:
rootErrorCode=n, rootErrorMessage=xxx, rootErrorSource=yyy.
 int getRootErrorCode()
          Return the root error code generated by the underlying repository.
 java.lang.String getRootErrorMessage()
          Return the root error message generated by underlying repository.
 java.lang.Object getRootErrorSource()
          Return the source of the error (probably repository identity which generated the root error code/message).
 boolean isRootErrorSet()
          Return true if the root error code or root error message is set.
 void setRootError(int inputRootErrorCode, java.lang.String inputRootErrorMessage, java.lang.Object inputRootErrorSource)
          Convenience method to set root error code, root error message and/or root source.
 void setRootError(java.util.logging.Level severity, int inputRootErrorCode, java.lang.String inputRootErrorMessage, java.lang.Object inputRootErrorSource)
          Convenience method to set root error code, root error message and/or root source.
 void setRootErrorCode(int inputRootErrorCode)
          Set the root error code generated by underlying repository.
 void setRootErrorCode(java.util.logging.Level severity, int inputRootErrorCode)
          Set the root error code generated by underlying repository.
 void setRootErrorMessage(java.util.logging.Level severity, java.lang.String inputRootErrorMessage)
          Set the root error message generated by underlying repository.
 void setRootErrorMessage(java.lang.String inputRootErrorMessage)
          Set the root error message generated by underlying repository.
 void setRootErrorSource(java.util.logging.Level severity, java.lang.Object inputRootErrorSource)
          Set the source of the error (probably repository identity which generated the root error code/message).
 void setRootErrorSource(java.lang.Object inputRootErrorSource)
          Set the source of the error (probably repository identity which generated the root error code/message).
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SUCCESS

public static final int SUCCESS
Return code for success.

See Also:
Constant Field Values
Constructor Detail

WIMException

public WIMException()
Default Constructor


WIMException

public WIMException(java.lang.String message)
Creates the WIMException.

Parameters:
message - The message or message key of the exception.

WIMException

public WIMException(java.lang.String message,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
message - The message or message key of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String message,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
message - The message or message key of the exception.
severity - The exception severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the messageKey.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the messageKey.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the messageKey.
severity - The exception severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.Object[] params)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
params - The parameters used for the message key of the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.Object[] params,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
params - The parameters used for the message key of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.Object[] params,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
params - The parameters used for the message key of the exception.
severity - The exception severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.Object[] params)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the message key.
params - The parameters used for the message key of the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.Object[] params,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the message key.
params - The parameters used for the message key of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.Object[] params,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the message key.
params - The parameters used for the message key of the exception.
severity - The exception severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.Throwable cause)
Creates the WIMException.

Parameters:
cause - The cause of the exception.

WIMException

public WIMException(java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
cause - The cause of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
cause - The cause of the exception.
severity - The exception severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String message,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
message - The error message.
cause - The cause of the exception.

WIMException

public WIMException(java.lang.String message,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
message - The error message.
cause - The cause of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String message,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
message - The error message.
cause - The cause of the exception.
severity - The exceptionm severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the messageKey.
cause - The cause of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the messageKey.
cause - The cause of the exception.
severity - The exceptionm severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.Object[] params,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
params - The parameters used for the message key of the exception.
cause - The cause of the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.Object[] params,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
params - The parameters used for the message key of the exception.
cause - The cause of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.Object[] params,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
params - The parameters used for the message key of the exception.
cause - The cause of the exception.
severity - The exceptionm severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.Object[] params,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the message key.
params - The parameters used for the message key of the exception.
cause - The cause of the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.Object[] params,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the message key.
params - The parameters used for the message key of the exception.
cause - The cause of the exception.
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.

WIMException

public WIMException(java.lang.String inputMessageKey,
                    java.lang.String inputMessageBundle,
                    java.lang.Object[] params,
                    java.util.logging.Level severity,
                    java.lang.String className,
                    java.lang.String methodName,
                    java.lang.Throwable cause)
Creates the WIMException.

Parameters:
inputMessageKey - The message key of the exception.
inputMessageBundle - The message bundle for the message key.
params - The parameters used for the message key of the exception.
cause - The cause of the exception.
severity - The exceptionm severity(java.util.logging.Level)
className - The name of the class throwing the exception.
methodName - The name of the method throwing the exception.
Method Detail

getMessageKey

public java.lang.String getMessageKey()
Return the message key.


getMessageBundle

public java.lang.String getMessageBundle()
Return the Message Bundle.


getMessageParams

public java.lang.Object[] getMessageParams()
Return the message parameters.


isRootErrorSet

public boolean isRootErrorSet()
Return true if the root error code or root error message is set.

See Also:
setRootError(int, String, Object), setRootErrorCode(int), setRootErrorMessage(String)

setRootErrorCode

public void setRootErrorCode(int inputRootErrorCode)
Set the root error code generated by underlying repository. This method will mostly be used by the adapters to set the error code returned by the underlying repository.

Parameters:
inputRootErrorCode - The root error code.
See Also:
setRootError(Level, int, String, Object)

setRootErrorCode

public void setRootErrorCode(java.util.logging.Level severity,
                             int inputRootErrorCode)
Set the root error code generated by underlying repository. This method will mostly be used by the adapters to set the error code returned by the underlying repository.

Parameters:
severity - The severity level for tracing(java.util.logging.Level)
inputRootErrorCode - The root error code.
See Also:
setRootError(int, String, Object)

getRootErrorCode

public int getRootErrorCode()
Return the root error code generated by the underlying repository.

See Also:
setRootError(int, String, Object)

setRootErrorMessage

public void setRootErrorMessage(java.lang.String inputRootErrorMessage)
Set the root error message generated by underlying repository. This method will mostly be used by the adapters to set the error message returned by the underlying repository.

Parameters:
inputRootErrorMessage - The root error message.
See Also:
setRootErrorMessage(Level, String)

setRootErrorMessage

public void setRootErrorMessage(java.util.logging.Level severity,
                                java.lang.String inputRootErrorMessage)
Set the root error message generated by underlying repository. This method will mostly be used by the adapters to set the error message returned by the underlying repository.

Parameters:
severity - The severity level for tracing(java.util.logging.Level)
inputRootErrorMessage - The root error message.
See Also:
setRootErrorMessage(String)

getRootErrorMessage

public java.lang.String getRootErrorMessage()
Return the root error message generated by underlying repository.

See Also:
setRootErrorMessage(String)

setRootErrorSource

public void setRootErrorSource(java.lang.Object inputRootErrorSource)
Set the source of the error (probably repository identity which generated the root error code/message). This method will mostly be used by the adapters.

Parameters:
inputRootErrorSource - The root source of the error.
See Also:
setRootErrorSource(Level, Object)

setRootErrorSource

public void setRootErrorSource(java.util.logging.Level severity,
                               java.lang.Object inputRootErrorSource)
Set the source of the error (probably repository identity which generated the root error code/message). This method will mostly be used by the adapters.

Parameters:
severity - The severity level for tracing(java.util.logging.Level)
inputRootErrorSource - The root source of the error.
See Also:
setRootErrorSource(Object)

getRootErrorSource

public java.lang.Object getRootErrorSource()
Return the source of the error (probably repository identity which generated the root error code/message).

See Also:
setRootErrorSource(Object)

setRootError

public void setRootError(int inputRootErrorCode,
                         java.lang.String inputRootErrorMessage,
                         java.lang.Object inputRootErrorSource)
Convenience method to set root error code, root error message and/or root source. This method will mostly be used by the adapters to set the errors generated by underlying repository.

Parameters:
inputRootErrorCode - The root error code.
inputRootErrorMessage - The root error message.
inputRootErrorSource - The root source of the error.
See Also:
setRootError(Level, int, String, Object)

setRootError

public void setRootError(java.util.logging.Level severity,
                         int inputRootErrorCode,
                         java.lang.String inputRootErrorMessage,
                         java.lang.Object inputRootErrorSource)
Convenience method to set root error code, root error message and/or root source. This method will mostly be used by the adapters to set the errors generated by underlying repository.

Parameters:
severity - The severity level for tracing(java.util.logging.Level)
inputRootErrorCode - The root error code.
inputRootErrorMessage - The root error message.
inputRootErrorSource - The root source of the error.
See Also:
setRootError(Level, int, String, Object)

getRootError

public java.lang.String getRootError()
Return the root error code, root error message and root error source in a string format:
rootErrorCode=n, rootErrorMessage=xxx, rootErrorSource=yyy.


getLocalizedMessage

public java.lang.String getLocalizedMessage()
Creates a localized description of this Throwable. Subclasses may override this method in order to produce a locale-specific message. For subclasses that do not override this method, the default implementation returns the same result as getMessage().

Overrides:
getLocalizedMessage in class java.lang.Throwable
Return:
java.lang.String

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale l)
Returns the error message string of this throwable object in the specified locale.

Parameters:
l - locale
Return:
java.lang.String

getMessage

public java.lang.String getMessage()
Returns the error message string of this throwable object.

Overrides:
getMessage in class java.lang.Throwable
Return:
the error message string of this Throwable object if it was created with an error message string; or null if it was created with no error message.

getMessage

public java.lang.String getMessage(java.util.Locale l)
Returns the error message string of this throwable object in the specified locale.

Parameters:
l - locale
Return:
the error message string of this Throwable object if it was created with an error message string; or null if it was created with no error message.