Author: Weston Price
Level: Intermediate
Technologies: JMS
Summary: The helloworld-jms
quickstart demonstrates the use of external JMS clients with WildFly.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
The helloworld-jms
quickstart demonstrates the use of external JMS clients with WildFly Application Server.
It contains the following:
A message producer that sends messages to a JMS destination deployed to a WildFly server.
A message consumer that receives message from a JMS destination deployed to a WildFly server.
The application this project produces is designed to be run on WildFly Application Server 11 or later.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven for WildFly 11 to make sure you are configured correctly for testing the quickstarts.
In the following instructions, replace WILDFLY_HOME
with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.
This quickstart uses secured management interfaces and requires that you create the following application user to access the running application.
UserName | Realm | Password | Roles |
---|---|---|---|
quickstartUser | ApplicationRealm | quickstartPwd1! | guest |
To add the application user, open a command prompt and type the following command:
For Linux: WILDFLY_HOME/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
For Windows: WILDFLY_HOME\bin\add-user.bat -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
If you prefer, you can use the add-user utility interactively. For an example of how to use the add-user utility, see the instructions located here: Add an Application User.
You configure the JMS test
queue by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a configure-jms.cli
script provided in the root directory of this quickstart.
WILDFLY_HOME/standalone/configuration/standalone-full.xml
For Linux: WILDFLY_HOME/bin/standalone.sh -c standalone-full.xml
For Windows: WILDFLY_HOME\bin\standalone.bat -c standalone-full.xml
configure-jms.cli
file in the root of this quickstart directory. This script adds the test
queue to the messaging
subsystem in the server configuration file.Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing WILDFLY_HOME with the path to your server:
For Linux: WILDFLY_HOME/bin/jboss-cli.sh --connect --file=configure-jms.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=configure-jms.cli
The batch executed successfully
After stopping the server, open the WILDFLY_HOME/standalone/configuration/standalone-full.xml
file and review the changes.
The following testQueue
jms-queue was configured in the default server configuration of the messaging-activemq
subsystem.
<jms-queue name="testQueue" entries="queue/test java:jboss/exported/jms/queue/test"/>
For Linux: WILDFLY_HOME/bin/standalone.sh -c standalone-full.xml
For Windows: WILDFLY_HOME\bin\standalone.bat -c standalone-full.xml
To run the quickstart from the command line:
Make sure you have started the WildFly server. See the instructions in the previous section.
Open a command prompt and navigate to the root of the helloworld-jms quickstart directory:
cd PATH_TO_QUICKSTARTS/helloworld-jms
Type the following command to compile and execute the quickstart:
mvn clean compile exec:java
NOTE: If you execute this command multiple times, you may see the following warning and exception, followed by a stacktrace. This is caused by a bug in Artemis that has been fixed, but not yet released. For details, see https://issues.apache.org/jira/browse/ARTEMIS-158. You can ignore this warning.
WARN: AMQ212007: connector.create or connectorFactory.createConnector should never throw an exception, implementation is badly behaved, but we will deal with it anyway.
java.lang.IllegalArgumentException: port out of range:-1
If the Maven command is successful, with the default configuration you will see output similar to this:
timestamp org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Attempting to acquire connection factory "jms/RemoteConnectionFactory"
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
timestamp org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Found connection factory "jms/RemoteConnectionFactory" in JNDI
timestamp org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Attempting to acquire destination "jms/queue/test"
timestamp org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Found destination "jms/queue/test" in JNDI
timestamp org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Sending 1 messages with content: Hello, World!
timestamp org.jboss.as.quickstarts.jms.HelloWorldJMSClient main
INFO: Received message with content Hello, World!
The example provides for a certain amount of customization for the mvn:exec
plug-in using the system properties.
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.
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
Default: quickstartPwd1!
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"
You can remove the JMS configuration by running the remove-jms.cli
script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file.
For Linux: WILDFLY_HOME/bin/standalone.sh -c standalone-full.xml
For Windows: WILDFLY_HOME\bin\standalone.bat -c standalone-full.xml
For Linux: WILDFLY_HOME/bin/jboss-cli.sh --connect --file=remove-jms.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=remove-jms.cli
test
queue from the messaging
subsystem in the server configuration. You should see the following result when you run the script:
The batch executed successfully
WILDFLY_HOME/standalone/configuration/standalone-full.xml
file with the back-up copy of the file.You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a WildFly server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
This quickstart consists of multiple projects, so it deploys and runs differently in JBoss Developer Studio than the other quickstarts.
standalone-full.xml
configuration file.test
queue by running the JBoss CLI commands as described above under Configure the Server.helloworld-jms
project and choose Run As
--> Java Application
. In the Select Java Application
window, choose HellowWorldJMSClient - org.jboss.as.quickstarts.jms
and click OK
. The client output displays in the Console
window. The output messages appear in the Console
window.If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
mvn dependency:sources