Quickstarts

ejb-in-ear: Deployment of an EAR Containing a JSF WAR and an EJB JAR

What is it?

This example demonstrates the deployment of an EAR artifact. The EAR contains: JSF 2.0 WAR and an EJB 3.1 JAR.

The example is composed of three maven projects, each with a shared parent. The projects are as follows:

  1. ejb: This project contains the EJB code and can be built independently to produce the JAR archive.

  2. web: This project contains the JSF pages and the managed bean.

  3. ear: This project builds the EAR artifact and pulls in the ejb and web artifacts.

The root pom.xml builds each of the subprojects in the above order and deploys the EAR archive to the server.

The example follows the common "Hello World" pattern. These are the steps that occur:

  1. A JSF page asks the user for their name.
  2. On clicking Greet, the name is sent to a managed bean named Greeter.
  3. On setting the name, the Greeter invokes the GreeterEJB, which was injected to the managed bean. Notice the field annotated with @EJB.
  4. The response from invoking the GreeterEJB is stored in a field (message) of the managed bean.
  5. 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

All you need to build this project is Java 6.0 (Java SDK 1.6) or better, Maven 3.0 or better.

The application this project produces is designed to be run on JBoss Enterprise Application Platform 6 or JBoss AS 7.

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

Start JBoss Enterprise Application Platform 6 or JBoss AS 7 with the Web Profile

  1. Open a command line and navigate to the root of the JBoss server directory.
  2. The following shows the command line to start the server with the web profile:

     For Linux:   JBOSS_HOME/bin/standalone.sh
     For Windows: JBOSS_HOME\bin\standalone.bat
    

Build and Deploy the Quickstart

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.

  1. Make sure you have started the JBoss Server as described above.
  2. Open a command line and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

     mvn clean package jboss-as:deploy
    
  4. This will deploy target/jboss-as-ejb-in-ear.ear to the running instance of the server.

Access the application

The application will be running at the following URL http://localhost:8080/jboss-as-ejb-in-ear.

Enter a name in the input field and click the Greet button to see the response.

Undeploy the Archive

  1. Make sure you have started the JBoss Server as described above.
  2. Open a command line and navigate to the root directory of this quickstart.
  3. When you are finished testing, type this command to undeploy the archive:

     mvn jboss-as:undeploy
    

Run the Quickstart in JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

Debug the Application

If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.

    mvn dependency:sources
    mvn dependency:resolve -Dclassifier=javadoc

Share the Knowledge

Find this guide useful?

Feedback

Find a bug in the guide? Something missing? You can fix it by forking the repository, making the correction and sending a pull request. If you're just plain stuck, feel free to ask a question in the user discussion forum.

Recent Changelog

  • Feb 12, 2013: Add quickstart source repository of record to the readme files Sande Gilda
  • Sep 11, 2012: Add target product (https://issues.jboss.org/browse/jdf-108) Sande Gilda
  • May 11, 2012: Readme maven config updates, change header titles to quickstart folder name, update experience levels, issue 258 Sande Gilda
  • May 18, 2012: Move metadata to quickstarts Pete Muir
  • Apr 11, 2012: Remove odd trailing slashes Pete Muir
  • Apr 10, 2012: Solve issue #194 :-) auto transform links from readme.md -> readme.html Pete Muir
  • Apr 05, 2012: Missed adding the arquillian instructions, fixed indentations, modified jta-crash-rec and jts-distributed-crash-rec, add missing authors Sande Gilda
  • Apr 01, 2012: More readme cleanup Sande Gilda
  • Mar 26, 2012: Attempt to standardize readme.md files Sande Gilda
  • Mar 21, 2012: Fix instructions to deploy ears Sande Gilda
  • Jan 26, 2012: Make the readme files consistent with titles, sections (what is it?, etc), and project and product names. uppercase readme.html file names Sande Gilda
  • Jan 16, 2012: Jira as7-2323: add getting started developing applications guide link to all readme.md files. change readme.md files to uppercase for consistency Sande Gilda

See full history »