Red Hat

Developer Materials

Red Hat JBoss Enterprise Application Platform (EAP) Quickstarts

  • Contributors: , , , , , , , , , ,
  • Published: Jul 18, 2014

Introduction

These quickstarts run on Red Hat JBoss Enterprise Application Platform 6.1 or later. We recommend using the JBoss EAP ZIP file. This version uses the correct dependencies and ensures you test and compile against your runtime environment.

Be sure to read this entire document before you attempt to work with the quickstarts. It contains the following information:

Use of EAP_HOME and JBOSS_HOME Variables

The quickstart README files use the replaceable value EAP_HOME to denote the path to the JBoss EAP 6 installation. When you encounter this value in a README file, be sure to replace it with the actual path to your JBoss EAP 6 installation.

  • If you installed JBoss EAP using the ZIP, the install directory is the path you specified when you ran the command.

  • If you installed JBoss EAP using the RPM, the install directory is /var/lib/jbossas/.

  • If you used the installer to install JBoss EAP, the default path for EAP_HOME is ${user.home}/EAP-6.3.0.

      For Linux: /home/USER_NAME/EAP-6.3.0/
      For Windows: "C:\Users\USER_NAME\EAP-6.3.0\"
    
  • If you used the JBoss Developer Studio installer to install and configure the JBoss EAP Server, the default path for EAP_HOME is ${user.home}/jbdevstudio/runtimes/jboss-eap.

      For Linux: /home/USER_NAME/jbdevstudio/runtimes/jboss-eap/
      For Windows: "C:\Users\USER_NAME\jbdevstudio\runtimes\jboss-eap" or "C:\Documents and Settings\USER_NAME\jbdevstudio\runtimes\jboss-eap\" 
    

The JBOSS_HOME environment variable, which is used in scripts, continues to work as it has in the past.

Available Quickstarts

The list of all currently available quickstarts can be found here: http://site-jdf.rhcloud.com/quickstarts/get-started/. The table lists each quickstart name, the technologies it demonstrates, gives a brief description of the quickstart, and the level of experience required to set it up. For more detailed information about a quickstart, click on the quickstart name.

Some quickstarts are designed to enhance or extend other quickstarts. These are noted in the Prerequisites column. If a quickstart lists prerequisites, those must be installed or deployed before working with the quickstart.

Note: Some of these quickstart use the H2 database included with JBoss EAP 6. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable and should NOT be used in a production environment!

[TOC-quickstart]

Suggested Approach to the Quickstarts

We suggest you approach the quickstarts as follows:

  • Regardless of your level of expertise, we suggest you start with the helloworld quickstart. It is the simplest example and is an easy way to prove your server is configured and started correctly.
  • If you are a beginner or new to JBoss, start with the quickstarts labeled Beginner, then try those marked as Intermediate. When you are comfortable with those, move on to the Advanced quickstarts.
  • Some quickstarts are based upon other quickstarts but have expanded capabilities and functionality. If a prerequisite quickstart is listed, be sure to deploy and test it before looking at the expanded version.

System Requirements

The applications these projects produce are designed to be run on Red Hat JBoss Enterprise Application Platform 6.1 or later.

To run these quickstarts with the provided build scripts, you need the following:

  1. Java 1.6, to run JBoss EAP and Maven. You can choose from the following:
    • OpenJDK
    • Oracle Java SE
    • Oracle JRockit
  2. Maven 3.0.0 or newer, to build and deploy the examples
    • If you have not yet installed Maven, see the Maven Getting Started Guide for details.
    • If you have installed Maven, you can check the version by typing the following in a command prompt:

        mvn --version 
      
  3. The JBoss EAP distribution ZIP.
  4. You can also use JBoss Developer Studio or Eclipse to run the quickstarts.

Run the Quickstarts

The root folder of each individual quickstart contains a README file with specific details on how to build and run the example. In most cases you do the following:

Build and Deploy the Quickstarts

See the README file in each individual quickstart folder for specific details and information on how to run and access the example.

Note: If you do not configure the Maven settings as described here, Configure Maven, you must pass the configuration setting on every Maven command as follows: ` -s QUICKSTART_HOME/settings.xml`

Build the Quickstart Archive

In most cases, you can use the following steps to build the application to test for compile errors or to view the contents of the archive. See the specific quickstart README file for complete details.

  1. Open a command prompt and navigate to the root directory of the quickstart you want to build.
  2. Use this command if you only want to build the archive, but not deploy it:
    • If you have configured the Maven settings :

         mvn clean install
      
    • If you have NOT configured settings Maven settings:

         mvn clean install -s QUICKSTART_HOME/settings.xml
      

Build and Deploy the Quickstart Archive

In most cases, you can use the following steps to build and deploy the application. See the specific quickstart README file for complete details.

  1. Make sure you start the JBoss EAP server as described in the quickstart README file.
  2. Open a command prompt and navigate to the root directory of the quickstart you want to run.
  3. Use this command to build and deploy the archive:

    • If you have configured the Maven settings :

         mvn clean install jboss-as:deploy
      
    • If you have NOT configured the Maven settings :

         mvn clean install jboss-as:deploy -s QUICKSTART_HOME/settings.xml
      

Undeploy an Archive

The command to undeploy the quickstart is simply:

    mvn jboss-as:undeploy

Verify the Quickstarts Build with One Command


You can verify the quickstarts build using one command. However, quickstarts that have complex dependencies must be skipped. For example, the jax-rs-client quickstart is a RESTEasy client that depends on the deployment of the helloworld-rs quickstart. As noted above, the root pom.xml file defines a complex-dependencies profile to exclude these quickstarts from the root build process.

To build the quickstarts:

  1. Do not start the JBoss EAP server.
  2. Open a command prompt and navigate to the root directory of the quickstarts.
  3. Use this command to build the quickstarts that do not have complex dependencies:

    • If you have configured the Maven settings :

         mvn clean install '-Pdefault,!complex-dependencies'
      
    • If you have NOT configured the Maven settings :

         mvn clean install '-Pdefault,!complex-dependencies' -s QUICKSTART_HOME/settings.xml
      

Note: If you see a java.lang.OutOfMemoryError: PermGen space error when you run this command, increase the memory by typing the following command for your operating system, then try the above command again.

    For Linux:   export MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"
    For Windows: SET MAVEN_OPTS="-Xmx512m -XX:MaxPermSize=128m"

Undeploy the Deployed Quickstarts with One Command


To undeploy the quickstarts from the root of the quickstart folder, you must pass the argument -fae (fail at end) on the command line. This allows the command to continue past quickstarts that fail due to complex dependencies and quickstarts that only have Arquillian tests and do not deploy archives to the server.

You can undeploy quickstarts using the following procedure:

  1. Start the JBoss EAP server.
  2. Open a command prompt and navigate to the root directory of the quickstarts.
  3. Use this command to undeploy any deployed quickstarts:

         mvn jboss-as:undeploy -fae
    

To undeploy any quickstarts that fail due to complex dependencies, follow the undeploy procedure described in the quickstart's README file.

Use JBoss Developer Studio or Eclipse to Run the Quickstarts

You can also deploy the quickstarts from Eclipse using JBoss tools. For more information on how to set up Maven and the JBoss tools, see the JBoss Enterprise Application Platform Documentation Getting Started Guide and Development Guide or Get Started with JBoss Developer Studio.

Optional Components

The following components are needed for only a small subset of the quickstarts. Do not install or configure them unless the quickstart requires it.

Recent Changelog

  • Jul 18, 2014(Sande Gilda):BZ1121140 Fix broken jboss.org links in the quickstart README files
  • Jun 12, 2014(Sande Gilda):BZ1097788 Clarify EAP_HOME path for RPM install
  • Jun 2, 2014(Sande Gilda):Bz1097788 Move EAP_HOME details to root README file
  • May 29, 2014(Sande Gilda):Bz1102929 Remove text and link to obsolete tutorials
  • May 2, 2014(Sande Gilda):Fix link to Maven instructions
  • Mar 27, 2014(Sande Gilda):Missed an underscore in EAP_HOME note
  • Mar 27, 2014(Sande Gilda):Bz1081446 replace JBOSS_HOME with EAP_HOME in ejb multi server and logging web app screens
  • Mar 2, 2014(Sande Gilda):Bz1025766 Replace JBoss with JBoss EAP
  • Feb 5, 2014(Sande Gilda):Replace start server link in README with guide in shared repository
  • Feb 5, 2014(Sande Gilda):Replace Arquillian instruction link in README files with guide in shared repository
Avg:
Your Rating:
×