public class SubFlowProxy extends FlowProxy
Represents a subflow that has been deployed to an execution group.
In order to use SubFlowProxy objects, applications must first obtain handles to them. Here is an example of how to do this:
BrokerProxy b = BrokerProxy.getLocalInstance("BrokerName"); ExecutionGroupProxy e = b.getExecutionGroupByName("default"); MessageFlowProxy m = e.getSubFlowByName("subflow1");
com.ibm.broker.config.proxy.SubFlowProxy extends
com.ibm.broker.config.proxy.FlowProxy implements
com.ibm.broker.config.proxy.DeployedObject
|
|
Responsibilities | Represents the state of a subflow that has been deployed to an execution group. |
Internal Collaborators | None |
Change Activity: -------- ----------- ------------- ------------------------------------ Reason: Date: Originator: Comments: -------- ----------- ------------- ------------------------------------ 2014-06-16 HDCAB v10 Release
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier and Type | Method and Description |
---|---|
ConfigurationObjectType |
getConfigurationObjectType()
Returns the ConfigurationObjectType associated
with this AdministeredObject type.
|
MessageFlowProxy.PolicySetBindingsName[] |
getDeployedPolicySetBindingsNames()
Asks the broker to return the names of the PolicySetBindings
in use by this subflow.
|
MessageFlowProxy.PolicySetName[] |
getDeployedPolicySetNames()
Return the names of the PolicySets in use by this subflow.
|
java.lang.String |
getFileExtension()
Returns the file extension relevant to sub flows, not
preceded by a '.' character.
|
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
flow.
|
java.util.Enumeration<MessageFlowProxy.Node> |
getNodes()
Returns an Enumeration of the Node objects that comprise this
flow.
|
void |
setName(java.lang.String name)
This method overrides the base class
implementation, so that an exception is thrown if this method
is invoked against this class.
|
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.
|
fullNameMatches, getBARFileName, getConfigurationObjectTypeOfParent, getDeployProperties, getDeployTime, getExecutionGroup, getFullName, getKeywords, getKeywordValue, getModifyTime, getNodeTypes, getQueues, getRuntimeProperty, getRuntimePropertyNames, getUserDefinedProperty, getUserDefinedPropertyNames, getVersion, setRuntimeProperties, setRuntimeProperty, setUserDefinedProperty
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, setProperties, setShortDescription, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates
getClass, hashCode, notify, notifyAll, wait, wait, wait
getName
public ConfigurationObjectType getConfigurationObjectType()
getConfigurationObjectType
in class FlowProxy
public java.lang.String getFileExtension()
getFileExtension
in interface DeployableObject
getFileExtension
in class FlowProxy
DeployableObject.getFileExtension()
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.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 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 static java.util.Properties withUUID(java.lang.String uuid)
public static java.util.Properties withName(java.lang.String name)
public void setName(java.lang.String name) throws ConfigManagerProxyLoggedException
setName
in class AdministeredObject
name
- (this is ignored)ConfigManagerProxyLoggedException
- to indicate this
method should not be called.