Hornetq JMS integration with Tomcat. Configure jms provider. Part 1 of 2

How to integrate hornetq jms provider with tomcat and apache/tomcat JNDI service.

If you are here, so you realy need to have ability to process some event in asynchronous fashion in your web application on tomcat or other lightweight web server. I dont want to use dedicated jms service , so i need in JVM communications only.

First of all lets check hornetq and tomcat jndi server jar dependency:

 
  <dependency> 
    <groupId>tomcat</groupId> 
    <artifactId>naming-factory</artifactId> 
    <version>5.5.23</version> 
    <scope>test</scope> 
  </dependency> 
  <dependency> 
    <groupId>tomcat</groupId> 
    <artifactId>naming-resources</artifactId> 
    <version>5.5.23</version> 
    <scope>test</scope> 
  </dependency> 
  <dependency> 
     <groupId>org.hornetq</groupId> 
     <artifactId>hornetq-core</artifactId> 
     <version>2.0.0.GA</version> 
     <scope>compile</scope> 
  </dependency> 
  <dependency> 
     <groupId>org.hornetq</groupId> 
     <artifactId>hornetq-jms</artifactId> 
     <version>2.0.0.GA</version> 
     <scope>compile</scope> 
  </dependency> 
  <dependency> 
     <groupId>org.hornetq</groupId> 
     <artifactId>hornetq-logging</artifactId> 
     <version>2.0.0.GA</version> 
     <scope>compile</scope> 
  </dependency> 
  <dependency> 
     <groupId>org.hornetq</groupId> 
     <artifactId>hornetq-transports</artifactId> 
     <version>2.0.0.GA</version> 
     <scope>compile</scope> 
  </dependency> 
  <dependency> 
     <groupId>org.jboss.netty</groupId> 
     <artifactId>netty</artifactId> 
     <version>3.1.0.GA</version> 
  </dependency> 
  <dependency> 
     <groupId>org.jboss.javaee</groupId> 
     <artifactId>jboss-jms-api</artifactId> 
     <version>1.1.0.GA</version> 
     <scope>compile</scope> 
  </dependency> 

As you can see there is no dependency from jboss jnpserver, because im gonne to use tomcat JNDI service.

Configuration in jndi.properties

java.naming.factory.initial=org.apache.naming.java.javaURLContextFactory 
java.naming.factory.url.pkgs=org.apache.naming 

#java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory 
#java.naming.factory.url.pkgs=org.jboss.naming:org.jnp.interfaces 
#java.naming.provider.url=jnp://localhost:1099 

My hornetq-jms.xml is following:

<?xml version="1.0" encoding="UTF-8"?>  
<configuration xmlns="urn:hornetq" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     
    xsi:schemaLocation="urn:hornetq /schema/hornetq-jms.xsd">  
    <connection-factory name="InVMConnectionFactory">
      <connectors>
         <connector-ref connector-name="in-vm"/>  
      </connectors>
      <entries> 
          <entry name="/HQConnectionFactory"/>
      </entries>
   </connection-factory>  
   <queue name="DLQ"><entry name="/queue/DLQ"/></queue>
   <queue name="ExpiryQueue"><entry name="/queue/ExpiryQueue"/>
   </queue><queue name="CustomerRegistrationQueue"><entry name="/queue/CustomerRegistrationQueue"/></queue>
</configuration>

Only in JVM connection factory is used and it binded to read/write JNDI context with HQConnectionFactory name.
At this point some can say, that context in tomcat is read only, but if you are have the brain you can perform small investigation and found, that you can bind to jndi context in tomcat, but not in java:/ context. For more information check the method checkWritable in org.apache.naming.NamingContext. If you ac try to use java:/ConnectionFactory name you will get the "javax.naming.NamingException: Context is read only".



File hornetq-configuration.xml

<configuration xmlns="urn:hornetq"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
               xsi:schemaLocation="urn:hornetq /schema/hornetq-configuration.xsd"> 

   <connectors>
       <connector name="in-vm"> 
         <factory-class>org.hornetq.core.remoting.impl.invm.InVMConnectorFactory</factory-class> 
      </connector>
   </connectors>

   <acceptors>
       <acceptor name="in-vm"> 
         <factory-class>org.hornetq.core.remoting.impl.invm.InVMAcceptorFactory</factory-class> 
         <param key="server-id" value="0"/>         
      </acceptor>
   </acceptors>

   <security-settings> 
      <security-setting match="#">
          <permission type="createDurableQueue" roles="guest"/>
          <permission type="deleteDurableQueue" roles="guest"/>
          <permission type="createTempQueue" roles="guest"/>
          <permission type="deleteTempQueue" roles="guest"/>
          <permission type="send" roles="guest"/>
          <permission type="consume" roles="guest"/>
          <permission type="manage" roles="guest"/>
      </security-setting> 
   </security-settings> 

   <address-settings> 
      <!--default for catch all--> 
      <address-setting match="#">
         <dead-letter-address>jms.queue.DLQ</dead-letter-address> 
         <expiry-address>jms.queue.ExpiryQueue</expiry-address> 
         <redelivery-delay>0</redelivery-delay> 
         <max-size-bytes>-1</max-size-bytes> 
         <page-size-bytes>10485760</page-size-bytes> 
         <message-counter-history-day-limit>10</message-counter-history-day-limit> 
      </address-setting> 
   </address-settings> 

   <paging-directory>${hornetq.data.dir}/paging</paging-directory> 
   <bindings-directory>${hornetq.data.dir}/bindings</bindings-directory> 
   <journal-directory>${hornetq.data.dir}/journal</journal-directory> 
   <large-messages-directory>${hornetq.data.dir}/large-messages</large-messages-directory> 
</configuration>

In servlet container wwe will need the hornetq-users.xml because of security issues.

<configuration xmlns="urn:hornetq"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:schemaLocation="urn:hornetq ../schemas/hornetq-users.xsd "> 
    <defaultuser name="guest" password="guest">
        <role name="guest"/>
    </defaultuser>
</configuration>    

Thats all with HornetQ and Tomcat. Next article will be with spring configuration files, that allow you to use hornetq via spring