Chapter 31. Resource Adapters

A Java Connector Architecture (JCA) Resource Adapter lets your applications communicate with any messaging provider. It configures how JEE components such as MDBs and other EJBs, and even Servlets, can send or receive messages.

31.1. About the Integrated Artemis Resource Adapter

JBoss EAP 7 includes an integrated Artemis resource adapter, which uses the pooled-connection-factory element to configure the outbound and inbound connections of the resource adapter.

Outbound Connection

Outbound connections are defined using the pooled-connection-factory element, which is then used in Java EE deployments by EJBs and servlets to send messages to and receive messages from queues or topics. Because connections created from connection factories are created in the scope of the application server, they can use application server features like the following:

  • Connection pooling
  • Authentication using the security domains defined by the application server
  • Participation in XA transactions using the transaction manager

This is a major difference with a pooled-connection-factory as these features are not available with a basic connection-factory like InVmConnectionFactory or RemoteConnectionFactory. Also, be aware that with a connection factory defined using pooled-connection-factory, it is not possible to do a lookup using JNDI from an external standalone JMS client.

Inbound Connections

Inbound connections are used only by message-driven beans (MDBs) to receive message from a queue or a topic. MDBs are stateless session beans that listen on a queue or topic. They must implement the public onMessage(Message message) method, which is called when a message is sent to a queue or a topic. The Artemis resource adapter is responsible for receiving the message from the queue or the topic and passing it to the onMessage(Message message) method. For this purpose it configures the inbound connection, which defines the location of the integrated Artemis server and some additional elements.

Each MDB session bean uses a thread from the client thread pool to consume the message from the destination. If the maximum pool size is not defined, it is determined to be eight (8) times the number of CPU core processors. For systems with many MDB sessions, such as test suites, this can potentially lead to thread exhaustion and force MDBs to wait for a free thread from the pool. You can increase the maximum pool size of client thread pool using the management CLI. The following command sets the maximum client thread pool size to 128.

/subsystem=messaging-activemq:write-attribute(name=global-client-thread-pool-max-size,value=128)

For information about how to configure the client thread pool size, see Client Thread Management. For more information about MDBs, see Message Driven Beans in Developing EJB Applications for JBoss EAP.

31.2. Using the Integrated Artemis Resource Adapter for Remote Connections

JBoss EAP includes a resource adapter to make connections to its integrated ActiveMQ Artemis messaging server. By default the pooled-connection-factory defined in the messaging-activemq subsystem uses the adapter to make the connections. However, you can use the same resource adapter to make connections to an Artemis server running inside a remote instance of JBoss EAP as well.

Important

The activemq-ra pooled connection factory, which is configured by default in the messaging-activemq subsystem, has the java:jboss/DefaultJMSConnectionFactory entry assigned. This entry is required by the messaging-activemq subsystem. If you decide to remove the activemq-ra pooled connection factory, you must assign this entry to a different connection factory. Otherwise you will see the following error in the server log on deployment.

WFLYCTL0412: Required services that are not installed:" => ["jboss.naming.context.java.jboss.DefaultJMSConnectionFactory"]

To connect to an Artemis server running inside a remote instance of JBoss EAP, create a new pooled-connection-factory by following the steps below.

  1. Create an outbound-socket-binding pointing to the remote messaging server:

    /socket-binding-group=standard-sockets/remote-destination-outbound-socket-binding=remote-server:add(host=<server host>, port=8080)
  2. Create a remote-connector referencing the outbound-socket-binding created in step 1.

    /subsystem=messaging-activemq/server=default/http-connector=remote-http-connector:add(socket-binding=remote-server,endpoint=http-acceptor)
  3. Create a pooled-connection-factory referencing the remote-connector created in step 2.

    /subsystem=messaging-activemq/server=default/pooled-connection-factory=remote-artemis:add(connectors=[remote-http-connector], entries=[java:/jms/remoteCF])

Configuring an MDB to use a pooled-connection-factory

After the pooled-connection-factory is configured to connect to a remote Artemis server, Message-Driven Beans (MDB) wanting to read messages from the remote server must be annotated with the @ResourceAdapter annotation using the name of the pooled-connection-factory resource.

import org.jboss.ejb3.annotation.ResourceAdapter;

@ResourceAdapter("remote-artemis")
@MessageDriven(name = "MyMDB", activationConfig = { ... })
public class MyMDB implements MessageListener {
    public void onMessage(Message message) {
       ...
    }
}

If the MDB needs to send messages to the remote server, it must inject the pooled-connection-factory by looking it up using one of its JNDI entries.

@Inject
@JMSConnectionFactory("java:/jms/remoteCF")
private JMSContext context;

Configuring the JMS destination

An MDB must also specify the destination from which it will consume messages. The standard way to do this is to define a destinationLookup activation config property that corresponds to a JNDI lookup on the local server.

@ResourceAdapter("remote-artemis")
@MessageDriven(name = "MyMDB", activationConfig = {
    @ActivationConfigProperty(propertyName = "destinationLookup", propertyValue = "myQueue"),
    ...
})
public class MyMDB implements MessageListener {
    ...
}

If the local server does not include a JNDI binding for the remote Artemis server, specify the name of the destination, as configured in the remote Artemis server, using the destination activation config property and set the useJNDI activation config property to false. This instructs the Artemis resource adapter to automatically create the JMS destination without requiring a JNDI lookup.

@ResourceAdapter("remote-artemis")
@MessageDriven(name = "MyMDB", activationConfig = {
    @ActivationConfigProperty(propertyName = "useJNDI", propertyValue = "false"),
    @ActivationConfigProperty(propertyName = "destination", propertyValue = "myQueue"),
    ...
})
public class MyMDB implements MessageListener {
    ...
}

In the above example, the activation config properties configure the MDB to consume messages from the JMS Queue named myQueue hosted on the remote Artemis server. In most cases, the MDB does not need to lookup other destinations to process the consumed messages, and it can use the JMSReplyTo destination if it is defined on the message.

If the MDB needs any other JMS destinations defined on the remote server, it must use client-side JNDI. See Connecting to a Server for more information.

31.3. Configuring the Artemis Resource Adapter to Connect to Red Hat AMQ

You can configure the integrated Artemis resource adapter to connect to a remote installation of Red Hat AMQ 7, which then becomes the JMS provider for your JBoss EAP 7.2 applications. This allows JBoss EAP to be a client for the remote Red Hat AMQ 7 server.

If you require support for other messaging protocols, such as AMQP or STOMP, you must configure Red Hat AMQ 7 as your messaging broker. The Artemis resource adapter integrated in the JBoss EAP server can then be used to process messages for the deployed applications.

Limitations of the Integrated Resource Adapter

Dynamic Creation of Queues and Topics

Be aware that the Artemis resource adapter that is integrated in JBoss EAP 7.2 does not support dynamic creation of queues and topics in the Red Hat AMQ 7 broker. You must configure all queue and topic destinations directly on the remote Red Hat AMQ 7 server.

Creation of Connection Factories

Although Red Hat AMQ allows connection factories to be configured using both the pooled-connection-factory and the external-context, there is a difference in the way each connection factory is created. When the external-context is used to create the connection factory, it creates simple JMS connection factory as defined in the JMS specification. The newly created connection factory is equivalent to the RemoteConnectionFactory, which is defined by default in messaging-activemq subsystem. This connection factory is independent of the other components in the application server, meaning it is not aware of, nor is it able to use, other components like the transaction manager or the security manager. For this reason, only the pooled-connection-factory can be used to create connection factories in JBoss EAP 7. The external-context can only be used to register JMS destinations, which are already configured on the remote AMQ 7 broker, into the JNDI tree of the JBoss EAP 7 server so that local deployments can look them up or inject them.

Connection factories created by configuring the external-context or the connection-factory elements cannot be used to connect to the remote AMQ 7 broker as they do not use the Artemis resource adapter. Only connection factories created by configuring the pooled-connection-factory element are supported for use when connecting to the remote AMQ7 broker.

Configure JBoss EAP to Use a Remote Red Hat AMQ Server

You can use the management CLI to configure JBoss EAP to use a remote installation of Red Hat AMQ 7 as the messaging provider by following the steps below:

  1. Configure the queue in the Red Hat AMQ 7 broker.xml deployment descriptor file.

    <configuration xmlns="urn:activemq"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   xsi:schemaLocation="urn:activemq /schema/artemis-configuration.xsd">
    
        <core xmlns="urn:activemq:core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="urn:activemq:core ">
            ...
            <acceptors>
                <acceptor name="netty-acceptor">tcp://localhost:61616?anycastPrefix=jms.queue.;multicastPrefix=jms.topic.
                </acceptor>
            </acceptors>
            <addresses>
                <address name="MyQueue">
                    <anycast>
                        <queue name="MyQueue" />
                    </anycast>
                </address>
                <address name="MyOtherQueue">
                    <anycast>
                        <queue name="MyOtherQueue" />
                    </anycast>
                </address>
                <address name="MyTopic">
                    <multicast/>
                </address>
            <addresses>
            ...
        </core>
    </configuration>
    Note

    The Artemis resource adapter that is included with JBoss EAP uses the ActiveMQ Artemis JMS Client 1.5.5. This client requires anycastPrefix and multicastPrefix prefixing on the address. It also expects the queue name to be the same as the address name.

  2. Create the remote connector.

    /subsystem=messaging-activemq/remote-connector=netty-remote-throughput:add(socket-binding=messaging-remote-throughput)

    This creates the following remote-connector in the messaging-activemq subsystem.

    <subsystem xmlns="urn:jboss:domain:messaging-activemq:4.0">
        ...
        <remote-connector name="netty-remote-throughput" socket-binding="messaging-remote-throughput"/>
        ...
    </subsystem>
  3. Add the remote destination outbound socket binding.

    /socket-binding-group=standard-sockets/remote-destination-outbound-socket-binding=messaging-remote-throughput:add(host=localhost, port=61616)

    This creates the following remote-destination in the outbound-socket-binding element configuration.

    <outbound-socket-binding name="messaging-remote-throughput">
        <remote-destination host="localhost" port="61616"/>
    </outbound-socket-binding>
  4. Add a pooled connection factory for the remote connector.

    /subsystem=messaging-activemq/pooled-connection-factory=activemq-ra-remote:add(transaction=xa,entries=[java:/RemoteJmsXA, java:jboss/RemoteJmsXA],connectors=[netty-remote-throughput])

    This creates the following pooled-connection-factory in the messaging-activemq subsystem.

    <subsystem xmlns="urn:jboss:domain:messaging-activemq:4.0">
        ...
        <pooled-connection-factory name="activemq-ra-remote" entries="java:/RemoteJmsXA java:jboss/RemoteJmsXA" connectors="netty-remote-throughput"/>
        ...
    </subsystem>
  5. Create the external-context bindings for the queues and topics.

    /subsystem=naming/binding=java\:global\/remoteContext:add(binding-type=external-context, class=javax.naming.InitialContext, module=org.apache.activemq.artemis, environment=[java.naming.factory.initial=org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory, java.naming.provider.url=tcp://127.0.0.1:61616, queue.MyQueue=MyQueue, queue.MyOtherQueue=MyOtherQueue, topic.MyTopic=MyTopic])

    This creates the following external-context bindings in the naming subsystem.

    <subsystem xmlns="urn:jboss:domain:naming:2.0">
        ...
        <bindings>
            <external-context name="java:global/remoteContext" module="org.apache.activemq.artemis" class="javax.naming.InitialContext">
                <environment>
                    <property name="java.naming.factory.initial" value="org.apache.activemq.artemis.jndi.ActiveMQInitialContextFactory"/>
                    <property name="java.naming.provider.url" value="tcp://127.0.0.1:61616"/>
                    <property name="queue.MyQueue" value="MyQueue"/>
                    <property name="queue.MyOtherQueue" value="MyOtherQueue"/>
                    <property name="topic.MyTopic" value="MyTopic"/>
                </environment>
            </external-context>
        </bindings>
        ...
    </subsystem>
  6. Create the lookup entry for the JMS queues and topics by setting the JNDI name to the Red Hat AMQ 7 address name value. This creates a mapping between the JNDI name and the Red Hat AMQ 7 address name.

    /subsystem=naming/binding=java\:\/MyQueue:add(lookup=java:global/remoteContext/MyQueue,binding-type=lookup)
    /subsystem=naming/binding=java\:\/MyOtherQueue:add(lookup=java:global/remoteContext/MyOtherQueue,binding-type=lookup)
    /subsystem=naming/binding=java\:\/MyTopic:add(lookup=java:global/remoteContext/MyTopic,binding-type=lookup)

    This creates the following lookup configurations in the naming subsystem.

    <subsystem xmlns="urn:jboss:domain:naming:2.0">
        ...
        <lookup name="java:/MyQueue" lookup="java:global/remoteContext/MyQueue"/>
        <lookup name="java:/MyOtherQueue" lookup="java:global/remoteContext/MyOtherQueue"/>
        <lookup name="java:/MyTopic" lookup="java:global/remoteContext/MyTopic"/>
        ...
    </subsystem>

    Alternatively, define the /subsystem=messaging-activemq/external-jms-queue or the /subsystem=messaging-activemq/external-jms-topic resource instead of configuring naming subsystem. For example:

    /subsystem=messaging-activemq/external-jms-queue=MyQueue:add(entries=[java:/MyQueue])

    This creates the following resource:

    <subsystem xmlns="urn:jboss:domain:messaging-activemq:4.0">
        ...
        <external-jms-queue name="MyQueue" entries="java:/MyQueue"/>
        ...
    </subsystem>
    Note

    The external-jms-queue resource does not provide operations for queue management and statistics.

JBoss EAP is now configured to use the remote installation of Red Hat AMQ 7 as the messaging provider.

31.4. Deploying a Red Hat JBoss A-MQ Resource Adapter

You can deploy the resource adapter provided by the Red Hat JBoss A-MQ product and have, for example, Red Hat JBoss A-MQ 6.3.0, become the external JMS provider for JBoss EAP.

See Install the ActiveMQ Resource Adapter in Integrating with JBoss Enterprise Application Platform, which is in the Red Hat JBoss A-MQ documentation suite, for details on how to deploy and configure a Red Hat JBoss A-MQ resource adapter.

Note

Be aware that the product name changed from Red Hat JBoss A-MQ in the 6.x releases to Red Hat AMQ in the 7.x releases.

31.4.1. Issues with the Red Hat JBoss A-MQ 6 Resource Adapter

  • JBoss EAP will track and monitor applications, looking for unclosed resources. While useful in many cases, such monitoring might cause unexpected behavior when an application tries to re-use a closed instance of UserTransaction in a single method. Add the attribute tracking="false" to the <connection-definition/> element when configuring the Red Hat JBoss A-MQ resource adapter if your applications re-use connections in this way.

    <connection-definition class-name="..." tracking="false" ... />
  • The Red Hat JBoss A-MQ 6 resource adapter does not implement XAResourceWrapper from the Narayana API, which is used by JBoss EAP. Consequently, when the Transaction Manager sends a commit to all the XA transaction participants and then crashes while waiting for a reply, it will go on indefinitely logging warnings until records of the committed transaction are removed from its object store.
  • The Red Hat JBoss A-MQ 6 resource adapter returns the code XAER_RMERR when an error, such as a network disconnection, occurs during the call of the commit method protocol. This behavior breaks the XA specification since the correct return code should be XAER_RMFAIL or XAER_RETRY. Consequently, the transaction is left in an unknown state on the message broker side, which can cause data inconsistency in some cases. A message will be logged similar to the one below when the unexpected error code is returned.

    WARN [com.arjuna.ats.jtax] ...: XAResourceRecord.rollback caused an XA error: ARJUNA016099: Unknown error code:0 from resource ... in transaction ...: javax.transaction.xa.XAException: Transaction ... has not been started.
  • Red Hat JBoss A-MQ 6.x supports the JMS 1.1 specification that is included with Java EE 6. It does not support the JMS 2.0 specification that was introduced in Java EE 7 and is supported in JBoss EAP 7. If you need to send messages to a remote Red Hat JBoss A-MQ broker, you must use the JMS 1.1 API within your application code. For more information about Red Hat JBoss A-MQ 6.x supported standards, see Red Hat JBoss A-MQ Supported Standards and Protocols.

31.5. Deploying the IBM MQ Resource Adapter

About IBM MQ

IBM MQ is the Messaging Oriented Middleware (MOM) product offering from IBM that allows applications on distributed systems to communicate with each other. This is accomplished through the use of messages and message queues. IBM MQ is responsible for delivering messages to the message queues and for transferring data to other queue managers using message channels. For more information about IBM MQ, see IBM MQ on the IBM products website.

Summary

IBM MQ can be configured as an external JMS provider for JBoss EAP 7.2. This section covers the steps to deploy and configure the IBM MQ resource adapter in JBoss EAP. This deployment and configuration can be accomplished by using the management CLI tool or the web-based management console.

JBoss EAP 7.2 has been tested with the following configurations.

  • The IBM MQ 8.0.0.10 resource adapter was tested against the IBM MQ 8.0.0.x broker. Versions 8.0.0.0 through 8.0.0.9 of the IBM MQ resource adapter are not supported.
  • The IBM MQ 9.0.0.4 resource adapter was tested against the IBM MQ 9.0.0.x broker. Versions 9.0.0.0 through 9.0.0.3 of the IBM MQ resource adapter are not supported.

See JBoss EAP supported configurations for the most current information about the supported configurations of IBM MQ.

Prerequisites

Before you get started, you must verify the version of the IBM MQ resource adapter and understand its configuration properties.

  • The IBM MQ resource adapter is supplied as a Resource Archive (RAR) file called wmq.jmsra.rar. You can obtain the wmq.jmsra.rar file from /opt/mqm/java/lib/jca/wmq.jmsra.rar. See JBoss EAP supported configurations for information about the specific versions that are supported for each release of JBoss EAP.
  • You must know the following IBM MQ configuration values. Refer to the IBM MQ product documentation for details about these values.

    • MQ_QUEUE_MANAGER: The name of the IBM MQ queue manager
    • MQ_HOST_NAME: The host name used to connect to the IBM MQ queue manager
    • MQ_CHANNEL_NAME: The server channel used to connect to the IBM MQ queue manager
    • MQ_QUEUE_NAME: The name of the destination queue
    • MQ_TOPIC_NAME: The name of the destination topic
    • MQ_PORT: The port used to connect to the IBM MQ queue manager
    • MQ_CLIENT: The transport type
  • For outbound connections, you must also be familiar with the following configuration value:

    • MQ_CONNECTIONFACTORY_NAME: The name of the connection factory instance that will provide the connection to the remote system

Procedure

Note

The following are default configurations provided by IBM and are subject to change. Please refer to IBM MQ documentation for more information.

  1. First, deploy the resource adapter manually by copying the wmq.jmsra.rar file to the EAP_HOME/standalone/deployments/ directory.
  2. Next, use the management CLI to add the resource adapter and configure it.

    /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar:add(archive=wmq.jmsra.rar, transaction-support=XATransaction)

    Note that the transaction-support element was set to XATransaction. When using transactions, be sure to supply the security domain of the XA recovery datasource, as in the example below.

    /subsystem=resource-adapters/resource-adapter=test/connection-definitions=test:write-attribute(name=recovery-security-domain,value=myDomain)

    For more information about XA Recovery see Configuring XA Recovery in the JBoss EAP Configuration Guide.

    For non-transactional deployments, change the value of transaction-support to NoTransaction.

    /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar:add(archive=wmq.jmsra.rar, transaction-support=NoTransaction)
  3. Now that the resource adapter is created, you can add the necessary configuration elements to it.

    1. Add an admin-object for queues and configure its properties.

      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/admin-objects=queue-ao:add(class-name=com.ibm.mq.connector.outbound.MQQueueProxy, jndi-name=java:jboss/MQ_QUEUE_NAME)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/admin-objects=queue-ao/config-properties=baseQueueName:add(value=MQ_QUEUE_NAME)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/admin-objects=queue-ao/config-properties=baseQueueManagerName:add(value=MQ_QUEUE_MANAGER)
    2. Add an admin-object for topics and configure its properties.

      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/admin-objects=topic-ao:add(class-name=com.ibm.mq.connector.outbound.MQTopicProxy, jndi-name=java:jboss/MQ_TOPIC_NAME)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/admin-objects=topic-ao/config-properties=baseTopicName:add(value=MQ_TOPIC_NAME)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/admin-objects=topic-ao/config-properties=brokerPubQueueManager:add(value=MQ_QUEUE_MANAGER)
    3. Add a connection definition for a managed connection factory and configure its properties.

      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/connection-definitions=mq-cd:add(class-name=com.ibm.mq.connector.outbound.ManagedConnectionFactoryImpl, jndi-name=java:jboss/MQ_CONNECTIONFACTORY_NAME, tracking=false)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/connection-definitions=mq-cd/config-properties=hostName:add(value=MQ_HOST_NAME)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/connection-definitions=mq-cd/config-properties=port:add(value=MQ_PORT)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/connection-definitions=mq-cd/config-properties=channel:add(value=MQ_CHANNEL_NAME)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/connection-definitions=mq-cd/config-properties=transportType:add(value=MQ_CLIENT)
      
      /subsystem=resource-adapters/resource-adapter=wmq.jmsra.rar/connection-definitions=mq-cd/config-properties=queueManager:add(value=MQ_QUEUE_MANAGER)
  4. If you want to change the default provider for the EJB3 messaging system in JBoss EAP from JBoss EAP 7 messaging to IBM MQ, use the management CLI to modify the ejb3 subsystem as follows:

    /subsystem=ejb3:write-attribute(name=default-resource-adapter-name,value=wmq.jmsra.rar)
  5. Configure the @ActivationConfigProperty and @ResourceAdapter annotations in the MDB code as follows:

    @MessageDriven(name="IbmMqMdb", activationConfig = {
        @ActivationConfigProperty(propertyName = "destinationType",propertyValue = "javax.jms.Queue"),
        @ActivationConfigProperty(propertyName = "useJNDI", propertyValue = "false"),
        @ActivationConfigProperty(propertyName = "hostName", propertyValue = "MQ_HOST_NAME"),
        @ActivationConfigProperty(propertyName = "port", propertyValue = "MQ_PORT"),
        @ActivationConfigProperty(propertyName = "channel", propertyValue = "MQ_CHANNEL_NAME"),
        @ActivationConfigProperty(propertyName = "queueManager", propertyValue = "MQ_QUEUE_MANAGER"),
        @ActivationConfigProperty(propertyName = "destination", propertyValue = "MQ_QUEUE_NAME"),
        @ActivationConfigProperty(propertyName = "transportType", propertyValue = "MQ_CLIENT")
    })
    
    @ResourceAdapter(value = "wmq.jmsra-VERSION.rar")
    @TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED)
    public class IbmMqMdb implements MessageListener {
    }

    Be sure to replace the VERSION in the @ResourceAdapter value with the actual version in the name of the RAR.

31.5.1. Limitations and Known Issues with the IBM MQ Resource Adapters

The following table lists known issues with the IBM MQ resource adapters. A checkmark () in the version column indicates the issue is a problem for that version of the resource adapter.

Table 31.1. Known Issues with the IBM MQ Resource Adapters

JIRADescription of IssueIBM MQ 8IBM MQ 9

JBEAP-503

The IBM MQ resource adapter returns different String values for the Queue.toString() and QueueBrowser.getQueue().toString() methods. Queue is instance of the com.ibm.mq.connector.outbound.MQQueueProxy class, which is different from the com.ibm.mq.jms.MQQueue class that is returned by the QueueBrowser.htmlQueueBrowser.getQueue() method. These classes contain different implementations of the toString() method. Be aware that you cannot rely on these toString() methods to return the same value.

JBEAP-511, JBEAP-550, JBEAP-3686

The following restrictions apply to message property names for IBM MQ.

  • In the activation-config section of the deployment descriptor, you must not configure the destinationName property using special characters such as _, &, or |. Use of these characters causes the MDB deployment to fail with a com.ibm.msg.client.jms.DetailedInvalidDestinationException exception.
  • In the activation-config section of the deployment descriptor, you must not configure the destinationName property using the java:/ prefix. Use of this prefix causes the MDB deployment to fail with a com.ibm.msg.client.jms.DetailedInvalidDestinationException exception.
  • A property must not begin with "JMS" or "usr.JMS" as they are reserved for use by IBM MQ JMS classes. Exceptions are noted on the IBM Knowledge Center website.

See Property name restrictions for IBM MQ, Version 8.0 and Property name restrictions for IBM MQ, Version 9.0 on the IBM Knowledge Center website for the complete list of message property name restrictions for each version of the resource adapter.

JBEAP-549

When specifying the destination property name value for an MDB using the @ActivationConfigProperty annotation, you must use all upper case letters. For example:

@ActivationConfigProperty(propertyName = "destination", propertyValue = "QUEUE")

JBEAP-624

If the IBM MQ resource adapter is used to create a connection factory in a Java EE deployment using the @JMSConnectionFactoryDefinition annotation, you must specify the resourceAdapter property. Otherwise, the deployment will fail.

@JMSConnectionFactoryDefinition(
    name = "java:/jms/WMQConnectionFactory",
    interfaceName = "javax.jms.ConnectionFactory",
    resourceAdapter = "wmq.jmsra",
    properties = {
        "channel=<channel>",
        "hostName=<hostname_wmq_broker>",
        "transportType=<transport_type>",
        "queueManager=<queue_manager>"
    }
)

JBEAP-2339

The IBM MQ resource adapter is able to read messages from queues and topics even before the connection has started. This means a consumer can consume messages before the connection is started. To avoid hitting this issue, use connection factories created by the remote IBM MQ broker using the external-context and not connection factories created by IBM MQ resource adapter.

JBEAP-3685

Once <transaction-support>XATransaction</transaction-support> is set, a JMSContext is always JMSContext.SESSION_TRANSACTED, whether it was created using injection or manually.

In the following code example, the @JMSSessionMode(JMSContext.DUPS_OK_ACKNOWLEDGE) is ignored and the JMSContext remains at JMSContext.SESSION_TRANSACTED.

@Inject
@JMSConnectionFactory("jms/CF")
@JMSPasswordCredential(userName="myusername", password="mypassword")
@JMSSessionMode(JMSContext.DUPS_OK_ACKNOWLEDGE)
transient JMSContext context3;

JBEAP-14633

According to the JMS specification, the QueueSession interface cannot be used to create objects specific to the publish/subscribe domain and certain methods that inherit from Session should throw an javax.jms.IllegalStateException. One such method is such QueueSession.createTemporaryTopic(). Instead of throwing an javax.jms.IllegalStateException, the IBM MQ resource adapter throws a java.lang.NullPointerException.

JBEAP-14634

The MQTopicProxy.getTopicName() returns different topic name than was set by the IBM MQ broker. For example, if the topic name was set to topic://MYTOPIC?XMSC_WMQ_BROKER_PUBQ_QMGR=QM, the MQTopicProxy returns topic://MYTOPIC.

JBEAP-14636

The default autoStart setting for the JMSContext is false, meaning the underlying connection used by the JMSContext is not started automatically when a consumer is created. This setting should default to true.

JBEAP-14640

The IBM MQ resource adapter throws DetailedJMSException instead of a JMSSecurityException when invalid credentials are used and logs the following error to the server console.

WARN  [org.jboss.jca.core.connectionmanager.pool.strategy.PoolByCri] (EJB default - 7) IJ000604: Throwable while attempting to get a new connection: null: com.ibm.mq.connector.DetailedResourceException: MQJCA1011: Failed to allocate a JMS connection., error code: MQJCA1011 An internal error caused an attempt to allocate a connection to fail. See the linked exception for details of the failure.

The following is an example of code that can cause this issue.

QueueConnection qc = queueConnectionFactory.createQueueConnection("invalidUserName", "invalidPassword");

JBEAP-14642

Due to an invalid class cast conversion by the resource adapter in the MQMessageProducer.send(Destination destination, Message message) and MQMessageProducer.send(Destination destination, Message message, int deliveryMode, int priority, long timeToLive, CompletionListener completionListener) methods, the IBM MQ resource adapter throws a JMSException and logs the following error message to the server console.

SVR-ERROR: Expected JMSException, received com.ibm.mq.connector.outbound.MQQueueProxy cannot be cast to com.ibm.mq.jms.MQDestination

This is because the JNDI name used in the queue or topic lookup is com.ibm.mq.connector.outbound.MQQueueProxy/MQTopicProxy.

JBEAP-14643

The setDeliveryDelay(expDeliveryDelay) method on the JMSProducer interface does not change the setting. After calling this method, it remains at the default setting of 0.

JBEAP-14670

If work is done on a QueueSession that was created prior to a UserTransaction.begin(), that work is not considered part of the transaction. This means that any message sent to the queue using this session is not committed by a UserTransaction.commit(), and after a UserTransaction.rollback(), the message remains on the queue.

JBEAP-14675

If you close a connection and then immediately create a JMSContext with the same clientID, the IBM MQ resource adapter intermittently logs the following error to the server console.

ERROR [io.undertow.request] (default task-1) UT005023: Exception handling request to /jmsServlet-1.0-SNAPSHOT/: com.ibm.msg.client.jms.DetailedJMSRuntimeException: MQJCA0002: An exception occurred in the IBM MQ layer. See the linked exception for details.
A call to IBM MQ classes for Java(tm) caused an exception to be thrown.

This issue does not occur when there is a delay in creating the new JMSContext after the connection with the same clientID is closed.

JBEAP-15535

If a stateful session bean tries to send a message to a topic while in a container managed transaction (CMT), the message send fails with the following message.

SVR-ERROR: com.ibm.msg.client.jms.DetailedJMSException: JMSWMQ2007: Failed to send a message to destination 'MDB_NAME TOPIC_NAME'

The stack trace shows it to be caused by the following exception.

com.ibm.mq.MQException: JMSCMQ0001: IBM MQ call failed with compcode '2' ('MQCC_FAILED') reason '2072' ('MQRC_SYNCPOINT_NOT_AVAILABLE')

 

31.6. Deploying a Generic JMS Resource Adapter

JBoss EAP can be configured to work with third-party JMS providers; however, not all JMS providers produce a JMS JCA resource adapter for integration with Java application platforms. This procedure covers the steps required to configure the generic JMS resource adapter included in JBoss EAP to connect to a JMS provider. In this procedure, Tibco EMS 8 is used as an example JMS provider. Other JMS providers may require different configuration.

Important

Before using the generic JMS resource adapter, check with the JMS provider to see if they have their own resource adapter that can be used with JBoss EAP. The generic JMS JCA resource adapter should only be used when a JMS provider does not provide its own resource adapter.

Before you can configure a generic resource adapter, you will need to do the following:

  • Your JMS provider server must already be configured and ready for use. Any binaries required for the provider’s JMS implementation will be needed.
  • You will need to know the values of the following JMS provider properties to be able to look up its JMS resources, such as connection factories, queues or topics.

    • java.naming.factory.initial
    • java.naming.provider.url
    • java.naming.factory.url.pkgs

In the example XML used in this procedure, these parameters are written as PROVIDER_FACTORY_INITIAL, PROVIDER_URL, and PROVIDER_CONNECTION_FACTORY respectively. Replace these placeholders with the JMS provider values for your environment.

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

  1. Create and configure the resource adapter module.

    Create a JBoss EAP module that contains all the libraries required to connect and communicate with the JMS provider. This module will be named org.jboss.genericjms.provider.

    • Create the following directory structure: EAP_HOME/modules/org/jboss/genericjms/provider/main
    • Copy the binaries required for the provider’s JMS implementation to EAP_HOME/modules/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.

    • Create a module.xml file in EAP_HOME/modules/org/jboss/genericjms/provider/main as below, listing the JAR files from the previous steps as resources:

      <module xmlns="urn:jboss:module:1.5" 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>
    • Add the module to the ee subsystem using the following CLI command:

      /subsystem=ee:list-add(name=global-modules, value={"name" => "org.jboss.genericjms.provider", "slot" =>"main"}
  2. Create and configure a JNDI external context to the JMS provider.

    The JMS resources, such as connection factories and destinations, are looked up in the JMS provider. Add an external context in the JBoss EAP 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 configuration file.

    Use the management CLI to create an external JNDI context and include its configuration properties. The properties in the example below should be replaced by the correct value to connect to the remote JMS provider. For example, some JMS providers, such as Tibco EMS, do not support the JNDI lookup(Name) method. In these cases, add the org.jboss.as.naming.lookup.by.string property with a value of true to work around this issue. Check the adapter’s documentation for information on required properties and their values.

    /subsystem=naming/binding="java:global/remoteJMS":add(binding-type=external-context,module=org.jboss.genericjms.provider,class=javax.naming.InitialContext,environment=[java.naming.factory.initial=com.tibco.tibjms.naming.TibjmsInitialContextFactory,java.naming.provider.url=tcp://<hostname>:7222,org.jboss.as.naming.lookup.by.string=true])

    With the external context configured properly, any JNDI lookup to a resource starting with java:global/remoteJMS/ will be done on the remote JMS provider. As an example, if a message-driven bean performs 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.

    Alternatively, you can make a JNDI lookup to the remote server without using an external-context when looking up the JNDI name. To do so, use the CLI to create a new binding that references the external-context, as in the example below.

    /subsystem=naming/binding=java\:\/jms\/queue\/myQueue:add(binding-type=lookup, lookup=java:global/remoteJMS/jms/queue/myQueue)

    In the example above, an application that does a JNDI lookup for java:/jms/queue/myQueue will locate the queue named myQueue on the remote server.

  3. Create the generic JMS resource adapter.

    Use the management CLI to create the resource adapter

    /subsystem=resource-adapters/resource-adapter=generic-ra:add(module=org.jboss.genericjms,transaction-support=XATransaction)
  4. Configure the generic JMS resource adapter.

    Use the management CLI to configure the resource adapter’s connection-definition and other elements.

    /subsystem=resource-adapters/resource-adapter=generic-ra/connection-definitions=tibco-cd:add(class-name=org.jboss.resource.adapter.jms.JmsManagedConnectionFactory, jndi-name=java:/jms/XAQCF)
    
    /subsystem=resource-adapters/resource-adapter=generic-ra/connection-definitions=tibco-cd/config-properties=ConnectionFactory:add(value=XAQCF)
    
    /subsystem=resource-adapters/resource-adapter=generic-ra/connection-definitions=tibco-cd/config-properties=JndiParameters:add(value="java.naming.factory.initial=com.tibco.tibjms.naming.TibjmsInitialContextFactory;java.naming.provider.url=tcp://<hostname>:7222")
    
    /subsystem=resource-adapters/resource-adapter=generic-ra/connection-definitions=tibco-cd:write-attribute(name=security-application,value=true)
  5. Configure the default message-driven bean pool in the ejb3 subsystem to use the generic resource adapter.

    /subsystem=ejb3:write-attribute(name=default-resource-adapter-name, value=generic-ra)

The generic JMS resource adapter is now configured and ready for use. Below is an example of using the resource adapter when creating a new message-driven bean.

Example: Code Using the Generic Resource Adapter

@MessageDriven(name = "HelloWorldQueueMDB", activationConfig = {
  // The generic JMS resource adapter requires the JNDI bindings
  // for the actual remote connection factory and destination
  @ActivationConfigProperty(propertyName = "connectionFactory", propertyValue = "java:global/remoteJMS/XAQCF"),
  @ActivationConfigProperty(propertyName = "destination", propertyValue = "java:global/remoteJMS/Queue1"),
  @ActivationConfigProperty(propertyName = "destinationType", propertyValue = "javax.jms.Queue"),
  @ActivationConfigProperty(propertyName = "acknowledgeMode", propertyValue = "Auto-acknowledge") })
  public class HelloWorldQueueMDB implements MessageListener {
  public void onMessage(Message message) {
  // called every time a message is received from the _Queue1_ queue on the JMS provider.
  }
}

Important

When using the generic JMS resource adapter, ensure you set the session to be transacted, to avoid a potential NullPointerException error. The error occurs because the generic JMS resource adapter attempts processing of parameters, when the Java EE specification states that they are not to be processed. This is accomplished by doing the following: connection.createSession(true, Session.SESSION_TRANSACTED);

You can also use the pooled connection factory from the resource adapter:

@Resource(lookup = "java:/jms/XAQCF")
private ConnectionFactory cf;

It is not possible to inject a resource from an external context directly but it is possible to inject an external context and then perform a lookup. For example, a lookup for a queue deployed in a Tibco EMS broker would be as follows.

@Resource(lookup = "java:global/remoteJMS")
private Context context;
...
Queue queue = (Queue) context.lookup("Queue1")

31.7. Using the Resource Annotation

Using the @Resource annotation, Enterprise Java Beans (EJBs) can directly inject Java Message Service (JMS) resources or connection factories. You can specify the following parameters using the @Resource annotations:

  • lookup
  • name
  • mappedName

To inject a resource, you must specify the Java Naming and Directory Interface (JNDI) name of the resource in one of these parameters.

31.7.1. Injecting JMS Resources

  1. Define your queue as shown below:

    <jms-queue name="OutQueue" entries="jms/queue/OutQueue java:jboss/exported/jms/queue/OutQueue"/>
  2. Inject this queue by specifying its JNDI name in the lookup, name, or mappedName parameter of the @Resource annotation. For example:

    @Resource(lookup = "java:jboss/exported/jms/queue/OutQueue")
    public Queue myOutQueue;

31.7.2. Injecting Connection Factories

  1. Define your connection factory as shown below. The example shows a JmsXA pooled connection factory.

    <pooled-connection-factory name="activemq-ra" entries="java:/JmsXA java:jboss/DefaultJMSConnectionFactory" connectors="in-vm" transaction="xa"/>
  2. Inject the default activemq-ra pooled connection factory as shown below:

    @Resource(lookup = "java:/JmsXA")
    private ConnectionFactory cf;

31.7.3. The Limitations and Known Issues for the Generic JMS Resource Adapter

  • The generic JMS resource adapter relies on the JMS API to communicate with JMS servers. Because the JMS API does not provide a programmatic way to create the JMS resources, the following new features that are defined in the Java™ Platform, Enterprise Edition (Java EE) Specification, v7 are not supported.

    • EE.5.18.4 JMS Connection Factory Resource Definition

      This is the ability for an application to define a JMS ConnectionFactory resource.

    • EE.5.18.5 JMS Destination Definition

      This is the ability for an application to define a JMS Destination resource.