com.ibm.broker.config.proxy

Class MessageFlowProxy

  • All Implemented Interfaces:
    DeployableObject, DeployedObject


    public class MessageFlowProxy
    extends FlowProxy
    Represents a message flow that has been deployed to an integration server. In order to use MessageFlowProxy objects, applications must first obtain handles to them. Here is an example of how to do this:
         BrokerProxy b = BrokerProxy.getInstance(
             new IntegrationNodeConnectionParameters("localhost", 4414)); 
         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 integration server.
    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()
     
    • Method Detail

      • start

        public void start()
                   throws ConfigManagerProxyLoggedException
        Asks the broker to start the message flow. If the message flow is already started, the broker will do nothing.
        Throws:
        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.
      • stop

        public void stop(boolean immediate)
                  throws ConfigManagerProxyLoggedException
        Deprecated. The immediate flag is ignored. Use stop() instead.
        Asks the broker to stop the message flow. The message flow will stop processing new units of work, and any current units of work will be allowed to complete. If the message flow is already stopped, the broker will do nothing.
        Parameters:
        immediate - Not used
        Throws:
        ConfigManagerProxyLoggedException - if the request to start the message flow could not be sent to the broker.
      • stop

        public void stop()
                  throws ConfigManagerProxyLoggedException
        Asks the broker to stop the message flow. The message flow will stop processing new units of work, and any current units of work will be allowed to complete. If the message flow is already stopped, the broker will do nothing.
        Throws:
        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.
      • stop

        public void stop(BrokerProxy.StopMode stopMode)
                  throws ConfigManagerProxyLoggedException
        Asks the broker to stop the message flow. If the message flow is already stopped, the broker will do nothing.
        Parameters:
        stopMode - If set to StopMode.normal, then the message flow will stop processing new units of work, and any current units of work will be allowed to complete. If set to StopMode.restartExecutionGroup, then the integration server will be immediately restarted. When the integration server has restarted, the message flow will be in the stopped state.
        Throws:
        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.
      • getUserTrace

        public MessageFlowProxy.UserTrace getUserTrace()
                                                throws ConfigManagerProxyPropertyNotInitializedException
        Returns the current state of user trace for this message flow
        Returns:
        MessageFlowProxy.UserTrace One of:
        • MessageFlowProxy.UserTrace.normal means that normal user trace is enabled
        • MessageFlowProxy.UserTrace.debug means that debug user trace is enabled
        • MessageFlowProxy.UserTrace.none means that user trace is disabled
        • MessageFlowProxy.UserTrace.unknown means that user trace settings are unknown
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the field could not be determined because the value has not yet been supplied to from the broker.
      • setUserTrace

        public void setUserTrace(MessageFlowProxy.UserTrace newTrace)
                          throws ConfigManagerProxyLoggedException

        Configures the user trace setting for the current flow.

        Parameters:
        newTrace - One of:
        • MessageFlowProxy.UserTrace.normal to enable normal user trace
        • MessageFlowProxy.UserTrace.debug to enable debug user trace
        • MessageFlowProxy.UserTrace.none to disable user trace
        Throws:
        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.
      • setServiceTrace

        public void setServiceTrace(MessageFlowProxy.UserTrace newTrace)
                             throws ConfigManagerProxyLoggedException
        Configures the service trace setting for the message flow. Changes take effect immediately.
        Parameters:
        newTrace - One of:
        • MessageFlowProxy.UserTrace.normal to enable normal service trace
        • MessageFlowProxy.UserTrace.debug to enable debug service trace
        • MessageFlowProxy.UserTrace.none to disable service trace
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • getStartMode

        public java.lang.String getStartMode()
                                      throws ConfigManagerProxyPropertyNotInitializedException
        Returns the current value of start mode for this message flow
        Returns:
        String One of:
        • AttributeConstants.STARTMODE_MAINTAINED which means at deploy time or restart the message flow will start based on its isRunEnabled value.
        • AttributeConstants.STARTMODE_MANUAL which means at deploy time or restart the message flow will be stopped.
        • AttributeConstants.STARTMODE_AUTOMATIC which means at deploy time or restart the message flow will be running.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the field could not be determined because the value has not yet been supplied to from the broker.
      • setStartMode

        public void setStartMode(java.lang.String newStartMode)
                          throws ConfigManagerProxyLoggedException

        Configures the start mode setting for the current flow.

        Parameters:
        newStartMode - One of:
        • AttributeConstants.STARTMODE_MAINTAINED which means at deploy time or restart the message flow will start based on its isRunEnabled value.
        • AttributeConstants.STARTMODE_MANUAL which means at deploy time or restart the message flow will be stopped.
        • AttributeConstants.STARTMODE_AUTOMATIC which means at deploy time or restart the message flow will be running.
        Throws:
        ConfigManagerProxyLoggedException
      • isRunning

        public boolean isRunning()
                          throws ConfigManagerProxyPropertyNotInitializedException
        Returns true only if the message flow is currently running. This method reports the actual runstate of the message flow; use isRunEnabled() to report whether the message flow is configured to run when the integration server starts (which can return true even if the integration server process is stopped).
        Returns:
        boolean True if and only if the flow is running.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the run state could not be determined from the broker.
      • isRunEnabled

        public boolean isRunEnabled()
                             throws ConfigManagerProxyPropertyNotInitializedException
        Returns true only if the message flow is able to run when the integration server is started. This method reports the logical runstate of the message flow, which means that it can return 'true' even if the integration server in which the message flow is deployed is currently stopped. Use isRunning() to report whether the message flow is currently running.
        Returns:
        boolean True if and only if the flow is able to run when the integration server is started.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the run state could not be determined from the broker.
      • setAdditionalInstances

        public void setAdditionalInstances(int newValue)
                                    throws ConfigManagerProxyLoggedException
        Asks the broker to directly set the number of additional thread instances for this message flow. A value of 0 means that one OS thread is assigned to the message flow. Each subsequent integer causes one additional thread to be associated with the message flow.
        Parameters:
        newValue - New number of additional threads
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • setWlmPolicy

        public void setWlmPolicy(java.lang.String newValue)
                          throws ConfigManagerProxyLoggedException
        Asks the broker to directly set the WLM policy for this message flow. A value of "" means that there is no WLM policy set. The WLM policy is used to configure workload management properties for the message flow.
        Parameters:
        newValue - The WLM policy to use.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • setNotificationThresholdMsgsPerSec

        public void setNotificationThresholdMsgsPerSec(int newValue)
                                                throws ConfigManagerProxyLoggedException
        Asks the broker to directly set the notification threshold for this message flow. A value of 0 means that there is no notification threshold. .....* A notification is published by the message flow when ever the threshold is exceeded or dropped below.
        Parameters:
        newValue - New notification threshold in messages per second
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • setMaximumRateMsgsPerSec

        public void setMaximumRateMsgsPerSec(int newValue)
                                      throws ConfigManagerProxyLoggedException
        Asks the broker to directly set the maximum rate for this message flow. A value of 0 means that there is no maximum rate. The message flow processing is delayed if the maximum rate is exceeded.
        Parameters:
        newValue - New maximum rate in messages per second
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker.
      • getCommitCount

        public int getCommitCount()
                           throws ConfigManagerProxyPropertyNotInitializedException
        Returns the configured value of the "commit count" parameter, which is the number of MQ messages to process before a syncpoint is taken.
        Returns:
        int Configured value of the commit count parameter
        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.
      • setTestRecordMode

        public void setTestRecordMode(java.lang.String newTestRecordMode)
                               throws ConfigManagerProxyLoggedException
        Configures the record mode setting for this message flow.
        Parameters:
        newTestRecordMode - One of:
        • AttributeConstants.MODE_ENABLED
        • AttributeConstants.MODE_DISABLED
        Throws:
        ConfigManagerProxyLoggedException
      • getConfigurationObjectType

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

        public void enableBasicStatistics()
                                   throws ConfigManagerProxyLoggedException
        Configures a standard set of snapshot statistics properties for the message flow and enables the gathering of these statistics. This method is logically equivalent to:
        • MessageFlowProxy.setStatisticsNodeDetailLevel(true, 1);
        • MessageFlowProxy.setStatisticsThreadDetailLevel(true, 1);
        • MessageFlowProxy.setStatisticsOutputFormat(true, "xml");
        • MessageFlowProxy.setStatisticsEnabled(true, true);
        The enableBasicStatistics() method is provided for convenience, but also for performance as this method sends only a single configuration request to the broker, as opposed to the four requests that calling the above separately would create.
        Throws:
        ConfigManagerProxyLoggedException
      • setStatisticsEnabled

        public void setStatisticsEnabled(boolean isSnapshot,
                                         boolean isEnabled)
                                  throws ConfigManagerProxyLoggedException
        Enables or disables the gathering of statistics for the message flow. This is the equivalent of running mqsichangeflowstats -c active|inactive for the current message flow.
        Parameters:
        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.
        Throws:
        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.
      • getStatisticsEnabled

        public boolean getStatisticsEnabled(boolean isSnapshot)
                                     throws ConfigManagerProxyPropertyNotInitializedException
        Returns true only if statistics gathering is enabled for the message flow.
        Parameters:
        isSnapshot - If true, the configuration of snapshot statistics will be returned. If false, the parameter for archive statistics will be returned.
        Returns:
        boolean true if and only if statistics is enabled
        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.
      • setStatisticsNodeDetailLevel

        public void setStatisticsNodeDetailLevel(boolean isSnapshot,
                                                 int detailLevel)
                                          throws ConfigManagerProxyLoggedException,
                                                 java.lang.IllegalArgumentException
        Sets the detail level of node statistics to gather for the message flow. This is the equivalent of running mqsichangeflowstats -n none|basic|advanced for the current message flow.
        Parameters:
        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.
        Throws:
        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.
      • getStatisticsNodeDetailLevel

        public int getStatisticsNodeDetailLevel(boolean isSnapshot)
                                         throws ConfigManagerProxyPropertyNotInitializedException
        Returns the node statistics detail level for the message flow.
        Parameters:
        isSnapshot - If true, the configuration of snapshot statistics will be returned. If false, the parameter for archive statistics will be returned.
        Returns:
        int node detail level: 0=none; 1=basic; 2=advanced.
        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.
      • setStatisticsOutputFormat

        public void setStatisticsOutputFormat(boolean isSnapshot,
                                              java.lang.String outputFormat)
                                       throws ConfigManagerProxyLoggedException,
                                              java.lang.IllegalArgumentException
        Configures the output format of statistics for the message flow. This is the equivalent of running mqsichangeflowstats -o usertrace|xml|smf|json for the current message flow.
        Parameters:
        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:
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_USERTRACE / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_USERTRACE
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_JSON / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_JSON
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_XML / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_XML
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_SMF / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_SMF
        Throws:
        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.
        Since:
        This method adds output formats to the existing list of formats. To overwrite the list of formats, set 'replaceExistingFormats' to true. Also, multiple formats can be now specified, using a comma-separated list
      • setStatisticsOutputFormat

        public void setStatisticsOutputFormat(boolean isSnapshot,
                                              java.lang.String outputFormats,
                                              boolean replaceExistingFormats)
                                       throws ConfigManagerProxyLoggedException,
                                              java.lang.IllegalArgumentException
        Configures the output format of statistics for the message flow. This is the equivalent of running mqsichangeflowstats -o [+/-]usertrace|xml|smf|json for the current message flow.
        Parameters:
        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:
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_USERTRACE / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_USERTRACE
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_JSON / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_JSON
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_XML / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_XML
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_SMF / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_SMF
        From Version 9 onwards multiple formats can be specified, by specifying a + or - to add a format without removing the existing one
        Throws:
        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.
      • getStatisticsOutputFormat

        public java.lang.String getStatisticsOutputFormat(boolean isSnapshot)
                                                   throws ConfigManagerProxyPropertyNotInitializedException
        Returns the output format of statistics for the message flow.
        Parameters:
        isSnapshot - If true, the configuration of snapshot statistics will be returned. If false, the parameter for archive statistics will be returned.
        Returns:
        String output format: One of:
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_USERTRACE / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_USERTRACE
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_XML / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_XML
        • AttributeConstants.MESSAGEFLOW_THIS_STATSARCHIVEOUTPUTFORMAT_SMF / AttributeConstants.MESSAGEFLOW_THIS_STATSSNAPOUTPUTFORMAT_SMF
        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.
      • setStatisticsThreadDetailLevel

        public void setStatisticsThreadDetailLevel(boolean isSnapshot,
                                                   int detailLevel)
                                            throws ConfigManagerProxyLoggedException,
                                                   java.lang.IllegalArgumentException
        Sets the detail level of thread statistics to gather for the message flow. This is the equivalent of running mqsichangeflowstats -t none|basic for the current message flow.
        Parameters:
        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.
        Throws:
        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.
      • getStatisticsThreadDetailLevel

        public int getStatisticsThreadDetailLevel(boolean isSnapshot)
                                           throws ConfigManagerProxyPropertyNotInitializedException
        Returns the thread statistics detail level for the message flow.
        Parameters:
        isSnapshot - If true, the configuration of snapshot statistics will be returned. If false, the parameter for archive statistics will be returned.
        Returns:
        int thread detail level: 0=none; 1=basic.
        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.
      • setStatisticsAccountingOrigin

        public void setStatisticsAccountingOrigin(boolean isSnapshot,
                                                  java.lang.String accountingOrigin)
                                           throws ConfigManagerProxyLoggedException
        Configures the accounting origin for the message flow. This is the equivalent of running mqsichangeflowstats -b for the current message flow.
        Parameters:
        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.
        Throws:
        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.
      • getStatisticsAccountingOrigin

        public java.lang.String getStatisticsAccountingOrigin(boolean isSnapshot)
                                                       throws ConfigManagerProxyPropertyNotInitializedException
        Returns the accounting origin for the message flow.
        Parameters:
        isSnapshot - If true, the configuration of snapshot statistics will be returned. If false, the parameter for archive statistics will be returned.
        Returns:
        String accounting origin 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.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException
      • resetArchiveStatistics

        public void resetArchiveStatistics()
                                    throws ConfigManagerProxyLoggedException
        Causes the archive of statistics to be reset for the message flow. This is the equivalent of running mqsichangeflowstats -r for the current message flow.
        Throws:
        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.
      • getDeployedPolicySetNames

        public MessageFlowProxy.PolicySetName[] getDeployedPolicySetNames()
                                                                   throws ConfigManagerProxyPropertyNotInitializedException
        Return the names of the PolicySets in use by this message flow.
        Returns:
        PolicySetName[] the names of the PolicySets. Each object in this array represents the name of a PolicySet associated with this message flow when it was deployed. If no PolicySet objects were associated with this message flow, 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 message flow.
        Returns:
        PolicySetBindingsName[] the names of the PolicySetBindings. Each object in this array represents the name of a PolicySetBindings associated with this message flow 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.