jakartaee9-servlet-starter-boilerplate

Yeah, this is another starter boilerplate project for Jakarta EE (esp. Servlet/Java Web) developers.

This repository is a lightweight variant of the original Jakarta EE 9 starter boilerplate, which allows you to run applications on a Servlet 5.0 compatible container, such as Apache Tomcat, Eclipse Jetty, WildFly Undertow.

The following features have been added:

• Jakarta REST 3.0(Jersey 3.0)
• CDI 3.0 (Weld 4.0)
• Jakarta Server Faces 3.0(Mojarra 3.0)
• And transitive dependencies of the above features, including Jakarta EL, Jakarta JSON Processing, Jakarta JSON Binding, Jakarta Validation(Hibernate Validator), etc.

Nowadays, the most popular Servlet containers, such as Apache Tomcat and Eclipse Jetty, have built-in support for Jakarta Servlet, Jakarta Server Pages (JSP), JSTL, Jakarta Expression Language (EL), and Jakarta WebSocket.

Note

For full-fledged features support of Jakarta EE 9, please go to hantsy/jakartaee9-starter-boilerplate.

Build

Prerequisites

Assume you have installed the following essential software:

• JDK 17 or JDK 21
• The latest Apache Maven

Apache Tomcat 10

Run the following command to run the application on Tomcat 10.

mvn clean package cargo:run

Eclipse Jetty 11

The new jetty-maven-plugin reorganizes the former run-fork goal and provides three modes for running a Jetty server.

• EMBEDDED
• FORKED
• EXTERNAL

The default mode is EMBEDDED, similar to the simplest jetty:run goal in the previous version.

The FORKED mode uses a forked thread to run the application.

The EXTERNAL mode runs the application on an external Jetty server.

This sample project provides configurations for EMBEDED and EXTERNAL modes.

There is a jetty-embed profile for EMBEDED mode and a jetty-external profile for EXTERNAL mode.

To run the application in EMBEDED mode, run the following command.

mvn clean jetty:run -Pjetty-embed

To run the application on EXTERNAL mode, firstly download a copy of the latest Eclipse Jetty 11 and set an environment variable JETTY_HOME to the location of the Jetty distribution.

Then run the following command.

mvn clean jetty:run -Pjetty-external

Testing

The testing code is written with JUnit and Arquillian.

Run the following command to execute tests against a Tomcat 10 Embedded adapter.

mvn clean verify -Parq-tomcat-embedded

Alternatively, you can just run the following command to execute tests against a Jetty 11 Embedded adapter.

mvn clean verify -Parq-jetty-embedded

There is another arq-weld Maven profile that allows you to run tests on a Weld embedded adapter.

mvn clean verify -Parq-weld

Note

The arq-weld is only used to test CDI components.

Resources

• How to install CDI in Tomcat?
• Happy Jakarta EE 9 with Jersey 3.0.0
• Apache Tomcat 10 Documentation
• Weld Reference Documentation#Servlet containers (such as Tomcat or Jetty)
• Eclipse Jetty: Operations Guide
• Eclipse Jetty: Programming Guide