public interface DeployedObject extends DeployableObject
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:
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 51619.8 2008-12-16 HDMPL v7 Release (no changes)
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier and Type | Method and Description |
---|---|
boolean |
fullNameMatches(java.lang.String fileName)
Tests if the name of this deployed object matches the
fileName passed in.
|
java.lang.String |
getBARFileName()
Returns the name of the Bar file that was used to deploy
the object to the execution group.
|
java.util.Properties |
getDeployProperties()
Returns a list of the properties associated with the
deployment of this deployed object.
|
java.util.Date |
getDeployTime()
Returns the time that the current deployed object was
last received by the broker for deployment to the execution group.
|
ExecutionGroupProxy |
getExecutionGroup()
Returns a reference to the execution group on
which this deployed object was deployed.
|
getFileExtension, getFullName, getKeywords, getKeywordValue, getModifyTime, getName, getVersion
java.util.Properties getDeployProperties() throws ConfigManagerProxyPropertyNotInitializedException
This method will pause until the object has received at least one update from the broker. If an update is not received before the timeout specified in BrokerProxy.setRetryCharacteristics() is reached, AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned Properties object will be null.
ConfigManagerProxyPropertyNotInitializedException
java.util.Date getDeployTime()
java.lang.String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ExecutionGroupProxy getExecutionGroup() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the parent
object is not immediately available and has to be
requested from the broker, but the
request could not be sent to the broker.boolean fullNameMatches(java.lang.String fileName) throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyLoggedException
- if the parent
object is not immediately available and has to be
requested from the broker, but the
request could not be sent to the broker.ConfigManagerProxyPropertyNotInitializedException