JDF-144: Add deltaspike-helloworld-jms example, a version of hellowor…

…ld-jms that uses DeltaSpike
wildfly · Dec 23, 2012 · f2fd7da · f2fd7da
1 parent 68965c1
commit f2fd7da
Show file tree

Hide file tree

Showing 6 changed files with 584 additions and 0 deletions.
diff --git a/deltaspike-helloworld-jms/README.md b/deltaspike-helloworld-jms/README.md
@@ -0,0 +1,216 @@
+deltaspike-helloworld-jms: HelloWorld JMS Example Using DeltaSpike Configuration Properties
+======================
+Author: Weston Price, Rafael Benevides
+Level: Intermediate
+Technologies: JMS, CDI, DeltaSpike
+Summary: Demonstrates a standalone (Java SE) JMS client using DeltaSpike configuration properties
+Target Product: WFK
+
+What is it?
+-----------
+
+This quickstart demonstrates the use of external JMS clients with JBoss Enterprise Application Platform 6 or JBoss AS 7 using DeltaSpike configuration properties.
+
+It contains the following:
+
+1. A message producer that sends messages to a JMS destination deployed to a JBoss Enterprise Application Platform 6 or JBoss AS 7 server.
+
+2. A message consumer that receives message from a JMS destination deployed to a JBoss Enterprise Application Platform 6 or JBoss AS 7 server. 
+
+
+System requirements
+-------------------
+
+All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.
+
+The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7. 
+
+
+Configure Maven
+---------------
+
+If you have not yet done so, you must [Configure Maven](../README.md#mavenconfiguration) before testing the quickstarts.
+
+
+Add an Application User
+----------------
+This quickstart uses secured management interfaces and requires that you create an application user to access the running application. Instructions to set up the quickstart application user can be found here: [Add an Application User](../README.md#addapplicationuser)
+
+
+Configure the JBoss Enterprise Application Platform 6 server
+---------------------------
+
+If you are using the JBoss AS 7 Quickstart distribution, the server configuration file already contains the JMS `test` queue and you can skip this step. 
+
+However, if you are using the JBoss Enterprise Application Platform 6 distribution, you need to add the JMS `test` queue and `topic` to the application server configuration file. You can configure JMS using the JBoss CLI or by manually editing the configuration file.
+
+#### Modify the Server JMS Configuration using the JBoss CLI Tool
+
+1. Start the JBoss Enterprise Application Platform 6 or JBoss AS 7 Server by typing the following: 
+
+        For Linux:  JBOSS_HOME_SERVER_1/bin/standalone.sh -c standalone-full.xml
+        For Windows:  JBOSS_HOME_SERVER_1\bin\standalone.bat -c standalone-full.xml
+2. To start the JBoss CLI tool, open a new command line, navigate to the JBOSS_HOME directory, and type the following:
+
+        For Linux: bin/jboss-cli.sh --connect
+        For Windows: bin\jboss-cli.bat --connect
+3. At the prompt, type the following:
+
+        [standalone@localhost:9999 /] jms-queue add --queue-address=testQueue --entries=queue/test,java:jboss/exported/jms/queue/test
+        [standalone@localhost:9999 /] jms-topic add --topic-address=testTopic --entries=topic/test,java:jboss/exported/jms/topic/test
+
+#### Modify the Server JMS Configuration Manually (Server must be stopped)
+
+1. Open the file: JBOSS_HOME/standalone/configuration/standalone-full.xml
+2. Add the JMS `test` queue as follows:
+    * Find the messaging subsystem:  
+
+            <subsystem xmlns="urn:jboss:domain:messaging:1.1">
+    * Scroll to the end of this section and add the following XML after the `</jms-connection-factories>` end tag but before the `</hornetq-server>` element:
+
+                <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>
+    * Save the changes and close the file.  
+
+
+Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Full Profile
+---------------
+
+1. Open a command line and navigate to the root of the JBoss server directory.
+2. The following shows the command line to start the server with the full profile:
+
+        For Linux:   JBOSS_HOME/bin/standalone.sh -c standalone-full.xml
+        For Windows: JBOSS_HOME\bin\standalone.bat -c standalone-full.xml
+
+
+Build and Deploy the Quickstart
+-------------------------
+
+To run the quickstart from the command line:
+
+1. Make sure you have started the JBoss server. See the instructions in the previous section.
+
+2. Open a command line and navigate to the root of the deltaspike-helloworld-jms quickstart directory:
+
+        cd PATH_TO_QUICKSTARTS/deltaspike-helloworld-jms
+
+3. Type the following command to compile and execute the quickstart:
+
+        For JBoss Enterprise Application Platform 6 (Maven user settings NOT configured): 
+
+            mvn clean compile exec:java -s PATH_TO_QUICKSTARTS/example-settings.xml
+
+        For JBoss AS 7 or JBoss Enterprise Application Platform 6 (Maven user settings configured): 
+
+            mvn clean compile exec:java
+
+ gt
+Investigate the Console Output
+-------------------------
+
+If the maven command is successful, with the default configuration you will see output similar to this:
+
+    Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
+    INFO: Attempting to acquire connection factory "jms/RemoteConnectionFactory"
+    Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
+    INFO: Found connection factory "jms/RemoteConnectionFactory" in JNDI
+    Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
+    INFO: Attempting to acquire destination "jms/queue/test"
+    Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
+    INFO: Found destination "jms/queue/test" in JNDI
+    Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
+    INFO: Sending 1 messages with content: Hello, World!
+    Mar 14, 2012 1:38:58 PM org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
+    INFO: Received message with content Hello, World!
+
+_Note_: After the above INFO message, you may see the following error. You can ignore the error as it is a well known error message and does not indicate the maven command was unsuccessful in any way. 
+
+    Mar 14, 2012 1:38:58 PM org.jboss.naming.remote.protocol.v1.RemoteNamingStoreV1$MessageReceiver handleEnd
+    ERROR: Channel end notification received, closing channel Channel ID cd114175 (outbound) of Remoting connection 00392fe8 to localhost/127.0.0.1:4447
+
+
+Optional Properties
+-------------------
+
+This quickstart uses DeltaSpike to inject properties configuration.
+
+The configuration is injected by using the `@ConfigProperty` annotation
+
+        @Inject
+        @ConfigProperty(name = "username", defaultValue = "quickstartUser")
+        private String usernameConfig;
+
+This quickstart provides for a certain amount of customization for the `mvn:exec` plugin using the system properties.
+
+Example:
+
+        mvn clean compile exec:java -Dusername=benevides -Dpassword=xxxxx -Dmessage.count=30
+        
+The following properties can be configured:        
+
+* `username`
+
+    This username is used for both the JMS connection and the JNDI look-up.  Instructions to set up the quickstart application user can be found here: [Add an Application User](../README.md#addapplicationuser).
+
+    Default: `quickstartUser`
+
+* `password`
+
+    This password is used for both the JMS connection and the JNDI look-up.  Instructions to set up the quickstart application user can be found here: [Add an Application User](../README.md#addapplicationuser)
+
+    Default: `quickstartPassword`
+
+* `connection.factory`
+
+    The name of the JMS ConnectionFactory you want to use.
+
+    Default: `jms/RemoteConnectionFactory`
+
+* `destination`
+
+    The name of the JMS Destination you want to use.
+
+    Default: `jms/queue/test`
+
+* `message.count`
+
+    The number of JMS messages you want to produce and consume.
+
+    Default: `1`
+
+* `message.content`
+
+    The content of the JMS TextMessage.
+
+    Default: `"Hello, World!"`
+
+* `java.naming.provider.url`
+
+	  This property allows configuration of the JNDI directory used to lookup the JMS destination. This is useful when the client resides on another host. 
+
+    Default: `"localhost"`
+
+
+
+Run the Quickstart in JBoss Developer Studio or Eclipse
+-------------------------------------
+You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see [Use JBoss Developer Studio or Eclipse to Run the Quickstarts](../README.md#useeclipse) 
+
+
+Debug the Application
+------------------------------------
+
+If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.
+
+        mvn dependency:sources
+        mvn dependency:resolve -Dclassifier=javadoc
+
+
diff --git a/deltaspike-helloworld-jms/deltaspike-helloworld-jms-logging.properties b/deltaspike-helloworld-jms/deltaspike-helloworld-jms-logging.properties
@@ -0,0 +1,36 @@
+# JBoss, Home of Professional Open Source
+# Copyright 2012, Red Hat, Inc. and/or its affiliates, and individual
+# contributors by the @authors tag. See the copyright.txt in the 
+# distribution for a full listing of individual contributors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# http://www.apache.org/licenses/LICENSE-2.0
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,  
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# Specify the handlers to create in the root logger
+# (all loggers are children of the root logger)
+# The following creates two handlers
+handlers = java.util.logging.ConsoleHandler, java.util.logging.FileHandler
+
+# Set the default logging level for the root logger
+.level = ALL
+
+# Set the default logging level for new ConsoleHandler instances
+java.util.logging.ConsoleHandler.level = ALL
+
+# Set the default logging level for new FileHandler instances
+java.util.logging.FileHandler.level = ALL
+java.util.logging.FileHandler.pattern = deltaspike-helloworld-jms.log
+java.util.logging.FileHandler.limit = 50000
+java.util.logging.FileHandler.count = 1
+
+# Set the default formatter for new ConsoleHandler instances
+java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
+
+# Set the default logging level for the logger named com.mycompany
+org.jboss.as.quickstarts.jms = ALL