Issue #80: Test for temporary queue

Author: pdudits

jms/temp-destination/pom.xml

@@ -7,8 +7,9 @@
         <version>1.0-SNAPSHOT</version>
   </parent>
 
-    <groupId>org.javaee7.jms</groupId>
     <artifactId>temp-destination</artifactId>
-    <version>1.0-SNAPSHOT</version>
     <packaging>war</packaging>
+
+    <name>Temporary destinations</name>
+    <description>Request/Response over JMS</description>
 </project>

jms/temp-destination/src/main/java/org/javaee7/jms/temp/destination/JmsClient.java

@@ -0,0 +1,51 @@
+package org.javaee7.jms.temp.destination;
+
+import javax.annotation.Resource;
+import javax.ejb.Stateless;
+import javax.ejb.TransactionAttribute;
+import javax.ejb.TransactionAttributeType;
+import javax.inject.Inject;
+import javax.jms.*;
+import java.lang.IllegalStateException;
+
+/**
+ * Client receiving response to a message via temporary queue.
+ * The client has to be non-trasactional, as we need to send message in the middle
+ * of the method.
+ * @author Patrik Dudits
+ */
+@Stateless
+@TransactionAttribute(TransactionAttributeType.NOT_SUPPORTED)
+public class JmsClient {
+
+    @Resource(name = Resources.REQUEST_QUEUE)
+    Queue requestQueue;
+
+    @Inject
+    JMSContext jms;
+
+    public String process(String request) {
+
+        // prepare the request message
+        TextMessage requestMessage = jms.createTextMessage(request);
+        TemporaryQueue responseQueue = jms.createTemporaryQueue();
+
+        // send the request
+        jms.createProducer()
+                .setJMSReplyTo(responseQueue)
+                .send(requestQueue, requestMessage);
+
+        // start listening on the temp queue for response
+        try (JMSConsumer consumer = jms.createConsumer(responseQueue)) {
+
+            // wait for the response
+            String response = consumer.receiveBody(String.class, 2000);
+
+            if (response == null) {
+                throw new IllegalStateException("Message processing timed out");
+            } else {
+                return response;
+            }
+        }
+    }
+}

jms/temp-destination/src/main/java/org/javaee7/jms/temp/destination/MessageSender.java

@@ -0,0 +1,41 @@
+package org.javaee7.jms.temp.destination;
+
+import javax.ejb.ActivationConfigProperty;
+import javax.ejb.MessageDriven;
+import javax.inject.Inject;
+import javax.jms.*;
+
+/**
+ * @author Patrik Dudits
+ */
+@MessageDriven(activationConfig = {
+        @ActivationConfigProperty(propertyName = "destinationLookup",
+                propertyValue = Resources.REQUEST_QUEUE),
+        @ActivationConfigProperty(propertyName = "destinationType",
+                propertyValue = "javax.jms.Queue"),
+})
+public class RequestResponseOverJMS implements MessageListener {
+
+    @Inject
+    JMSContext jms;
+
+    @Override
+    public void onMessage(Message message) {
+        try {
+            Destination replyTo = message.getJMSReplyTo();
+            if (replyTo == null) {
+                // no response required, finish now.
+                return;
+            }
+            TextMessage request = (TextMessage) message;
+            String payload = request.getText();
+
+            System.out.println("Got request: "+payload);
+
+            String response = "Processed: "+payload;
+            jms.createProducer().send(replyTo, response);
+        } catch (JMSException e) {
+            e.printStackTrace();
+        }
+    }
+}

jms/temp-destination/src/main/java/org/javaee7/jms/temp/destination/RequestResponseOverJMS.java

@@ -0,0 +1,20 @@
+package org.javaee7.jms.temp.destination;
+
+import javax.jms.JMSDestinationDefinition;
+import javax.jms.JMSDestinationDefinitions;
+
+/**
+ * Application scoped JMS resources for the samples.
+ * @author Patrik Dudits
+ */
+@JMSDestinationDefinitions({
+    @JMSDestinationDefinition(
+        name = Resources.REQUEST_QUEUE,
+        resourceAdapter = "jmsra",
+        interfaceName = "javax.jms.Queue",
+        destinationName="requestQueue",
+        description="Queue for service requests"),
+})
+public class Resources {
+    public static final String REQUEST_QUEUE = "java:global/jms/requestQueue";
+}

jms/temp-destination/src/main/java/org/javaee7/jms/temp/destination/Resources.java

@@ -0,0 +1,53 @@
+package org.javaee7.jms.temp.destination;
+
+import org.jboss.arquillian.container.test.api.Deployment;
+import org.jboss.arquillian.junit.Arquillian;
+import org.jboss.shrinkwrap.api.ShrinkWrap;
+import org.jboss.shrinkwrap.api.spec.WebArchive;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import javax.ejb.EJB;
+
+/**
+ * Temporary queues are JMS queues that exist for the lifetime of single JMS connection.
+ * Also the reception of the messages is exclusive to the connection, therefore no
+ * reasonable use case exist for temporary topic within Java EE container, as connection
+ * is usually exclusive to single component.
+ *
+ * Temporary queues are usually used as reply channels for request / response communication
+ * over JMS.
+ */
+@RunWith(Arquillian.class)
+public class TempQueueTest {
+
+    /**
+     * In this test we created a server component +RequestResponseOverJMS+, that
+     * listens on a Queue and passes the response to the destination specified in
+     * +JMSReplyTo+ header of the message.
+     *
+     * +JmsClient+ is a client to this server, and has to be non transactional,
+     * otherwise the request would be first sent upon commit, i. e. after the
+     * business method finishes. That would be too late. We need to send the message
+     * immediately, and wait for the response to arrive.
+     *
+     */
+    @Deployment
+    public static WebArchive deployment() {
+        return ShrinkWrap.create(WebArchive.class)
+                .addClasses(RequestResponseOverJMS.class, JmsClient.class, Resources.class);
+    }
+
+    @EJB
+    JmsClient client;
+
+    /**
+     * We invoke the client, and verify that the response is processed
+     */
+    @Test
+    public void testRequestResposne() {
+        String response = client.process("Hello");
+        Assert.assertEquals("Processed: Hello", response);
+    }
+}

jms/temp-destination/src/main/webapp/WEB-INF/beans.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<arquillian xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://jboss.org/schema/arquillian" xsi:schemaLocation="http://jboss.org/schema/arquillian
+                         http://jboss.org/schema/arquillian/arquillian_1_0.xsd">
+
+    <defaultProtocol type="Servlet 3.0"/>
+
+    <container qualifier="test" default="true">
+        <configuration>
+            <property name="jbossHome">${serverRoot:target/wildfly-8.0.0.CR1}</property>
+            <property name="serverConfig">${serverProfile:standalone-full.xml}</property>
+        </configuration>
+    </container>
+    <container qualifier="debug">
+        <configuration>
+            <property name="jbossHome">${serverRoot:target/wildfly-8.0.0.CR1}</property>
+            <property name="serverConfig">${serverProfile:standalone-full.xml}</property>
+            <property name="javaVmArguments">-Xrunjdwp:transport=dt_socket,address=55407,server=y,suspend=y -Xmx512m -XX:MaxPermSize=128m</property>
+        </configuration>
+    </container>
+
+</arquillian>