Red Hat JBoss Enterprise Application Platform (JBoss EAP) Quickstarts
Summary: The quickstarts demonstrate Java EE 7 and a few additional technologies from the JBoss stack. They provide small, specific, working examples that can be used as a reference for your own project.
These quickstarts run on Red Hat JBoss Enterprise Application Platform 7 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:
Available Quickstarts: List of the available quickstarts and details about each one.
Suggested Approach to the Quickstarts: A suggested approach on how to work with the quickstarts.
System Requirements: List of software required to run the quickstarts.
Configure Maven: How to configure the Maven repository for use by the quickstarts.
Run the Quickstarts: General instructions for building, deploying, and running the quickstarts.
Run the Arquillian Tests: How to run the Arquillian tests provided by some of the quickstarts.
Optional Components: How to install and configure optional components required by some of the quickstarts.
Contributing Guide: This document contains information targeted for developers who want to contribute to JBoss developer projects.
Use of EAP7_HOME and JBOSS_HOME Variables
The quickstart README files use the replaceable value
EAP7_HOME to denote the path to the JBoss EAP installation. When you encounter this value in a README file, be sure to replace it 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.
All available quickstarts can be found here: http://www.jboss.org/developer-materials/#!formats=jbossdeveloper_quickstart. You can filter by the quickstart name, the product, and the technologies demonstrated by the quickstart. You can also limit the results based on skill level and date published. The resulting page provides a brief description of each matching quickstart, the skill level, and the technologies used. Click on the quickstart to see more detailed information about how to run it. Some quickstarts require deployment of other quickstarts. This information is noted in the
Prerequisites section of the quickstart README file.
Note: Some of these quickstarts use the H2 database included with JBoss EAP. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment!
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.
The applications these projects produce are designed to be run on Red Hat JBoss Enterprise Application Platform 7 or later.
All you need to build these projects is Java 8.0 (Java SDK 1.8) or later and Maven 3.2.5 or later. See Configure Maven for JBoss EAP 7 to make sure you are configured correctly for testing the quickstarts.
To run these quickstarts with the provided build scripts, you need the JBoss EAP distribution ZIP. For information on how to install and run JBoss, see the Red Hat JBoss Enterprise Application Platform Documentation Getting Started Guide located on the Customer Portal.
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.
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.
- Open a command prompt and navigate to the root directory of the quickstart you want to build.
Use this command if you only want to build the archive, but not deploy it:
mvn clean install
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.
- Make sure you start the JBoss EAP server as described in the quickstart README file.
- Open a command prompt and navigate to the root directory of the quickstart you want to run.
Use this command to build and deploy the archive:
mvn clean install wildfly:deploy
Undeploy an Archive
The command to undeploy the quickstart is simply:
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
resteasy-jaxrs-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:
- Do not start the JBoss EAP server.
- Open a command prompt and navigate to the root directory of the quickstarts.
Use this command to build the quickstarts that do not have complex dependencies:
mvn clean install '-Pdefault,!complex-dependencies'
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:
- Start the JBoss EAP server.
- Open a command prompt and navigate to the root directory of the quickstarts.
Use this command to undeploy any deployed quickstarts:
mvn wildfly:undeploy -fae
To undeploy any quickstarts that fail due to complex dependencies, follow the undeploy procedure described in the quickstart's README file.
Run the Quickstarts in Red Hat JBoss Developer Studio or Eclipse
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.
The following components are needed for only a small subset of the quickstarts. Do not install or configure them unless the quickstart requires it.
Create Users Required by the Quickstarts: Add a Management or Application user for the quickstarts that run in a secured mode.
Configure the PostgreSQL Database for Use with the Quickstarts: The PostgreSQL database is used for the distributed transaction quickstarts.
Configure Byteman for Use with the Quickstarts: This tool is used to demonstrate crash recovery for distributed transaction quickstarts.