Package com.ibm.broker.config.proxy

Reference documentation for the IBM Integration API.

See: Description

Package com.ibm.broker.config.proxy Description

Reference documentation for the IBM Integration API.

This is the reference documentation for the IBM Integration API, previously known as the "CMP". It allows user-written applications to configure, view and operate instances of a broker runtime. Tasks that can be performed using this interface include:

A good starting point for reference information is the BrokerProxy class, as this class provides the ability to connect to brokers. After successfully completing the following statement in the following code snippet, b represents an active connection to a locally-defined broker called "MYBROKER". With this object, it is possible to view and manipulate the broker, its execution groups and its deployed objects.
   BrokerProxy b = BrokerProxy.getLocalInstance("MYBROKER");
It is also possible to use the API to connect to brokers that have been defined on other machines by using a TCP/IP connection to the remote broker.

In order to build and run applications that use the IBM Integration API (CMP), the CLASSPATH environment variable needs to contain instdir/common/classes/IntegrationAPI.jar, whereinstdir is the installation directory for IBM Integration Bus.

Additionally you need to ensure that the following are included in your CLASSPATH: instdir/server/jetty/lib/jetty-io.jar, instdir/server/jetty/lib/jetty-util.jar, instdir/server/jetty/lib/websocket-api.jar, instdir/server/jetty/lib/websocket-client.jar, instdir/server/jetty/lib/websocket-common.jar.

Use this documentation in conjunction with the IBM Integration API (CMP) Exerciser sample, as this will allow you to most easily discover the capabilities of the interface.