The quickstarts demonstrate Jakarta EE 10 and a few additional technologies from the WildFly Application Server stack. They provide small, specific, working examples that can be used as a reference for your own project.
These quickstarts run on the WildFly application server. The quickstarts are configured to use the correct Maven dependencies and ensure that you test and compile the quickstarts against the correct runtime environment.
Each quickstart folder contains a README-source.adoc
file that describes the quickstart features and provides instructions about how to build and run it. Instructions are provided to build the more readable README.html
files.
Make sure you read this entire document before you attempt to work with the quickstarts.
The applications these projects produce are designed to be run on WildFly Application Server 34 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.
The quickstart README
files use the replaceable value WILDFLY_HOME
to denote the path to the WildFly server. When you encounter this value in a README
file, make sure you replace it with the actual path to your WildFly server.
When you see the replaceable variable QUICKSTART_HOME, replace it with the path to the root directory of all of the quickstarts.
We recommend that 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 asIntermediate
. When you are comfortable with those, move on to theAdvanced
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.
The root folder of each individual quickstart contains a README.html
file with detailed instructions on how to build and run the example.
The sources for all available quickstarts, which are listed in the following table, can be found here: https://github.com/wildfly/quickstart/.
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 WildFly Application Server 34. 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 | Openshift Compatible | Description | Experience Level Required | Prerequisites |
---|---|---|---|---|---|
CDI, Batch 1.0, JSF |
Yes |
The |
Intermediate |
none |
|
EJB, BMT |
Yes |
The |
Intermediate |
none |
|
EJB, CMT, JMS |
Yes |
The |
Intermediate |
none |
|
EE Security, Servlet, CDI |
Yes |
The |
Intermediate |
none |
|
EJB, EAR |
No |
The |
Advanced |
none |
|
EJB, JNDI |
Yes |
The |
Intermediate |
none |
|
EJB, Security |
No |
The |
Advanced |
none |
|
EJB, Security |
No |
The |
Intermediate |
none |
|
EJB, EAR |
No |
The |
Intermediate |
none |
|
EJB Timer |
Yes |
The |
Beginner |
none |
|
EJB, JTA, Clustering |
Yes |
The |
Intermediate |
none |
|
EJB, Singleton Deployments, Clustering |
No |
The |
Advanced |
none |
|
JBoss MSC, Singleton Service, Clustering |
No |
The |
Advanced |
none |
|
Servlet |
Yes |
The |
Beginner |
none |
|
JMS |
No |
The |
Intermediate |
none |
|
JMS, EJB, MDB |
Yes |
The |
Intermediate |
none |
|
Mutual TLS, Undertow |
No |
The |
Intermediate |
none |
|
Mutual TLS, Security, Undertow |
No |
The |
Intermediate |
none |
|
EJB, Singleton |
Yes |
The |
Beginner |
none |
|
JAX-WS |
Yes |
The |
Beginner |
none |
|
Hibernate |
Yes |
The |
Intermediate |
none |
|
EJB, Security |
No |
The |
Intermediate |
none |
|
JAX-RS |
Yes |
The |
Beginner |
none |
|
JAX-RS, Security |
Yes |
The |
Intermediate |
none |
|
JAX-WS |
Yes |
The |
Beginner |
none |
|
JAX-WS |
Yes |
The |
Beginner |
none |
|
CDI, JSF, JSON-P |
Yes |
The |
Beginner |
none |
|
JTA, Crash Recovery |
No |
The |
Advanced |
none |
|
JTS, EJB, JMS |
No |
The |
Intermediate |
||
CDI, JSF, JPA, EJB, JAX-RS, BV |
Yes |
The |
Intermediate |
none |
|
Logging |
Yes |
The |
Intermediate |
none |
|
JavaMail, CDI, JSF |
No |
The |
Beginner |
none |
|
JMS, MDB, Clustering |
No |
The |
Advanced |
none |
|
Micrometer |
Yes |
The |
Beginner |
none |
|
MicroProfile Config |
Yes |
The |
Beginner |
none |
|
MicroProfile, Fault Tolerance |
Yes |
The |
Intermediate |
none |
|
MicroProfile Health |
Yes |
The |
Beginner |
none |
|
JWT, Security, MicroProfile |
Yes |
The |
Intermediate |
none |
|
MicroProfile LRA |
Yes |
The |
Beginner |
none |
|
MicroProfile OpenAPI |
Yes |
This guide demonstrate how to use the MicroProfile OpenAPI functionality in WildFly to expose an OpenAPI document for a simple REST application. |
Beginner |
none |
|
MicroProfile Reactive Messaging |
Yes |
The |
Beginner |
none |
|
MicroProfile REST Client |
Yes |
The |
Beginner |
none |
|
CDI, JSF |
Yes |
The |
Beginner |
none |
|
OpenTelemetry Tracing |
Yes |
The |
Beginner |
none |
|
JMS, EJB, MDB |
Yes |
The |
Intermediate |
none |
|
Servlet, EJB, Security |
No |
The |
Advanced |
none |
|
Asynchronous Servlet, CDI, EJB |
Yes |
The |
Intermediate |
none |
|
Servlet Filter, Servlet Listener |
Yes |
The |
Intermediate |
none |
|
Servlet, Security |
Yes |
The |
Intermediate |
none |
|
Resteasy, Spring |
Yes |
The |
Beginner |
none |
|
JSF, JPA |
Yes |
The |
Intermediate |
none |
|
CDI, JSF, SLSB EJB |
Yes |
The |
Beginner |
none |
|
Batch, CDI, EE Concurrency, JAX-RS, JMS, JPA, JSON, Web Sockets |
Yes |
A thread racing web application that demonstrates technologies introduced or updated in the latest Jakarta EE specification. |
Beginner |
none |
|
JPA, JAX-RS, OpenShift, Galleon |
Yes |
The |
Intermediate |
none |
|
CDI, WebSocket, JSON-P |
Yes |
Shows how to use WebSockets with JSON to broadcast information to all open WebSocket sessions in WildFly. |
Beginner |
none |
|
WebSocket, CDI, JSF |
Yes |
The |
Beginner |
none |