Class Hierarchy All Classes All Fields and Methods

Class com.ibm.broker.config.proxy.MessageFlowProxy

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

 

Inner Class Index
Class Description
MessageFlowProxy.UserTrace A small structure that represents all the possible types of user trace.
Method Index
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.

Methods

getAdditionalInstances

public int getAdditionalInstances() throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the "AdditionalInstances" parameter

getBARFileName

public String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedException

Returns the name of the BAR file that was used to deploy the message flow to the execution group. This method will return null if:

getCommitCount

public int getCommitCount() throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the "CommitCount" parameter

getCommitInterval

public int getCommitInterval() throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the "CommitInterval" parameter

getConfigurationObjectType

public ConfigurationObjectType getConfigurationObjectType() 

Returns the ConfigurationObjectType associated with this AdministeredObject type.

getConfigurationObjectTypeOfParent

public ConfigurationObjectType getConfigurationObjectTypeOfParent() 

Returns the ConfigurationObjectType associated with the logical parent of this AdministeredObject type.

getCoordinatedTransaction

public boolean getCoordinatedTransaction() throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the "CoordinatedTransaction" parameter

getDeployTime

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.

getExecutionGroup

public ExecutionGroupProxy getExecutionGroup() throws ConfigManagerProxyLoggedException

Returns 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.

getFileExtension

public String getFileExtension() 

Returns the file extension relevant to message flows. Currently, this is the constant string "cmf".

getFullName

public String getFullName() throws ConfigManagerProxyPropertyNotInitializedException

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.

getKeywords

public String[] getKeywords() throws ConfigManagerProxyPropertyNotInitializedException

Returns 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.

getKeywordValue

public String getKeywordValue(String keyword) throws ConfigManagerProxyPropertyNotInitializedException

Returns the value of the supplied keyword. If the supplied keyword was not found during the deployment of this object, this method returns null.

getModifyTime

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.

getUserTrace

public MessageFlowProxy.UserTrace getUserTrace() throws ConfigManagerProxyPropertyNotInitializedException

Returns the current state of user trace for this message flow

getVersion

public String getVersion() throws ConfigManagerProxyPropertyNotInitializedException

Returns the version string associated with the current message flow. If the version string was not set by the user (for example, during a RAD deployment), 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.

isRunning

public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException

Returns true if the Message Flow is running.

setUserTrace

public void setUserTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException

Configures the user trace setting for the current flow.

start

public void start() throws ConfigManagerProxyLoggedException

Requests that the messageflow.runstate attribute be set to "running", which causes the message flow to start.

stop

public void stop(boolean immediate) throws ConfigManagerProxyLoggedException

Requests that the messageflow.runstate attribute be set to "stopped", which causes the message flow to stop.

withName

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.

withUUID

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.

Class Hierarchy All Classes All Fields and Methods