Page Comparison

...

When configuring WSO2 ESB's JMS transport with HornetQ, you can either configure with a standalone HornetQ server or with HornetQ embedded in a JBoss Enterprise Application Platform (JBoss EAP) server.

See the following topics for detailed instructions:

...

Go to the required tab for step by step instructions based on how you need to configure the ESB's JMS transport with HornetQ.

Localtabgroup

Localtab

title	Configure with a standalone HornetQ server

Follow the instructions below to configure WSO2 ESB's JMS transport with a standalone HornetQ server.

Download HornetQ from the HornetQ Downloads site.
Anchor
createQueue
createQueue
Create a sample queue by editing the <HORNET_HOME>/config/stand-alone/non-clustered/hornetq-jms.xml file as follows:
Code Block
language xml
<queue name="wso2"> <entry name="/queue/mySampleQueue"/> </queue>

Add the following two connection entries to the same file. These entries are required to enable the ESB to act as a JMS consumer.

Code Block

language	xml

<connection-factory name="QueueConnectionFactory">
      <xa>false</xa>
      <connectors>
         <connector-ref connector-name="netty"/>
      </connectors>
      <entries>
         <entry name="/QueueConnectionFactory"/>
      </entries>
</connection-factory>
 
 
<connection-factory name="TopicConnectionFactory">
      <xa>false</xa>
      <connectors>
         <connector-ref connector-name="netty"/>
      </connectors>
      <entries>
         <entry name="/TopicConnectionFactory"/>
      </entries>
</connection-factory>

If you have not already done so, download WSO2 ESB and install as described in the Installation Guide.

Copy the hornet-all.jar into the <ESB_HOME>/repository/components/lib folder. This jar can be downloaded from here.

Info

title	Note

If you are packing the JARs yourself, make sure you remove the javax.jms package from the assembled JAR to avoid the carbon runtime from picking this implementation of JMS over the bundled-in distribution.

Uncomment the following line in the <ESB_HOME>/repository/conf/axis2/axis2.xml file to enable the JMS transport sender on axis2core.
Code Block
language xml
<transportSender name="jms" class="org.apache.axis2.transport.jms.JMSSender"/>

Enable the JMS listener with the HornetQ configuration parameters in the <ESB_HOME>/repository/conf/axis2/axis2.xml file by un-commenting the following lines of code.

Code Block

language	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.jnp.interfaces.NamingContextFactory</parameter>
  <parameter name="java.naming.factory.url.pkgs"locked="false">org.jboss.naming:org.jnp.interfaces</parameter>
  <parameter name="java.naming.provider.url" locked="false">jnp://localhost:1099</parameter>
  <parameter name="transport.jms.ConnectionFactoryJNDIName"
   locked="false">TopicConnectionFactory</parameter>
  <parameter name="transport.jms.ConnectionFactoryType"
   locked="false">topic</parameter>
 </parameter>
 <parameter name="myQueueConnectionFactory" locked="false">
  <parameter name="java.naming.factory.initial"locked="false">org.jnp.interfaces.NamingContextFactory</parameter>
  <parameter name="java.naming.factory.url.pkgs"locked="false">org.jboss.naming:org.jnp.interfaces</parameter>
  <parameter name="java.naming.provider.url" locked="false">jnp://localhost:1099</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.jnp.interfaces.NamingContextFactory</parameter>
  <parameter name="java.naming.factory.url.pkgs"locked="false">org.jboss.naming:org.jnp.interfaces</parameter>
  <parameter name="java.naming.provider.url" locked="false">jnp://localhost:1099</parameter>
  <parameter name="transport.jms.ConnectionFactoryJNDIName"
   locked="false">QueueConnectionFactory</parameter>
  <parameter name="transport.jms.ConnectionFactoryType"
   locked="false">queue</parameter>
 </parameter>
 
</transportReceiver>

Start HornetQ with the following command.
- On Windows: <HORNETQ_HOME>\bin\run.bat --run
- On Linux/Solaris: sh <HORNETQ_HOME>/bin/run.sh

Now you have configured the ESB's JMS transport with a standalone HornetQ server. The next section describes how you can test the configuration.

Testing the configuration

To test the configuration we create a proxy service named JMSPublisher to publish messages from the ESB to the HornetQ sample queue, and create the JMSListener queue to read messages from the HornetQ sample queue.

Image Added

Start the ESB management console. See Running the Product for more information.

Create the JMSPublisher proxy service with the following configuration:

Code Block

language	xml

 <proxy xmlns="http://ws.apache.org/ns/synapse"
       name="JMSPublisher"
       transports="https,http"
       statistics="enable"
       trace="enable"
       startOnLoad="true">
   <target>
      <inSequence>
         <property name="FORCE_SC_ACCEPTED" value="true" scope="axis2"/>
         <property name="Accept-Encoding" scope="transport" action="remove"/>
         <property name="Content-Length" scope="transport" action="remove"/>
         <property name="Content-Type" scope="transport" action="remove"/>
         <property name="User-Agent" scope="transport" action="remove"/>
         <property name="OUT_ONLY" value="true"/>
         <log level="full"/>
         <send>
            <endpoint>
               <address uri="jms:/queue/mySampleQueue?transport.jms.ConnectionFactoryJNDIName=QueueConnectionFactory&amp;java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory&amp;java.naming.provider.url=jnp://localhost:1099&amp;transport.jms.DestinationType=queue"/>
            </endpoint>
         </send>
      </inSequence>
   </target>
   <publishWSDL uri="file:repository/samples/resources/proxy/sample_proxy_1.wsdl"/>
   <description>HornetQ-WSO2 ESB sample</description>
</proxy>

Info

icon	false

The proxy service is created for the SimpleStockQuoteService service shipped with the ESB samples in this example so that the configuration can be tested by sending a request to call one of the operations of the service.
The OUT_ONLY parameter is set to true since this proxy service is created only for the purpose of publishing the messages of the ESB to the mySampleQueue queue specified in the address URI.
You may have to change the host name, port etc. of the JMS string based on your environment

Create the JMSListener proxy service with the following configuration:

Code Block

language	xml

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="JMSListener"
       transports="jms"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <log level="custom">
            <property name="JMS LISTENER PROXY" value="LOCATED"/>
         </log>
         <log level="full"/>
         <drop/>
      </inSequence>
   </target>
   <parameter name="transport.jms.ContentType">
      <rules>
         <jmsProperty>contentType</jmsProperty>
         <default>application/xml</default>
      </rules>
   </parameter>
   <parameter name="transport.jms.Destination">queue/mySampleQueue</parameter>
   <description/>
</proxy>

Use a client application of your choice to send a request to the endpoint of the JMSPublisher proxy service. In this example, the following request is sent using SOAPUI, calling the placeOrder operation of the SimpleStockQuoteService for which the JMSPublisher proxy service is created.

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.samples" xmlns:xsd="http://services.samples/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:placeOrder>
         <!--Optional:-->
         <ser:order>
            <!--Optional:-->
            <xsd:price>20</xsd:price>
            <!--Optional:-->
            <xsd:quantity>20</xsd:quantity>
            <!--Optional:-->
            <xsd:symbol>IBM</xsd:symbol>
         </ser:order>
      </ser:placeOrder>
   </soapenv:Body>
</soapenv:Envelope>

Check the log on your ESB terminal. You will see the following log, which indicates that the request published in the queue is picked by the JMSListener proxy.

Code Block

language	xml

[<TIME Stamp>]  INFO - LogMediator JMS LISTENER PROXY = LOCATED

[<TIME Stamp>]  INFO - LogMediator To: , WSAction: "urn:placeOrder", SOAPAction: "urn:placeOrder", MessageID: ID:be08707e-033d-11e4-8307-25263fbb9173, Direction: request, Envelope: <?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><soapenv:Envelope xmlns:xsd="http://services.samples/xsd" xmlns:ser="http://services.samples"><soapenv:Body>

      <ser:placeOrder>
         <!--Optional:-->
         <ser:order>
            <!--Optional:-->
            <xsd:price>20</xsd:price>
            <!--Optional:-->
            <xsd:quantity>20</xsd:quantity>
            <!--Optional:-->
            <xsd:symbol>IBM</xsd:symbol>
         </ser:order>
      </ser:placeOrder>
   </soapenv:Body></soapenv:Envelope></soapenv:Body></soapenv:Envelope>

Localtab

title	Configure with HornetQ embedded in a JBoss EAP server

Follow the instructions below to set up and configure WSO2 ESB with HornetQ embedded in JBoss EAP server.

Setting up JBoss EAP

This section describes the steps to install JBoss EAP server and create a message queue within the server.

Download JBoss EAP Server 7.0.0 from JBoss EAP Downloads and run the JBoss EAP installer as described here.
Execute one of the following commands in command prompt to create a new application user.
- On Windows: <EAP_HOME>\bin\add-user.bat -a -u 'SampleUser' -p 'SamplePwd1!' -g 'guest'
- On Linux/Mac: <EAP_HOME>/bin/add-user.sh -a -u 'SampleUser' -p 'SamplePwd1!' -g 'guest'

Create a sample queue by editing the <EAP_HOME>/standalone/configuration/standalone-full.xml file. Add the following content within the <hornetq-server> element:

Code Block

language	xml

<jms-destinations>
      <jms-queue name="sampleQueue">
          <entry name="queue/test"/>
          <entry name="java:jboss/exported/jms/queue/test"/>
      </jms-queue>
</jms-destinations>

Start the JBoss EAP server by executing one of the following commands in command prompt:
- On Windows: <EAP_HOME>\bin\standalone.bat -c standalone-full.xml
- On Linux/Mac: <EAP_HOME>/bin/standalone.sh -c standalone-full.xml
Acess the management console of the JBoss EAP server using the following URL:
http://127.0.0.1:9990
Log in to the Management Console using admin as both the username and password. In the Profile menu, click Messaging -> Destinations and you will be able to see the queue you added in Step 4 in the Queues/Topics section.
Image Added

Now you have configured the JBoss EAP Server. In the next section you will configure WSO2 ESB to listen and fetch messages from the queue that we created above.

Configuring WSO2 ESB

If you have not already done so, download and install WSO2 ESB.

Enable the JMS listener with the JBoss EAP configuration parameters in the <ESB_HOME>/repository/conf/axis2/axis2.xml file by adding the following lines of code.

Code Block

language	xml

<transportReceiver name="jms" class="org.apache.axis2.transport.jms.JMSListener">
	<parameter name="QueueConnectionFactory" locked="false">
      		<parameter name="java.naming.factory.initial" locked="false">org.jboss.naming.remote.client.InitialContextFactory</parameter>
     		 <parameter name="java.naming.provider.url" locked="false">remote://localhost:4447</parameter>
      		<parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">jms/RemoteConnectionFactory</parameter>
      		<parameter name="transport.jms.UserName" locked="false">SampleUser</parameter>
     		<parameter name="transport.jms.Password" locked="false">SamplePwd1!</parameter>
      		<parameter name="java.naming.security.principal" locked="false">SampleUser</parameter>
      		<parameter name="java.naming.security.credentials" locked="false">SamplePwd1!</parameter>
      		<parameter name="transport.jms.ConnectionFactoryType" locked="false">queue</parameter>
	</parameter>
</transportReceiver>

Info
The username and password created for the guest user in the above section are used in the configuration.

Enable the JMS sender by uncommenting the following line of code in the <ESB_HOME>/repository/conf/axis2/axis2.xml file.
Code Block
language xml
<transportSender name="jms" class="org.apache.axis2.transport.jms.JMSSender"/>

Now you have configured the ESB's JMS transport with HornetQ embedded in a JBoss EAP server. The next section describes how you can test the configuration.

Testing the configuration

To test the configuration we create a proxy service named JMSPublisher to publish messages from the ESB to the HornetQ sample queue, and create the JMSListener queue to read messages from the HornetQ sample queue.

Image Added

Start the ESB management console. See Running the Product for more information.

Create the JMSPublisher proxy service with the following configuration:

Code Block

language	xml

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="JMSPublisher"
       transports="https,http"
       statistics="enable"
       trace="enable"
       startOnLoad="true">
   <target>
      <inSequence>
         <property name="FORCE_SC_ACCEPTED" value="true" scope="axis2"/>
         <property name="Accept-Encoding" scope="transport" action="remove"/>
         <property name="Content-Length" scope="transport" action="remove"/>
         <property name="Content-Type" scope="transport" action="remove"/>
         <property name="User-Agent" scope="transport" action="remove"/>
         <property name="OUT_ONLY" value="true"/>
         <log level="full"/>
         <send>
            <endpoint>
               <address uri="jms:/jms/queue/test?transport.jms.ConnectionFactoryJNDIName=jms/RemoteConnectionFactory&amp;java.naming.factory.initial=org.jboss.naming.remote.client.InitialContextFactory&amp;java.naming.provider.url=remote://localhost:4447&amp;transport.jms.DestinationType=queue&amp;transport.jms.UserName=SampleUser&amp;transport.jms.Password=SamplePwd1!&amp;java.naming.security.principal=SampleUser&amp;java.naming.security.credentials=SamplePwd1!"/>            </endpoint>
</send>

      </inSequence>
   </target>
   <publishWSDL uri="file:repository/samples/resources/proxy/sample_proxy_1.wsdl"/>
   <description>HornetQ-WSO2 ESB sample</description>
</proxy>

Info

title	Note

The proxy service is created for the SimpleStockQuoteService service shipped with the ESB samples in this example so that the configuration can be tested by sending a request to call one of the operations of the service.
The OUT_ONLY parameter is set to true since this proxy service is created only for the purpose of publishing the messages of the ESB to the mySampleQueue queue specified in the address URI.
You may have to change the host name, port etc. of the JMS string based on your environment

Create the JMSListener proxy service with the following configuration:

Code Block

language	xml

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="JMSListener"
       transports="jms"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
      <inSequence>
         <log level="custom">
            <property name="JMS LISTENER PROXY" value="LOCATED"/>
         </log>
         <log level="full"/>
         <drop/>
      </inSequence>
   </target>
   <parameter name="transport.jms.ContentType">
      <rules>
         <jmsProperty>contentType</jmsProperty>
         <default>text/plain</default>
      </rules>
   </parameter>
<parameter name="transport.jms.ConnectionFactory">QueueConnectionFactory</parameter>
   <parameter name="transport.jms.Destination">jms/queue/test</parameter>
<description/>

</proxy>

Use a client application of your choice to send a request to the endpoint of the JMSPublisher proxy service. In this example, the following request is sent using SOAPUI, calling the placeOrder operation of the SimpleStockQuoteService for which the JMSPublisher proxy service is created.

Code Block

language	xml

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.samples" xmlns:xsd="http://services.samples/xsd">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:placeOrder>
         <!--Optional:-->
         <ser:order>
            <!--Optional:-->
            <xsd:price>20</xsd:price>
            <!--Optional:-->
            <xsd:quantity>20</xsd:quantity>
            <!--Optional:-->
            <xsd:symbol>IBM</xsd:symbol>
         </ser:order>
      </ser:placeOrder>
   </soapenv:Body>
</soapenv:Envelope>

Check the log on your ESB terminal. You will see the following log, which indicates that the request published in the queue is picked by the JMSListener proxy.

Code Block

language	xml

[<TIME Stamp>]  INFO - LogMediator JMS LISTENER PROXY = LOCATED

[<TIME Stamp>]  INFO - LogMediator To: , WSAction: "urn:placeOrder", SOAPAction: "urn:placeOrder", MessageID: ID:be08707e-033d-11e4-8307-25263fbb9173, Direction: request, Envelope: <?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><soapenv:Envelope xmlns:xsd="http://services.samples/xsd" xmlns:ser="http://services.samples"><soapenv:Body>

      <ser:placeOrder>
         <!--Optional:-->
         <ser:order>
            <!--Optional:-->
            <xsd:price>20</xsd:price>
            <!--Optional:-->
            <xsd:quantity>20</xsd:quantity>
            <!--Optional:-->
            <xsd:symbol>IBM</xsd:symbol>
         </ser:order>
      </ser:placeOrder>
   </soapenv:Body></soapenv:Envelope></soapenv:Body></soapenv:Envelope>

Versions Compared

Old Version 16

New Version 17

Key

Testing the configuration

Setting up JBoss EAP

Configuring WSO2 ESB

Testing the configuration