com.ibm.datapower.wamt.clientAPI
Class FullException

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.FullException
All Implemented Interfaces:
java.io.Serializable

public class FullException
extends ClientAPIException

The container you are trying to add an item to is already at its maximum capacity. Your "add" request was unsuccessful.

This is generally used with queues for background tasks. In more technical terms, the queue is already full and the requested background task can not be added to it. The length of the queue is set at the time that the Manager is instantiated via Manager.getInstance(Map). Use the option Manager.OPTION_TASK_QUEUE_SIZE. The default value of the task queue size is "unlimited", so in practice this exception should not occur unless the default has been overridden.

The idea behind limiting the task queue size is to prevent users from submitting tasks to a queue that already has work outstanding, meaning that the user made a decision to do something to an environment which may be changed before their request is serviced. The queue operates in a FIFO manner. If the user had waited until all the outstanding work was completed, they may have wanted to make a different choice. However noble this idea, in the end we felt it was too limiting, and the manager has the principle of getting to the desired end state even though it may take a non-optimal route to get there. This is why the default value of the task queue size is "unlimited". However, we wanted to give other users the ability to take a more conservative approach if they wished to do so.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
 
Constructor Summary
FullException()
          Create an exception with no message and no cause.
FullException(java.lang.String message)
          Create an exception with a message but with no chained cause.
FullException(java.lang.String message, java.lang.String msgKey)
          Create an exception with a message and NLS attributes, but with no chained cause.
FullException(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.
FullException(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.
FullException(java.lang.String message, java.lang.Throwable cause)
          Create an exception with a message and a chained cause.
FullException(java.lang.String message, java.lang.Throwable cause, java.lang.String msgKey)
          Create an exception with a message, NLS attributes and a chained cause.
FullException(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.
FullException(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.
FullException(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

FullException

public FullException()
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.


FullException

public FullException(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

FullException

public FullException(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 Ojbect[] that gives the attributes to be used with msgKey

FullException

public FullException(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 Ojbect that gives the attributes to be used with msgKey

FullException

public FullException(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.

FullException

public FullException(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.

FullException

public FullException(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 Ojbect[] that gives the attributes to be used with msgKey

FullException

public FullException(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 Ojbect that gives the attribute to be used with msgKey

FullException

public FullException(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.

FullException

public FullException(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.