java.lang.Object com.ibm.broker.config.proxy.AdministeredObject com.ibm.broker.config.proxy.MessageFlowProxy
public class MessageFlowProxy
implements DeployedObject
extends AdministeredObject
Represents a message flow that has been deployed to an execution group. In order to use MessageFlowProxy 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"); MessageFlowProxy m = e.getMessageFlowByName("mf1");
com.ibm.broker.config.proxy.MessageFlowProxy extends
com.ibm.broker.config.proxy.AdministeredObject implements
com.ibm.broker.config.proxy.DeployedObject
|
|
Responsibilities | Represents the state of a message flow that has been deployed to an execution group. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 25103.8 2004-03-18 HDMPL v6 Release
Class | Description |
---|---|
MessageFlowProxy.UserTrace | A small structure that represents all the possible types of user trace. |
Method | Description |
---|---|
int getAdditionalInstances() | Returns the value of the "AdditionalInstances" parameter |
String getBARFileName() | Returns the name of the BAR file that was used to deploy the message flow to the execution group. |
int getCommitCount() | Returns the value of the "CommitCount" parameter |
int getCommitInterval() | Returns the value of the "CommitInterval" parameter |
ConfigurationObjectType getConfigurationObjectType() | Returns the ConfigurationObjectType associated with this AdministeredObject type. |
ConfigurationObjectType getConfigurationObjectTypeOfParent() | Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type. |
boolean getCoordinatedTransaction() | Returns the value of the "CoordinatedTransaction" parameter |
Date getDeployTime() | Returns the time that the current message flow 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 message flow was deployed. |
String getFileExtension() | Returns the file extension relevant to message flows. |
String getFullName() | Returns the name of the current deployable 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 deployed object 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 message flow was last modified, according to the file modification associated with the cmf file in the broker archive. |
MessageFlowProxy.UserTrace getUserTrace() | Returns the current state of user trace for this message flow |
String getVersion() | Returns the version string associated with the current message flow. |
boolean isRunning() | Returns true if the Message Flow is running. |
void setUserTrace(MessageFlowProxy.UserTrace) | Configures the user trace setting for the current flow. |
void start() | Requests that the messageflow.runstate attribute be set to "running", which causes the message flow to start. |
void stop(boolean) | Requests that the messageflow.runstate attribute be set to "stopped", which causes the message flow to stop. |
Properties withName(String) | Returns a new Properties object that has the name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. |
Properties withUUID(String) | Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. |
public int getAdditionalInstances() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the value of the "AdditionalInstances" parameter
- Returns
- int AdditionalInstances parameter
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the value of the field could not be determined because the value has not yet been supplied to us from the Configuration Manager.
public String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the name of the BAR file that was used to deploy the message flow to the execution group. This method will return null if:
- the connected Configuration Manager is of a version earlier than v6, or
- the message flow 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 message flow
- Throws
ConfigManagerProxyPropertyNotInitializedException
If information on the name was not supplied by the Configuration Manager before a timeout occurred.
public int getCommitCount() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the value of the "CommitCount" parameter
- Returns
- int CommitCount parameter
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the value of the field could not be determined because the value has not yet been supplied to us from the Configuration Manager.
public int getCommitInterval() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the value of the "CommitInterval" parameter
- Returns
- String CommitInterval parameter
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the value of the field could not be determined because the value has not yet been supplied to us from the Configuration Manager.
public ConfigurationObjectType getConfigurationObjectType()Returns the ConfigurationObjectType associated with this AdministeredObject type.
- Returns
- ConfigurationObjectType associated with this class.
- Overrides
public ConfigurationObjectType getConfigurationObjectTypeOfParent()Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.
- Returns
- ConfigurationObjectType associated with the logical parent of this class.
- Overrides
public boolean getCoordinatedTransaction() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the value of the "CoordinatedTransaction" parameter
- Returns
- boolean CoordinatedTransaction parameter
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the value of the field could not be determined because the value has not yet been supplied to us from the Configuration Manager.
public Date getDeployTime()Returns the time that the current message flow was last received by the Configuration Manager for deployment to the execution group. This method will return null if the application is connected to a v5 Configuration Manager, or if the message flow was deployed using a v5 Configuration Manager.
- Returns
- Date the time of the most recent deployment.
- See Also
public ExecutionGroupProxy getExecutionGroup() throws ConfigManagerProxyLoggedExceptionReturns a reference to the execution group on which this message flow was deployed. This method is the same as calling getParent(), except that getExecutionGroup() returns an ExecutionGroupProxy object rather than an object of the parent AdministeredObject type.
- Returns
- ExecutionGroup
- See Also
public String getFileExtension()Returns the file extension relevant to message flows. Currently, this is the constant string "cmf".
- Returns
- String file extension
- See Also
public String getFullName() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the name of the current deployable as it existed in the BAR file at deployment time- including any file extension but excluding any path information.
- 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 deployed object which were found embedded in the object at deploy time. Use DeployedObject.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 message flow was last modified, according to the file modification associated with the cmf file in the broker archive. This method will return null if the application is connected to a v5 Configuration Manager, or if the message flow was deployed using a v5 Configuration Manager.
- Returns
- Date the time of the last modification.
- See Also
public MessageFlowProxy.UserTrace getUserTrace() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the current state of user trace for this message flow
- Returns
- MessageFlowProxy.UserTrace One of:
- MessageFlowProxy.UserTrace.normal means that normal user trace is enabled
- MessageFlowProxy.UserTrace.debug means that debug user trace is enabled
- MessageFlowProxy.UserTrace.none means that user trace is disabled
- MessageFlowProxy.UserTrace.unknown means that user trace settings are unknown
- Throws
ConfigManagerProxyPropertyNotInitializedException
if the value of the field could not be determined because the value has not yet been supplied to us from the Configuration Manager.
public String getVersion() throws ConfigManagerProxyPropertyNotInitializedExceptionReturns the version string associated with the current message flow. If the version string was not set by the user the return value is not specified. If the application is connected to a v5 Configuration Manager, or if the message flow was deployed using a v5 Configuration Manager, the return value is null.
- Throws
ConfigManagerProxyNotInitializedException
If information on this broker's queue manager has not yet been supplied by the Configuration Manager.
- See Also
public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException
Returns true if the Message Flow is running.
- Returns
- boolean - True if and only if the flow is running.
- Throws
ConfigManagerProxyPropertyNotInitializedException
- if, due to the administered object not having been updated by the Configuration Manager yet, the value of the run state is unknown.
public void setUserTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException
Configures the user trace setting for the current flow.
- Parameters
- newTrace - One of:
- MessageFlowProxy.UserTrace.normal to enable normal user trace
- MessageFlowProxy.UserTrace.debug to enable debug user trace
- MessageFlowProxy.UserTrace.none to disable user trace
- Throws
ConfigManagerProxyLoggedException
if the request could not be sent to the Configuration Manager.
public void start() throws ConfigManagerProxyLoggedException
Requests that the messageflow.runstate attribute be set to "running", which causes the message flow to start.
- Throws
ConfigManagerProxyLoggedException
if the request to start the message flow could not be sent to the Configuration Manager
public void stop(boolean immediate) throws ConfigManagerProxyLoggedExceptionRequests that the messageflow.runstate attribute be set to "stopped", which causes the message flow to stop.
- Parameters
- immediate - True only if the 'immediate' flag should be used.
- Throws
ConfigManagerProxyLoggedException
if the request to start the message flow could not be sent to the Configuration Manager
public static Properties withName(String name)Returns a new Properties object that has the name attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. This provides an easy way of supplying filters to the get* calls. For example, broker1.getExecutionGroup(ExecutionGroup.withName("eg1")); will return the Execution Group with Name "eg1" that exists in broker1.
- Returns
- java.util.Properties - a new Properties object with the relevant key/value pairs set.
public static Properties withUUID(String uuid)Returns a new Properties object that has the UUID attribute set to the supplied String, and the type attribute to be the name of the subclass of AdministeredObject being used. This provides an easy way of supplying filters to the get* calls. For example, broker1.getExecutionGroup(ExecutionGroup.withUUID("1234")); will return the Execution Group with UUID "1234" that exists in broker1.
- Returns
- java.util.Properties - a new Properties object with the relevant key/value pairs set.