com.ibm.broker.config.proxy
Interface DeployedObject

All Superinterfaces:
DeployableObject
All Known Implementing Classes:
MessageFlowDependency, MessageFlowProxy

public interface DeployedObject
extends DeployableObject

Each instance of a class that implements this interface represents a file that has been successfully deployed to a single execution group.

DeployedObject is a specialization of the DeployableObject interface in that DeployedObject refers to a specific instance of a DeployableObject that exists on an execution group. Because of this, the DeployedObject interface extends its DeployableObject parent by adding methods to interrogate the deploy time, the execution group and the BAR file information that is specific to the deployment.

There are currently two classes that directly implement this interface, both of which live in the com.ibm.broker.config.proxy package:

User-written classes do not need to implement this interface.

Classes that implement this interface are able to describe lists of keywords and their values that may be associated with the deployed object. For a detailed discussion of the eyecatchers used when describing keywords, see the documentation for the DeployableObject interface.

interface com.ibm.broker.config.proxy.DeployedObject extends com.ibm.broker.config.proxy.DeployableObject

Responsibilities States that implementing classes represent objects that have been deployed to execution groups.
Internal Collaborators None

 Change Activity:
 --------  ----------- -------------   ------------------------------------
 Reason:   Date:       Originator:     Comments:
 --------  ----------- -------------   ------------------------------------
 f35474    2004-07-15  HDMPL           v6 Release
 f45166    2007-06-11  HDMPL           v6.1 Release:
                                           Now extends DeployableObject

 

Version:
Config/com/ibm/broker/config/proxy/DeployedObject.java, CMP, S000 1.12

Field Summary
 
Fields inherited from interface com.ibm.broker.config.proxy.DeployableObject
BARNAME_KEYWORD, VERSION_KEYWORD
 
Method Summary
 java.lang.String getBARFileName()
          Returns the name of the BAR file that was used to deploy the object to the execution group.
 java.util.Date getDeployTime()
          Returns the time that the current deployed object was last received by the Configuration Manager for deployment to the execution group.
 ExecutionGroupProxy getExecutionGroup()
          Returns a reference to the execution group on which this deployed object was deployed.
 
Methods inherited from interface com.ibm.broker.config.proxy.DeployableObject
getFileExtension, getFullName, getKeywords, getKeywordValue, getModifyTime, getName, getVersion
 

Method Detail

getDeployTime

java.util.Date getDeployTime()
Returns the time that the current deployed object was last received by the Configuration Manager for deployment to the execution group.

Returns:
Date the time of the most recent deployment.

getBARFileName

java.lang.String getBARFileName()
                                throws ConfigManagerProxyPropertyNotInitializedException
Returns the name of the BAR file that was used to deploy the object to the execution group. This method will return null if:

Returns:
String name of the BAR file that deployed the object
Throws:
ConfigManagerProxyPropertyNotInitializedException - If information on the name was not supplied by the Configuration Manager before a timeout occurred.

getExecutionGroup

ExecutionGroupProxy getExecutionGroup()
                                      throws ConfigManagerProxyLoggedException
Returns a reference to the execution group on which this deployed object was deployed.

Returns:
ExecutionGroupProxy
Throws:
ConfigManagerProxyLoggedException - if the parent object is not immediately available and has to be requested from the Configuration Manager, but the request could not be sent to the Configuration Manager.