servicemix-jms

ServiceMix ships with a JBI compliant JMS binding component named servicemix-jms.

Here are the main features:

• JBI compliant Binding Component
• Usable in a lightweight mode in servicemix.xml configuration files
• SOAP 1.1 and 1.2 support
• MIME attachments
• WS-Addressing support
• WSDL based and XBean based deployments
• Support for all MEPs as consumers or providers

Installation

Installing the servicemix-jms component can be done in several ways:

• drop the installer zip in an hotdeploy directory monitored by ServiceMix
• using ant tasks

Note that when using ant tasks, the component is not started, you will have to start it manually using ant tasks or a console.

Configuration

Several parameters can be configured using a JMX console.

XBean deployment

You can deploy Service Units containing a file named xbean.xml for activating consumer and provider endpoints.

This xml file should respect the given syntax, though this is a spring based xml configuration file from where all beans of class JmsEndpoint are retrieved.
See a full example here.  Note that you have to define the jms namespace with

Any numbers of endpoints can be specified in the xbean.xml file.

Consumer endpoint

A consumer endpoint is a server-side http endpoint that will consume plain JMS, or JMS+SOAP requests and send them into the NMR to a given JBI endpoint, which is called the proxied endpoint.

Following is an example of an jms consumer endpoint.

The targetService, targetEndpoint and targetInterfaceName attributes can be used to specify the routing method to use (routing by interface, service or endpoint) and is also useful to allow several proxy endpoints to be created for the same JBI endpoint. For example to create an JMS only endpoint and an JMS+SOAP endpoint, both jms endpoints will have the same targetEndpoint and targetService, but they must have different endpoint names.

Provider endpoint

A provider endpoint is a client-side jbi endpoint which can receive requests from the NMR and send them to a given url where the service is provided.

Here is an example of an jms provider endpoint:

Processors

Several types of processors are defined to configure the behavior of servicemix-jms endpoints. These are:

• multiplexing (default) is optimized for ActiveMQ
• standard which is best suited for other JMS providers
• jca can be used for transacted deliveries

The processor used on a given endpoint can be configured using the processorName attribute on the endpoint.

JCA enabled endpoints need specific configuration. A full example is available here

Configuring the ConnectionFactory and Destination

JNDI configuration

When the ConnectionFactory or the Destination is lookup in JNDI, the JNDI context will be created in the following order:

• using the initialContextFactory and jndiProviderURL
• using the initialContextFactory and jndiProviderURL configured on the component configuration
• using the default context provided by the JBI container

ConnectionFactory

The JMS ConnectionFactory is retrieved using the properties defined on the endpoint in the following order:

• using connectionFactory
• using jndiConnectionFactoryName to lookup the ConnectionFactory in JNDI
• using the connectionFactory configured on the component configuration
• using the jndiConnectionFactoryName configured on the component configuration to lookup the ConnectionFactory in JNDI

Destination

The JMS Destination is retrieved in the following order:

• using destination
• using jndiDestinationName
• using jmsProviderDestinationName and destinationStyle

Examples

Using JNDI

If you use ActiveMQ, you can use the following definition:

WSDL Deployment

In addition to xbean based deployment, the component accepts WSDL-based deployment.
The service unit may contain any number of WSDL files, each one being parsed and activating the specified endpoints.
To retrieve the necessary informations from the wsdl, the component can recognize a jms extension to provide JNDI informations and a jbi extension which specifies the role of the component and the default MEP to use for JBI exchanges.

Here is an example of a WSDL:

Lightweight mode

The servicemix-jms component can also be configured in a spring/xbean configuration file, for use in an embedded ServiceMix.
Here is an example of such a configuration:

Accessing WSDLs

WSDLs for consumer endpoints are retrieved using the following method:

• for a WSDL based deployed endpoint, the WSL will be used as is
• for an XBean based deployed endpoint, the WSDL will be retrieved from the wsdlResource attribute
• if this information is not provided, the component will try to generate a WSDL by retrieving the target endpoint WSDL and adding the relevant informations to it.

WSDLs are accessible on the MBean for the Endpoint using a JMX console.

WS-Addressing

When used on a SOAP consumer endpoint, servicemix-jms handles the WS-Adressing Action and To headers.

wsa:Action

The wsa:Action header can be used to specify the target interface name and operation to use for the JBI exchange.

The header uses the following syntax:

where:

• [delimiter] is ":" when the [target namespace] is a URN, otherwise "/".
• [target namespace] is the namespace of the interface.
• [interface name] is the name of the interface.
• [operation name] is the name of the operation.

For example, the following header

will be used to address the JBI exchange with the following properties:

• interface name: {http://example.com/stockquote\}StockQuoteInterface
• operation name: {http://example.com/stockquote\}GetLastTradePrice

wsa:To

The wsa:To header specifies the target JBI service name and endpoint name.

The header uses the following syntax:

where:

• [delimiter] is ":" when the [target namespace] is a URN, otherwise "/".
• [target namespace] is the namespace of the interface.
• [service name] is the name of the service.
• [endpoint name] is the name of the endpoint.

For example, the following header

will be used to address the JBI exchange with the following properties:

• service name: {urn:example:stockquote}StockQuoteService
• endpoint name: JBIEndpoint