Skip to content

README.adoc

Latest commit

 

History

History
1452 lines (1202 loc) · 59.2 KB

README.adoc

File metadata and controls

1452 lines (1202 loc) · 59.2 KB
Raw

helloworld-mdb: Helloworld Using an MDB (Message-Driven Bean)

The helloworld-mdb quickstart uses JMS and EJB Message-Driven Bean (MDB) to create and deploy JMS topic and queue resources in JBoss EAP.

What is it?

The helloworld-mdb quickstart demonstrates the use of JMS and EJB Message-Driven Bean in Red Hat JBoss Enterprise Application Platform.

This project creates two JMS resources:

  • A queue named HELLOWORLDMDBQueue bound in JNDI as java:/queue/HELLOWORLDMDBQueue

  • A topic named HELLOWORLDMDBTopic bound in JNDI as java:/topic/HELLOWORLDMDBTopic

System Requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 8.1 or later.

All you need to build this project is Java SE 17.0 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.

Use of the EAP_HOME and QUICKSTART_HOME Variables

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.

Building and running the quickstart application with a JBoss EAP server distribution

Start the JBoss EAP Standalone Server

  1. Open a terminal and navigate to the root of the JBoss EAP directory.

  2. Start the JBoss EAP server with the full profile by typing the following command.

    $ EAP_HOME/bin/standalone.sh -c standalone-full.xml
    Note
    		 For Windows, use the EAP_HOME\bin\standalone.bat script.

Build and Deploy the Quickstart

  1. Make sure JBoss EAP server is started.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. Type the following command to build the quickstart.

    $ mvn clean package

  4. Type the following command to deploy the quickstart.

    $ mvn wildfly:deploy

This deploys the helloworld-mdb/target/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.

Look at the JBoss EAP console or server log and you should see log messages corresponding to the deployment of the message-driven beans and the JMS destinations:

INFO  [org.jboss.as.server.deployment] (MSC service thread 1-1) WFLYSRV0027: Starting deployment of "helloworld-mdb.war" (runtime-name: "helloworld-mdb.war")
...
INFO  [org.wildfly.extension.messaging-activemq] (MSC service thread 1-4) WFLYMSGAMQ0006: Unbound messaging object to jndi name java:/queue/HELLOWORLDMDBQueue
INFO  [org.wildfly.extension.messaging-activemq] (MSC service thread 1-4) WFLYMSGAMQ0002: Bound messaging object to jndi name java:/queue/HELLOWORLDMDBQueue
INFO  [org.wildfly.extension.messaging-activemq] (MSC service thread 1-2) WFLYMSGAMQ0006: Unbound messaging object to jndi name java:/topic/HELLOWORLDMDBTopic
INFO  [org.wildfly.extension.messaging-activemq] (MSC service thread 1-3) WFLYMSGAMQ0002: Bound messaging object to jndi name java:/topic/HELLOWORLDMDBTopic
INFO  [org.jboss.as.ejb3] (MSC service thread 1-4) WFLYEJB0042: Started message driven bean 'HelloWorldQueueMDB' with 'activemq-ra.rar' resource adapter
INFO  [org.jboss.as.ejb3] (MSC service thread 1-1) WFLYEJB0042: Started message driven bean 'HelloWorldQTopicMDB' with 'activemq-ra.rar' resource adapter
...
INFO  [org.wildfly.extension.undertow] (ServerService Thread Pool -- 87) WFLYUT0021: Registered web context: '/helloworld-mdb' for server 'default-server'
INFO  [org.jboss.as.server] (management-handler-thread - 1) WFLYSRV0010: Deployed "helloworld-mdb.war" (runtime-name : "helloworld-mdb.war")

Access the Application

The application will be running at the following URL: http://localhost:8080/helloworld-mdb/ and will send some messages to the queue.

To send messages to the topic, use the following URL: http://localhost:8080/helloworld-mdb/HelloWorldMDBServletClient?topic

Investigate the Server Console Output

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 5
INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-6 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 1
INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-7 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 4
INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-5 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 2
INFO  [class org.jboss.as.quickstarts.mdb.HelloWorldQueueMDB] (Thread-4 (ActiveMQ-client-global-threads-1189700957)) Received Message from queue: This is message 3

Run the Integration Tests

This quickstart includes integration tests, which 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.

  1. Make sure JBoss EAP server is started.

  2. Make sure the quickstart is deployed.

  3. Type the following command to run the verify goal with the integration-testing profile activated.

    $ mvn verify -Pintegration-testing

Undeploy the Quickstart

When you are finished testing the quickstart, follow these steps to undeploy the archive.

  1. Make sure JBoss EAP server is started.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. Type this command to undeploy the archive:

    $ mvn wildfly:undeploy

Building and running the quickstart application with provisioned JBoss EAP server

Instead of using a standard JBoss EAP server distribution, you can alternatively provision a JBoss EAP server to deploy and run the quickstart. The functionality is provided by the WildFly Maven Plugin, and you may find its configuration in the quickstart pom.xml:

<profile>
    <id>provisioned-server</id>
    <activation>
        <activeByDefault>true</activeByDefault>
    </activation>
    <build>
        <plugins>
            <plugin>
                <groupId>org.jboss.eap.plugins</groupId>
                <artifactId>eap-maven-plugin</artifactId>
                <configuration>
                    ...
                    <feature-packs>
                        <feature-pack>
                            <location>org.jboss.eap:wildfly-ee-galleon-pack</location>
                        </feature-pack>
                        ...
                    </feature-packs>
                    <layers>...</layers>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>package</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            ...
        </plugins>
    </build>
</profile>
Note

When built, the provisioned JBoss EAP server can be found in the target/server directory, and its usage is similar to a standard server distribution, with the simplification that there is never the need to specify the server configuration to be started.

Follow these steps to run the quickstart using the provisioned server.

Procedure

  1. Make sure the server is provisioned.

    $ mvn clean package

  2. Start the JBoss EAP provisioned server, using the WildFly Maven Plugin start goal.

    $ mvn wildfly:start

  3. Type the following command to run the integration tests.

    $ mvn verify -Pintegration-testing

  4. Shut down the JBoss EAP provisioned server.

    $ mvn wildfly:shutdown

Building and running the quickstart application with OpenShift

Build the JBoss EAP Source-to-Image (S2I) Quickstart to OpenShift with Helm Charts

On OpenShift, the S2I build with Apache Maven uses an openshift Maven profile to provision a JBoss EAP server, deploy and run the quickstart in OpenShift environment.

The server provisioning functionality is provided by the EAP Maven Plugin, and you may find its configuration in the quickstart pom.xml:

<profile>
    <id>openshift</id>
    <build>
        <plugins>
            <plugin>
                <groupId>org.jboss.eap.plugins</groupId>
                <artifactId>eap-maven-plugin</artifactId>
                <configuration>
                    ...
                    <feature-packs>
                        <feature-pack>
                            <location>org.jboss.eap:wildfly-ee-galleon-pack</location>
                        </feature-pack>
                        <feature-pack>
                            <location>org.jboss.eap.cloud:eap-cloud-galleon-pack</location>
                        </feature-pack>
                    </feature-packs>
                    <layers>...</layers>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>package</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            ...
        </plugins>
    </build>
</profile>

You may note that it uses the cloud feature pack which enables a configuration tuned for the OpenShift environment.

Getting Started with JBoss EAP for OpenShift and Helm Charts

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.

Prerequisites

  • 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/eap81         ...             ...             A Helm chart to build and deploy EAP 8.1 applications

Deploy the JBoss EAP Source-to-Image (S2I) Quickstart to OpenShift with Helm Charts

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 helloworld-mdb -f charts/helm.yaml jboss-eap/eap81 --wait --timeout=10m0s 
NAME: helloworld-mdb
...
STATUS: deployed
REVISION: 1

This command will return once the application has successfully deployed. In case of a timeout, you can check the status of the application with the following command in another terminal:

oc get deployment helloworld-mdb

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.1.x
  contextDir: helloworld-mdb
deploy:
  replicas: 2

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/eap81

Get the URL of the route to the deployment.

$ oc get route helloworld-mdb -o jsonpath="{.spec.host}"

Access the application in your web browser using the displayed URL.

Run the Integration Tests with OpenShift

The integration tests included with this quickstart, which verify that the quickstart runs correctly, may also be run with the quickstart running on OpenShift.

Note

The 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 integration-testing profile activated and the proper URL:

$ mvn verify -Pintegration-testing -Dserver.host=https://$(oc get route 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.

Undeploy the JBoss EAP Source-to-Image (S2I) Quickstart from OpenShift with Helm Charts

$ helm uninstall helloworld-mdb

Clustering

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 each type of server.

Before you begin:

  1. If it is running, stop the JBoss EAP server.

  2. If you plan to test using a standalone server, back up the standalone server configuration file:

    EAP_HOME/standalone/configuration/standalone-full-ha.xml

  3. If you plan to test using a managed domain, back up the following files:

    EAP_HOME/domain/configuration/domain.xml
EAP_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.

Configure the Server and Deploy the Quickstart

Configure the Server and Deploy the Quickstart to a Managed Domain

You configure the server by running the install-domain.cli script provided in the root directory of this quickstart.

Start the JBoss EAP Managed Domain

  1. Open a terminal and navigate to the root of the JBoss EAP directory.

  2. Start the JBoss EAP managed domain by typing the following command.

    $ EAP_HOME/bin/domain.sh
    Note
    		 For Windows, use the EAP_HOME\bin\domain.bat script.
Configure the Domain Server and Deploy the Quickstart Using the JBoss CLI

  1. 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.

  2. Open a terminal, navigate to the root directory of this quickstart, and run the following command to run the script:

    $ EAP_HOME/bin/jboss-cli.sh --connect --file=install-domain.cli
    Note
    		 For Windows, use the EAP_HOME\bin\jboss-cli.bat script.

    You should see "outcome" ⇒ "success" for all of the commands.

  3. Restart the server in a managed domainas described above.

Configure the Server and Deploy the Quickstart to a Standalone Server

If you choose to run standalone servers instead of a managed domain, 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.

Start the Standalone Server Using the Full HA Profile.

  1. Open a terminal and navigate to the root of the JBoss EAP directory.

  2. Start the JBoss EAP server with the standalone full HA profile, which supports messaging and high availability, by typing the following command.

    $ EAP_HOME/bin/standalone.sh -c standalone-full-ha.xml
    Note
    		 For Windows, use the EAP_HOME\bin\standalone.bat script.
Configure the Standalone Server and Deploy the Quickstart Using the JBoss CLI

  1. 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

  2. Open a terminal, navigate to the root directory of this quickstart, and run the following command to run the script:

    $ EAP_HOME_1/bin/jboss-cli.sh --connect --file=install-standalone.cli
    Note
    		 For Windows, use the EAP_HOME_1\bin\jboss-cli.bat script.

You should see "outcome" ⇒ "success" for all of the commands.

Clone the JBoss EAP Directory

After you have successfully configured the server, you must make a copy of this JBoss EAP directory structure to use for the second server.

  1. Stop the server.

  2. Make a copy of this JBoss EAP directory structure to use for the second server.

  3. Remove the following directories from the cloned instance:

    EAP_HOME_2/standalone/data/activemq/bindings/
EAP_HOME_2/standalone/data/activemq/journal/
EAP_HOME_2/standalone/data/activemq/largemessages/
Start the JBoss EAP Standalone Servers with the Full HA Profile

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.

$ EAP_HOME_1/bin/standalone.sh -c standalone-full-ha.xml
$ EAP_HOME_2/bin/standalone.sh -c standalone-full-ha.xml -Djboss.socket.binding.port-offset=100
Note
 For Windows, use the EAP_HOME_1\bin\standalone.bat and EAP_HOME_2\bin\standalone.bat scripts.

Access the Application

Access the Application Running in a Managed Domain

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

Access the Application Running in a Standalone Server

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

Investigate the Server Console Output

Look at the JBoss EAP server console or log and you should see log messages like the following:

[Server:quickstart-messagingcluster-node1] 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] 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] 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] 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] 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.

Server Log: Expected Warnings and Errors

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)

After the server has been running for a period of time, you might 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>

Undeploy the Archive

When you are finished testing, use the following instructions to undeploy the quickstart.

Undeploy the Quickstart from a Managed Domain

  1. Make sure you have started the JBoss EAP server in a managed domain as described above.

  2. Open a terminal, navigate to the root directory of this quickstart, and run the following command to undeploy the helloworld-mdb quickstart:

    $ EAP_HOME/bin/jboss-cli.sh --connect --file=undeploy-domain.cli
    Note
    		 For Windows, use the EAP_HOME\bin\jboss-cli.bat script.

Undeploy the Quickstart from a Standalone Server

  1. Make sure you start the JBoss EAP server as described above.

  2. Open a terminal, navigate to the root directory of this quickstart, and run the following command to undeploy the helloworld-mdb quickstart:

    $ EAP_HOME/bin/jboss-cli.sh --connect --file=undeploy-standalone.cli
    Note
    		 For Windows, use the EAP_HOME\bin\jboss-cli.bat script.

Remove the Server Configuration

Remove the Domain Server Configuration

You can remove the domain configuration by manually restoring the back-up copies the configuration files or by running the JBoss CLI Script.

Remove the Domain Server Configuration Manually
Important
 This method ensures the server is restored to its prior configuration.

  1. If it is running, stop the JBoss EAP server.

  2. Restore the EAP_HOME/domain/configuration/domain.xml and EAP_HOME/domain/configuration/host.xml files with the back-up copies of the files. Make sure you replace EAP_HOME with the path to your server.

Remove the Domain Server Configuration by Running the JBoss CLI Script
Important
 This script returns the server to the default configuration, which might not match the server configuration that existed 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 domain configuration to its previous state.

  1. Start the JBoss EAP server by typing the following:

    $ EAP_HOME/bin/jboss-cli.sh --connect --file=install-domain.cli
    Note
    		 For Windows, use the EAP_HOME\bin\jboss-cli.bat script.

  2. 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-domain.cli
    Note
    		 For Windows, use the EAP_HOME\bin\jboss-cli.bat script.

    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
Important

If the :stop-server command does not complete before the next commands are issued, you might 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.

Remove the Standalone Server Configuration

You can remove the domain configuration by manually restoring the back-up copies the configuration files or by running the JBoss CLI Script.

Remove the Standalone Server Configuration Manually
Important
 This method ensures the server is restored to its prior configuration.

  1. If they are running, stop both JBoss EAP servers.

  2. Restore the EAP_HOME_1/standalone/configuration/standalone-full-ha.xml file with the back-up copies of the file. Make sure you replace EAP_HOME_1 with the path to your server.

Remove the Standalone Configuration by Running the JBoss CLI Script
Important
 This script returns the server to the default configuration, which might not match the server configuration that existed 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 standalone configuration to its previous state.

  1. Start the JBoss EAP server by typing the following:

    $ EAP_HOME_1/bin/standalone.sh -c standalone-full-ha.xml
    Note
    		 For Windows, use the EAP_HOME_1\bin\standalone.bat script.

  2. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing EAP_HOME_1 with the path to your server.

    $ EAP_HOME_1/bin/jboss-cli.sh --connect --file=remove-standalone.cli
    Note
    		 For Windows, use the EAP_HOME_1\bin\jboss-cli.bat script.

    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

Delete the Cloned Standalone JBoss EAP Directory

  1. If it is running, stop the second instance of the JBoss EAP server.

  2. Delete the cloned directory.