com.ibm.datapower.wamt.clientAPI
Class ShutdownException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.ibm.datapower.wamt.DMgrException
              extended by com.ibm.datapower.wamt.clientAPI.ClientAPIException
                  extended by com.ibm.datapower.wamt.clientAPI.ShutdownException
All Implemented Interfaces:
java.io.Serializable

public class ShutdownException
extends ClientAPIException

An operation was prematurely terminated because the Manager is being shut down. In the case of a BackgroundTask or Notification, those Tasks will be discarded and not executed. The reason why we need to mark Tasks as "terminated because of shutdown" is because there typically are ProgressContainers associated with these Tasks, and it is possible that another thread may be blocking waiting for those ProgressContainers to complete. Without marking the ProgressContainers complete via this exception, it is possible that the other threads may wait forever on a ProgressContainer that will never be completed. So it is likely the only place you will see this exception used is inside a ProgressContainer.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
 
Constructor Summary
ShutdownException()
          Create an exception with no message and no cause.
ShutdownException(java.lang.String message)
          Create an exception with a message but with no chained cause.
ShutdownException(java.lang.String message, java.lang.String msgKey)
          Create an exception with a message and NLS attributes, but with no chained cause.
ShutdownException(java.lang.String message, java.lang.String msgKey, java.lang.Object msgParm)
          Create an exception with a message and NLS attributes, but with no chained cause.
ShutdownException(java.lang.String message, java.lang.String msgKey, java.lang.Object[] msgParms)
          Create an exception with a message and NLS attributes, but with no chained cause.
ShutdownException(java.lang.String message, java.lang.Throwable cause)
          Create an exception with a message and a chained cause.
ShutdownException(java.lang.String message, java.lang.Throwable cause, java.lang.String msgKey)
          Create an exception with a message, NLS attributes and a chained cause.
ShutdownException(java.lang.String message, java.lang.Throwable cause, java.lang.String msgKey, java.lang.Object msgParm)
          Create an exception with a message, NLS attributes and a chained cause.
ShutdownException(java.lang.String message, java.lang.Throwable cause, java.lang.String msgKey, java.lang.Object[] msgParms)
          Create an exception with a message, NLS attributes and a chained cause.
ShutdownException(java.lang.Throwable cause)
          Create an exception with a chained cause and no message.
 
Method Summary
 
Methods inherited from class com.ibm.datapower.wamt.DMgrException
getMessage, getMessageExplanation, getMessageExplanation, getMessageUseraction, getMessageUseraction
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT_2009_2010

public static final java.lang.String COPYRIGHT_2009_2010
See Also:
Constant Field Values
Constructor Detail

ShutdownException

public ShutdownException()
Create an exception with no message and no cause. Please use one of the other constructors to provide as much information about the exception as possible. You really shouldn't be using this zero-argument constructor.


ShutdownException

public ShutdownException(java.lang.String message)
Create an exception with a message but with no chained cause.

Parameters:
message - a string that provides some explanation/description of the exception

ShutdownException

public ShutdownException(java.lang.String message,
                         java.lang.String msgKey,
                         java.lang.Object[] msgParms)
Create an exception with a message and NLS attributes, but with no chained cause.

Parameters:
message - a string that provides some explanation/description of the exception. This message should have already been localized for the jvm's locale, if possible.
msgKey - a string giving the key of the NLS enabled message to be used with the exception.
msgParms - an Object[] that gives the attributes to be used with msgKey

ShutdownException

public ShutdownException(java.lang.String message,
                         java.lang.String msgKey,
                         java.lang.Object msgParm)
Create an exception with a message and NLS attributes, but with no chained cause.

Parameters:
message - a string that provides some explanation/description of the exception. This message should have already been localized for the jvm's locale, if possible.
msgKey - a string giving the key of the NLS enabled message to be used with the exception.
msgParm - an Object that gives the attributes to be used with msgKey

ShutdownException

public ShutdownException(java.lang.String message,
                         java.lang.String msgKey)
Create an exception with a message and NLS attributes, but with no chained cause.

Parameters:
message - a string that provides some explanation/description of the exception. This message should have already been localized for the jvm's locale, if possible.
msgKey - a string giving the key of the NLS enabled message to be used with the exception.

ShutdownException

public ShutdownException(java.lang.String message,
                         java.lang.Throwable cause)
Create an exception with a message and a chained cause.

Parameters:
message - string that provides some explanation/description of the exception
cause - a reference to another exception that occurred at a lower level which is the cause for this higher-level exception.

ShutdownException

public ShutdownException(java.lang.String message,
                         java.lang.Throwable cause,
                         java.lang.String msgKey,
                         java.lang.Object[] msgParms)
Create an exception with a message, NLS attributes and a chained cause.

Parameters:
message - string that provides some explanation/description of the exception. This message should have already been localized for the jvm's locale, if possible.
cause - a reference to another exception that occurred at a lower level which is the cause for this higher-level exception.
msgKey - a string giving the key of the NLS enabled message to be used with the exception.
msgParms - an Object[] that gives the attributes to be used with msgKey

ShutdownException

public ShutdownException(java.lang.String message,
                         java.lang.Throwable cause,
                         java.lang.String msgKey,
                         java.lang.Object msgParm)
Create an exception with a message, NLS attributes and a chained cause.

Parameters:
message - string that provides some explanation/description of the exception. This message should have already been localized for the jvm's locale, if possible.
cause - a reference to another exception that occurred at a lower level which is the cause for this higher-level exception.
msgKey - a string giving the key of the NLS enabled message to be used with the exception.
msgParm - an Object that gives the attribute to be used with msgKey

ShutdownException

public ShutdownException(java.lang.String message,
                         java.lang.Throwable cause,
                         java.lang.String msgKey)
Create an exception with a message, NLS attributes and a chained cause.

Parameters:
message - string that provides some explanation/description of the exception. This message should have already been localized for the jvm's locale, if possible.
cause - a reference to another exception that occurred at a lower level which is the cause for this higher-level exception.
msgKey - a string giving the key of the NLS enabled message to be used with the exception.

ShutdownException

public ShutdownException(java.lang.Throwable cause)
Create an exception with a chained cause and no message.

Parameters:
cause - a reference to another exception that occurred at a lower level which is the cause for this higher-level exception.


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.