com.ibm.broker.config.proxy

Class DeployResult

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


  • public class DeployResult
    extends java.lang.Object

    Each DeployResult instance is used to describe the outcome of a BAR file deployment through the ExecutionGroupProxy.deploy() methods. Once each instance is supplied to the calling application, it is no longer updated by the IBM Integration API (CMP).

    class com.ibm.broker.config.proxy.DeployResult

    Responsibilities Each instance represents a possible outcome of a deployment operation.
    Internal Collaborators None
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     25103.2  2004-04-23  HDMPL           v6 Release
     44739.7  2007-07-30  HDMPL           v6.1 Release:
                                              Methods now return genericized types where relevant
     51619.6  2008-12-02  HDMPL           v7 Release:
                                              Deprecated methods related to Configuration Manager deployment
                                              Added getDeployResponses()
                                              Added getDeployStartTime()
                                              Added getDeployStopTime()
    
     
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      CompletionCodeType getCompletionCode()
      Returns the overall outcome for the current deployment.
      CompletionCodeType getCompletionCodeForBroker(BrokerProxy b)
      Deprecated. 
      As the application is directly connected to the broker that is affected by the deployment, this method is no longer required. Use getCompletionCode() instead.
      java.util.Enumeration<BrokerProxy> getDeployedBrokers()
      Deprecated. 
      Since WebSphere Message Broker v7, each the IBM Integration API (CMP) application is directly connected to the broker, and so this method is not relevant.
      java.util.Enumeration<LogEntry> getDeployResponses()
      Returns all deployment messages associated with the deployment request.
      java.util.Date getDeployStartTime()
      Returns the start time associated with the current deployment.
      java.util.Date getDeployStopTime()
      Returns the stop time associated with the current deployment.
      java.util.Enumeration<LogEntry> getLogEntries()
      Deprecated. 
      The recommended way of displaying all deployment responses as of WMB v7 is by using getDeployResponses().
      java.util.Enumeration<LogEntry> getLogEntriesForBroker(BrokerProxy b)
      Deprecated. 
      The recommended way of displaying all deployment responses as of WebSphere Message Broker v7 is by using getDeploymentResponses().
      int getNumberOfDeployedBrokers()
      Deprecated. 
      This method is no longer required, because the number of brokers affected by a single deployment is always 1.
      static void setDeployResultReturnTimeDelayMs(long timeDelayMs)
      Deprecated. 
      This method is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
      java.lang.String toString()
      Returns a String representation of the overall outcome of the deploy.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Method Detail

      • toString

        public final java.lang.String toString()
        Returns a String representation of the overall outcome of the deploy.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String overall outcome
      • getDeployedBrokers

        public java.util.Enumeration<BrokerProxy> getDeployedBrokers()
        Deprecated. Since WebSphere Message Broker v7, each the IBM Integration API (CMP) application is directly connected to the broker, and so this method is not relevant.
        Returns an enumeration of BrokerProxy objects to which the deployment refers.
        Returns:
        Enumeration containing exactly one BrokerProxy object.
      • getNumberOfDeployedBrokers

        public int getNumberOfDeployedBrokers()
        Deprecated. This method is no longer required, because the number of brokers affected by a single deployment is always 1.
        Returns the number of BrokerProxy objects to which the deploy refers. Since WebSphere Message Broker v7, this method always returns 1.
        Returns:
        int
      • getCompletionCodeForBroker

        public CompletionCodeType getCompletionCodeForBroker(BrokerProxy b)
        Deprecated. As the application is directly connected to the broker that is affected by the deployment, this method is no longer required. Use getCompletionCode() instead.
        Returns the completion code for the current deployment operation.
        Parameters:
        b - Ignored.
        Returns:
        CompletionCodeType describing the outcome of the deploy.
      • getLogEntriesForBroker

        public java.util.Enumeration<LogEntry> getLogEntriesForBroker(BrokerProxy b)
        Deprecated. The recommended way of displaying all deployment responses as of WebSphere Message Broker v7 is by using getDeploymentResponses().
        Returns an Enumeration of available LogEntry objects that describe the deployment responses from the broker.
        Parameters:
        b - Ignored
        Returns:
        Enumeration containing zero or more LogEntry objects.
      • getLogEntries

        public java.util.Enumeration<LogEntry> getLogEntries()
        Deprecated. The recommended way of displaying all deployment responses as of WMB v7 is by using getDeployResponses().
        Returns the LogEntry objects supplied by the broker that describe the overall outcome of the deployment request.
        Returns:
        Enumeration containing zero or more LogEntry objects.
      • getDeployResponses

        public java.util.Enumeration<LogEntry> getDeployResponses()
        Returns all deployment messages associated with the deployment request.
        Returns:
        Enumeration containing zero or more LogEntry objects.
      • getCompletionCode

        public CompletionCodeType getCompletionCode()
        Returns the overall outcome for the current deployment. The returned result will be one of the following objects:
        • CompletionCodeType.success states that the broker successfully processed the deployment request.
        • CompletionCodeType.failure states that the deployment failed. Use getDeployResponses() for more information on why the deployment failed.
        • CompletionCodeType.cancelled states that the deployment was cancelled by a separate user action before it was processed by the broker.
        • CompletionCodeType.pending states that the deployment message is held in a batch by the IBM Integration API (CMP) and will not be sent until the application issues BrokerProxy.sendUpdates().
        • CompletionCodeType.submitted states that the deploy message was successfully sent to the broker but no response was received before the timeout occurred.
        If the deployment failed because the deployment message could not be sent to the broker, a ConfigManagerProxyLoggedException will be thrown at deployment time.
        Returns:
        CompletionCodeType the overall outcome of the deployment request.
      • setDeployResultReturnTimeDelayMs

        public static void setDeployResultReturnTimeDelayMs(long timeDelayMs)
        Deprecated. This method is specific to Configuration Manager connections, which are not supported as of WebSphere Message Broker V7.
        This method does nothing.
      • getDeployStartTime

        public java.util.Date getDeployStartTime()
        Returns the start time associated with the current deployment.
      • getDeployStopTime

        public java.util.Date getDeployStopTime()
        Returns the stop time associated with the current deployment. If the outcome of the deployment was not known at the time the DeployResult object was returned to the caller, this method will return null.