Managing integration nodes by using JavaCompute nodes

You can use the IBM® Integration API to manage integration nodes and their associated resources from JavaCompute nodes in deployed message flows.

Before you begin

You must create a JavaCompute node in a message flow.

About this task

Use IBM Integration API methods and classes in your JavaCompute node to explore and manage integration nodes and other resources.


  1. Create the Java class for the node in which you want to include IBM Integration API methods.
  2. Add the IBM Integration API JAR file (IntegrationAPI.jar), which is in the install_dir/common/classes/ directory, to the Java build path for the associated Java project.
  3. Add the following static method to the class:
    BrokerProxy thisBroker = BrokerProxy.getLocalInstance();

    This method returns an instance of the BrokerProxy object for the integration node to which the message flow (that contains this node) is deployed.

  4. To work with an integration server on this integration node, add the following static method to your code:
    ExecutionGroupProxy thisEG = ExecutionGroupProxy.getLocalInstance();
    This method returns an instance of the ExecutionGroupProxy object for the integration server to which the message flow is deployed.
  5. If you want to connect to a different integration node on the computer to which your node and message flow are deployed, you can use a variant of this class:
    BrokerProxy secondBroker = BrokerProxy.getLocalInstance(string)

    Specify the name of the alternative local integration node as the value of the variable string. Your code can manage this second integration node, and its associated resources, by using the BrokerProxy object that is returned by this call.

  6. Include additional IBM Integration API methods in your Java code to run the operations that you want against the integration node or integration server by using the objects that are obtained by following the previous steps.
    You can follow the guidance that is provided in other topics in this section for further information and examples that show how to use IBM Integration API methods in custom integration applications.

    If you include methods that affect the message flow in which your custom integration application is running, it might not be able to receive all notifications that these operations are successfully complete. Stopping, deleting, and redeploying the message flow are examples in this category; consider carefully the consequences of using these methods.

  7. Deploy the JAR file, and all associated message flows, in a BAR file.
    You do not have to deploy the IntegrationAPI.jar file to the target integration server, because the integration node can access these classes independently.
  8. It is best practice to call disconnect() on the BrokerProxy object after you have finished using it.
    By calling disconnect(), you deregister all listeners that are registered to the BrokerProxy instance and close the link to the integration node.