Page Comparison

This section describes how to configure the WSO2 ESB's JMS transport with ActiveMQ.

Table of Contents

maxLevel	3

Setting up WSO2 ESB and ActiveMQ

Follow the instructions below to set up and configure.

1. Download, set up and start Apache ActiveMQ.

2. Follow the Getting Started and set up WSO2 ESB.

Info
ActiveMQ should be up and running before starting the ESB.

...

ActiveMQ 5.8.0 and above

activemq-broker-5.8.0.jar
activemq-client-5.8.0.jar
geronimo-jms_1.1_spec-1.1.1.jar
geronimo-j2ee-management_1.1_spec-1.0.1.jar

Info

icon	false

If you are using ActiveMQ version 5.8.0 or later, copy hawtbuf-1.2.jar to < ESB_HOME>/repository/components/lib directory .

Earlier version of ActiveMQ

activemq-core-5.5.1.jar
geronimo-j2ee-management_1.0_spec-1.0.jar
geronimo-jms_1.1_spec-1.1.1.jar

4. Next, configure transport listeners and senders in ESB.

...

To enable the JMS transport listener, un-comment the following listener configuration related to ActiveMQ in <ESB_HOME>/repository/conf/axis2/axis2.xml file.

...

language	html/xml

...

This section describes how to configure the WSO2 ESB's JMS transport with ActiveMQ.

Table of Contents

maxLevel	3

Setting up WSO2 ESB and ActiveMQ

Follow the instructions below to set up and configure.

1. Download, set up and start Apache ActiveMQ.

2. Follow the Getting Started and set up WSO2 ESB.

Info
ActiveMQ should be up and running before starting the ESB.

Anchor

	clientLibs
	clientLibs

3. Copy the following client libraries from the <AMQ_HOME>/lib directory to the <ESB_HOME>/repository/components/lib directory.

ActiveMQ 5.8.0 and above

activemq-broker-5.8.0.jar
activemq-client-5.8.0.jar
activemq-kahadb-store-5.8.0.jar
geronimo-jms_1.1_spec-1.1.1.jar
geronimo-j2ee-management_1.1_spec-1.0.1.jar
geronimo-jta_1.0.1B_spec-1.0.1.jar
hawtbuf-1.9.jar
Slf4j-api-1.6.6.jar
activeio-core-3.1.4.jar (available in <AMQ_HOME>/lib/optional folder)

Earlier version of ActiveMQ

activemq-core-5.5.1.jar
geronimo-j2ee-management_1.0_spec-1.0.jar
geronimo-jms_1.1_spec-1.1.1.jar

4. Next, configure transport listeners and senders in ESB.

Note

When configuring JMS with ActiveMQ, you can append ActiveMQ-specific properties to the value of the java.naming.provider.url property. For example, you can set the redeliveryDelay and initialRedeliveryDelay properties when configuring a JMS inbound endpoint as follows:

<parameter name="java.naming.provider.url">tcp://localhost:61616?jms.redeliveryPolicy.redeliveryDelay=10000&jms.redeliveryPolicy.initialRedeliveryDelay=10000</parameter>

Anchor
JMSListener
JMSListener
Setting up the JMS Listener

To enable the JMS transport listener, un-comment the following listener configuration related to ActiveMQ in <ESB_HOME>/repository/conf/axis2/axis2.xml file.

Code Block

language	html/xml

<transportReceiver name="jms" class="org.apache.axis2.transport.jms.JMSListener">
       <parameter name="myTopicConnectionFactory" locked="false">
           <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           <parameter name="java.naming.provider.url" locked="false">tcp://localhost:61616</parameter>
           <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">TopicConnectionFactory</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">topic</parameter>
       </parameter>
 
       <parameter name="myTopicConnectionFactorymyQueueConnectionFactory" locked="false">
           <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           <parameter name="java.naming.provider.url" locked="false">tcp://localhost:61616</parameter>
           <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">TopicConnectionFactory<>QueueConnectionFactory</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">topic<>queue</parameter>
       </parameter>
 
       <parameter name="myQueueConnectionFactorydefault" locked="false">
           <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           <parameter name="java.naming.provider.url" locked="false">tcp://localhost:61616</parameter>
           <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">QueueConnectionFactory</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">queue</parameter>
       </parameter>
 
       <parameter name="default" locked="false">
           <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           <parameter name="java.naming.provider.url" locked="false">tcp://localhost:61616</parameter>
           <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">QueueConnectionFactory</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">queue</parameter>
       </parameter>
   </transportReceiver>

...

To enable the JMS transport sender, un-comment the following configuration in <ESB_HOME>/repository/conf/axis2/axis2.xml file.

Code Block

language	html/xml

<transportSender name="jms" class="org.apache.axis2.transport.jms.JMSSender"/>

Info
For details on the JMS configuration parameters used in the code segments above, see JMS Connection Factory Parameters.

Info

The above configurations do not address the problem of transient failures of ActiveMQ message broker. Let's say for some reason ActiveMQ goes down and comes back up after a while. ESB won't reconnect to ActiveMQ but instead it'll throw some errors as requests are sent to ESB till it is restarted. In order to tackle this issue one needs to add the following configuration in the place of the java.naming.provider.url,

failover:tcp://localhost:61616

This will simply make sure re-connection takes place when ActiveMQ is up and running. Failover prefix is associated with the Failover Transport of ActiveMQ. For further information about this please try The Failover Transport.

You now have instances of ActiveMQ and WSO2 ESB configured, up and running. Next, refer to section JMS Usecases for implementation details of various JMS use cases.

Note

title	Note

When working with JMS message stores, if you are using ActiveMQ 5.12.2 and above, you need to set the following system property on server start up for WSO2 ESB's JMS message store to work as expected.

Code Block

language	bash

-Dorg.apache.activemq.SERIALIZABLE_PACKAGES=“*"

With ActiveMQ 5.12.2 and above, you need to set the above property because users are enforced to explicitly whitelist packages that can be exchanged using ObjectMessages, and due to this restriction the message processor fails to read messages from ActiveMQ with the following error:

Code Block

language	bash

ERROR - JmsConsumer [JMS-C-1] cannot receive message from store. Error:Failed to build body from content. Serializable class not available to broker. Reason: java.lang.ClassNotFoundException: Forbidden class org.apache.synapse.message.store.impl.commons.StorableMessage! This class is not trusted to be serialized as ObjectMessage payload.

Connecting multiple ActiveMQ brokers

The WSO2 ESB can be configured as explained in the following procedure in order to work with two ActiveMQ brokers. In this example, port 61616 is used for one ActiveMQ instance and port 61617 is used for the other.

...

Add another transport receiver to the <ESB_Home>/repository/conf/axis2/axis2.xml file as follows. Note that the name of the transport receiver is different to that of the transport receiver already entered. The port specified is 61617.

...

language	xml

...

>queue</parameter>
       </parameter>
   </transportReceiver>

Anchor
JMSSender
JMSSender
Setting up the JMS Sender

To enable the JMS transport sender, un-comment the following configuration in <ESB_HOME>/repository/conf/axis2/axis2.xml file.

Code Block

language	html/xml

<transportSender name="jms" class="org.apache.axis2.transport.jms.JMSSender"/>

Info
For details on the JMS configuration parameters used in the code segments above, see JMS Connection Factory Parameters.

Info

The above configurations do not address the problem of transient failures of ActiveMQ message broker. Let's say for some reason ActiveMQ goes down and comes back up after a while. ESB won't reconnect to ActiveMQ but instead it'll throw some errors as requests are sent to ESB till it is restarted. In order to tackle this issue one needs to add the following configuration in the place of the java.naming.provider.url,

failover:tcp://localhost:61616

This will simply make sure re-connection takes place when ActiveMQ is up and running. Failover prefix is associated with the Failover Transport of ActiveMQ. For further information about this please try The Failover Transport.

You now have instances of ActiveMQ and WSO2 ESB configured, up and running. Next, refer to section JMS Usecases for implementation details of various JMS use cases.

Note

title	Note

When working with JMS message stores, if you are using ActiveMQ 5.12.2 and above, you need to set the following system property on server start up for WSO2 ESB's JMS message store to work as expected.

Code Block

language	bash

-Dorg.apache.activemq.SERIALIZABLE_PACKAGES=“*"

With ActiveMQ 5.12.2 and above, you need to set the above property because users are enforced to explicitly whitelist packages that can be exchanged using ObjectMessages, and due to this restriction the message processor fails to read messages from ActiveMQ with the following error:

Code Block

language	bash

ERROR - JmsConsumer [JMS-C-1] cannot receive message from store. Error:Failed to build body from content. Serializable class not available to broker. Reason: java.lang.ClassNotFoundException: Forbidden class org.apache.synapse.message.store.impl.commons.StorableMessage! This class is not trusted to be serialized as ObjectMessage payload.

Connecting multiple ActiveMQ brokers

The WSO2 ESB can be configured as explained in the following procedure in order to work with two ActiveMQ brokers. In this example, port 61616 is used for one ActiveMQ instance and port 61617 is used for the other.

Configure the ESB to work with one ActiveMQ broker as described above.
Start another ActiveMQ instance.

Add another transport receiver to the <ESB_Home>/repository/conf/axis2/axis2.xml file as follows. Note that the name of the transport receiver is different to that of the transport receiver already entered. The port specified is 61617.

Code Block

language	xml

<transportReceiver name="jms1" class="org.apache.axis2.transport.jms.JMSListener">
       <parameter name="myTopicConnectionFactory" locked="false">
           <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           <parameter name="java.naming.provider.url" locked="false">tcp://localhost:61617</parameter>
           <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">TopicConnectionFactory</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">topic</parameter>
       </parameter>
 
       <parameter name="myTopicConnectionFactorymyQueueConnectionFactory" locked="false">
           <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           <parameter name="java.naming.provider.url" locked="false">tcp://localhost:61617</parameter>
           <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">TopicConnectionFactory<>QueueConnectionFactory</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">topic<>queue</parameter>
       </parameter>
 
       <parameter name="myQueueConnectionFactorydefault" locked="false">
           <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           <parameter name="java.naming.provider.url" locked="false">tcp://localhost:61617</parameter>
           <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">QueueConnectionFactory</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">queue</parameter>
   
   </parameter>          <parameter name="defaulttransport.jms.ConnectionFactoryType" locked="false">>queue</parameter>
       </parameter>
   <parameter name="java.naming.factory.initial" locked="false">org.apache.activemq.jndi.ActiveMQInitialContextFactory</parameter>
           </transportReceiver>

Set up the JMS sender as explained in Setting up the JMS sender.

Configuring Redelivery in ActiveMQ Queues

When WSO2 ESB is configured to consume messages from an ActiveMQ queue, you have the option to configure message re-delivery. This is useful when messages are unable to be processed by ESB due to failures.

Enable the JMS listener as explained in Setting up the JMS listener.

Add the following JMS parameters into the proxy service configuration in WSO2 ESB:

Code Block

language	xml

<parameter name="java.naming.provider.url" locked="false">tcp://localhost:61617</parameter>
          redeliveryPolicy.maximumRedeliveries">1</parameter>
<parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">QueueConnectionFactory<DestinationType">queue</parameter>
            <parameter name="transport.jms.ConnectionFactoryTypeSessionTransacted">true</parameter>
<parameter lockedname="false">queue<transport.jms.Destination">JMStoHTTPStockQuoteProxy</parameter>
       <<parameter name="redeliveryPolicy.redeliveryDelay">2000</parameter>
   </transportReceiver>

Set up the JMS sender as explained in Setting up the JMS sender.

Configuring Redelivery ActiveMQ Queues

When WSO2 ESB is configured to consume messages from an ActiveMQ queue, you have the option to configure message re-delivery. This is useful when messages are unable to be processed by ESB due to failures.

Enable the JMS listener as explained in Setting up the JMS listener.

Add the following JMS parameters into the proxy service configuration in WSO2 ESB:

Code Block

language	xml

<parameter name="redeliveryPolicy.maximumRedeliveries">1</parameter>
<parameter name="transport.jms.DestinationType">queue</parameter>
<parameter name="transport.jms.SessionTransacted">true</parameter>
<parameter name="transport.jms.Destination">JMStoHTTPStockQuoteProxy</parameter>
<parameter name="redeliveryPolicy.redeliveryDelay">2000</parameter>
<parameter name="transport.jms.CacheLevel">consumer</parameter>

Parameters

- redeliveryPolicy.maximumRedeliveries: Maximum number of retries for delivering the message. If set to -1 ActiveMQ will retry inifinitely.
- transport.jms.SessionTransacted: When set to true, this enables the JMS session transaction for the proxy service.
- redeliveryPolicy.redeliveryDelay: Delay time in milliseconds between retries.
- transport.jms.CacheLevel: This needs to be set to consumer for the ActiveMQ redelivery mechanism to work.

<parameter name="transport.jms.CacheLevel">consumer</parameter>
Parameters
- redeliveryPolicy.maximumRedeliveries: Maximum number of retries for delivering the message. If set to -1 ActiveMQ will retry inifinitely.
- transport.jms.SessionTransacted: When set to true, this enables the JMS session transaction for the proxy service.
- redeliveryPolicy.redeliveryDelay: Delay time in milliseconds between retries.
- transport.jms.CacheLevel: This needs to be set to consumer for the ActiveMQ redelivery mechanism to work.

Add the following line in your fault sequence:

<property name="SET_ROLLBACK_ONLY" value="true" scope="axis2"/>

Info

title	SET_ROLLBACK_ONLY

This parameter must be defined for ActiveMQ to redeliver the message.

When ESB is unable to deliver a message to the back-end service due to an error, it will be routed to the fault sequence in the ESB configuration. When "SET_ROLLBACK_ONLY" property is set in the fault sequence, ESB informs ActiveMQ to redeliver the message.

Below is a sample proxy service configuration:

Code Block

language	xml

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="JMStoHTTPStockQuoteProxy"
       transports="jms"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <property name="transactionID"
                   expression="get-property('MessageID')"
                   scope="default"/>
         <property name="sourceMessageID"
                   expression="get-property('MessageID')"
                   scope="default"/>
         <property name="proxyMessageID"
                   expression="get-property('MessageID')"
                   scope="default"/>
         <log level="full">
            <property name="transactionID" expression="get-property('transactionID')"/>
            <property name="sourceMessageID" expression="get-property('sourceMessageID')"/>
            <property name="MessageID" expression="get-property('proxyMessageID')"/>
         </log>
         <property name="SET_ROLLBACK_ONLY" value="true" scope="axis2"/>
         <drop/>
      </inSequence>
      <faultSequence="jms_fault">
   </target>
   <parameter name="redeliveryPolicy.maximumRedeliveries">1</parameter>
   <parameter name="transport.jms.DestinationType">queue</parameter>
   <parameter name="transport.jms.SessionTransacted">true</parameter>
   <parameter name="transport.jms.Destination">JMStoHTTPStockQuoteProxy</parameter>
   <parameter name="redeliveryPolicy.redeliveryDelay">2000</parameter>
   <parameter name="transport.jms.CacheLevel">consumer</parameter>
   <description/>
</proxy>

...

Versions Compared

Old Version 11

New Version Current

Key

Setting up WSO2 ESB and ActiveMQ

Setting up WSO2 ESB and ActiveMQ

Anchor
JMSListener
JMSListener
Setting up the JMS Listener

Connecting multiple ActiveMQ brokers

Anchor
JMSSender
JMSSender
Setting up the JMS Sender

Connecting multiple ActiveMQ brokers

Configuring Redelivery in ActiveMQ Queues

Configuring Redelivery ActiveMQ Queues

Page Comparison

Versions Compared

Old Version 11

New Version Current

Key

Setting up WSO2 ESB and ActiveMQ

Setting up WSO2 ESB and ActiveMQ

AnchorJMSListenerJMSListenerSetting up the JMS Listener

Connecting multiple ActiveMQ brokers

AnchorJMSSenderJMSSenderSetting up the JMS Sender

Connecting multiple ActiveMQ brokers

Configuring Redelivery in ActiveMQ Queues

Configuring Redelivery ActiveMQ Queues

Anchor
JMSListener
JMSListener
Setting up the JMS Listener

Anchor
JMSSender
JMSSender
Setting up the JMS Sender