22.10. Configure a Generic JMS Resource Adapter for Use with a Third-party JMS Provider

Procedure 22.10.  Configure a Generic JMS Resource Adapter for Use with a Third-party JMS Provider

1. Create a JBoss Module for the JMS provider

   Create a JBoss module that contains all the libraries required to connect and communicate with the JMS provider. This module will be named org.jboss.genericjms.provider.
   1. Create the following directory structure: EAP_HOME/modules/system/layers/base/org/jboss/genericjms/provider/main
   2. Copy the binaries required for the provider's JMS implementation to EAP_HOME/modules/system/layers/base/org/jboss/genericjms/provider/main.

      Note

      For Tibco EMS, the binaries required are tibjms.jar and tibcrypt.jar from the Tibco installation's lib directory.
   3. Create a module.xml file in EAP_HOME/modules/system/layers/base/org/jboss/genericjms/provider/main as below, listing the JAR files from the previous steps as resources:

      <module xmlns="urn:jboss:module:1.1" name="org.jboss.genericjms.provider">
        <resources> 
          <!-- all jars required by the JMS provider, in this case Tibco -->
          <resource-root path="tibjms.jar"/> 
          <resource-root path="tibcrypt.jar"/>
        </resources> 
        <dependencies> 
          <module name="javax.api"/> 
          <module name="javax.jms.api"/> 
        </dependencies> 
      </module>

2. Configure a JNDI external context to the JMS provider

   The JMS resources (connection factories and destinations) are looked up in the JMS provider. We will add an external context in the JBoss EAP 6 instance so that any local lookup for this resource will automatically look up the resource on the remote JMS provider.

   Note

   In this procedure, EAP_HOME/standalone/configuration/standalone-full.xml is used as the JBoss EAP 6 configuration file.
   In EAP_HOME/standalone/configuration/standalone-full.xml, under <subsystem xmlns="urn:jboss:domain:naming:1.4">, add:

   <bindings>
     <external-context name="java:global/remoteJMS/"
       module="org.jboss.genericjms.provider" 
       class="javax.naming.InitialContext">
       <environment>
         <property name="java.naming.factory.initial" value="${PROVIDER_FACTORY_INITIAL}"/>
         <property name="java.naming.provider.url" value="${PROVIDER_URL}"/>
         <property name="java.naming.factory.url.pkgs" value="${PROVIDER_URL_PKGS}"/>
       </environment>
     </external-context>
   </bindings>

   These three properties' values must be replaced by the correct value to connect to the remote JMS provider. Take care when replacing the placeholder text to keep the ${} intact.

3. Enable Lookup by String

   There are some JMS provider (such as Tibco EMS) that do not support the JNDI lookup(Name) method. In these cases, add the org.jboss.as.naming.lookup.by.string property with a value true to workaround this issue.

   Example 22.2.  Enable Lookup by String with Tibco EMS

   A complete definition for an external-context to Tibco EMS would be as follows.

   <bindings>
     <external-context name="java:global/remoteJMS/"
         module="org.jboss.genericjms.provider"
         class="javax.naming.InitialContext">
       <environment>
         <property name="java.naming.factory.initial" value="com.tibco.tibjms.naming.TibjmsInitialContextFactory"/>
         <property name="java.naming.provider.url" value="TIBCO_EMS_SERVER_HOST_NAME:PORT"/>
         <property name="java.naming.factory.url.pkgs" value="com.tibco.tibjms.naming"/>
         <property name="org.jboss.as.naming.lookup.by.string" value="true"/>
       </environment>
     </external-context>
   </bindings>

   With this external context, any JNDI lookup to a resource starting with java:global/remoteJMS/ will be done on the remote JMS provider (after removing this prefix). As an example, if a Message-Driven Bean perform a JNDI lookup for java:global/remoteJMS/Queue1, the external context will connect to the remote JMS provider and perform a lookup for the Queue1 resource.

4. Configure the Generic JMS Resource Adapter

   In EAP_HOME/standalone/configuration/standalone-full.xml, add the generic resource adapter configuration to <subsystem xmlns="urn:jboss:domain:resource-adapters:1.1">.

   Example 22.3.  Tibco EMS Resource Adapter Configuration

   A complete resource adapter definition for Tibco EMS would be as follows.

   <resource-adapter id="org.jboss.genericjms">
     <module slot="main" id="org.jboss.genericjms"/>
     <transaction-support>NoTransaction</transaction-support>
     <connection-definitions>
       <connection-definition class-name="org.jboss.resource.adapter.jms.JmsManagedConnectionFactory"
         jndi-name="java:/jms/XAQCF"
         pool-name="XAQCF">
         <config-property name="ConnectionFactory">
           XAQCF
         </config-property>
         <config-property name="JndiParameters">
     java.naming.factory.initial=com.tibco.tibjms.naming.TibjmsInitialContextFactory;java.naming.provider.url=TIBCO_EMS_SERVER_HOST_NAME:PORT
         </config-property>
         <security>
           <application/>
         </security>
       </connection-definition>
     </connection-definitions>
   </resource-adapter>

5. Configure the default message-driven bean pool with the generic resource adapter.

   In EAP_HOME/standalone/configuration/standalone-full.xml, in <subsystem xmlns="urn:jboss:domain:ejb3:1.5">, update the <mdb> configuration with:

   <mdb>
     <resource-adapter-ref resource-adapter-name="org.jboss.genericjms"/>
     <bean-instance-pool-ref pool-name="mdb-strict-max-pool"/>
   </mdb>