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()
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright
IBM Copyright
|
protected static java.lang.String |
sccsid
Version information
|
Modifier | Constructor and Description |
---|---|
protected |
DeployResult(ExecutionGroupProxy egRequestingDeploy)
Creates a new DeployResult instance that refers to a deployment request
to the supplied execution group.
|
Modifier and Type | Method and Description |
---|---|
protected void |
addResponse(CompletionCodeType ccType,
java.util.List<LogEntry> l)
Adds the log entry to the set of responses for the DeployResult.
|
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.
|
protected static long |
getDeployResultReturnTimeDelayMs()
Deprecated.
This method is specific to Configuration Manager connections,
which are not supported as of WebSphere Message Broker V7.
|
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.
|
protected ExecutionGroupProxy |
getExecutionGroupThatRequestedDeploy()
Returns the ExecutionGroupProxy that started the deployment operation.
|
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.
|
protected boolean |
isCompleted()
Returns true if and only the deployment request has
succeeded, failed, or is being held in a batch.
|
protected void |
setCompletionCode(CompletionCodeType ccType)
Sets the completion code for the DeployResult.
|
static void |
setDeployResultReturnTimeDelayMs(long timeDelayMs)
Deprecated.
This method is specific to Configuration Manager connections,
which are not supported as of WebSphere Message Broker V7.
|
protected void |
setDeployStartTime()
Updates the start time associated with the current deployment
with the current time.
|
protected void |
setDeployStopTime()
Updates the stop time associated with the current deployment
with the current time.
|
java.lang.String |
toString()
Returns a String representation of the overall outcome of the deploy.
|
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected DeployResult(ExecutionGroupProxy egRequestingDeploy)
egRequestingDeploy
- The ExecutionGroupProxy that is requesting
the deploy.protected void addResponse(CompletionCodeType ccType, java.util.List<LogEntry> l)
ccType
- The outcome of the deploymentl
- List of LogEntry objects that give more information on what happened.public final java.lang.String toString()
toString
in class java.lang.Object
public java.util.Enumeration<BrokerProxy> getDeployedBrokers()
public int getNumberOfDeployedBrokers()
public CompletionCodeType getCompletionCodeForBroker(BrokerProxy b)
b
- Ignored.public java.util.Enumeration<LogEntry> getLogEntriesForBroker(BrokerProxy b)
b
- Ignoredpublic java.util.Enumeration<LogEntry> getLogEntries()
public java.util.Enumeration<LogEntry> getDeployResponses()
protected void setCompletionCode(CompletionCodeType ccType)
ccType
- public CompletionCodeType getCompletionCode()
protected ExecutionGroupProxy getExecutionGroupThatRequestedDeploy()
protected boolean isCompleted()
public static void setDeployResultReturnTimeDelayMs(long timeDelayMs)
protected static long getDeployResultReturnTimeDelayMs()
protected void setDeployStartTime()
protected void setDeployStopTime()
public java.util.Date getDeployStartTime()
public java.util.Date getDeployStopTime()