public class MessageFlowProxy extends AdministeredObject implements DeployedObject
BrokerConnectionParameters bcp = new MQBrokerConnectionParameters("localhost", 1414, "QMGR"); BrokerProxy b = BrokerProxy.getInstance(bcp); 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 getDeployedPolicySetBindingsNames() Added getDeployedPolicySetNames() Added MessageFlowProxy.PolicySetName Added MessageFlowProxy.PolicySetBindingsName 51517 2008-06-12 HDMPL v7.0 Release: Deprecated immediate parameter on stop() Added getNodes() Added getNodeConnections() Added getNodeByName() Added setServiceTrace() Added setStatisticsEnabled() Added setStatisticsNodeDetailLevel() Added setStatisticsThreadDetailLevel() Added setStatisticsAccountingOrigin() Added resetArchiveStatistics() Added getStatisticsEnabled() Added getStatisticsNodeDetailLevel() Added getStatisticsThreadDetailLevel() Added getStatisticsOutputFormat() Added getStatisticsAccountingOrigin() Added enableBasicStatistics() 80006.2 2011-05-13 HDCAB v8.0 Release: Added getActivityLog() 80006.4 2011-09-30 HDCAB Added getStartMode(), setStartMode()
Modifier and Type | Class and Description |
---|---|
class |
MessageFlowProxy.Node
A small class that represents a node in a message flow.
|
class |
MessageFlowProxy.NodeConnection
A small class that represents the connection
between two nodes in a message flow.
|
class |
MessageFlowProxy.PolicySetBindingsName
This class represents a PolicySetBinding associated in some way with the message flow.
|
class |
MessageFlowProxy.PolicySetName
This class represents a PolicySet associated in some way with the message flow.
|
static class |
MessageFlowProxy.UserTrace
A small structure that represents all the possible types of
user trace.
|
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier and Type | Method and Description |
---|---|
void |
enableBasicStatistics()
Configures a standard set of snapshot statistics properties for the
message flow and enables the gathering of these statistics.
|
boolean |
fullNameMatches(java.lang.String fileName)
Tests if the name of this deployed object matches the
fileName passed in.
|
ActivityLogProxy |
getActivityLog()
Returns an ActivityLogProxy object that contains the activity
log messages that are associated with the current message
flow.
|
int |
getAdditionalInstances()
Returns the number of additional thread instances that are allocated
to the message flow.
|
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 configured value of the "commit count" parameter, which
is the number of MQ messages to process before a syncpoint is taken.
|
int |
getCommitInterval()
Returns the configured value of the commit interval parameter, which is the
time in milliseconds between MQ message commits.
|
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()
Describes whether message flows should participate as part of a
co-ordinated transaction.
|
MessageFlowProxy.PolicySetBindingsName[] |
getDeployedPolicySetBindingsNames()
Asks the broker to return the names of the PolicySetBindings in use by this message flow.
|
MessageFlowProxy.PolicySetName[] |
getDeployedPolicySetNames()
Return the names of the PolicySets in use by this message flow.
|
java.util.Properties |
getDeployProperties()
Returns a list of the properties associated with the
deployment of this message flow.
|
java.util.Date |
getDeployTime()
Returns the time that the current message flow was
last deployed 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, not preceded
by a '.' character.
|
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.
|
int |
getMaximumRateMsgsPerSec()
Returns the maximum rate for the message flow.
|
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.
|
MessageFlowProxy.Node |
getNodeByName(java.lang.String name)
Returns the node with the supplied name.
|
java.util.Enumeration<MessageFlowProxy.NodeConnection> |
getNodeConnections()
Returns an Enumeration of the NodeConnection objects that comprise this
message flow.
|
java.util.Enumeration<MessageFlowProxy.Node> |
getNodes()
Returns an Enumeration of the Node objects that comprise this
message flow.
|
java.lang.String[] |
getNodeTypes()
Returns a list of the types of nodes used in this message flow.
|
int |
getNotificationThresholdMsgsPerSec()
Returns the notification threshold for the message flow.
|
java.lang.String[] |
getQueues()
Returns a list of the MQ queues referenced by this message flow.
|
java.lang.String |
getRuntimeProperty(java.lang.String objectAndPropertyName)
Returns the value of the runtime property with the supplied name.
|
java.lang.String[] |
getRuntimePropertyNames()
Returns a string array of the basic runtime properties
associated with this object.
|
java.lang.String |
getStartMode()
Returns the current value of start mode for this message flow
|
java.lang.String |
getStatisticsAccountingOrigin(boolean isSnapshot)
Returns the accounting origin for the message flow.
|
boolean |
getStatisticsEnabled(boolean isSnapshot)
Returns true only if statistics gathering is enabled for the message flow.
|
int |
getStatisticsNodeDetailLevel(boolean isSnapshot)
Returns the node statistics detail level for the message flow.
|
java.lang.String |
getStatisticsOutputFormat(boolean isSnapshot)
Returns the output format of statistics for the message flow.
|
int |
getStatisticsThreadDetailLevel(boolean isSnapshot)
Returns the thread statistics detail level for the message flow.
|
java.lang.Object |
getUserDefinedProperty(java.lang.String propertyName)
Returns the value of the user-defined property with the
supplied name.
|
java.lang.String[] |
getUserDefinedPropertyNames()
Returns a String array of the names of all user-defined
properties associated with this object.
|
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.
|
java.lang.String |
getWlmPolicy()
Returns the WLM policy for the message flow.
|
boolean |
isRunEnabled()
Returns true only if the message flow is able to run when the
execution group is started.
|
boolean |
isRunning()
Returns true only if the message flow is currently running.
|
void |
resetArchiveStatistics()
Causes the archive of statistics to be reset for the message flow.
|
void |
setAdditionalInstances(int newValue)
Asks the broker to directly set the number of additional thread
instances for this message flow.
|
void |
setMaximumRateMsgsPerSec(int newValue)
Asks the broker to directly set the maximum rate
for this message flow.
|
void |
setNotificationThresholdMsgsPerSec(int newValue)
Asks the broker to directly set the notification threshold
for this message flow.
|
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary message flow property.
|
void |
setServiceTrace(MessageFlowProxy.UserTrace newTrace)
Configures the service trace setting for the message flow.
|
void |
setStartMode(java.lang.String newStartMode)
Configures the start mode setting for the current flow.
|
void |
setStatisticsAccountingOrigin(boolean isSnapshot,
java.lang.String accountingOrigin)
Configures the accounting origin for the message flow.
|
void |
setStatisticsEnabled(boolean isSnapshot,
boolean isEnabled)
Enables or disables the gathering of statistics for the message flow.
|
void |
setStatisticsNodeDetailLevel(boolean isSnapshot,
int detailLevel)
Sets the detail level of node statistics to gather for the message flow.
|
void |
setStatisticsOutputFormat(boolean isSnapshot,
java.lang.String outputFormat)
Configures the output format of statistics for the message flow.
|
void |
setStatisticsOutputFormat(boolean isSnapshot,
java.lang.String outputFormats,
boolean replaceExistingFormats)
Configures the output format of statistics for the message flow.
|
void |
setStatisticsThreadDetailLevel(boolean isSnapshot,
int detailLevel)
Sets the detail level of thread statistics to gather for the message flow.
|
void |
setUserDefinedProperty(java.lang.String propertyName,
java.lang.Object propertyValue)
Asks the broker to configure a message flow's
user-defined property.
|
void |
setUserTrace(MessageFlowProxy.UserTrace newTrace)
Configures the user trace setting for the current flow.
|
void |
setWlmPolicy(java.lang.String newValue)
Asks the broker to directly set the WLM policy
for this message flow.
|
void |
start()
Asks the broker to start the message flow.
|
void |
stop()
Asks the broker to stop the message flow.
|
void |
stop(boolean immediate)
Deprecated.
The immediate flag is ignored. Use stop() instead.
|
void |
stop(BrokerProxy.StopMode stopMode)
Asks the broker to stop the message flow.
|
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.
|
deregisterListener, deregisterListener, elements, equals, getAdvancedProperties, getBasicProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperty, getProperty, getProperty, getProperty, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isShared, refresh, registerListener, registerListener, registerListener, setLongDescription, setName, setProperties, setShortDescription, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates
getClass, hashCode, notify, notifyAll, wait, wait, wait
getName
public void start() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public void stop(boolean immediate) throws ConfigManagerProxyLoggedException
immediate
- Not usedConfigManagerProxyLoggedException
- if the request to start the
message flow could not be sent to the broker.public void stop() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public void stop(BrokerProxy.StopMode stopMode) throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public 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 from the broker.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 broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public void setServiceTrace(MessageFlowProxy.UserTrace newTrace) throws ConfigManagerProxyLoggedException
newTrace
- One of:
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker.public java.lang.String getStartMode() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the field could not be determined because
the value has not yet been supplied to from the broker.public void setStartMode(java.lang.String newStartMode) throws ConfigManagerProxyLoggedException
Configures the start mode setting for the current flow.
newStartMode
- One of:
ConfigManagerProxyLoggedException
public boolean isRunning() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the run state could not be determined from
the broker.public boolean isRunEnabled() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the run state could not be determined from
the broker.public int getAdditionalInstances() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setAdditionalInstances(int newValue) throws ConfigManagerProxyLoggedException
newValue
- New number of additional threadsConfigManagerProxyLoggedException
- if the request could not
be sent to the broker.public java.lang.String getWlmPolicy() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setWlmPolicy(java.lang.String newValue) throws ConfigManagerProxyLoggedException
newValue
- The WLM policy to use.ConfigManagerProxyLoggedException
- if the request could not
be sent to the broker.public int getNotificationThresholdMsgsPerSec() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setNotificationThresholdMsgsPerSec(int newValue) throws ConfigManagerProxyLoggedException
newValue
- New notification threshold in messages per secondConfigManagerProxyLoggedException
- if the request could not
be sent to the broker.public int getMaximumRateMsgsPerSec() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setMaximumRateMsgsPerSec(int newValue) throws ConfigManagerProxyLoggedException
newValue
- New maximum rate in messages per secondConfigManagerProxyLoggedException
- if the request could not
be sent to the broker.public int getCommitCount() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public int getCommitInterval() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public boolean getCoordinatedTransaction() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.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 the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public boolean fullNameMatches(java.lang.String fileName) throws ConfigManagerProxyPropertyNotInitializedException
fullNameMatches
in interface DeployedObject
ConfigManagerProxyLoggedException
- if the parent
object is not immediately available and has to be
requested from the broker, but the
request could not be sent to the broker.ConfigManagerProxyPropertyNotInitializedException
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 the value of the parameter could not be determined because
the information was not supplied from the broker 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 upConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.DeployableObject.getKeywordValue(java.lang.String)
public java.lang.String getVersion() throws ConfigManagerProxyPropertyNotInitializedException
getVersion
in interface DeployableObject
ConfigManagerProxyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.DeployableObject.getVersion()
public java.lang.String[] getRuntimePropertyNames()
Only properties that have explicitly been set on the message flow will be returned by this method. Properties that have default values might not be returned, although it might still be possible to set their values using MessageFlowProxy.setRuntimeProperty(), for example, "This/StatsArchivalOn". This is a change in behavior over versions earlier than WebSphere Message Broker V7.
public java.util.Properties getDeployProperties() throws ConfigManagerProxyPropertyNotInitializedException
This method will pause until the object has received at least one update from the broker. If an update is not received before the timeout specified in BrokerProxy.setRetryCharacteristics() is reached, AdministeredObject.hasBeenPopulatedByBroker() will return false and the returned Properties object will be null.
getDeployProperties
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
public java.lang.String[] getUserDefinedPropertyNames()
public java.lang.String getBARFileName() throws ConfigManagerProxyPropertyNotInitializedException
getBARFileName
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker 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 broker, but the
request could not be sent to the broker.DeployedObject.getExecutionGroup()
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class AdministeredObject
public ConfigurationObjectType getConfigurationObjectTypeOfParent()
getConfigurationObjectTypeOfParent
in class AdministeredObject
public MessageFlowProxy.PolicySetName[] getDeployedPolicySetNames() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public MessageFlowProxy.PolicySetBindingsName[] getDeployedPolicySetBindingsNames() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String[] getQueues() throws ConfigManagerProxyPropertyNotInitializedException
This method will return an empty array if the message flow was deployed through a Configuration Manager of a version earlier than v6.1.
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public java.lang.String[] getNodeTypes() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setRuntimeProperty(java.lang.String objectAndPropertyName, java.lang.String propertyValue) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
To set runtime properties that affect the broker, use BrokerProxy.setRuntimeProperty(). To set runtime properties that affect the broker's HTTP listener, use BrokerProxy.setHTTPListenerProperty(). To set runtime properties for a broker's configurable service, use BrokerProxy.setConfigurableServiceProperty().
Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible. To set properties that are not defined in this interface, the objectAndPropertyName parameter can also be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters* of mqsichangeproperties. For example, "DynamicSubscriptionEngine/userTraceLevel" would request a change to the execution group's user trace level property. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.
The list of currently defined property names can be obtained using the method getRuntimePropertyNames(). However, not all runtime properties returned by this method can be set.
objectAndPropertyName
- The complete object and property name of the
property being manipulated, for example "This/StatsSnapPublicationOn"propertyValue
- The new value to associate with the property, for
example "active".ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public java.lang.String getRuntimeProperty(java.lang.String objectAndPropertyName) throws ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
If you wish to directly look up a specific named property, use constants defined in the AttributeConstants interface wherever possible. If a constant does not exist, the objectAndpropertyName parameter can be made up of a String of the form "ObjectName/PropertyName", where ObjectName and PropertyName are the object and property names supplied on the -o and -n parameters respectively of mqsireportproperties. The '/' separator is defined as AttributeConstants.OBJECT_NAME_DELIMITER.
Only properties that have explicitly been set on the message flow will be returned by this method. Properties that have default values might yield a null return value from this method, although it might still be possible to set a value using MessageFlowProxy.setRuntimeProperty(), for example, "This/StatsArchivalOn". This is a change in behavior over versions earlier than WebSphere Message Broker V7.
objectAndPropertyName
- The name of the property to be reportedConfigManagerProxyPropertyNotInitializedException
- if
if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.java.lang.IllegalArgumentException
- if objectAndPropertyName is not a valid syntax.public void setUserDefinedProperty(java.lang.String propertyName, java.lang.Object propertyValue) throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
propertyName
- The property name of the property being manipulatedpropertyValue
- The new value to associate with the propertyConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if propertyName is not of the correct syntax.public java.lang.Object getUserDefinedProperty(java.lang.String propertyName) throws ConfigManagerProxyLoggedException, ConfigManagerProxyPropertyNotInitializedException, java.lang.IllegalArgumentException
propertyName
- The name of the property to be reportedConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the property
does not exist or its data type is not supported.java.lang.IllegalArgumentException
- if propertyName is not of the correct syntax.public java.util.Enumeration<MessageFlowProxy.Node> getNodes() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void enableBasicStatistics() throws ConfigManagerProxyLoggedException
public void setStatisticsEnabled(boolean isSnapshot, boolean isEnabled) throws ConfigManagerProxyLoggedException
isSnapshot
- If true, the configuration of snapshot statistics
will be modified. If false, the parameter for archive statistics
will be modified.isEnabled
- If true, statistics gathering will be enabled.
If false, statistics gathering will be disabled.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public boolean getStatisticsEnabled(boolean isSnapshot) throws ConfigManagerProxyPropertyNotInitializedException
isSnapshot
- If true, the configuration of snapshot statistics
will be returned. If false, the parameter for archive statistics
will be returned.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setStatisticsNodeDetailLevel(boolean isSnapshot, int detailLevel) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
isSnapshot
- If true, the configuration of snapshot statistics
will be modified. If false, the parameter for archive statistics
will be modified.detailLevel
- Level of detail to configure: 0=none; 1=basic; 2=advanced.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if the supplied parameter is not
0, 1 or 2.public int getStatisticsNodeDetailLevel(boolean isSnapshot) throws ConfigManagerProxyPropertyNotInitializedException
isSnapshot
- If true, the configuration of snapshot statistics
will be returned. If false, the parameter for archive statistics
will be returned.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setStatisticsOutputFormat(boolean isSnapshot, java.lang.String outputFormat) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
isSnapshot
- If true, the configuration of snapshot statistics
will be modified. If false, the parameter for archive statistics
will be modified.outputFormat
- Valid formats are:ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if the supplied outputFormat
parameter is not valid.public void setStatisticsOutputFormat(boolean isSnapshot, java.lang.String outputFormats, boolean replaceExistingFormats) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
isSnapshot
- If true, the configuration of snapshot statistics
will be modified. If false, the parameter for archive statistics
will be modified.outputFormats
- Valid formats are:ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if the supplied outputFormat
parameter is not valid.public java.lang.String getStatisticsOutputFormat(boolean isSnapshot) throws ConfigManagerProxyPropertyNotInitializedException
isSnapshot
- If true, the configuration of snapshot statistics
will be returned. If false, the parameter for archive statistics
will be returned.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setStatisticsThreadDetailLevel(boolean isSnapshot, int detailLevel) throws ConfigManagerProxyLoggedException, java.lang.IllegalArgumentException
isSnapshot
- If true, the configuration of snapshot statistics
will be modified. If false, the parameter for archive statistics
will be modified.detailLevel
- Level of detail to configure: 0=none; 1=basic.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.java.lang.IllegalArgumentException
- if the supplied parameter is not
0 or 1.public int getStatisticsThreadDetailLevel(boolean isSnapshot) throws ConfigManagerProxyPropertyNotInitializedException
isSnapshot
- If true, the configuration of snapshot statistics
will be returned. If false, the parameter for archive statistics
will be returned.ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public void setStatisticsAccountingOrigin(boolean isSnapshot, java.lang.String accountingOrigin) throws ConfigManagerProxyLoggedException
isSnapshot
- If true, the configuration of snapshot statistics
will be modified. If false, the parameter for archive statistics
will be modified.accountingOrigin
- New accounting origin for the message flow.ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public java.lang.String getStatisticsAccountingOrigin(boolean isSnapshot) throws ConfigManagerProxyPropertyNotInitializedException
isSnapshot
- If true, the configuration of snapshot statistics
will be returned. If false, the parameter for archive statistics
will be returned.ConfigManagerProxyPropertyNotInitializedException
public void resetArchiveStatistics() throws ConfigManagerProxyLoggedException
ConfigManagerProxyLoggedException
- if the request could not be
sent to the broker. If synchronous updates have been enabled using
BrokerProxy.setSynchronous(), subclasses of this exception type will
also be thrown if the request is rejected by the broker, or if the
request is not processed before a timeout occurs.public MessageFlowProxy.Node getNodeByName(java.lang.String name) throws ConfigManagerProxyPropertyNotInitializedException
name
- node nameConfigManagerProxyPropertyNotInitializedException
- if the node list could not be determined because
information was not supplied from the broker before a
timeout occurred.public java.util.Enumeration<MessageFlowProxy.NodeConnection> getNodeConnections() throws ConfigManagerProxyPropertyNotInitializedException
ConfigManagerProxyPropertyNotInitializedException
- if the value of the parameter could not be determined because
the information was not supplied from the broker before a
timeout occurred.public ActivityLogProxy getActivityLog() throws ConfigManagerProxyPropertyNotInitializedException, ConfigManagerProxyLoggedException
ConfigManagerProxyPropertyNotInitializedException
- if the log could not be retrieved because
the information was not supplied from the broker before a
timeout occurred.ConfigManagerProxyLoggedException
- if the log could not be created because
the information was not supplied from the broker before a
timeout occurred.