com.ibm.broker.config.proxy

Class SubFlowProxy

  • All Implemented Interfaces:
    DeployableObject, DeployedObject


    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
     
    • Method Detail

      • getConfigurationObjectType

        public ConfigurationObjectType getConfigurationObjectType()
        Returns the ConfigurationObjectType associated with this AdministeredObject type.
        Overrides:
        getConfigurationObjectType in class FlowProxy
        Returns:
        ConfigurationObjectType associated with this class.
      • getDeployedPolicySetNames

        public MessageFlowProxy.PolicySetName[] getDeployedPolicySetNames()
                                                                   throws ConfigManagerProxyPropertyNotInitializedException
        Return the names of the PolicySets in use by this subflow.
        Returns:
        PolicySetName[] the names of the PolicySets. Each object in this array represents the name of a PolicySet associated with this subflow when it was deployed. If no PolicySet objects were associated with this subflow, the returned array will be empty. See the description of the PolicySetName class.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getDeployedPolicySetBindingsNames

        public MessageFlowProxy.PolicySetBindingsName[] getDeployedPolicySetBindingsNames()
                                                                                   throws ConfigManagerProxyPropertyNotInitializedException
        Asks the broker to return the names of the PolicySetBindings in use by this subflow.
        Returns:
        PolicySetBindingsName[] the names of the PolicySetBindings. Each object in this array represents the name of a PolicySetBindings associated with this subflow when it was deployed. If no PolicySetBindings objects were associated with this message flow, the returned array will be empty. See the description of the PolicySetBindingsName class.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getNodeByName

        public MessageFlowProxy.Node getNodeByName(java.lang.String name)
                                            throws ConfigManagerProxyPropertyNotInitializedException
        Returns the node with the supplied name. If the flow contains more than one node of the same name, the returned result is arbitrary. If the flow does not contain any node with the supplied name, null is returned. Node names are case sensitive.
        Parameters:
        name - node name
        Returns:
        MessageFlowProxy.Node Node that has the supplied name, or null if the node could not be found.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the node list could not be determined because information was not supplied from the broker before a timeout occurred.
      • withUUID

        public 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. This provides an easy way of supplying filters to the get* calls. For example, broker1.getExecutionGroup(ExecutionGroup.withUUID("1234")); will return the Execution Group with UUID "1234" that exists in broker1.
        Returns:
        Properties a new Properties object with the relevant key/value pairs set.
      • withName

        public 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. This provides an easy way of supplying filters to the get* calls. For example, broker1.getExecutionGroup(ExecutionGroup.withName("eg1")); will return the Execution Group with Name "eg1" that exists in broker1.
        Returns:
        Properties a new Properties object with the relevant key/value pairs set.