Apache Tomcat migration tool for Jakarta EE

Clone this repo:
  1. 9ad4d7b Improve logging to avoid confusing users on what is really happening by remm · 3 weeks ago master
  2. a96fe39 Better wording by remm · 3 weeks ago
  3. 1a7ff40 Refactor for duplication by remm · 3 weeks ago
  4. 1e14545 Improve on the load check by remm · 4 weeks ago
  5. b89a835 Validate changes by the class transformer by remm · 4 weeks ago

Apache Tomcat migration tool for Jakarta EE

Build Status Coverage Status License

Overview

This tool is a work in progress.

The aim of the tool is to take a web application written for Java EE 8 that runs on Apache Tomcat 9 and convert it automatically so it runs on Apache Tomcat 10 which implements Jakarta EE 9.

The tool can be used from the command line or as an Ant task.

Usage

Download

Download a source or binary distribution from https://tomcat.apache.org/download-migration.cgi

Build

Build the migration tool from source with:

./mvnw verify

To run the migration tool locally, you are most likely to want:

target/jakartaee-migration-*-shaded.jar

Migrate

Migrate your Servlet application with:

java -jar jakartaee-migration-*-shaded.jar <source> <destination>

The source should be a path to a compressed archive, a folder or an individual file. The destination will be created at the specified path as a resource of the same type as the source.

INFO This tool will remove cryptographic signatures from JAR files contained in the source, as the changed resources would not match them anymore.

A warning will be logged for each JAR file where the signature has been removed.

This tool is also available on Debian and Ubuntu systems by installing the tomcat-jakartaee-migration package and invoking the javax2jakarta command.

Ant task

The migration tool is available as an Ant task, here is an example:

<taskdef name="javax2jakarta" classname="org.apache.tomcat.jakartaee.MigrationTask" classpath="jakartaee-migration-*-shaded.jar"/>

<javax2jakarta src="webapp.war" dest="webapp.migrated.war" profile="tomcat"/>

Differences between Java EE 8 and Jakarta EE 9

The difference between Java EE 8 and Jakarta EE 9 is that all the Java EE 8 packages in the javax.* namespace have moved to the jakarta.* namespace. Some sub-packages have also been renamed. This migration tool performs all the necessary changes to migrate an application from Java EE 8 to Jakarta EE 9 by renaming each Java EE 8 package to its Jakarta EE 9 replacement.

Note: Not all javax.* packages are part of Java EE. Only those defined by Java EE have moved to the jakarta.* namespace.

Note: It is not necessary to migrate any references to XML schemas. The schemas don't directly reference javax packages and Jakarta EE 9 will continue to support the use of schemas from Java EE 8 and earlier.