Moderne licensed

Relocate Spring Boot web server classes to their Spring Boot 4.0 packages

Recipe IDorg.openrewrite.java.spring.boot4.RelocateWebServerClassesArtifactorg.openrewrite.recipe:rewrite-spring

Spring Boot 4.0 relocated the embedded web server (Tomcat, Jetty) and web server application context classes into dedicated modular packages. This recipe updates references to the relocated classes' new fully-qualified names, including the servlet and reactive WebServerFactory variants, which moved into servlet and reactive subpackages. Undertow support was removed in Spring Boot 4.0 and is intentionally not handled here.

Composite recipespringbootMSAL

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.java.spring.boot4.RelocateWebServerClasses")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:6.40.0")
}

Then run

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.spring.boot4.RelocateWebServerClasses

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:RELEASE

Definition

This recipe runs the following recipes in order.

Change type org.springframework.boot.web.embedded.tomcat.CompressionConnectorCustomizer to org.springframework.boot.tomcat.CompressionConnectorCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.ConfigurableTomcatWebServerFactory to org.springframework.boot.tomcat.ConfigurableTomcatWebServerFactoryorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.ConnectorStartFailedException to org.springframework.boot.tomcat.ConnectorStartFailedExceptionorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.ConnectorStartFailureAnalyzer to org.springframework.boot.tomcat.ConnectorStartFailureAnalyzerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.DisableReferenceClearingContextCustomizer to org.springframework.boot.tomcat.DisableReferenceClearingContextCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.LazySessionIdGenerator to org.springframework.boot.tomcat.LazySessionIdGeneratororg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.SslConnectorCustomizer to org.springframework.boot.tomcat.SslConnectorCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatConnectorCustomizer to org.springframework.boot.tomcat.TomcatConnectorCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatContextCustomizer to org.springframework.boot.tomcat.TomcatContextCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatEmbeddedContext to org.springframework.boot.tomcat.TomcatEmbeddedContextorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatEmbeddedWebappClassLoader to org.springframework.boot.tomcat.TomcatEmbeddedWebappClassLoaderorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatProtocolHandlerCustomizer to org.springframework.boot.tomcat.TomcatProtocolHandlerCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatWebServer to org.springframework.boot.tomcat.TomcatWebServerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory to org.springframework.boot.tomcat.servlet.TomcatServletWebServerFactoryorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.tomcat.TomcatReactiveWebServerFactory to org.springframework.boot.tomcat.reactive.TomcatReactiveWebServerFactoryorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.jetty.ConfigurableJettyWebServerFactory to org.springframework.boot.jetty.ConfigurableJettyWebServerFactoryorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.jetty.ForwardHeadersCustomizer to org.springframework.boot.jetty.ForwardHeadersCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.jetty.JettyServerCustomizer to org.springframework.boot.jetty.JettyServerCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.jetty.JettyWebServer to org.springframework.boot.jetty.JettyWebServerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.jetty.SslServerCustomizer to org.springframework.boot.jetty.SslServerCustomizerorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory to org.springframework.boot.jetty.servlet.JettyServletWebServerFactoryorg.openrewrite.java.ChangeType
Change type org.springframework.boot.web.embedded.jetty.JettyReactiveWebServerFactory to org.springframework.boot.jetty.reactive.JettyReactiveWebServerFactoryorg.openrewrite.java.ChangeType
Rename package name org.springframework.boot.web.servlet.context to org.springframework.boot.web.server.servlet.contextorg.openrewrite.java.ChangePackage
Rename package name org.springframework.boot.web.reactive.context to org.springframework.boot.web.server.reactive.contextorg.openrewrite.java.ChangePackage

Data tables

Structured output this recipe can produce.

Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats