public class MessageFlowDependency extends java.lang.Object implements DeployedObject
In order to use MessageFlowDependency objects, applications must first obtain handles to them. Here is an example of how to do this:
BrokerConnectionParameters bcp = new MQBrokerConnectionParameters("localhost", 1414, "QMGR"); BrokerProxy b = BrokerProxy.getInstance(bcp); ExecutionGroupProxy e = b.getExecutionGroupByName("default"); MessageFlowDependency mfd = e.getMessageFlowDependencyByName("mrm.dictionary");Unlike MessageFlowProxy and other AdministeredObject children, MessageFlowDependency is a short-lived class. Instances are generated on demand to represent data logically owned by, and updated in, the ExecutionGroupProxy object. This means that the information described in each MessageFlowDependency does not get updated once it has been initially populated, and any changes to dependencies are sent to AdministeredObjectListener instances registered on the ExecutionGroupProxy object.
com.ibm.broker.config.proxy.MessageFlowDependency implements
com.ibm.broker.config.proxy.DeployedObject
|
|
Responsibilities | Represents an object deployed to an execution group that is required in order for it to process message flow logic. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.8 2004-03-18 HDMPL v6 Release 44739.7 2007-07-30 HDMPL v6.1 Release 51619.8 2008-12-16 HDMPL v7 Release 80006 2011-05-13 HDCAB v8 release: Added equals() method.
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares this MessageFlowDependency with the Object passed
in.
|
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 dependency to the execution group.
|
java.util.Properties |
getDeployProperties()
Returns a list of the properties associated with the
deployment of this dependency.
|
java.util.Date |
getDeployTime()
Returns the time that the current dependency was
last deployed.
|
ExecutionGroupProxy |
getExecutionGroup()
Returns a reference to the execution group on
which this dependency was deployed.
|
java.lang.String |
getFileExtension()
Returns the file extension of the current dependency.
|
java.lang.String |
getFullName()
Returns the name of the current dependency as it
existed in the Bar file at deployment time- including
any file extension but excluding any path information.
|
java.lang.String[] |
getKeywords()
Returns the set of keywords for this dependency
which were found embedded in the object at deploy time.
|
java.lang.String |
getKeywordValue(java.lang.String keyword)
Returns the value of the supplied keyword.
|
java.util.Date |
getModifyTime()
Returns the time that the current dependency was
last modified, according to the file modification date
set in the Bar file.
|
java.lang.String |
getName()
Returns the name of the current dependency.
|
DeployedObjectGroupProxy |
getParent()
Returns a reference to the execution group, application or
library on which this dependency was deployed.
|
java.lang.String |
getVersion()
Returns the version string for this dependency
as it was set at deploy time.
|
java.lang.String |
toString()
Returns a string representation of the object.
|
public java.lang.String getFileExtension()
getFileExtension
in interface DeployableObject
public java.util.Date getDeployTime()
getDeployTime
in interface DeployedObject
public java.util.Date getModifyTime()
getModifyTime
in interface DeployableObject
public java.lang.String getName() throws ConfigManagerProxyPropertyNotInitializedException
getName
in interface DeployableObject
ConfigManagerProxyPropertyNotInitializedException
- if the name could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String getFullName() throws ConfigManagerProxyPropertyNotInitializedException
getFullName
in interface DeployableObject
ConfigManagerProxyPropertyNotInitializedException
- if the full name could not be determined because
the information was not supplied from the broker before a
timeout occurred.public boolean fullNameMatches(java.lang.String fileName) throws ConfigManagerProxyPropertyNotInitializedException
fullNameMatches
in interface DeployedObject
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
public java.lang.String getVersion() throws ConfigManagerProxyPropertyNotInitializedException
getVersion
in interface DeployableObject
ConfigManagerProxyPropertyNotInitializedException
- if the version could not be determined because
the information was not supplied from the broker before a
timeout occurred.public 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.
getDeployProperties
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
public ExecutionGroupProxy getExecutionGroup() throws ConfigManagerProxyLoggedException
getExecutionGroup
in interface DeployedObject
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.public DeployedObjectGroupProxy getParent()
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String[] getKeywords() throws ConfigManagerProxyPropertyNotInitializedException
See the DeployedObject class for an overview of how to associate keywords with deployed objects.
getKeywords
in interface DeployableObject
ConfigManagerProxyPropertyNotInitializedException
- if the keywords could not be determined because
the information was not supplied from the broker before a
timeout occurred.DeployableObject.getKeywords()
public java.lang.String getKeywordValue(java.lang.String keyword) throws ConfigManagerProxyPropertyNotInitializedException
See the DeployedObject class for an overview of how to associate keywords with deployed objects.
getKeywordValue
in interface DeployableObject
keyword
- The keyword to look upConfigManagerProxyPropertyNotInitializedException
- if the value of the keyword could not be determined because
the information was not supplied from the broker before a
timeout occurred.DeployableObject.getKeywordValue(java.lang.String)
public java.lang.String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedException
getBARFileName
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
- if the Bar file name could not be determined because
the information was not supplied from the broker before a
timeout occurred.public boolean equals(java.lang.Object obj)
Two instances of a MessageFlowDependency are equal if and only if they are both MessageFlowDependencies and they have the same name and AdministeredObject parent.
equals
in class java.lang.Object
obj
- - the object that is to be compared with this one.