Configure with HornetQ

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

1. Download HornetQ from the HornetQ Downloads site.
   

2. Create a sample queue by editing the <HORNET_HOME>/config/stand-alone/non-clustered/hornetq-jms.xml file as follows:

   <queue name="wso2">
         <entry name="/queue/mySampleQueue"/>
   </queue>

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

   <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>

4. If you have not already done so, download WSO2 ESB and install as described in Getting Started.

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

   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.

6. Uncomment the following line in the <ESB_HOME>/repository/conf/axis2/axis2.xml file to enable the JMS transport sender on axis2core. 

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

7. 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.

   <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>

8. 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. 

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

2. Create the JMSPublisher  proxy service with the following configuration:

    <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>

   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

3. Create the JMSListener proxy service with the following configuration:

   <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>

4. 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.

   <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>

5. 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.
   

   [<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>