com.ibm.broker.config.proxy
Class DeployResult
java.lang.Object
com.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
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:
- CompletionCodeType.pending - states that the deploy
is held in a batch and will not be sent until the user issues
ConfigManagerProxy.sendUpdates().
- CompletionCodeType.submitted - states that the deploy message
was sent but no response has yet been received from the Config Manager
saying that deployment has been initiated.
- CompletionCodeType.initiated - states that the Config Manager
has replied stating that deployment has started, but no reply has
been returned from the broker yet.
- CompletionCodeType.success - states that the Config Manager
issued the deployment request, and the broker successfully applied the
deployment changes.
- CompletionCodeType.failure - states that the Config Manager
issued the deployment request, and the broker responded by saying that the
deployment was not successful. (Use getLogEntriesForBroker() for more
information on why the deployment failed.)
- CompletionCodeType.notRequired - states that a deployment
request was submitted to the Configuration Manager that involved the
supplied broker, but the broker was not sent the request because its
configuration is already up to date.
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:
- CompletionCodeType.pending - states that the deploy
is held in a batch and will not be sent until the user issues
ConfigManagerProxy.sendUpdates(). (If it applies, this message
is returned immediately – that is, without waiting for the timeout
period to expire.)
- CompletionCodeType.submitted - states that the deploy message
was sent to the Config Manager but no response was received 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.)
- CompletionCodeType.initiated - states that the Config Manager
has replied stating that deployment has started, but no broker responses
were received before the timeout occurred.
- CompletionCodeType.successSoFar - states that the Config
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.
- CompletionCodeType.success - states that the Config Manager
issued the deployment request, and all relevant brokers responded
successfully before the timeout period expired. (This message will be
sent as soon as all relevant brokers have responded successfully).
- CompletionCodeType.failure - states that the Config Manager
issued the deployment request, and at least one broker responded negatively.
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.