Skip to main content

Create Jetty server source file

io.moderne.java.server.jboss.jetty.CreateJettySourceFile

Creates a JettyServer.java source file for projects containing JBoss descriptor files.

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.jetty
StringcontextPathOptional. The context path for the Jetty application./myapp
IntegerportOptional. The default port for the Jetty 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.eclipse.jetty.ee10.webapp.WebAppContext;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.util.resource.ResourceFactory;
import org.eclipse.jetty.xml.XmlConfiguration;

import java.net.URL;
import java.nio.file.Path;

public class JettyServer {

    private static final int DEFAULT_PORT = 9090;
    private static final String CONTEXT_PATH = "/myapp";
    private static final String WEBAPP_DIR = "src/main/webapp";

    public static void main(String[] args) throws Exception {
        Server server = new Server(DEFAULT_PORT);
        WebAppContext webapp = new WebAppContext();

        webapp.setContextPath(CONTEXT_PATH);
        webapp.setBaseResourceAsPath(Path.of(WEBAPP_DIR));
        webapp.setParentLoaderPriority(true);

        URL jettyEnvUrl = JettyServer.class.getClassLoader().getResource("jetty-env.xml");
        if (jettyEnvUrl != null) {
            XmlConfiguration config = new XmlConfiguration(ResourceFactory.root().newResource(jettyEnvUrl.toURI()));
            config.configure(webapp);
        }

        server.setHandler(webapp);
        server.start();
        server.join();
    }
}
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.CreateJettySourceFileExample
displayName: Create Jetty server source file example
recipeList:
  - io.moderne.java.server.jboss.jetty.CreateJettySourceFile:
      packageName: com.example.jetty
      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 CreateJettySourceFile --recipe-option "packageName=com.example.jetty" --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.0.1

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.