18.8. Configuration

1. Enable the JMS subsystem in JBoss EAP 6.

   Within the <extensions> element, verify that the following line is present and is not commented out:

   <extension module="org.jboss.as.messaging"/>

2. Add the basic JMS subsystem.

   If the Messaging subsystem is not present in your configuration file, add it.
   1. Look for the <profile> which corresponds to the profile you use, and locate its <subsystems> tag.
   2. Paste the following XML immediately following the <profile> tag.

      <subsystem xmlns="urn:jboss:domain:messaging:1.4">
          <hornetq-server>
          <!-- ALL XML CONFIGURATION IS ADDED HERE -->
          </hornetq-server>
      </subsystem>

      All further configuration will be added to the empty line above.

3. Add basic configuration for JMS.

   Add the following XML in the blank line after the <subsystem xmlns="urn:jboss:domain:messaging:1.4"><hornetq-server> tag:

   <journal-min-files>2</journal-min-files>
   <journal-type>NIO</journal-type>
   <persistence-enabled>true</persistence-enabled>

   Customize the values above to meet your needs.

   Warning

   The value of journal-file-size must be higher than or equal to min-large-message-size (100KiB by default), or the server won't be able to store the message.

4. Add connection factory instances to HornetQ

   The client uses a JMS ConnectionFactory object to make connections to the server. To add a JMS connection factory object to HornetQ, include a single <jms-connection-factories> tag and <connection-factory> element for each connection factory as follows:

     <jms-connection-factories>
       <connection-factory name="InVmConnectionFactory">
           <connectors>
               <connector-ref connector-name="in-vm"/>
           </connectors>
           <entries>
               <entry name="java:/ConnectionFactory"/>
           </entries>
       </connection-factory>
       <connection-factory name="RemoteConnectionFactory">
           <connectors>
               <connector-ref connector-name="netty"/>
           </connectors>
           <entries>
               <entry name="java:jboss/exported/jms/RemoteConnectionFactory"/>
           </entries>
       </connection-factory>
       <pooled-connection-factory name="hornetq-ra">
           <transaction mode="xa"/>
           <connectors>
               <connector-ref connector-name="in-vm"/>
           </connectors>
           <entries>
               <entry name="java:/JmsXA"/>
           </entries>
       </pooled-connection-factory>
   </jms-connection-factories>
   

5. Configure the netty connectors and acceptors

   This JMS connection factory uses netty acceptors and connectors. These are references to connector and acceptor objects deployed in the server configuration file. The connector object defines the transport and parameters used to connect to the HornetQ server. The acceptor object identifies the type of connections accepted by the HornetQ server.
   To configure the netty connectors, include the following settings:

   <connectors>
       <netty-connector name="netty" socket-binding="messaging"/>
       <netty-connector name="netty-throughput" socket-binding="messaging-throughput">
           <param key="batch-delay" value="50"/>
       </netty-connector>
       <in-vm-connector name="in-vm" server-id="0"/>
   </connectors>
   

   To configure the netty acceptors, include the following settings:

   <acceptors>
       <netty-acceptor name="netty" socket-binding="messaging"/>
       <netty-acceptor name="netty-throughput" socket-binding="messaging-throughput">
           <param key="batch-delay" value="50"/>
           <param key="direct-deliver" value="false"/>
       </netty-acceptor>
       <in-vm-acceptor name="in-vm" server-id="0"/>
   </acceptors>
   

6. Review the configuration

   If you have followed the previous steps, your messaging subsystem should look like the following:

   <subsystem xmlns="urn:jboss:domain:messaging:1.4">
       <hornetq-server>
           <journal-min-files>2</journal-min-files>
           <journal-type>NIO</journal-type>
           <persistence-enabled>true</persistence-enabled>
           <jms-connection-factories>
               <connection-factory name="InVmConnectionFactory">
                   <connectors>
                       <connector-ref connector-name="in-vm"/>
                   </connectors>
                   <entries>
                       <entry name="java:/ConnectionFactory"/>
                   </entries>
               </connection-factory>
               <connection-factory name="RemoteConnectionFactory">
                   <connectors>
                       <connector-ref connector-name="netty"/>
                   </connectors>
                   <entries>
                       <entry name="java:jboss/exported/jms/RemoteConnectionFactory"/>
                   </entries>
               </connection-factory>
               <pooled-connection-factory name="hornetq-ra">
                   <transaction mode="xa"/>
                   <connectors>
                       <connector-ref connector-name="in-vm"/>
                   </connectors>
                   <entries>
                       <entry name="java:/JmsXA"/>
                   </entries>
               </pooled-connection-factory>
           </jms-connection-factories>
           <connectors>
               <netty-connector name="netty" socket-binding="messaging"/>
               <netty-connector name="netty-throughput" socket-binding="messaging-throughput">
                   <param key="batch-delay" value="50"/>
               </netty-connector>
               <in-vm-connector name="in-vm" server-id="0"/>
           </connectors>	
           <acceptors>
               <netty-acceptor name="netty" socket-binding="messaging"/>
               <netty-acceptor name="netty-throughput" socket-binding="messaging-throughput">
                   <param key="batch-delay" value="50"/>
                   <param key="direct-deliver" value="false"/>
               </netty-acceptor>
               <in-vm-acceptor name="in-vm" server-id="0"/>
           </acceptors>
       </hornetq-server>
   </subsystem>
   

7. Configure the socket binding groups

   The netty connectors reference the messaging and messaging-throughput socket bindings. The messaging socket binding uses port 5445, and the messaging-throughput socket binding uses port 5455. The <socket-binding-group> tag is in a separate section of the server configuration file. Ensure the following socket bindings are present in the <socket-binding-groups> element:

   <socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:0}">
       ...
       <socket-binding name="messaging" port="5445"/>
       <socket-binding name="messaging-throughput" port="5455"/>
       ...
     </socket-binding-group>
   

8. Add queue instances to HornetQ

   There are 4 ways to setup the queue instances (or JMS destinations) for HornetQ.
   • Use the Management Console
     To use the Management Console, the server must have been started in the Message-Enabled mode. You can do this by using the -c option and forcing the use of the standalone-full.xml (for standalone servers) configuration file. For example, in the standalone mode, the following will start the server in a message enabled mode

     ./standalone.sh -c standalone-full.xml

     Once the server has started, logon to the Management Console and select the Configuration tab. Expand the Subsystems menu, then expand the Messaging menu and click Destinations. Next to Default on the JMS Messaging Provider table, click View, and then click Add to enter details of the JMS destination.
   • Use the Management CLI:
     First, connect to the Management CLI:

      bin/jboss-cli.sh --connect

     Next, change into the messaging subsystem:

     cd /subsystem=messaging/hornetq-server=default

     Finally, execute an add operation, replacing the examples values given below with your own:

     ./jms-queue=testQueue:add(durable=false,entries=["java:jboss/exported/jms/queue/test"])

   • Create a JMS configuration file and add it to the deployments folder
     Start by creating a JMS configuration file: example-jms.xml. Add the following entries to it, replacing the values with your own:

     <?xml version="1.0" encoding="UTF-8"?>				  	  <messaging-deployment xmlns="urn:jboss:messaging-deployment:1.0">
         <hornetq-server>
             <jms-destinations>
                 <jms-queue name="testQueue">
                     <entry name="queue/test"/>
                     <entry name="java:jboss/exported/jms/queue/test"/>
                 </jms-queue>
                 <jms-topic name="testTopic">
                     <entry name="topic/test"/>
                     <entry name="java:jboss/exported/jms/topic/test"/>
                 </jms-topic>
             </jms-destinations>
         </hornetq-server>
     </messaging-deployment>

     Save this file in the deployments folder and do a deployment.
   • Add entries in the JBoss EAP 6 configuration file.
     Queue attributes can be set in one of two ways.
     • Configuration at a JMS level
       The following shows a queue predefined in the standalone.xml or domain.xml configuration file.

       <jms-queue name="selectorQueue">
       	<entry name="/queue/selectorQueue"/>
       	<selector string="color='red'"/>
       	<durable>true</durable>
       </jms-queue>

       This name attribute of queue defines the name of the queue. When we do this at a jms level we follow a naming convention so the actual name of the core queue will be jms.queue.selectorQueue.
       The entry element configures the name that will be used to bind the queue to JNDI. This is a mandatory element and the queue can contain multiple of these to bind the same queue to different names.
       The selector element defines what JMS message selector the predefined queue will have. Only messages that match the selector will be added to the queue. This is an optional element with a default of null when omitted.
       The durable element specifies whether the queue will be persisted. This again is optional and defaults to true if omitted.
     • Configuration at a core level
       A queue can be predefined at a core level in the standalone.xml or domain.xml file. For example:

       <core-queues>
       	<queue name="jms.queue.selectorQueue">
       		<address>jms.queue.selectorQueue</address>
       		<filter string="color='red'"/>
       		<durable>true</durable>
       	</queue>
       </core-queues>

9. Perform additional configuration

   If you need additional settings, review the DTD in EAP_HOME/docs/schema/jboss-as-messaging_1_4.xsd.

• Configure Address Setting and Pattern Attributes

  Choose either the Management CLI or the Management Console to configure your pattern attributes as required.

  • Configure the Address Settings Using the Management CLI

    Use the Management CLI to configure address settings.

    1. Add a New Pattern

       Use the add operation to create a new address setting if required. You can run this command from the root of the Management CLI session, which in the following examples creates a new pattern titled patternname, with a max-delivery-attempts attribute declared as 5. The examples for both Standalone Server and a Managed Domain editing on the full profile are shown.

       [standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default/address-setting=patternname/:add(max-delivery-attempts=5)

       [domain@localhost:9999 /] /profile=full/subsystem=messaging/hornetq-server=default/address-setting=patternname/:add(max-delivery-attempts=5)

    2. Edit Pattern Attributes

       Use the write operation to write a new value to an attribute. You can use tab completion to help complete the command string as you type, as well as to expose the available attributes. The following example updates the max-delivery-attempts value to 10

       [standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default/address-setting=patternname/:write-attribute(name=max-delivery-attempts,value=10)

       [domain@localhost:9999 /] /profile=full/subsystem=messaging/hornetq-server=default/address-setting=patternname/:write-attribute(name=max-delivery-attempts,value=10)

    3. Confirm Pattern Attributes

       Confirm the values are changed by running the read-resource operation with the include-runtime=true parameter to expose all current values active in the server model.

       [standalone@localhost:9999 /] /subsystem=messaging/hornetq-server=default/address-setting=patternname/:read-resource

       [domain@localhost:9999 /] /profile=full/subsystem=messaging/hornetq-server=default/address-setting=patternname/:read-resource

  • Configure the Address Settings Using the Management Console

    Use the Management Console to configure address settings.
    1. Log into the Management Console of your Managed Domain or Standalone Server.
    2. Select the Configuration tab at the top of the screen. For Domain mode, select a profile from the Profile menu at the top left. Only the full and full-ha profiles have the messaging subsystem enabled.
    3. Expand the Messaging menu, and select Destinations.
    4. A list of JMS Providers is shown. In the default configuration, only one provider, called default, is shown. Click View to view the detailed settings for this provider.
    5. Click the Address Settings tab. Either add a new pattern by clicking Add, or select an existing pattern and clickEdit to update the settings.
    6. If you are adding a new pattern, the Pattern field refers to the match parameter of the address-setting element. You can also edit the Dead Letter Address, Expiry Address, Redelivery Delay, and Max Delivery Attempts. Other options need to be configured using the Management CLI.

Procedure 18.1. Set HornetQ logging by editing server configuration files manually

1. Open the server configuration file(s) for editing. For example standalone-full.xml and standalone-full-ha.xml
2. Navigate to logging subsystem configuration in the file(s). The default configuration looks like this:

   <logger category="com.arjuna">
    <level name="TRACE"/>
   </logger>
   ...
   <logger category="org.apache.tomcat.util.modeler">
    <level name="WARN"/>
   </logger>
   ....
   

3. Add the org.hornetq logger category along with the desired logging level as shown in the following example:

   <logger category="com.arjuna">
     <level name="TRACE"/>
   </logger>
   ...
   <logger category="org.hornetq">
     <level name="INFO"/>
   </logger>
   ....