Author: Serge Pagop, Andy Taylor, Jeff Mesnil
Level: Intermediate
Technologies: JMS, EJB, MDB
Summary: The helloworld-mdb-propertysubstitution
quickstart demonstrates the use of JMS and EJB MDB, enabling property substitution with annotations.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
The helloworld-mdb-propertysubstitution
quickstart demonstrates the use of JMS and EJB Message-Driven Bean in WildFly Application Server.
It is based on the helloworld-mdb quickstart, but has been enhanced to enable property substitution using the @Resource
and @ActivationConfigProperty
annotations.
This project creates two JMS resources:
HELLOWORLDMDBQueue
bound in JNDI as java:/${property.helloworldmdb.queue}
HELLOWORLDMDBTopic
bound in JNDI as java:/${property.helloworldmdb.topic}
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.
You enable MDB property substitution by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a enable-mdb-property-substitution.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
enable-mdb-property-substitution.cli
script file in the root of this quickstart directory. This script first enables MDB annotation property substitution the ee
subsystem of the server configuration file by creating an annotation-property-replacement
property with a value of true
. It then defines the system properties that are used in the substitution.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=enable-mdb-property-substitution.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=enable-mdb-property-substitution.cli
You should see the following result when you run the script:
The batch executed successfully
After stopping the server, open the WILDFLY_HOME/standalone/configuration/standalone-full.xml
file and review the changes.
The <annotation-property-replacement>
attribute is set to true in the ee
subsystem :
<subsystem xmlns="urn:jboss:domain:ee:4.0">
...
<annotation-property-replacement>true</annotation-property-replacement>
...
</subsystem>
The following system properties are defined and appear after the <extensions>
:
<system-properties>
<property name="property.helloworldmdb.queue" value="java:/queue/HELLOWORLDMDBPropQueue"/>
<property name="property.helloworldmdb.topic" value="java:/topic/HELLOWORLDMDBPropTopic"/>
<property name="property.connection.factory" value="java:/ConnectionFactory"/>
</system-properties>
For Linux: WILDFLY_HOME/bin/standalone.sh -c standalone-full.xml
For Windows: WILDFLY_HOME\bin\standalone.bat -c standalone-full.xml
mvn clean install wildfly:deploy
This will deploy target/helloworld-mdb-propertysubstitution.war
to the running instance of the server. Look at the WildFly 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.wildfly.extension.messaging-activemq] (MSC service thread 1-8) WFLYMSGAMQ0002: Bound messaging object to jndi name java:/${property.helloworldmdb.queue}
INFO [org.wildfly.extension.messaging-activemq] (MSC service thread 1-5) WFLYMSGAMQ0002: Bound messaging object to jndi name java:/${property.helloworldmdb.topic}
...
INFO [org.wildfly.extension.messaging-activemq] (ServerService Thread Pool -- 70) WFLYMSGAMQ0002: Bound messaging object to jndi name java:/queue/HELLOWORLDMDBPropQueue
INFO [org.apache.activemq.artemis.core.server] (ServerService Thread Pool -- 73) AMQ221003: trying to deploy queue jms.topic.HelloWorldMDBTopic
INFO [org.apache.activemq.artemis.core.server] (ServerService Thread Pool -- 72) AMQ221003: trying to deploy queue jms.topic.HELLOWORLDMDBTopic
INFO [org.wildfly.extension.messaging-activemq] (ServerService Thread Pool -- 72) WFLYMSGAMQ0002: Bound messaging object to jndi name java:/topic/HELLOWORLDMDBPropTopic
INFO [org.apache.activemq.artemis.core.server] (ServerService Thread Pool -- 71) AMQ221003: trying to deploy queue jms.queue.HelloWorldMDBQueue
INFO [org.jboss.as.ejb3] (MSC service thread 1-7) WFLYEJB0042: Started message driven bean 'HelloWorldQTopicMDB' with 'activemq-ra.rar' resource adapter
INFO [org.jboss.as.ejb3] (MSC service thread 1-6) WFLYEJB0042: Started message driven bean 'HelloWorldQueueMDB' with 'activemq-ra.rar' resource adapter
The application will be running at the following URL: http://localhost:8080/helloworld-mdb-propertysubstitution/ and will send some messages to the queue.
To send messages to the topic, use the following URL: http://localhost:8080/helloworld-mdb-propertysubstitution/HelloWorldMDBServletClient?topic
Look at the WildFly 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
mvn wildfly:undeploy
You can remove the server configuration by running the disable-mdb-property-substitution.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=disable-mdb-property-substitution.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=disable-mdb-property-substitution.cli
This script removes the system properties and sets the <annotation-property-replacement>
value to false
in the ee
subsystem of 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.
standalone-full.xml
configuration file.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