Author: Jess Sightler
Level: Intermediate
Technologies: JMS, MDB
Summary: The messaging-clustering
quickstart does not contain any code and instead uses the helloworld-mdb
quickstart to demonstrate clustering using ActiveMQ Messaging.
Prerequisites: helloworld-mdb
Target Product: JBoss EAP
Source: https://github.com/jboss-developer/jboss-eap-quickstarts/
The messaging-clustering
quickstart demonstrates the use of clustering with Apache ActiveMQ and Red Hat JBoss Enterprise Application Platform. It uses the helloworld-mdb quickstart for its tests, so there is no code associated with this quickstart. Instructions are provided to run the quickstart on either a standalone server or in a managed domain.
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7.1 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 JBoss EAP 7.1 to make sure you are configured correctly for testing the quickstarts.
In the following instructions, replace EAP7_HOME
with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP7_HOME and JBOSS_HOME Variables.
IMPORTANT: This quickstart depends on the deployment of the helloworld-mdb
quickstart WAR for its tests. Before you continue, you must build the helloworld-mdb
quickstart WAR.
Open a command prompt and navigate to the root directory of the helloworld-mdb quickstart. Type this command to build the WAR archive:
mvn clean install
See the helloworld-mdb README for further information about this quickstart.
You can choose to deploy and run this quickstart in a managed domain or on a standalone server. The sections below describe how to configure and start the server for both modes.
NOTE - Before you begin:
-
If it is running, stop the JBoss EAP server.
-
If you plan to test using a standalone server, back up the file:
EAP7_HOME/standalone/configuration/standalone-full-ha.xml
-
If you plan to test using a managed domain, back up the following files:
EAP7_HOME/domain/configuration/domain.xml EAP7_HOME/domain/configuration/host.xml
After you have completed testing this quickstart, you can replace these files to restore the server to its original configuration.
You configure the server by running the install-domain.cli script provided in the root directory of this quickstart.
-
Open a command prompt and navigate to the root of the JBoss EAP directory.
-
The following shows the command line to start the server in domain mode:
For Linux: EAP7_HOME/bin/domain.sh For Windows: EAP7_HOME\bin\domain.bat
-
Review the
install-domain.cli
file in the root of this quickstart directory. This script creates the server group and servers and configures messaging clustering for testing this quickstart. You will note it does the following:- Stops the servers
- Creates a server-group to test ActiveMQ Clustering
- Adds 2 servers to the server-group
- Configures ActiveMQ clustering in the full-ha profile
- Deploys the
helloworld-mdb.war
archive - Restarts the servers.
NOTE: If your
helloworld-mdb
quickstart is not located at the same level in the file structure as this quickstart, you must modify its path in this script. Find theNOTE:
in the file for instructions. -
Open a command prompt, navigate to the root directory of this quickstart, and run the following command to run the script:
For Linux: EAP7_HOME/bin/jboss-cli.sh --connect --file=install-domain.cli For Windows: EAP7_HOME\bin\jboss-cli.bat --connect --file=install-domain.cli
You should see "outcome" => "success" for all of the commands.
-
Restart the server in domain mode as described above.
If you choose to use standalone servers rather than domain mode, you will need two instances of the application server. Application
server 2 must be started with a port offset parameter provided to the startup script as -Djboss.socket.binding.port-offset=100
.
Since both application servers must be configured in the same way, you must configure the first server and then clone it.
-
Open a command prompt and navigate to the root of the JBoss EAP directory.
-
The following shows the command line to start the server with the full-ha profile. This profile supports clustering/HA
For Linux: EAP7_HOME_1/bin/standalone.sh -c standalone-full-ha.xml For Windows: EAP7_HOME_1\bin\standalone.bat -c standalone-full-ha.xml
-
Review the
install-standalone.cli
file in the root of this quickstart directory. This script configures clustering for a standalone server. You will note it does the following:- Enables console logging. By default, the full HA profile does not log to the console, so this script enables it.
- Enables clustering and sets a cluster password
- Enables clustering in the RemoteConnectionFactory
- Deploys the
helloworld-mdb.war
archive - Reloads the server configuration
NOTE: If your
helloworld-mdb
quickstart is not located at the same level in the file structure as this quickstart, you must modify its path in this script. Find theNOTE:
in the file for instructions. -
Open a command prompt, navigate to the root directory of this quickstart, and run the following command to run the script:
For Linux: EAP7_HOME_1/bin/jboss-cli.sh --connect --file=install-standalone.cli For Windows: EAP7_HOME_1\bin\jboss-cli.bat --connect --file=install-standalone.cli
You should see "outcome" => "success" for all of the commands.
After you have successfully configured the server, you must make a copy of this JBoss EAP directory structure to use for the second server.
-
Stop the server.
-
Make a copy of this JBoss EAP directory structure to use for the second server.
-
Remove the following directories from the cloned instance:
EAP7_HOME_2/standalone/data/activemq/bindings EAP7_HOME_2/standalone/data/activemq/journal EAP7_HOME_2/standalone/data/activemq/largemessages
When you start the servers, you must pass the cluster password on the command line to avoid the warning "AMQ222186: unable to authorise cluster control".
If you are using Linux:
Server 1: EAP7_HOME_1/bin/standalone.sh -c standalone-full-ha.xml
Server 2: EAP7_HOME_2/bin/standalone.sh -c standalone-full-ha.xml -Djboss.socket.binding.port-offset=100
If you are using Windows:
Server 1: EAP7_HOME_1\bin\standalone.bat -c standalone-full-ha.xml
Server 2: EAP7_HOME_2\bin\standalone.bat -c standalone-full-ha.xml -Djboss.socket.binding.port-offset=100
The application will be running at the following URL: http://localhost:9080/helloworld-mdb/HelloWorldMDBServletClient.
It will send some messages to the queue.
To send messages to the topic, use the following URL: http://localhost:9080/helloworld-mdb/HelloWorldMDBServletClient?topic
The application will be running at the following URL: http://localhost:8080/helloworld-mdb/HelloWorldMDBServletClient.
It will send some messages to the queue.
To send messages to the topic, use the following URL: http://localhost:8080/helloworld-mdb/HelloWorldMDBServletClient?topic
Look at the JBoss EAP server console or log and you should see log messages like the following:
[Server:quickstart-messagingcluster-node1] 16:34:41,165 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-8 (ActiveMQ-client-global-threads-1067469862)) Received Message from queue: This is message 1
[Server:quickstart-messagingcluster-node1] 16:34:41,274 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-8 (ActiveMQ-client-global-threads-1067469862)) Received Message from queue: This is message 3
[Server:quickstart-messagingcluster-node1] 16:34:41,323 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-6 (ActiveMQ-client-global-threads-1067469862)) Received Message from queue: This is message 5
[Server:quickstart-messagingcluster-node2] 16:34:41,324 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-8 (ActiveMQ-client-global-threads-1771031398)) Received Message from queue: This is message 2
[Server:quickstart-messagingcluster-node2] 16:34:41,330 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-7 (ActiveMQ-client-global-threads-1771031398)) Received Message from queue: This is message 4
Note that the logging indicates messages have arrived from both node 1 (quickstart-messagingcluster-node1) as well as node 2 (quickstart-messagingcluster-node2).
Note: You will see the following warnings in the server logs. You can ignore these warnings as they are intended for production servers.
WARNING [org.jgroups.protocols.UDP] (Thread-0 (ActiveMQ-server-ActiveMQServerImpl::serverUUID=c79278db-56e6-11e5-af50-69dd76236ee8-1573164340)) JGRP000015: the send buffer of socket DatagramSocket was set to 1MB, but the OS only allocated 212.99KB. This might lead to performance problems. Please set your max send buffer in the OS correctly (e.g. net.core.wmem_max on Linux)
WARNING [org.jgroups.protocols.UDP] (Thread-0 (ActiveMQ-server-ActiveMQServerImpl::serverUUID=c79278db-56e6-11e5-af50-69dd76236ee8-1573164340)) JGRP000015: the receive buffer of socket DatagramSocket was set to 20MB, but the OS only allocated 212.99KB. This might lead to performance problems. Please set your max receive buffer in the OS correctly (e.g. net.core.rmem_max on Linux)
WARNING [org.jgroups.protocols.UDP] (Thread-0 (ActiveMQ-server-ActiveMQServerImpl::serverUUID=c79278db-56e6-11e5-af50-69dd76236ee8-1573164340)) JGRP000015: the send buffer of socket MulticastSocket was set to 1MB, but the OS only allocated 212.99KB. This might lead to performance problems. Please set your max send buffer in the OS correctly (e.g. net.core.wmem_max on Linux)
WARNING [org.jgroups.protocols.UDP] (Thread-0 (ActiveMQ-server-ActiveMQServerImpl::serverUUID=c79278db-56e6-11e5-af50-69dd76236ee8-1573164340)) JGRP000015: the receive buffer of socket MulticastSocket was set to 25MB, but the OS only allocated 212.99KB. This might lead to performance problems. Please set your max receive buffer in the OS correctly (e.g. net.core.rmem_max on Linux)
NOTE: After the server has been running for a period of time, you may see the following warnings in the server log, which are followed by a stacktrace. You can ignore these warnings as this is is a known issue and is harmless. See JBEAP-794 for more information.
WARN [org.infinispan.topology.ClusterTopologyManagerImpl] (transport-thread--p15-t6) ISPN000197: Error updating cluster member list: org.infinispan.util.concurrent.TimeoutException: Replication timeout for <application-name>
When you are finished testing, use the following instructions to undeploy the quickstart.
-
Make sure you have started the JBoss EAP server in domain mode as described above.
-
Open a command prompt, navigate to the root directory of this quickstart, and run the following command to undeploy the helloworld-mdb quickstart:
For Linux: EAP7_HOME/bin/jboss-cli.sh --connect --file=undeploy-domain.cli For Windows: EAP7_HOME\bin\jboss-cli.bat --connect --file=undeploy-domain.cli
-
Make sure you have started the JBoss EAP server in standalone mode as described above.
-
Open a command prompt, navigate to the root directory of this quickstart, and run the following command to undeploy the helloworld-mdb quickstart:
For Linux: EAP7_HOME_1/bin/jboss-cli.sh --connect --file=undeploy-standalone.cli For Windows: EAP7_HOME_1\bin\jboss-cli.bat --connect --file=undeploy-standalone.cli
You can remove the domain configuration by manually restoring the back-up copies the configuration files or by running the JBoss CLI Script.
Note: This method ensures the server is restored to its prior configuration.
- If it is running, stop the JBoss EAP server.
- Restore the
EAP7_HOME/domain/configuration/domain.xml
andEAP7_HOME/domain/configuration/host.xml
files with the back-up copies of the files. Be sure to replace EAP7_HOME with the path to your server.
Note: This script returns the server to a default configuration and the result may not match the server configuration prior to testing this quickstart. If you were not running with the default configuration before testing this quickstart, you should follow the intructions above to manually restore the configuration to its previous state.
-
Start the JBoss EAP server by typing the following:
For Linux: EAP7_HOME/bin/domain.sh For Windows: EAP7_HOME\bin\domain.bat
-
Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing EAP7_HOME with the path to your server.
For Linux: EAP7_HOME/bin/jboss-cli.sh --connect --file=remove-domain.cli For Windows: EAP7_HOME\bin\jboss-cli.bat --connect --file=remove-domain.cli
This script removes the server configuration that was done by the
install-domain.cli
script. You should see the following result following the script commands:The batch executed successfully
_Note: If the
:stop-server
command does not complete before the next commands are issued, you may see an error similar to the following:{"JBAS014653: Composite operation failed and was rolled back. Steps that failed:" => {"Operation step-1" => "JBAS010977: Server (quickstart-messagingcluster-node1) still running"}}
Simply wait a few seconds and run the command a second time._
You can remove the domain configuration by manually restoring the back-up copies the configuration files or by running the JBoss CLI Script.
Note: This method ensures the server is restored to its prior configuration.
- If they are running, stop both JBoss EAP servers.
- Restore the
EAP7_HOME_1/standalone/configuration/standalone-full-ha.xml
file with the back-up copies of the file. Be sure to replace EAP7_HOME_1 with the path to your server.
Note: This script returns the server to a default configuration and the result may not match the server configuration prior to testing this quickstart. If you were not running with the default configuration before testing this quickstart, you should follow the intructions above to manually restore the configuration to its previous state.
-
Start the JBoss EAP server by typing the following:
For Linux: EAP7_HOME_1/bin/standalone.sh -c standalone-full-ha.xml For Windows: EAP7_HOME_1\bin\domain.bat -c standalone-full-ha.xml
-
Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing EAP7_HOME_1 with the path to your server.
For Linux: EAP7_HOME_1/bin/jboss-cli.sh --connect --file=remove-standalone.cli For Windows: EAP7_HOME_1\bin\jboss-cli.bat --connect --file=remove-standalone.cli
This script removes the server configuration that was done by the install-standalone.cli
script. You should see the following result following the script commands:
The batch executed successfully
- If it is running, stop the second instance of the JBoss EAP server.
- Delete the cloned directory.