Java EE MDB SetRollbackOnly with DLQ Example

This example shows you how to send a message to an MDB and then roll back the transaction forcing delivery of the message to a DLQ.

The example will send deploy a simple MDB and demonstrate sending a message, MDB consuming it, and then the standalone client consuming it from the DLQ and printing out the special DLQ properties "_HQ_ORIG_ADDRESS" and "_HQ_ORIG_QUEUE".

The example leverages the JBoss Arquillian framework to run a WildFly instance and deploy the MDB.

Example step-by-step

download WildFly 8.0.0.Final from here and install.

set the JBOSS_HOME property to point to the WildFly install directory

type mvn verify from the example directory to run

  1. First we need to get an initial context so we can look-up the JMS connection factory and destination objects from JNDI. This initial context will get it's properties from the jndi.properties file in the directory config
    2.            final Properties env = new Properties();

           env.put(Context.INITIAL_CONTEXT_FACTORY, "org.jboss.naming.remote.client.InitialContextFactory");

           env.put(Context.PROVIDER_URL, "http-remoting://localhost:8080");

           initialContext = new InitialContext(env);
  2. We look up the JMS queue object from JNDI
    3.            Queue queue = (Queue)initialContext.lookup("jms/queues/testQueue");
  3. We look up the JMS connection factory object from JNDI
    4.            ConnectionFactory cf = (ConnectionFactory)initialContext.lookup("/jms/RemoteConnectionFactory");
  4. We create a JMS connection
    5.            connection = cf.createConnection("guest", "password");
  5. We create a JMS session. The session is created as non transacted and will auto acknowledge messages.
    6.            Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
  6. We create a JMS message producer on the session. This will be used to send the messages.
    7.           MessageProducer messageProducer = session.createProducer(queue);
  7. We create a JMS text messages that we are going to send.
    8.             TextMessage message = session.createTextMessage("This is a text message");
  8. We send messages to the queue
    9.            producer.send(message);
  9. The MDB receives the message
    We know the message is a TextMessage so we cast to it.
    10.            TextMessage tm = (TextMessage)message;
  10. The MDB gets the text and prints it
    11.              String text = textMessage.getText();
             System.out.println("message " + text + " received");
  11. The MDB rolls back the container-managed transaction to send the message to the DLQ
    12.              ctx.setRollbackOnly();
  12. Perform a lookup on the DLQ
    13.             destination = (Destination) initialContext.lookup("jms/queues/dlq");
  13. Create the consumer and start the connection
    14.             MessageConsumer consumer = session.createConsumer(destination);
            connection.start();
  14. Receive the message.
    15.             message = (TextMessage) consumer.receive(3000);
  15. Print the special DLQ properties
    16.              System.out.println("Original address: " + message.getStringProperty("_HQ_ORIG_ADDRESS"));
             System.out.println("Original queue: " + message.getStringProperty("_HQ_ORIG_QUEUE"));
  16. And finally, always remember to close your JMS connections and resources after use, in a finally block. Closing a JMS connection will automatically close all of its sessions, consumers, producer and browser objects
    17.            finally
           {
              if (initialContext != null)
              {
                initialContext.close();
              }
              if (connection != null)
              {
                 connection.close();
              }
           }