The remote-helloworld-mdb
quickstart demonstrates the use of JMS and EJB Message-Driven Bean in JBoss EAP with a remote broker.
The remote-helloworld-mdb
quickstart demonstrates the use of JMS and EJB Message-Driven Bean in Red Hat JBoss Enterprise Application Platform with a remote Red Hat AMQ broker.
This project uses two JMS resources on a remote broker:
-
A queue named
HELLOWORLDMDBQueue
bound in JNDI asjava:/queue/HELLOWORLDMDBQueue
-
A topic named
HELLOWORLDMDBTopic
bound in JNDI asjava:/topic/HELLOWORLDMDBTopic
The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 8.0 or later.
All you need to build this project is Java 11.0 (Java SDK 11) or later and Maven 3.6.0 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.
In the following instructions, replace EAP_HOME
with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP_HOME and JBOSS_HOME Variables.
When you see the replaceable variable QUICKSTART_HOME, replace it with the path to the root directory of all of the quickstarts.
You can run Red Hat AMQ broker locally using docker or podman:
$ docker run --rm --name artemis -e AMQ_USER=admin -e AMQ_PASSWORD=admin -p8161:8161 -p61616:61616 -e AMQ_DATA_DIR=/home/jboss/data registry.redhat.io/amq7/amq-broker-rhel8:7.10
You can access the console of Red Hat AMQ at the URL: http://localhost:8161/console with admin/admin to authenticate.
Before you begin, back up your server configuration file.
-
If it is running, stop the JBoss EAP server.
-
Back up the
EAP_HOME/standalone/configuration/standalone-full.xml
file.
After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration.
-
Open a terminal and navigate to the root of the JBoss EAP directory.
-
Start the JBoss EAP server with the full profile by typing the following command.
$ EAP_HOME/bin/standalone.sh -c standalone-full.xml
NoteFor Windows, use the EAP_HOME\bin\standalone.bat
script.
You configure the JMS connection factory to the remote broker by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a configure-remote-broker.cli
script provided in the root directory of this quickstart.
-
Before you begin, make sure you do the following:
-
Back up the JBoss EAP standalone server configuration as described above.
-
Start the JBoss EAP server with the standalone full profile as described above.
-
-
Review the
configure-remote-broker.cli
file in the root of this quickstart directory. This script adds thetest
queue to themessaging-activemq
subsystem in the server configuration file. -
Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing EAP_HOME with the path to your server:
$ EAP_HOME/bin/jboss-cli.sh --connect --file=configure-remote-broker.cli
NoteFor Windows, use the EAP_HOME\bin\jboss-cli.bat
script. -
You should see the following result when you run the script:
"outcome" => "success", "response-headers" => {"process-state" => "reload-required"}
-
Stop the JBoss EAP server.
After stopping the server, open the EAP_HOME/standalone/configuration/standalone-full.xml
file and review the changes.
The following testQueue
jms-queue was configured in the configuration of the messaging-activemq
subsystem.
<remote-connector name="artemis" socket-binding="remote-artemis"/>
<pooled-connection-factory name="RemoteConnectionFactory" entries="java:jboss/RemoteConnectionFactory java:jboss/exported/jms/RemoteConnectionFactory" connectors="artemis" user="admin" password="admin" enable-amq1-prefix="false"/>
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type the following command to build the quickstart.
$ mvn clean package
-
Type the following command to deploy the quickstart.
$ mvn wildfly:deploy
This deploys the remote-helloworld-mdb/target/remote-helloworld-mdb.war
to the running instance of the server.
You should see a message in the server log indicating that the archive deployed successfully.
The application will be running at the following URL: http://localhost:8080/remote-helloworld-mdb/.
Look at the JBoss EAP console or Server log and you should see log messages like the following:
INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-9 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 1
INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-6 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 2
INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-7 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 3
INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-5 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 4
INFO [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-4 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 5
This quickstart includes Arquillian integration tests. They are located under the src/test/
directory. The integration tests verify that the quickstart runs correctly when deployed on the server.
Follow these steps to run the integration tests.
-
Make sure you start the JBoss EAP server, as previously described.
-
Make sure you build and deploy the quickstart, as previously described.
-
Type the following command to run the
verify
goal with thearq-remote
profile activated.$ mvn verify -Parq-remote
Note
|
You may also use the environment variable |
When you are finished testing the quickstart, follow these steps to undeploy the archive.
-
Make sure you start the JBoss EAP server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type this command to undeploy the archive:
$ mvn wildfly:undeploy
You can restore the original server configuration using either of the following methods.
-
You can run the
remove-remote-broker.cli
script provided in the root directory of this quickstart. -
You can manually restore the configuration using the backup copy of the configuration file.
-
Start the JBoss EAP server as described above.
-
Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing
EAP_HOME
with the path to your server:$ EAP_HOME/bin/jboss-cli.sh --connect --file=remove-remote-broker.cli
NoteFor Windows, use the EAP_HOME\bin\jboss-cli.bat
script.
This script removes the remote broker connection from the messaging-activemq
subsystem and restore the default
internal broker. You should see the following result when you run the script:
"outcome" => "success",
"response-headers" => {
"operation-requires-reload" => true,
"process-state" => "reload-required"
}
When you have completed testing the quickstart, you can restore the original server configuration by manually restoring the backup copy the configuration file.
-
If it is running, stop the JBoss EAP server.
-
Replace the
EAP_HOME/standalone/configuration/standalone-full.xml
file with the backup copy of the file.
$ oc run artemis --env AMQ_USER=admin --env AMQ_PASSWORD=admin --image=registry.redhat.io/amq7/amq-broker-rhel8:7.10 --port=61616 --expose=true
This will create a broker instance named artemis
on OpenShift that can be accessed on the port 61616
on the service artemis
with the account admin/admin.
This section contains the basic instructions to build and deploy this quickstart to JBoss EAP for OpenShift or JBoss EAP for OpenShift Online using Helm Charts.
-
You must be logged in OpenShift and have an
oc
client to connect to OpenShift -
Helm must be installed to deploy the backend on OpenShift.
Once you have installed Helm, you need to add the repository that provides Helm Charts for JBoss EAP.
$ helm repo add jboss-eap https://jbossas.github.io/eap-charts/
"jboss-eap" has been added to your repositories
$ helm search repo jboss-eap
NAME CHART VERSION APP VERSION DESCRIPTION
jboss-eap/eap8 ... ... A Helm chart to build and deploy EAP 8.0 applications
Log in to your OpenShift instance using the oc login
command.
The backend will be built and deployed on OpenShift with a Helm Chart for JBoss EAP.
Navigate to the root directory of this quickstart and run the following command:
$ helm install remote-helloworld-mdb -f charts/helm.yaml jboss-eap/eap8
NAME: remote-helloworld-mdb
...
STATUS: deployed
REVISION: 1
The Helm Chart for this quickstart contains all the information to build an image from the source code using S2I on Java 17:
build:
uri: https://github.com/jboss-developer/jboss-eap-quickstarts.git
ref: 8.0.x
contextDir: remote-helloworld-mdb
deploy:
replicas: 1
This will create a new deployment on OpenShift and deploy the application.
If you want to see all the configuration elements to customize your deployment you can use the following command:
$ helm show readme jboss-eap/eap8
Let’s wait for the application to be built and deployed:
$ oc get deployment remote-helloworld-mdb -w
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
remote-helloworld-mdb 1 1 1 0 12s
...
remote-helloworld-mdb 1 1 1 1 2m
Get the URL of the route to the deployment.
$ oc get route remote-helloworld-mdb -o jsonpath="{.spec.host}"
Access the application in your web browser using the displayed URL.
Note
|
The Maven profile named |
This quickstart includes Arquillian integration tests. They are located under the src/test/
directory. The integration tests verify that the quickstart runs correctly when deployed on the server.
Note
|
The Arquillian integration tests expect a deployed application, so make sure you have deployed the quickstart on OpenShift before you begin. |
Run the integration tests using the following command to run the verify
goal with the arq-remote
profile activated and the proper URL:
$ mvn clean verify -Parq-remote -Dserver.host=https://$(oc get route remote-helloworld-mdb --template='{{ .spec.host }}')
Note
|
The tests are using SSL to connect to the quickstart running on OpenShift. So you need the certificates to be trusted by the machine the tests are run from. |