|
|||||||||
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
public class 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 45112.7 2007-07-30 HDMPL v6.1 Release: Methods now return genericized types where relevant Added getQueues() Added getNodeTypes() Added setAdditionalInstances(String) Added getPolicySetBindingNames(long) Added getPolicySetNames(long)
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.DeployableObject |
---|
BARNAME_KEYWORD, VERSION_KEYWORD |
Method Summary | |
---|---|
int |
getAdditionalInstances()
Returns the value of the "AdditionalInstances" parameter as it was set when originally deployed in the Bar file. |
java.lang.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 |
java.util.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. |
java.lang.String |
getFileExtension()
Returns the file extension relevant to message flows. |
java.lang.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. |
java.lang.String[] |
getKeywords()
Returns the set of keywords for this deployed object 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 message flow was last modified, according to the file modification associated with the cmf file in the broker archive. |
java.lang.String[] |
getNodeTypes()
Returns a list of the types of nodes used in this message flow. |
java.lang.String[] |
getPolicySetBindingNames(long timeToWaitMs)
Asks the broker to return the names of the policy set bindings in use by this message flow. |
java.lang.String[] |
getPolicySetNames(long timeToWaitMs)
Asks the broker to return the names of the policy sets in use by this message flow. |
java.lang.String[] |
getQueues()
Returns a list of the MQ queues referenced by this message flow. |
MessageFlowProxy.UserTrace |
getUserTrace()
Returns the current state of user trace for this message flow |
java.lang.String |
getVersion()
Returns the version string associated with the current message flow. |
boolean |
isRunning()
Returns true if the Message Flow is running. |
void |
setAdditionalInstances(int newValue)
Attempts to ask the broker to directly set the value of the Additional Instances property for this message flow. |
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 java.util.Properties |
withName(java.lang.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 java.util.Properties |
withUUID(java.lang.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.DeployableObject |
---|
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 Configuration 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 Configuration 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 Configuration 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 Configuration 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 Configuration 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 Configuration Manager.public void setAdditionalInstances(int newValue) throws ConfigManagerProxyLoggedException
newValue
- New value to assign to the AdditionalInstances
parameter.
ConfigManagerProxyLoggedException
- if a request could not
be sent to the Configuration Managerpublic 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 Configuration 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 Configuration 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 Configuration Manager.public static java.util.Properties withUUID(java.lang.String uuid)
public static java.util.Properties withName(java.lang.String name)
public java.lang.String getFileExtension()
getFileExtension
in interface DeployableObject
DeployableObject.getFileExtension()
public java.lang.String getFullName() throws ConfigManagerProxyPropertyNotInitializedException
getFullName
in interface DeployableObject
ConfigManagerProxyPropertyNotInitializedException
- If information on the name was not supplied
by the Configuration Manager before a timeout occurred.public java.util.Date getDeployTime()
getDeployTime
in interface DeployedObject
DeployedObject.getDeployTime()
public java.util.Date getModifyTime()
getModifyTime
in interface DeployableObject
DeployableObject.getModifyTime()
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 information on the set of keywords was not supplied
by the Configuration Manager 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 up
ConfigManagerProxyPropertyNotInitializedException
- If information on the deployed object was not supplied
by the Configuration Manager before a timeout occurred.DeployableObject.getKeywordValue(java.lang.String)
public java.lang.String getVersion() throws ConfigManagerProxyPropertyNotInitializedException
getVersion
in interface DeployableObject
ConfigManagerProxyNotInitializedException
- If information on this broker's queue manager
has not yet been supplied by the Configuration Manager.
ConfigManagerProxyPropertyNotInitializedException
- If information on the version was not supplied
by the Configuration Manager before a timeout occurred.DeployableObject.getVersion()
public java.lang.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
public java.lang.String[] getPolicySetNames(long timeToWaitMs) throws ConfigManagerProxyPropertyNotInitializedException
The property is discovered directly and synchronously from the broker runtime and will block until the broker has responded or the timeout condition set by the timeToWaitMs value is reached. The value is not cached on the Configuration Manager or within the Configuration Manager Proxy. Therefore, it is advisable to call this method sparingly.
timeToWaitMs
- Maximum time (in milliseconds) to wait for the response
from the broker to arrive. A value of -1 will cause the method to
block indefinitely, until the broker responds.
ConfigManagerProxyPropertyNotInitializedException
- if the information has not
yet been supplied by the Configuration manager.public java.lang.String[] getPolicySetBindingNames(long timeToWaitMs) throws ConfigManagerProxyPropertyNotInitializedException
The property is discovered directly and synchronously from the broker runtime and will block until the broker has responded or the timeout condition set by the timeToWaitMs value is reached. The value is not cached on the Configuration Manager or within the Configuration Manager Proxy. Therefore, it is advisable to call this method sparingly.
timeToWaitMs
- Maximum time (in milliseconds) to wait for the response
from the broker to arrive. A value of -1 will cause the method to
block indefinitely, until the broker responds.
ConfigManagerProxyPropertyNotInitializedException
- if the information has not
yet been supplied by the Configuration manager.public java.lang.String[] getQueues() throws ConfigManagerProxyPropertyNotInitializedException
This method will return an empty array if the connected Configuration Manager is of a version less than v6.1, or if the message flow was deployed through a Configuration Manager of a version earlier than v6.1.
ConfigManagerProxyPropertyNotInitializedException
- if the information has not
yet been supplied by the Configuration manager.public java.lang.String[] getNodeTypes() throws ConfigManagerProxyPropertyNotInitializedException
This method will return an empty array if the connected Configuration Manager is of a version less than v6.1, or if the message flow was deployed through a Configuration Manager of a version earlier than v6.1.
ConfigManagerProxyPropertyNotInitializedException
- if the information has not
yet been supplied by the Configuration manager.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |