Connectivity > Containers > Resource Adapter > TomEE

Apache TomEE is a distribution of Tomcat with fully integrated ActiveMQ Classic offering full JMS support to plain war files, Servlets and more. No setup is required and code like the following will work out of the box.

import javax.annotation.Resource; import javax.servlet.http.HttpServlet; import javax.jms.Topic; import javax.jms.Queue; import javax.jms.ConnectionFactory;

public class MyServet extends HttpServlet {

@Resource(name = "foo")
private Topic fooTopic;

@Resource(name = "bar")
private Queue barQueue;

private ConnectionFactory connectionFactory;

protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

    Connection connection = connectionFactory.createConnection();

    // Create a Session
    Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);

    // Create a MessageProducer from the Session to the Topic or Queue
    MessageProducer producer = session.createProducer(fooTopic);

    // Create a message
    TextMessage message = session.createTextMessage("Hello World!");

    // Tell the producer to send the message

} }

All topics and queues are created automatically when declared properly in code as above. For example, the following reference in code:

@Resource(name = "foo")
private Topic fooTopic;

Is identical to the following declaration in the /conf/tomee.xml file or WEB-INF/resources.xml file:

<Resource id="foo" type="javax.jms.Topic" />

In both situations Topic name would be ‘foo’.

Configuring an Embedded Broker

If no broker is configured and JMS is used in the webapp, TomEE will create a broker equivalent to the following declaration:

BrokerXmlConfig = broker:(tcp://someHostName:61616) ServerUrl = vm://localhost ResourceAdapter = MyJmsResourceAdapter

This creates an ActiveMQ Classic Broker that runs inside TomEE and is bound to the address someHostName:61616. This broker will start when TomEE starts and shutdown when TomEE shuts down. All JMS communication happening inside TomEE itself will happen using the embedded ActiveMQ Classic Broker over the ActiveMQ Classic “vm” transport which is optimized for sending and receiving messages when in the same JVM as the Broker.

Connecting to an External Broker

It is possible to connect to an ActiveMQ Classic Broker running externally. The setup is similar to the above with only two changes.

BrokerXmlConfig = ServerUrl = tcp://someHostName:61616 ResourceAdapter = MyJmsResourceAdapter

Here the BrokerXmlConfig property is empty as we are not configuring an embedded broker to be run inside TomEE. The ServerUrl now points to an explicit remote host and port someHostName:61616 where an ActiveMQ Classic Broker must be running. This Broker can be a plain ActiveMQ Classic install or an ActiveMQ Classic Broker embedded in a TomEE install.

Apache, ActiveMQ, Apache ActiveMQ, the Apache feather logo, and the Apache ActiveMQ project logo are trademarks of The Apache Software Foundation. Copyright © 2024, The Apache Software Foundation. Licensed under Apache License 2.0.