com.ibm.broker.config.proxy

Class DeployedObjectGroupProxy

  • Direct Known Subclasses:
    ApplicationProxy, ExecutionGroupProxy, LibraryProxy


    public abstract class DeployedObjectGroupProxy
    extends AdministeredObject
    This is the abstract superclass from which groups of deployed objects 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 traverse and manipulate the object hierarchy.

    com.ibm.broker.config.proxy.DeployedObjectGroupProxy extends com.ibm.broker.config.proxy.AdministeredObject

    Responsibilities Acts as a container of deployed message flows and resources. Provides the ability to deploy information to execution groups, applications and libraries represented by each instance.
    Internal Collaborators com.ibm.broker.config.proxy.MessageFlowProxy
    
     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     80006.1  2011-04-06  HDCAB           v8 Release
    
     
    • Method Detail

      • getMessageFlows

        public java.util.Enumeration<MessageFlowProxy> getMessageFlows(java.util.Properties filter)
                                                                throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the MessageFlowProxy objects that match the filter specified by the Properties argument.

        Note that only those message flows that are deployed directly to the current deployed object group are returned. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those message flows deployed directly to the execution group will be returned by this method, and any message flows that have been deployed as part of an application or library will not be returned. To return the message flows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.

        Parameters:
        filter - Filter to select which message flows to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all message flows directly deployed to this deployed object group,
        Returns:
        Enumeration The MessageFlowProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getSubFlows

        public java.util.Enumeration<SubFlowProxy> getSubFlows(java.util.Properties filter)
                                                        throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the SubFlowProxy objects that match the filter specified by the Properties argument.

        Note that only those subflows that are deployed directly to the current deployed object group are returned. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those subflows deployed directly to the execution group will be returned by this method, and any subflows that have been deployed as part of an application or library will not be returned. To return the subflows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.

        Parameters:
        filter - Filter to select which subflows to return. Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match all subflows directly deployed to this deployed object group,
        Returns:
        Enumeration The SubFlowProxy objects that matched the supplied filter.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if subflow information could not be determined because the information was not supplied from the broker before a timeout occurred.
        See Also:
        AttributeConstants
      • getMessageFlow

        public MessageFlowProxy getMessageFlow(java.util.Properties props)
                                        throws ConfigManagerProxyPropertyNotInitializedException
        Returns the first MessageflowProxy object that matches the filter specified by the Properties argument. If multiple message flows match the supplied filter, an arbitrary match is returned.

        Note that only those message flows that are deployed directly to the current deployed object group are accessible from this method. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those message flows deployed directly to the execution group can be returned by this method, and any message flows that have been deployed as part of an application or library cannot be returned. To return the message flows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.

        Parameters:
        props - Filter to select the MessageFlowProxy Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary message flow deployed to this deployed object group.
        Returns:
        MessageFlowProxy The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getSubFlow

        public SubFlowProxy getSubFlow(java.util.Properties props)
                                throws ConfigManagerProxyPropertyNotInitializedException
        Returns the first SubFlowProxy object that matches the filter specified by the Properties argument. If multiple message flows match the supplied filter, an arbitrary match is returned.

        Note that only those subflows that are deployed directly to the current deployed object group are accessible from this method. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those subflows deployed directly to the execution group can be returned by this method, and any subflows that have been deployed as part of an application or library cannot be returned. To return the subflows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.

        Parameters:
        props - Filter to select the SubFlowProxy Each key is an attribute name of the required object and each value is the required value of the attribute. A null or empty Properties object will match an arbitrary subflow deployed to this deployed object group.
        Returns:
        SubFlowProxy The first object that matched the supplied filter, or null if no objects matched.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if subflow information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getMessageFlowByName

        public MessageFlowProxy getMessageFlowByName(java.lang.String messageFlowName)
                                              throws ConfigManagerProxyPropertyNotInitializedException
        Returns the MessageFlowProxy object with the supplied name, or null if a flow of that name does not exist or if the supplied argument was null.

        Note that only those message flows that are deployed directly to the current deployed object group are accessible. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those message flows deployed directly to the execution group can be returned by this method, and any message flows that have been deployed as part of an application or library cannot be returned. To return the message flows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.

        Parameters:
        messageFlowName - Name of the message flow to look up
        Returns:
        MessageFlowProxy Object representing the named message flow
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getSubFlowByName

        public SubFlowProxy getSubFlowByName(java.lang.String subFlowName)
                                      throws ConfigManagerProxyPropertyNotInitializedException
        Returns the SubFlowProxy object with the supplied name, or null if a subflow of that name does not exist or if the supplied argument was null.

        Note that only those subflows that are deployed directly to the current deployed object group are accessible. This means, for example, that if the DeployedObjectGroupProxy instance represents an execution group, only those subflows deployed directly to the execution group can be returned by this method, and any subflows that have been deployed as part of an application or library cannot be returned. To return the subflows deployed as part of one of these containers, the caller must use the same method on the relevant ApplicationProxy or LibraryProxy.

        Parameters:
        subFlowName - Name of the subflow to look up
        Returns:
        SubFlowProxy Object representing the named message subflow
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if subflow information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • startMessageFlows

        public void startMessageFlows()
                               throws ConfigManagerProxyLoggedException
        Asks the broker to start all message flows in the deployed object group. The object group is assumed to be running; use DeployedObjectGroupProxy.start() to start the container (such as the execution group process).
        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.
      • stopMessageFlows

        public void stopMessageFlows(boolean immediate)
                              throws ConfigManagerProxyLoggedException
        Deprecated. The immediate flag is ignored. Use stopMessageFlows() instead.
        Stops all message flows in the deployed object group.
        Parameters:
        immediate - Not used
        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.
      • stopMessageFlows

        public void stopMessageFlows()
                              throws ConfigManagerProxyLoggedException
        Stops all message flows in the deployed object group, but allows the object group container (e.g. execution group process) to continue to run. All message flows deployed to the object group will be stopped once they have finished their current unit of work. Alternatively, consider using DeployedObjectGroupProxy.stop() to stop the object group completely.
        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.
      • getMessageSets

        public java.util.Enumeration<DeployedObject> getMessageSets()
                                                             throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the message sets deployed to the current object group. The enumeration will have no elements if no message sets are deployed.

        This method is the same as calling getDeployedObjects("dictionary").

        Returns:
        Enumeration Containing DeployedObject objects representing message sets.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if message set information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getDeployedObjectByName

        public DeployedObject getDeployedObjectByName(java.lang.String filename)
                                               throws ConfigManagerProxyPropertyNotInitializedException
        Returns a reference to the deployed object with the supplied name (e.g. "mset1") or full name (e.g. "mset1.dictionary") that is deployed directly to the current object group.

        If there is more than one dependency that matches the supplied filter, an arbitrary (unspecified) match is returned.

        This method discovers deployed objects that are required by message flows in order to run (e.g. message sets). In order to discover message flows themselves, use getMessageFlowByName() instead.

        Parameters:
        filename - A non-null value means to return the object with the supplied name. A null value will return an arbitrary object deployed to this object group.
        Returns:
        DeployedObject the matched object, or null if and only if a match could not be found.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if deployed object information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getMessageFlowDependencies

        public java.util.Enumeration<DeployedObject> getMessageFlowDependencies()
                                                                         throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the dependencies directly deployed to the current object group.

        This method discovers deployed objects that might be required by message flows in order to run (e.g. message sets). In order to discover everything deployed to this object group (i.e. including message flows themselves), use getDeployedObjects() instead.

        Returns:
        Enumeration Containing DeployedObject objects representing all dependencies deployed to this object group.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if dependency information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getDeployedObjects

        public java.util.Enumeration<DeployedObject> getDeployedObjects()
                                                                 throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the objects directly deployed to the current object group. This method is the same as calling getDeployedObjects(null).

        This method discovers all objects deployed on the object group, including message flows, message sets and others.

        Returns:
        Enumeration Containing DeployedObject objects. Each element represents one object deployed to this object group.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if deployed object information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getDeployedObjects

        public java.util.Enumeration<DeployedObject> getDeployedObjects(java.lang.String fileExtension)
                                                                 throws ConfigManagerProxyPropertyNotInitializedException
        Returns an Enumeration of all the deployed objects with the supplied extension that are directly deployed to the current object group. The enumeration will have no elements if no matching objects are deployed.
        Parameters:
        fileExtension - A non-null value means to filter the results so only those dependencies with the supplied file extension are returned. A null value will return all dependencies deployed to this execution group.
        Returns:
        Enumeration Containing DeployedObject objects. Each element represents one object deployed to the object group.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if deployed object information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getDeployedObjectsCount

        public int getDeployedObjectsCount(java.lang.String name)
                                    throws ConfigManagerProxyPropertyNotInitializedException
        Returns the number of deployed objects that match the supplied name. Use this method before calling deleteDeployedObjectsByName() to ensure that the object being deleted is not ambiguously specified; a value greater than one means that the name requires greater precision. To avoid ambiguity, always specify deployed objects for deletion with their correct file extension; for example, "flow1.cmf" rather than "flow".
        Parameters:
        name - Name of the object to match
        Returns:
        int number of objects deployed to this execution group that match the supplied criterion.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the deployed objects count could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getDeployedObjectFromSubcomponentString

        public DeployedObject getDeployedObjectFromSubcomponentString(java.lang.String subcomponentString)
        If the supplied string is the value part of a property in the dependency or subcomponent groups, AND it represents a DeployedObject instance, this method returns a DeployedObject instance that represents it. Otherwise, this method returns null. If this method is used on a subcomponent string that is part of the removedChildren list in the AdvancedAdministeredObjectListener processModify method, null will be returned because the deployed object has been removed.
        Parameters:
        subcomponentString - String representation of a subcomponent
        Returns:
        DeployedObject describing the object, or null if the string did not represent a deployable object or the deployable object has been deleted.
      • setUserTrace

        public void setUserTrace(MessageFlowProxy.UserTrace newTrace)
                          throws ConfigManagerProxyLoggedException,
                                 ConfigManagerProxyPropertyNotInitializedException
        Iterates through every deployed message flow configuring its user trace settings.
        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 or if the current user is not authorized to view the list of message flows on this execution group. 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.
        ConfigManagerProxyPropertyNotInitializedException - if message flow information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • deploy

        public DeployResult deploy(java.lang.String barFileName,
                                   boolean isIncremental,
                                   long timeToWaitMs)
                            throws ConfigManagerProxyLoggedException,
                                   java.io.IOException
        Starts a deploy of the Bar file pointed to by the supplied filename, to the object group.
        Parameters:
        barFileName - Path and file name of the Bar file, relative to the current directory.
        isIncremental - If true, the contents of the Bar file will add or modify what has already been deployed on the execution group. If false, the contents of the execution group will be completely cleared before deployment (also known as a "complete" deploy).
        timeToWaitMs - A positive value describes the maximum length of time to wait for broker responses (in milliseconds) before returning the DeployResult. Alternatively:
        • A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
        • A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
        • A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until responses have been received from the broker.
        • If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
        • If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deployment, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.
        Returns:
        DeployResult object that can be used to query the results of the deployment.
        Throws:
        ConfigManagerProxyLoggedException - if the Bar file could not be sent to the broker.
        java.io.FileNotFoundException - if the Bar file could not be found
        java.io.IOException - if the file could not be closed. In this case the deployment might have succeeded.
      • deploy

        public DeployResult deploy(java.io.InputStream barStream,
                                   java.lang.String barFileLabel,
                                   boolean isIncremental,
                                   long timeToWaitMs)
                            throws ConfigManagerProxyLoggedException
        Starts a deploy of the Bar file, whose contents are embedded in the supplied InputStream, to the object group.
        Parameters:
        barStream - InputStream containing the BAR file contents. The first byte read by the stream must be the first byte of the Bar file's contents.
        barFileLabel - the name of the Bar file being deployed. Every DeployedObject that results from this deployment will return this value (which may be null) from the getBARFileName() method.
        isIncremental - If true, the contents of the Bar file will add or modify what has already been deployed on the execution group. If false, the contents of the execution group will be completely cleared before deployment (also known as a "complete" deploy).
        timeToWaitMs - A positive value describes the maximum length of time to wait for broker responses (in milliseconds) before returning the DeployResult. Alternatively:
        • A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
        • A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the connected broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
        • A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until responses have been received from the broker.
        • If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
        • If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deployment, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.
        Returns:
        DeployResult object that can be used to query the results of the deployment.
        Throws:
        ConfigManagerProxyLoggedException - if the Bar file could not be sent to the broker.
      • deploy

        public DeployResult deploy(BarFile barfile,
                                   boolean isIncremental,
                                   long timeToWaitMs)
                            throws ConfigManagerProxyLoggedException
        Starts a deploy of the BarFile object to the object group.
        Parameters:
        barfile - The BarFile to be deployed.
        isIncremental - If true, the contents of the Bar file will add or modify what has already been deployed on the execution group. If false, the contents of the execution group will be completely cleared before deployment (also known as a "complete" deploy).
        timeToWaitMs - A positive value describes the maximum length of time to wait for broker responses (in milliseconds) before returning the DeployResult. Alternatively:
        • A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
        • A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the connected broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
        • A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until responses have been received from the broker.
        • If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
        • If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deployment, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.
        Returns:
        DeployResult object that can be used to query the results of the deployment.
        Throws:
        ConfigManagerProxyLoggedException - if the Bar file could not be sent to the broker.
      • deploy

        public void deploy(java.lang.String barFileName)
                    throws ConfigManagerProxyLoggedException,
                           java.io.IOException
        Starts an incremental deploy of the Bar file pointed to by the supplied filename, to the object group. The method reads the contents of the file, enqueues the deployment message for the connected broker and then immediately returns.
        Parameters:
        barFileName - Path and file name of the Bar file, relative to the current directory.
        Throws:
        ConfigManagerProxyLoggedException - if the Bar file could not be sent to the broker.
        java.io.FileNotFoundException - if the Bar file could not be found
        java.io.IOException - if the file could not be closed. In this case the deployment might have succeeded.
      • deploy

        public void deploy(java.io.InputStream barStream)
                    throws ConfigManagerProxyLoggedException
        Starts an incremental deploy of the Bar file, whose contents are embedded in the supplied InputStream, to the object group. The method reads the contents of the file, enqueues the deployment message for the broker and then immediately returns. The name of the Bar file will not be available to any DeployedObject objects that result from this deployment.
        Parameters:
        barStream - InputStream containing the Bar file contents. The first byte read by the stream must be the first byte of the Bar file's contents.
        Throws:
        ConfigManagerProxyLoggedException - if the Bar file could not be sent to the broker.
      • deleteDeployedObjects

        public DeployResult deleteDeployedObjects(DeployedObject[] forDeletion,
                                                  long timeToWaitMs)
                                           throws ConfigManagerProxyLoggedException
        Attempts to remove deployed objects from the object group.
        Parameters:
        forDeletion - representing the DeployedObject objects that require deletion (e.g. message flows, message sets). If the value is null or empty, this method does nothing. If an element in the array is null, the element is ignored.
        timeToWaitMs - A positive value describes the maximum length of time to wait for broker responses (in milliseconds) before returning the DeployResult. Alternatively:
        • A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
        • A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the connected broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
        • A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until the response has been received from the broker.
        • If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
        • If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deletion, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker
      • deleteDeployedObjectsByName

        public DeployResult deleteDeployedObjectsByName(java.lang.String[] forDeletion,
                                                        long timeToWaitMs)
                                                 throws ConfigManagerProxyLoggedException,
                                                        ConfigManagerProxyPropertyNotInitializedException
        Attempts to remove deployed objects from the object group.

        It is acceptable to remove objects of different types in the same request. It is the caller's responsibility to ensure that the supplied names refer to exactly one object deployed in the execution group. If a deployed object with the supplied name cannot be found, that element of the array is ignored and no exception is thrown. If an ambiguous String is supplied (e.g. "doc1" when "doc1.xsl" and "doc1.dictionary" are both deployed) then the call will fail with ConfigManagerProxyLoggedException.

        Parameters:
        forDeletion - An array of Strings, with each element being the name (e.g. "mf1") or fullname (e.g. "mf1.cmf") of an object that is to be removed from the execution group. If the array is null or empty, this method does nothing. If an element in the array is null, the element is ignored.
        timeToWaitMs - A positive value describes the maximum length of time to wait for broker responses (in milliseconds) before returning the DeployResult. Alternatively:
        • A value of 0 causes the method to return immediately after the message has been successfully sent to the connected broker.
        • A value of AttributeConstants.DEPLOYRESULT_SUPPRESSION causes the method to return null immediately after the message has been successfully sent to the broker. DeployResult objects are relatively expensive to create and maintain, and so supplying this constant should be used if the DeployResult is not parsed, or if application performance is critical.
        • A value of AttributeConstants.DEPLOYRESULT_WAIT_INDEFINITELY causes the method to wait until the response has been received from the broker affected by the deploy.
        • If batch mode is enabled the method returns immediately regardless of the value of this parameter. All completion codes in the returned DeployResult object will be 'pending' unless the value of timeToWaitMs is AttributeConstants.DEPLOYRESULT_SUPPRESSION, in which case the DeployResult will be null (as usual).
        • If the current IBM Integration API (CMP) application is deployed inside a JavaCompute or Java User Defined Node, and there is a possibility that the flow in which the IBM Integration API (CMP) application is deployed might be affected by the deletion, you must use a value of 0 or AttributeConstants.DEPLOYRESULT_SUPPRESSION.
        Throws:
        ConfigManagerProxyLoggedException - if the request could not be sent to the broker, or if at least one supplied name is ambiguous.
        ConfigManagerProxyPropertyNotInitializedException - if deployed object information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getQueues

        public java.lang.String[] getQueues()
                                     throws ConfigManagerProxyPropertyNotInitializedException
        Returns a list of the MQ queues referenced by the message flows in use by this deployed object group. Only queues directly referenced by the following nodes are reported:
        • MQInput
        • MQOutput
        • MQGet
        Each element of the returned list contains any queue name parameter that was specified when each flow was deployed. If a queue manager name was also supplied this will be described in the same element, before the queue name and separated by a forward slash character ('/') - for example, "MYQMGR/TEST.QUEUE". This character is defined by the constant AttributeConstants.MESSAGEFLOW_QMGRQUEUE_DELIMITER.

        This method works by aggregating the responses from calling the MessageFlowProxy.getQueues() method for each message flow that is currently deployed to the execution group.

        Returns:
        String[] the names of the queues that were specified during deployment
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if queue information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getDeployedPolicySetNames

        public MessageFlowProxy.PolicySetName[] getDeployedPolicySetNames()
                                                                   throws ConfigManagerProxyPropertyNotInitializedException
        Returns the names of the PolicySets associated with the message flows in use by this object group.
        Returns:
        PolicySetName[] the names of the PolicySets. Each object in this array represents the name of a PolicySet associated in some way with a message flow in use by this execution group when it was deployed. See the description of the PolicySetName class.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if the value of the parameter could not be determined because policy set information was not supplied from the broker before a timeout occurred.
      • getDeployedPolicySetBindingsNames

        public MessageFlowProxy.PolicySetBindingsName[] getDeployedPolicySetBindingsNames()
                                                                                   throws ConfigManagerProxyPropertyNotInitializedException
        Returns the names of the PolicySetBindings associated with the message flows in use by this object group.
        Returns:
        PolicySetBindingsName[] the names of the PolicySetBindings. Each object in this array represents the name of a PolicySetBinding associated in some way with a message flow in use by this execution group when it was deployed. See the description of the PolicySetBindingsName class.
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if policy set bindings information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • getNodeTypes

        public java.lang.String[] getNodeTypes()
                                        throws ConfigManagerProxyPropertyNotInitializedException
        Returns a list of the types of nodes used in this object group. The names returned are the internal names, which are unique for every node type.

        This method works by aggregating the responses from calling the MessageFlowProxy.getNodeTypes() method for each message flow that is currently deployed to the execution group.

        Returns:
        String[] the names of the node types that were specified during deployment
        Throws:
        ConfigManagerProxyPropertyNotInitializedException - if node information could not be determined because the information was not supplied from the broker before a timeout occurred.
      • setAllMessageFlowsRuntimeProperty

        public abstract void setAllMessageFlowsRuntimeProperty(java.lang.String objectAndPropertyName,
                                                               java.lang.String propertyValue)
                                                        throws ConfigManagerProxyLoggedException,
                                                               java.lang.IllegalArgumentException
        Asks the broker to configure an arbitrary property of all message flows owned by the object group.

        Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible.

        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.

        Parameters:
        objectAndPropertyName - The complete object and property name of the property being manipulated
        propertyValue - The new value to associate with the property
        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 objectAndPropertyName is not a valid syntax.
      • setAllMessageFlowsRuntimeProperties

        public abstract void setAllMessageFlowsRuntimeProperties(java.util.Properties props)
                                                          throws ConfigManagerProxyLoggedException,
                                                                 java.lang.IllegalArgumentException
        Asks the broker to configure an arbitrary set of properties of all message flows owned by the object group.

        Constants exist for many common objectAndPropertyName values in the AttributeConstants interface, and you should use these wherever possible.

        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.

        Parameters:
        props - A set of properties to set on all message flows owned by the object group. The key is the complete object and property name of the property being manipulated. The value is the new value to associate with the property
        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 objectAndPropertyName is not a valid syntax.