Skip to main content

Migrate JBoss to Tomcat

io.moderne.java.server.jboss.tomcat.CreateTomcatFilesInPath

Comprehensive migration from JBoss to Tomcat.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringpackageNameThe package name for the generated Java source files.com.example.tomcat
StringcontextPathOptional. The context path for the Tomcat application./myapp
IntegerportOptional. The default port for the Tomcat server.8080

Used by​

This recipe is used as part of the following composite recipes:

Example​

Parameters​
ParameterValue
packageNamecom.example
contextPath/myapp
port9090
New file​
package com.example;

import org.apache.catalina.Context;
import org.apache.catalina.WebResourceRoot;
import org.apache.catalina.startup.Tomcat;
import org.apache.catalina.webresources.DirResourceSet;
import org.apache.catalina.webresources.JarResourceSet;
import org.apache.catalina.webresources.StandardRoot;

import java.io.File;
import java.net.URL;

public class TomcatServer {

    private static final int DEFAULT_PORT = 9090;
    private static final String CONTEXT_PATH = "/myapp";

    public static void main(String[] args) throws Exception {
        Tomcat tomcat = new Tomcat();
        tomcat.setPort(DEFAULT_PORT);
        tomcat.getConnector();

        File baseDir = new File(System.getProperty("java.io.tmpdir"), "tomcat-" + DEFAULT_PORT);
        baseDir.mkdirs();
        tomcat.setBaseDir(baseDir.getAbsolutePath());

        URL resource = TomcatServer.class.getClassLoader().getResource("webapp");
        if (resource == null) {
            throw new IllegalStateException("webapp directory not found on classpath");
        }

        File docBase = new File(baseDir, "docBase");
        docBase.mkdirs();
        Context ctx = tomcat.addWebapp(CONTEXT_PATH, docBase.getAbsolutePath());

        WebResourceRoot resources = new StandardRoot(ctx);
        if ("file".equals(resource.getProtocol())) {
            resources.addPreResources(new DirResourceSet(resources, "/",
                    new File(resource.toURI()).getAbsolutePath(), "/"));
        } else {
            String jarPath = resource.getPath();
            jarPath = jarPath.substring(jarPath.indexOf(":") + 1, jarPath.indexOf("!"));
            resources.addPreResources(new JarResourceSet(resources, "/", jarPath, "/webapp"));
        }
        ctx.setResources(resources);

        tomcat.start();
        tomcat.getServer().await();
    }
}
New file​
<?xml version="1.0" encoding="UTF-8"?>
<Context>
</Context>
Unchanged​
<?xml version="1.0" encoding="UTF-8"?>
<jboss-web>
    <context-root>/myapp</context-root>
</jboss-web>

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.CreateTomcatFilesInPathExample
displayName: Migrate JBoss to Tomcat example
recipeList:
  - io.moderne.java.server.jboss.tomcat.CreateTomcatFilesInPath:
      packageName: com.example.tomcat
      contextPath: /myapp
      port: 8080

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe CreateTomcatFilesInPath --recipe-option "packageName=com.example.tomcat" --recipe-option "contextPath=/myapp" --recipe-option "port=8080"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install io.moderne.recipe:rewrite-java-application-server:0.5.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.