Client API

To make it simpler to use we've created a JBI Client API which makes it easy to work with any JBI container and other JBI components.

The JavaDoc is probably self evident for many things, especially if you are aware of the JBI APIs. There is an example test case which shows many of these APIs in action.

Using the JBI interfaces

The following helper methods just provide some helper methods for easier use of the JBI APIs

Sending messages

This example uses a specific service to invoke

In this example, we assume that the JBI container will have setup a default routing connection for our client, so we don't have to worry about specifying the endpoint.

Invoking services

Working with URIs and Destinations

ServiceMix has integrated support for URIs to simplify the accessing of endpoints within the NMR. The ServiceMixClient (from 3.0-M3 or later) allows you to work with URIs easily via a Destination interface. This interface acts as a factory of MessageExchange objects which are pre-wired to specific endpoints specified via a URI.

The following shows how to work with InOnly for one way messaging

Or using InOut for request-response

Simpler one-way messaging with Destinations

For one-way messaging its sometimes simpler to just work with a Message instance (you can always refer to the MessageExchange via the getExchange() method if need be). For example

For more detail see the unit test case

Using the POJO methods

We provide a few helper POJO based methods to allow you to use JBI using regular POJOs to hide some of the XML marshaling detail. Then you can use a plugable Marshaler to map your POJOs to JAXP Sources.

Sending messages

This example uses a specific service to invoke

In this example, we assume that the JBI container will have setup a default routing connection for our client, so we don't have to worry about specifying the endpoint.

Invoking services

Configuring the ServiceMixClient

We use the Spring XML configuration files to configure the client. You can then use dependency injection to inject the client into your POJOs.

Here's an example of using a basic client...

Note that the jbi bean reference is the ServiceMix JBI container.

This example creates a client which is hard-wired to default to a specific service when an invocation is performed.

If you have access to a ComponentContext

If you are inside a JBI component you can create a ServiceMixClient as follows

If you want to access a remote ServiceMix instance

If you want to create a ServiceMixClient to access services on a remote ServiceMix instance, you can use the RemoteServiceMixClient. The constructor arguments shown below is the URI for connecting to ServiceMix's embedded ActiveMQ instance. This only works if the remote instance has the JMS Flow enabled.

If you are using Spring, this becomes

Using ClientFactory

Starting from 3.0-M3, you can retrieve a ClientFactory from JNDI.

Note that creating client is somewhat expensive, so it's best to create a client once and reuse it.