java.lang.Object com.ibm.broker.config.proxy.MessageFlowDependency
public class MessageFlowDependency
implements DeployedObject
extends Object
Represents an object deployed to an execution group that is required in order for it to process message flow logic.
In order to use MessageFlowDependency objects, applications must first obtain handles to them. Here is an example of how to do this:
ConfigManagerConnectionParameters cmcp = new MQConfigManagerConnectionParameters("localhost", 1414, "QMGR"); ConfigManagerProxy cmp = ConfigManagerProxy.getInstance(cmcp); TopologyProxy t = cmp.getTopology(); BrokerProxy b = t.getBrokerByName("BROKER1"); 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.
When connected to v5 Configuration Managers, the only supported dependency type is the message set. Later Configuration Managers support other types (such as XSL Stylesheets). Furthermore, version information (such as the deploy time and version string) is not available when connected to a v5 Configuration Manager (or when referring to objects deployed using a v5 Configuration Manager).
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
Method | Description |
---|---|
String getBARFileName() | Returns the name of the BAR file that was used to deploy the dependency to the execution group. |
Date getDeployTime() | Returns the time that the current dependency 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 dependency was deployed. |
String getFileExtension() | Returns the file extension of the current dependency. |
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. |
String[] getKeywords() | Returns the set of keywords for this dependency which were found embedded in the object at deploy time. |
String getKeywordValue(String) | Returns the value of the supplied keyword. |
Date getModifyTime() | Returns the time that the current dependency was last modified, according to the file modification date set in the broker archive file. |
String getName() | Returns the name of the current dependency. |
String getVersion() | Returns the version string for this dependency as it was set at deploy time. |
String toString() | Returns a string representation of the object. |
public String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the name of the BAR file that was used to deploy the dependency to the execution group. This method will return null if:
- the connected Configuration Manager is of a version earlier than v6, or
- the dependency was deployed using the v5.x Rapid Application Development tools, or
- the BAR file was deployed by specifying an InputStream parameter to ExecutionGroupProxy.deploy() and a valid BAR file label was not supplied.
- 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.
public Date getDeployTime()Returns the time that the current dependency was last received by the Configuration Manager for deployment to the execution group. If the dependency was deployed using a v5 Configuration Manager, or if the Configuration Manager Proxy is connected to a v5 Configuration Manager, this method returns null.
- Returns
- Date the time of the most recent deployment, or null if the information is not available.
public ExecutionGroupProxy getExecutionGroup() throws ConfigManagerProxyLoggedExceptionReturns a reference to the execution group on which this dependency 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.
public String getFileExtension()Returns the file extension of the current dependency. The String returned is taken from the name of the file as it existed in the BAR file at deployment time- from the first character after the last period ('.') to the end of the filename.
Note that the only message flow dependency supported on v5 Configuration Managers is the message set, and so this method will return the constant string "dictionary" when connected to v5 Configuration Managers. the file ext, or if the Configuration Manager Proxy is connected to a v5 Configuration Manager, this method returns null.
- Returns
- String file extension, or the empty string if the file did not have any extension.
public String getFullName() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns 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. If the dependency was deployed using a v5 Configuration Manager, or if the Configuration Manager Proxy is connected to a v5 Configuration Manager, this method returns null.
- Returns
- String name of the deployable
- Throws
ConfigManagerProxyPropertyNotInitializedException
If information on the name was not supplied by the Configuration Manager before a timeout occurred.
public String[] getKeywords() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the set of keywords for this dependency which were found embedded in the object at deploy time. Use MessageFlowDependency.getKeywordValue() to look up the value of a given keyword.
See the DeployedObject class for an overview of how to associate keywords with deployed objects.
- Returns
- String[] the set of keywords that were found.
- Throws
ConfigManagerProxyPropertyNotInitializedException
If information on the set of keywords was not supplied by the Configuration Manager before a timeout occurred.
- See Also
public String getKeywordValue(String keyword) throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the value of the supplied keyword. If the supplied keyword was not found during the deployment of this object, this method returns null.
See the DeployedObject class for an overview of how to associate keywords with deployed objects.
- Parameters
- keyword - The keyword to look up
- Returns
- String value of the supplied keyword, or null if the keyword could not be found for the object.
- Throws
ConfigManagerProxyPropertyNotInitializedException
If information on the deployed object was not supplied by the Configuration Manager before a timeout occurred.
- See Also
public Date getModifyTime()Returns the time that the current dependency was last modified, according to the file modification date set in the broker archive file. If the dependency was deployed using a v5 Configuration Manager, or if the Configuration Manager Proxy is connected to a v5 Configuration Manager, this method returns null.
- Returns
- Date the time of the most last modification, or null if the information is not available.
public String getName() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the name of the current dependency. This is taken from the name of the file as it existed in the BAR file at deployment time- up to but excluding the last period ('.').
- Returns
- String name of the deployable
- Throws
ConfigManagerProxyPropertyNotInitializedException
If information on the name was not supplied by the Configuration Manager before a timeout occurred.
public String getVersion() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the version string for this dependency as it was set at deploy time. If no string was set the return value is not specified.
- Returns
- String version information
- Throws
ConfigManagerProxyPropertyNotInitializedException
If information on the version was not supplied by the Configuration Manager before a timeout occurred.
public String toString()Returns a string representation of the object.
- Returns
- String
- Overrides
- toString in class Object