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.
What is it?
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 using the following workflow.
-
A JSF page asks for the user name.
-
On clicking Greet, 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.
System Requirements
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 to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.
Use of EAP_HOME
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.
Start the JBoss EAP Standalone Server
-
Open a terminal and navigate to the root of the JBoss EAP directory.
-
Start the JBoss EAP server with the default profile by typing the following command.
$ EAP_HOME/bin/standalone.sh
NoteFor Windows, use the EAP_HOME\bin\standalone.bat
script.
Build and Deploy the Quickstart
-
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 artifacts.
$ mvn clean package wildfly:deploy
This deploys the ejb-in-war/target/ejb-in-war.war
to the running instance of the server.
You should see a message in the server log indicating that the archive deployed successfully.
Access the Application
The application will be running at the following URL http://localhost:8080/ejb-in-war/.
Undeploy the Quickstart
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
Run the Arquillian Tests
This quickstart provides Arquillian tests. By default, these tests are configured to be skipped since Arquillian tests require the use of a container.
Note
|
The Arquillian tests deploy the application, so make sure you undeploy the quickstart before you begin. |
Follow these steps to run the tests.
-
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 run the
verify
goal with thearq-remote
profile activated.$ mvn clean verify -Parq-remote
Note
|
You can also let Arquillian manage the JBoss EAP server by using the |
Investigate the Console Output
When you run the Arquillian tests, Maven prints summary of the performed tests to the console. You should see the following results.
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")
Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse
You can also start the server and deploy the quickstarts or run the Arquillian tests in Red Hat JBoss Developer Studio or 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.
Deploy the Quickstart to OpenShift Online
Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.
Create and Deploy the Quickstart Project
Follow these instructions to deploy this quickstart to OpenShift Online.
-
Browse to OpenShift Online console and login with your credentials.
-
On the View All Projects or Welcome to Project page, click Create Project.
-
On the Create Project page, enter the following information:
Name: ejb-in-war Display Name ejb-in-war Description: ejb-in-war
-
Click Create to create the project.
-
On the My Projects page, choose your new ejb-in-war and click Browse Catalog.
-
Choose JBoss EAP CD (no https) and then click Next to view the Information page.
-
Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.
Add to Project: ejb-in-war Application Name: ejb-in-war Custom http Route Hostname: (leave blank) Git Repository URL: https://github.com/jboss-developer/jboss-eap-quickstarts/ Git Reference: openshift Context directory: ejb-in-war
-
Click the Create button.
-
Click on the Continue to the project overview link.
-
You should see "Build #1 is running …" with the console log below.
Cloning ... Downloading ... Building ... Copying ... Pushing ...
-
At the end of the build, you should see "Push successful".
-
Click View Full Log to see the entire log.
-
-
Click the Overview tab to see the
ejb-in-war
deployment. -
Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:
http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com
Delete the Quickstart Project
Follow these instructions to delete the project from OpenShift Online.
-
Go to the View All Projects page and select Delete Project from the drop down list to the right of the ejb-in-war project.
-
Type the name of the project to confirm, and then click Delete
Debug the Application
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