Author: Jess Sightler
Level: Intermediate
Technologies: JMS, MDB, HornetQ
Summary: Demonstrates the use of HornetQ Clustering
Prerequisites: helloworld-mdb
Target Product: EAP
Product Versions: EAP 6.1, EAP 6.2
Source: https://github.com/jboss-developer/jboss-eap-quickstarts/
This example demonstrates the use of clustering with HornetQ. 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 6.1 or later.
All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.
If you have not yet done so, you must Configure Maven before testing the quickstarts.
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 server.
-
If you plan to test using a standalone server, backup the file:
$JBOSS_HOME/standalone/configuration/standalone-full-ha.xml
-
If you plan to test using a managed domain, backup the following files:
$JBOSS_HOME/domain/configuration/domain.xml $JBOSS_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 server directory.
-
The following shows the command line to start the server in domain mode:
For Linux: JBOSS_HOME/bin/domain.sh For Windows: JBOSS_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 HornetQ Clustering for testing this quickstart. You will note it does the following:- Stops the servers
- Creates a server-group to test HornetQ Clustering
- Adds 2 servers to the server-group
- Configures HornetQ 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 the 'NOTE:' 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:
JBOSS_HOME/bin/jboss-cli.sh --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 server directory.
-
The following shows the command line to start the server with the full-ha profile. This profile supports clustering/HA
For Linux: JBOSS_HOME/bin/standalone.sh -c standalone-full-ha.xml For Windows: JBOSS_HOME\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 the 'NOTE:' 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:
JBOSS_HOME/bin/jboss-cli.sh --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 directory structure to use for the second server.
-
Stop the server.
-
Make a copy of this JBoss directory structure to use for the second server.
-
Remove the following directories from the cloned instance:
JBOSS_HOME_SERVER_2/standalone/data/messagingbindings JBOSS_HOME_SERVER_2/standalone/data/messagingjournal JBOSS_HOME_SERVER_2/standalone/data/messaginglargemessages
If you are using Linux:
Server 1: JBOSS_HOME_SERVER_1/bin/standalone.sh -c standalone-full-ha.xml
Server 2: JBOSS_HOME_SERVER_2/bin/standalone.sh -c standalone-full-ha.xml -Djboss.socket.binding.port-offset=100
If you are using Windows:
Server 1: JBOSS_HOME_SERVER_1\bin\standalone.bat -c standalone-full-ha.xml
Server 2: JBOSS_HOME_SERVER_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/jboss-helloworld-mdb/HelloWorldMDBServletClient.
It will send some messages to the queue.
To send messages to the topic, use the following URL: http://localhost:9080/jboss-helloworld-mdb/HelloWorldMDBServletClient?topic
The application will be running at the following URL: http://localhost:8080/jboss-helloworld-mdb/HelloWorldMDBServletClient.
It will send some messages to the queue.
To send messages to the topic, use the following URL: http://localhost:8080/jboss-helloworld-mdb/HelloWorldMDBServletClient?topic
Look at the JBoss Application Server console or Server log and you should see log messages like the following:
[Server:jdf-hornetqcluster-node1] 16:34:41,165 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-8 (HornetQ-client-global-threads-1067469862)) Received Message from queue: This is message 1
[Server:jdf-hornetqcluster-node1] 16:34:41,274 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-8 (HornetQ-client-global-threads-1067469862)) Received Message from queue: This is message 3
[Server:jdf-hornetqcluster-node1] 16:34:41,323 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-6 (HornetQ-client-global-threads-1067469862)) Received Message from queue: This is message 5
[Server:jdf-hornetqcluster-node2] 16:34:41,324 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-8 (HornetQ-client-global-threads-1771031398)) Received Message from queue: This is message 2
[Server:jdf-hornetqcluster-node2] 16:34:41,330 INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-7 (HornetQ-client-global-threads-1771031398)) Received Message from queue: This is message 4
Note that the logging indicates messages have arrived from both node 1 (jdf-hornetqcluster-node1) as well as node 2 (jdf-hornetqcluster-node2).
When you are finished testing, use the following instructions to undeploy the quickstart.
-
Make sure you have started the JBoss 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:
JBOSS_HOME/bin/jboss-cli.sh --connect --file=undeploy-domain.cli
-
Make sure you have started the JBoss 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:
JBOSS_HOME/bin/jboss-cli.sh --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
JBOSS_HOME/domain/configuration/domain.xml
andJBOSS_HOME/domain/configuration/host.xml
files with the back-up copies of the files. Be sure to replace JBOSS_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: JBOSS_HOME/bin/domain.sh For Windows: JBOSS_HOME\bin\domain.bat
-
Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing JBOSS_HOME with the path to your server.
JBOSS_HOME/bin/jboss-cli.sh --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 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 (jdf-hornetqcluster-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 it is running, stop the JBoss EAP server.
- Restore the
JBOSS_HOME/standalone/configuration/standalone-full-ha.xml
file with the back-up copies of the file. Be sure to replace JBOSS_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: JBOSS_HOME/bin/standalone.sh -c standalone-full-ha.xml For Windows: JBOSS_HOME\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 JBOSS_HOME with the path to your server.
JBOSS_HOME/bin/jboss-cli.sh --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.