Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.CompletionCodeType

java.lang.Object
        com.ibm.broker.config.proxy.CompletionCodeType

public class CompletionCodeType
extends Object

The CompletionCodeType type is used to describe the outcome of the operation that has been performed. The type is used in two places in the Configuration Manager Proxy:

  1. As a parameter to AdministeredObjectListener.processActionResponse(). User classes that implement the AdministeredObjectListener interface (and that have registered themselves with the Configuration Manager Proxy) are notified when responses to previously submitted actions are received. Each such notification includes one of the following CompletionCodeType objects:
  2. CompletionCodeType instances are also used in DeployResult objects. They can be used to discover the overall outcome of deployment requests, and also the outcome for individual brokers.

    class com.ibm.broker.config.proxy.CompletionCodeType

    Responsibilities Each instance represents a completion code for operations.
    Internal Collaborators None

    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     25103.12 2004-04-07  HDMPL           v6 Release
    
     

    Field Index
    Field Description
    failure States that an operation failed.
    initiated When querying the completion code of a deploy operation, this object states that the Configuration Manager has replied stating that deployment has started, but no broker responses were received before the timeout occurred.
    notRequired States that a deployment request was submitted to the Configuration Manager, but the broker to which this CompletionCode refers was not sent the request because its configuration is already up to date.
    pending When querying the completion code of a deploy operation, this object states that the deploy is held in a batch and will not be sent until the user issues ConfigManagerProxy.sendUpdates().
    submitted States that the deploy message was sent to the Configuration Manager but no 'deploy initiated' response was received from the Config Manager before the timeout occurred.
    success States that an operation completed successfully.
    successSoFar States that the Configuration Manager issued the deployment request and some, but not all, brokers responded with a “success” message before the timeout period expired.
    unknown New administered objects will return a getLastReturnCode() of unknown when they have never been updated by the Configuration Manager.
    Method Index
    Method Description
    CompletionCodeType getCompletionCodeType(int) Returns the CompletionCodeType object that has the supplied int value.
    int intValue() Returns the unique int associated with this instance.
    String toString() Returns a String representation of the instance.

    Fields

    failure

    public static final com.ibm.broker.config.proxy.CompletionCodeType failure

    States that an operation failed. When querying the completion code of a deploy operation, this completion code means that at least one broker has responded negatively.

    initiated

    public static final com.ibm.broker.config.proxy.CompletionCodeType initiated

    When querying the completion code of a deploy operation, this object states that the Configuration Manager has replied stating that deployment has started, but no broker responses were received before the timeout occurred.

    notRequired

    public static final com.ibm.broker.config.proxy.CompletionCodeType notRequired

    States that a deployment request was submitted to the Configuration Manager, but the broker to which this CompletionCode refers was not sent the request because its configuration is already up to date.

    pending

    public static final com.ibm.broker.config.proxy.CompletionCodeType pending

    When querying the completion code of a deploy operation, this object states that the deploy is held in a batch and will not be sent until the user issues ConfigManagerProxy.sendUpdates().

    submitted

    public static final com.ibm.broker.config.proxy.CompletionCodeType submitted

    States that the deploy message was sent to the Configuration Manager but no 'deploy initiated' response was received from the Config Manager before the timeout occurred. (Note that if the deployment message could not be sent to the Config Manager, a ConfigManagerProxyLoggedException will be thrown at deploy time instead.)

    success

    public static final com.ibm.broker.config.proxy.CompletionCodeType success

    States that an operation completed successfully. When querying the completion code of a deploy operation, this completion code means that all brokers have responded positively.

    successSoFar

    public static final com.ibm.broker.config.proxy.CompletionCodeType successSoFar

    States that the Configuration Manager issued the deployment request and some, but not all, brokers responded with a “success” message before the timeout period expired. No brokers responded negatively.

    unknown

    public static final com.ibm.broker.config.proxy.CompletionCodeType unknown

    New administered objects will return a getLastReturnCode() of unknown when they have never been updated by the Configuration Manager.

    In addition, when querying a deploy result of a specific broker, 'unknown' is used to describe the situation when the deploy result is not being monitored for this broker (for example, if the Configuration Manager Proxy was already monitoring the broker for another deploy result).

    Methods

    getCompletionCodeType

    public static final CompletionCodeType getCompletionCodeType(int intValue) 

    Returns the CompletionCodeType object that has the supplied int value.

    • Parameters
      • intValue - - The value to look up
    • Returns
      • CompletionCodeType that has an int value equal to the supplied int, or null if no such CompletionCodeType exists.

    intValue

    public final int intValue() 

    Returns the unique int associated with this instance. Useful in developing switch statements based on completion codes.

    • Returns
      • int - The unique value associated with this instance.

    toString

    public final String toString() 

    Returns a String representation of the instance.