|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.broker.config.proxy.AdministeredObject
com.ibm.broker.config.proxy.MessageFlowProxy
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
Nested Class Summary | |
---|---|
static class |
MessageFlowProxy.UserTrace
A small structure that represents all the possible types of user trace. |
Field Summary |
---|
Fields inherited from interface com.ibm.broker.config.proxy.DeployedObject |
---|
BARNAME_KEYWORD, VERSION_KEYWORD |
Method Summary | |
---|---|
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 keyword)
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 newTrace)
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 immediate)
Requests that the messageflow.runstate attribute be set to "stopped", which causes the message flow to stop. |
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. |
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.broker.config.proxy.DeployedObject |
---|
getName |
Method Detail |
public void start() throws ConfigManagerProxyLoggedException
Requests that the messageflow.runstate attribute be set to "running", which causes the message flow to start.
ConfigManagerProxyLoggedException
- if the request to start the
message flow could not be sent to the Config Managerpublic void stop(boolean immediate) throws ConfigManagerProxyLoggedException
immediate
- True only if the 'immediate' flag should be used.
ConfigManagerProxyLoggedException
- if the request to start the
message flow could not be sent to the Config Managerpublic MessageFlowProxy.UserTrace getUserTrace() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to us from the Config Manager.public void setUserTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException
Configures the user trace setting for the current flow.
newTrace
- One of:
ConfigManagerProxyLoggedException
- if the request could not be
sent to the Config Manager.public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException
Returns true if the Message Flow is running.
ConfigManagerProxyPropertyNotInitializedException
- -
if, due to the administered object not having
been updated by the Config Manager yet,
the value of the run state is unknown.public int getAdditionalInstances() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to us from the Config Manager.public int getCommitCount() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to us from the Config Manager.public int getCommitInterval() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to us from the Config Manager.public boolean getCoordinatedTransaction() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to us from the Config Manager.public static Properties withUUID(String uuid)
public static Properties withName(String name)
public String getFileExtension()
getFileExtension
in interface DeployedObject
DeployedObject.getFileExtension()
public String getFullName() throws ConfigManagerProxyPropertyNotInitializedException
getFullName
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
- If information on the name was not supplied
by the Configuration Manager before a timeout occurred.public Date getDeployTime()
getDeployTime
in interface DeployedObject
DeployedObject.getDeployTime()
public Date getModifyTime()
getModifyTime
in interface DeployedObject
DeployedObject.getModifyTime()
public String[] getKeywords() throws ConfigManagerProxyPropertyNotInitializedException
getKeywords
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
- If information on the set of keywords was not supplied
by the Configuration Manager before a timeout occurred.DeployedObject.getKeywords()
public String getKeywordValue(String keyword) throws ConfigManagerProxyPropertyNotInitializedException
getKeywordValue
in interface DeployedObject
keyword
- The keyword to look up
ConfigManagerProxyPropertyNotInitializedException
- If information on the deployed object was not supplied
by the Configuration Manager before a timeout occurred.DeployedObject.getKeywordValue(java.lang.String)
public String getVersion() throws ConfigManagerProxyPropertyNotInitializedException
getVersion
in interface DeployedObject
ConfigManagerProxyNotInitializedException
- If information on this broker's queue manager
has not yet been supplied by the Config Manager.
ConfigManagerProxyPropertyNotInitializedException
- If information on the version was not supplied
by the Configuration Manager before a timeout occurred.DeployedObject.getVersion()
public String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedException
getBARFileName
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
- If information on the name was not supplied
by the Configuration Manager before a timeout occurred.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 Configuration Manager, but the
request could not be sent to the Configuration Manager.DeployedObject.getExecutionGroup()
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
|
WBI BrokersTM Config Manager Proxy API |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |