WBI BrokersTM
Config Manager Proxy API

com.ibm.broker.config.proxy
Class DeployResult

java.lang.Object
  extended bycom.ibm.broker.config.proxy.DeployResult

public class DeployResult
extends Object

The DeployResult type is used to describe the outcome of deployment operations. Each instance represents the state of a deployment at the time it is returned from one of the deploy() methods. In other words, once an instance is supplied to the application, it is no longer updated by the Config Manager Proxy.

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

 


Method Summary
 CompletionCodeType getCompletionCode()
          Returns the overall outcome for the current deployment.
 CompletionCodeType getCompletionCodeForBroker(BrokerProxy b)
          Returns the completion code for the supplied broker.
 Enumeration getDeployedBrokers()
          Returns an enumeration of BrokerProxy objects to which the deploy was sent.
 Enumeration getLogEntries()
          Returns any LogEntry objects, supplied by the Configuration Manager, that describe the overall outcome of the deployment request.
 Enumeration getLogEntriesForBroker(BrokerProxy b)
          Returns an enumeration of available LogEntry objects that describe the deployment outcome for the current broker.
 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 String toString()
Returns a String representation of the overall outcome of the deploy.

Returns:
String overall outcome

getDeployedBrokers

public Enumeration getDeployedBrokers()
Returns an enumeration of BrokerProxy objects to which the deploy was sent.

Further information can be determined by using the getCompletionCodeForBroker() and getLogEntryForBroker() methods, and by parsing the LogProxy object directly.

Returns:
Enumeration containing zero or more BrokerProxy objects.

getCompletionCodeForBroker

public CompletionCodeType getCompletionCodeForBroker(BrokerProxy b)
Returns the completion code for the supplied broker. The result will be one of the following objects: If the deploy to which this result refers did not involve the supplied broker (or if the supplied argument was null), null will be returned.

Returns:
CompletionCodeType describing the outcome of the deploy for the supplied broker.

getLogEntriesForBroker

public Enumeration getLogEntriesForBroker(BrokerProxy b)
Returns an enumeration of available LogEntry objects that describe the deployment outcome for the current broker.

If the deploy to which this result refers did not involve the supplied broker (or if the supplied argument was null), null will be returned.

Returns:
Enumeration containing zero or more LogEntry objects.

getLogEntries

public Enumeration getLogEntries()
Returns any LogEntry objects, supplied by the Configuration Manager, that describe the overall outcome of the deployment request.

Returns:
Enumeration containing zero or more LogEntry objects.

getCompletionCode

public CompletionCodeType getCompletionCode()
Returns the overall outcome for the current deployment. The result will be one of the following objects: Further information can be determined by using the getCompletionCodeForBroker() and getLogEntryForBroker() methods, and by parsing the LogProxy object directly.

Returns:
CompletionCodeType the overall outcome of the deployment request.

WBI BrokersTM
Config Manager Proxy API