public class FlowProxy extends AdministeredObject implements DeployedObject
This is the superclass from which message flows and subflows inherit.
The class provides a set of methods common to all these types, such as the setting and getting of common attributes and the ability to access node and connection details.
com.ibm.broker.config.proxy.FlowProxy extends
com.ibm.broker.config.proxy.AdministeredObject implements
com.ibm.broker.config.proxy.DeployedObject
|
|
Responsibilities | Represents the state of a message flow or subflow that has been deployed to an integration server. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 2014-06-16 HDCAB v10000 Release
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier and Type | Method and Description |
---|---|
boolean |
fullNameMatches(java.lang.String fileName)
Tests if the name of this deployed object matches the
fileName passed in.
|
java.lang.String |
getBARFileName()
Returns the name of the BAR file that was used to deploy the
flow to the integration server.
|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
ConfigurationObjectType |
getConfigurationObjectTypeOfParent()
Returns the ConfigurationObjectType associated
with the logical parent of this AdministeredObject type.
|
java.util.Properties |
getDeployProperties()
Returns a list of the properties associated with the
deployment of this flow.
|
java.util.Date |
getDeployTime()
Returns the time that the current flow was last deployed to
the integration server.
|
ExecutionGroupProxy |
getExecutionGroup()
Returns a reference to the integration server on which this
flow was deployed.
|
java.lang.String |
getFileExtension()
Returns the file extension relevant to 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.
|
java.util.Date |
getModifyTime()
Returns the time that the current 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 flow.
|
java.lang.String[] |
getQueues()
Returns a list of the MQ queues referenced by this 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.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.
|
java.lang.String |
getVersion()
Returns the version string associated with the current flow.
|
void |
setRuntimeProperties(java.util.Properties props)
Asks the broker to configure an arbitrary set of flow
properties.
|
void |
setRuntimeProperty(java.lang.String objectAndPropertyName,
java.lang.String propertyValue)
Asks the broker to configure an arbitrary flow property.
|
void |
setUserDefinedProperty(java.lang.String propertyName,
java.lang.Object propertyValue)
Asks the broker to configure a flow's user-defined property.
|
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, withName, withUUID
getClass, hashCode, notify, notifyAll, wait, wait, wait
getName
public java.lang.String getFileExtension()
getFileExtension
in interface DeployableObject
DeployableObject.getFileExtension()
public boolean fullNameMatches(java.lang.String fileName) throws ConfigManagerProxyPropertyNotInitializedException
fullNameMatches
in interface DeployedObject
ConfigManagerProxyPropertyNotInitializedException
- 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.public java.util.Date getModifyTime()
getModifyTime
in interface DeployableObject
DeployableObject.getModifyTime()
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 java.util.Date getDeployTime()
getDeployTime
in interface DeployedObject
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
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.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 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 java.lang.String[] getRuntimePropertyNames()
Only properties that have explicitly been set on the 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 void setRuntimeProperties(java.util.Properties props) 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 integration server'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.
props
- A set of properties to set on all flows
owned by the library. The key is the complete object and
property name of the property being manipulated, for example
"This/StatsSnapPublicationOn". The value is 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 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 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 integration server'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[] getUserDefinedPropertyNames()
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.lang.String[] getQueues() throws ConfigManagerProxyPropertyNotInitializedException
This method will return an empty array if the 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.