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
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
copyright
IBM Copyright
|
protected static java.lang.String |
sccsid
Version information
|
baseRetryWaitTime, LOCAL_ATTRIBUTE_IDENTIFIER, maxRetries, objectUnavailable, owningPool, potentialNewSubcomponents, propertyUpdateLock, retryWaitTimeIncrement, subcomponentsToBeSubmittedForCreationInCurrentBatch, UUID_DELIMITER
BARNAME_KEYWORD, USAGE_KEYWORD, VERSION_KEYWORD
Modifier | Constructor and Description |
---|---|
protected |
SubFlowProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
DO NOT USE THIS CONSTRUCTOR - use
ExecutionGroupProxy.getSubFlowByName() instead.
|
protected |
SubFlowProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop,
ConfigurationObjectType inParentType) |
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.
|
protected void |
setLocalProperty(java.lang.String key,
java.lang.String value)
We override the setLocalProperty method of AdministeredObject
so that we can target flow design related attributes to our
internal message flow representation.
|
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, getElements, getExecutionGroup, getFullName, getKeywords, getKeywordValue, getModifyTime, getNodeTypes, getQueues, getRuntimeProperty, getRuntimePropertyNames, getUserDefinedProperty, getUserDefinedPropertyNames, getVersion, setRuntimeProperties, setRuntimeProperty, setUserDefinedProperty
checkTypeAndBase64DecodePropertyValue, checkTypeAndBase64EncodePropertyValue, clearPredictedNewSubcomponents, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, createManagedSubcomponent, deleteManagedSubcomponents, deregisterListener, deregisterListener, elements, equals, execute, getAdvancedProperties, getAdvancedProperties, getBasicProperties, getBasicProperties, getGrandParentUUIDProperties, getLastBIPMessages, getLastCompletionCode, getLastUpdateUser, getLongDescription, getManagedSubcomponent, getManagedSubcomponentFromStringRepresentation, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponents, getManagedSubcomponentsAsStrings, getManagedSubcomponentsAsStrings, getName, getNumberOfSubcomponents, getParent, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getProperty, getPropertyBaseName, getPropertyInt, getPropertyInternal, getRefreshRequired, getRepositoryTimestamp, getShortDescription, getTimeOfLastCompletionCode, getTimeOfLastUpdate, getType, getUUID, getUUIDOfGrandParent, getUUIDOfParent, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenPopulatedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByBroker, hasBeenRestrictedByConfigManager, hasBeenRestrictedByConfigManager, hasBeenUpdatedByConfigManager, hasBeenUpdatedByConfigManager, isAUserDefinedObjectDestructor, isAwaitingSubmissionForCreation, isAwaitingSubmissionForDeletion, isDeployed, isLastPropertyIdentifier, isPartOfAPropertyGroup, isShared, predictPropertiesOfNewObject, refresh, refresh, registerListener, registerListener, registerListener, removeLocalProperty, setIsAwaitingSubmissionForCreation, setIsAwaitingSubmissionForDeletion, setLastBIPMessages, setLastCompletionCode, setLongDescription, setProperties, setProperties, setRefreshRequired, setShortDescription, setTimeOfLastUpdate, toString, toVerboseString, unsubscribeFromConfigurationManagerUpdates, validateObjectAndPropertyName, validateServiceObjectAndPropertyName
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getName
protected static final java.lang.String copyright
protected static final java.lang.String sccsid
protected SubFlowProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop)
aop
- The pool that will own this object.protected SubFlowProxy(com.ibm.broker.config.proxy.AdministeredObjectPool aop, ConfigurationObjectType inParentType)
protected void setLocalProperty(java.lang.String key, java.lang.String value)
setLocalProperty
in class AdministeredObject
key
- The name of the property to set.
Use the AttributeConstants.*_PROPERTY constants here.value
- The value to set the property to.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.