Author: Paul Robinson
Level: Intermediate
Technologies: EJB, JSF, WAR
Summary: The ejb-in-war
quickstart demonstrates how to package an EJB bean in a WAR archive and deploy it to JBoss EAP. Arquillian tests are also provided.
Target Product: JBoss EAP
Source: https://github.com/jbossas/eap-quickstarts/
The ejb-in-war
quickstart demonstrates the deployment of an EJB bean bundled in a WAR archive for deployment to Red Hat JBoss Enterprise Application Platform. The project also includes a set of Arquillian tests for the managed bean and EJB.
The example follows the common "Hello World" pattern. These are the steps that occur:
- A JSF page asks the user for their name.
- On clicking submit, the name is sent to a managed bean named
Greeter
. - On setting the name, the
Greeter
invokes theGreeterEJB
, which was injected into the managed bean. Notice the field annotated with@EJB
. - The response from invoking the
GreeterEJB
is stored in a fieldmessage
of the managed bean. - The managed bean is annotated as
@SessionScoped
, so the same managed bean instance is used for the entire session. This ensures that the message is available when the page reloads and is displayed to the user.
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.
-
Open a command prompt and navigate to the root of the JBoss EAP directory.
-
The following shows the command line to start the server:
For Linux: EAP7_HOME/bin/standalone.sh For Windows: EAP7_HOME\bin\standalone.bat
-
Make sure you have started the JBoss EAP server as described above.
-
Open a command prompt and navigate to the root directory of this quickstart.
-
Type this command to build and deploy the archive:
mvn clean install wildfly:deploy
-
This will deploy
target/ejb-in-war.war
to the running instance of the server.
The application will be running at the following URL http://localhost:8080/ejb-in-war/.
-
Make sure you have started the JBoss EAP server as described above.
-
Open a command prompt and navigate to the root directory of this quickstart.
-
When you are finished testing, type this command to undeploy the archive:
mvn wildfly:undeploy
This quickstart provides Arquillian tests. By default, these tests are configured to be skipped as Arquillian tests require the use of a container.
-
Make sure you have started the JBoss EAP server as described above.
-
Open a command prompt and navigate to the root directory of this quickstart.
-
Type the following command to run the test goal with the following profile activated:
mvn clean verify -Parq-remote
You can also let Arquillian manage the JBoss EAP server by using the arq-managed
profile. For more information about how to run the Arquillian tests, see Run the Arquillian Tests.
JUnit will present you test report summary:
Tests run: 2, Failures: 0, Errors: 0, Skipped: 0
If you are interested in more details, check target/surefire-reports
directory.
You can check console output to verify that Arquillian has really used the real application server.
Search for lines similar to the following ones in the server output log:
INFO [org.jboss.as.server.deployment] (MSC service thread 1-3) WFLYSRV0027: Starting deployment of "test.war" (runtime-name: "test.war")
...
INFO [org.jboss.as.server] (management-handler-thread - 29) WFLYSRV0010: Deployed "test.war" (runtime-name : "test.war")
...
INFO [org.jboss.as.server.deployment] (MSC service thread 1-3) WFLYSRV0028: Stopped deployment test.war (runtime-name: test.war) in 12ms
...
INFO [org.jboss.as.server] (management-handler-thread - 30) WFLYSRV0009: Undeployed "test.war" (runtime-name: "test.war")
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 JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
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