com.ibm.broker.config.proxy

Class CompletionCodeType

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


  • public class CompletionCodeType
    extends java.lang.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:
      • CompletionCodeType.success states that the operation completed successfully.
      • CompletionCodeType.failure states that the operation failed.
    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
       47371    2007-07-30  HDMPL           v6.1 Release (no changes)
       51619.6  2008-11-26  HDMPL           v7 Release:
                                                Deprecated successSoFar, notRequired
       51619.40 2009-05-26  HDCAB               Added timedOut and cancelled
      
       
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static CompletionCodeType cancelled
      When querying the completion code of an operation, this object states that the operation was submitted to the broker but was cancelled by a separate user action before it was processed.
      static CompletionCodeType failure
      States that an operation failed.
      static CompletionCodeType initiated
      When querying the status of an administration queue entry this completion code means that the request has been created and is about to be queued ready to be processed by the broker.
      static CompletionCodeType notRequired
      Deprecated. 
      This property is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
      static CompletionCodeType pending
      When querying the completion code of a deploy operation, this object states that the deploy is waiting to be processed.
      static CompletionCodeType submitted
      States that the deploy message was sent to the broker but no response was received from the before a timeout occurred.
      static CompletionCodeType success
      States that an operation completed successfully.
      static CompletionCodeType successSoFar
      Deprecated. 
      This property is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
      static CompletionCodeType timedOut
      When querying the completion code of an operation, this object states that a response was received from the broker but the broker was not able to complete the operation in the expected time frame.
      static CompletionCodeType unknown
      New administered objects will return a getLastReturnCode() of unknown when they have never been updated by the broker.
    • Field Detail

      • unknown

        public static final CompletionCodeType unknown
        New administered objects will return a getLastReturnCode() of unknown when they have never been updated by the broker. When querying the status of an administration queue entry this completion code means that the IBM Integration API (CMP) has not received any information from the broker about the request.
      • success

        public static final CompletionCodeType success
        States that an operation completed successfully. When querying the completion code of a deploy operation, this completion code means that the broker successfully processed the deployment message and is running with the new configuration. When querying the status of an administration queue entry this completion code means that the broker successfully processed the request.
      • failure

        public static final CompletionCodeType failure
        States that an operation failed. When querying the completion code of a deploy operation, this completion code means that the broker was not able to successfully process the deployment message. When querying the status of an administration queue entry this completion code means that the broker was not able to successfully process the request.
      • initiated

        public static final CompletionCodeType initiated
        When querying the status of an administration queue entry this completion code means that the request has been created and is about to be queued ready to be processed by the broker.
      • pending

        public static final CompletionCodeType pending
        When querying the completion code of a deploy operation, this object states that the deploy is waiting to be processed. This is because the deployment message held in a batch by the IBM Integration API (CMP) and will not be sent until the application issues BrokerProxy.sendUpdates(). When querying the status of an administration queue entry this completion code means that the request is queued waiting to be processed by the broker.
      • submitted

        public static final CompletionCodeType submitted
        States that the deploy message was sent to the broker but no response was received from the before a timeout occurred. (Note that if the deployment message could not be sent to the broker, a ConfigManagerProxyLoggedException will be thrown by the deploy method instead.) When querying the status of an administration queue entry this completion code means that the request has been sent to the brokers administration agent and is currently being processed.
      • successSoFar

        public static final CompletionCodeType successSoFar
        Deprecated. This property is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
      • notRequired

        public static final CompletionCodeType notRequired
        Deprecated. This property is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
      • timedOut

        public static final CompletionCodeType timedOut
        When querying the completion code of an operation, this object states that a response was received from the broker but the broker was not able to complete the operation in the expected time frame. When querying the status of an entry in the administration queue, this completion code means that the request was sent to the broker but no response was received in the expected time frame.
      • cancelled

        public static final CompletionCodeType cancelled
        When querying the completion code of an operation, this object states that the operation was submitted to the broker but was cancelled by a separate user action before it was processed.
    • Method Detail

      • 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 java.lang.String toString()
        Returns a String representation of the instance.
        Overrides:
        toString in class java.lang.Object
      • 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.