Red Hat JBoss Enterprise Application Platform (JBoss EAP) Quickstarts

Table of Contents

1. Introduction
2. System Requirements
3. Use of EAP_HOME and QUICKSTART_HOME Variables
4. Suggested Approach to the Quickstarts
5. Table of Available Quickstarts

The quickstarts demonstrate Jakarta EE 10 and a few additional technologies from the Red Hat JBoss Enterprise Application Platform stack. They provide small, specific, working examples that can be used as a reference for your own project.

1. Introduction

These quickstarts run on Red Hat JBoss Enterprise Application Platform 8.0.

We recommend that you use the Red Hat JBoss Enterprise Application Platform 8.0 Quickstarts ZIP file, which you can download from the JBoss EAP Software Download page on the Red Hat Customer Portal. This version of the quickstarts uses the correct dependencies and ensures that you test and compile against the correct server runtime environment.

Each quickstart folder contains a README.adoc file that describes the quickstart features and provides instructions about how to build and run it.

Make sure you read this entire document before you attempt to work with the quickstarts.

2. System Requirements

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

All you need to build these projects is Java 11.0 (Java SDK 11) or later and Maven 3.6.0 or later.

3. Use of EAP_HOME and QUICKSTART_HOME Variables

The quickstart README files use the replaceable value EAP_HOME to denote the path to the JBoss EAP installation. When you encounter this value in a README file, make sure you replace it 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

When you see the replaceable variable QUICKSTART_HOME, replace it with the path to the root directory of all of the quickstarts.

4. 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 the server is configured and running 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, make sure you deploy and test it before looking at the expanded version.

5. Table of Available Quickstarts

The sources for all available quickstarts, which are listed in the following table, can be found here: https://github.com/jboss-developer/jboss-eap-quickstarts/.

Each quickstart provides the list of technologies demonstrated by the quickstart and the required experience level needed to build and deploy it. Click on the quickstart link in the table 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.html file.

Note	Some of these quickstarts use the H2 database included with Red Hat JBoss Enterprise Application Platform 8.0. 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!

Quickstart Name	Demonstrated Technologies	Description	Experience Level Required	Prerequisites
cmt	EJB, CMT, JMS	The `cmt` quickstart demonstrates Container-Managed Transactions (CMT), showing how to use transactions managed by the container.	Intermediate	none
ee-security	EE Security, Servlet, CDI	The `ee-security` quickstart demonstrates Jakarta EE security.	Intermediate	none
helloworld	Servlet	The `helloworld` quickstart demonstrates the use of Servlet 6 and is a good starting point to verify JBoss EAP is configured correctly.	Beginner	none
helloworld-ws	JAX-WS	The `helloworld-ws` quickstart demonstrates a simple Hello World application, bundled and deployed as a WAR, that uses JAX-WS to say Hello.	Beginner	none
jaxrs-client	JAX-RS	The `jaxrs-client` quickstart demonstrates JAX-RS Client API, which interacts with a JAX-RS Web service that runs on JBoss EAP.	Beginner	none
kitchensink	CDI, JSF, JPA, EJB, JAX-RS, BV	The `kitchensink` quickstart demonstrates a Jakarta EE 10 web-enabled database application using JSF, CDI, EJB, JPA, and Bean Validation.	Intermediate	none
numberguess	CDI, JSF	The `numberguess` quickstart demonstrates the use of CDI (Contexts and Dependency Injection) and JSF (JavaServer Faces) in JBoss EAP.	Beginner	none
remote-helloworld-mdb	JMS, EJB, MDB	The `remote-helloworld-mdb` quickstart demonstrates the use of JMS and EJB Message-Driven Bean in JBoss EAP with a remote broker.	Intermediate	none
servlet-security	Servlet, Security	The `servlet-security` quickstart demonstrates the use of Jakarta EE declarative security to control access to Servlets and Security in JBoss EAP.	Intermediate	none
temperature-converter	CDI, JSF, SLSB EJB	The `temperature-converter` quickstart does temperature conversion using an EJB Stateless Session Bean (SLSB), CDI, and a JSF front-end client.	Beginner	none
thread-racing	Batch, CDI, EE Concurrency, JAX-RS, JMS, JPA, JSON, Web Sockets	A thread racing web application that demonstrates technologies introduced or updated in the latest Jakarta EE specification.	Beginner	none
todo-backend	JPA, JAX-RS, OpenShift, Galleon	The `todo-backend` quickstart demonstrates how to implement a backend that exposes a HTTP API with JAX-RS	Intermediate	none
websocket-hello	WebSocket, CDI, JSF	The `websocket-hello` quickstart demonstrates how to create a simple WebSocket application.	Beginner	none