Use WebServerFactoryCustomizer
org.openrewrite.java.spring.boot2.MigrateToWebServerFactoryCustomizer
Use
WebServerFactoryCustomizer instead of the deprecated EmbeddedServletContainerCustomizer in Spring Boot 2.0 or higher. This recipe will replace look for any classes that implement EmbeddedServletContainerCustomizer and change the interface to WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>. This recipe also adjusts the types used in the customize() method from *EmbeddedServletContainerFactory to their *ServletWebServerFactory counterparts.- groupId: org.openrewrite.recipe
- artifactId: rewrite-spring
- version: 5.0.10
This recipe has no required configuration options. It can be activated by adding a dependency on
org.openrewrite.recipe:rewrite-spring:5.0.10 in your build file or by running a shell command (in which case no build changes are needed):Gradle
Gradle init script
Maven POM
Maven Command Line
- 1.Add the following to your
build.gradlefile:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.3.11")
}
rewrite {
activeRecipe("org.openrewrite.java.spring.boot2.MigrateToWebServerFactoryCustomizer")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-spring:5.0.10")
}
- 2.Run
gradle rewriteRunto run the recipe.
- 1.Create a file named
init.gradlein the root of your project.
init.gradle
initscript {
repositories {
maven { url "https://plugins.gradle.org/m2" }
}
dependencies { classpath("org.openrewrite:plugin:6.3.11") }
}
rootProject {
plugins.apply(org.openrewrite.gradle.RewritePlugin)
dependencies {
rewrite("org.openrewrite.recipe:rewrite-spring:5.0.10")
}
rewrite {
activeRecipe("org.openrewrite.java.spring.boot2.MigrateToWebServerFactoryCustomizer")
}
afterEvaluate {
if (repositories.isEmpty()) {
repositories {
mavenCentral()
}
}
}
}
- 2.Run
gradle --init-script init.gradle rewriteRunto run the recipe.
- 1.Add the following to your
pom.xmlfile:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.5.2</version>
<configuration>
<activeRecipes>
<recipe>org.openrewrite.java.spring.boot2.MigrateToWebServerFactoryCustomizer</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-spring</artifactId>
<version>5.0.10</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
- 2.Run
mvn rewrite:runto run the recipe.
shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run \
-Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-spring:RELEASE \
-Drewrite.activeRecipes=org.openrewrite.java.spring.boot2.MigrateToWebServerFactoryCustomizer
Recipe List
Yaml Recipe List
- oldFullyQualifiedTypeName:
org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer - newFullyQualifiedTypeName:
org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory
- oldFullyQualifiedTypeName:
org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory - newFullyQualifiedTypeName:
org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
- oldFullyQualifiedTypeName:
org.springframework.boot.context.embedded.jetty.JettyEmbeddedServletContainerFactory - newFullyQualifiedTypeName:
org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory
- oldFullyQualifiedTypeName:
org.springframework.boot.context.embedded.undertow.UnderTowEmbeddedServletContainerFactory - newFullyQualifiedTypeName:
org.springframework.boot.web.embedded.undertow.UnderTowServletWebServerFactory
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.spring.boot2.MigrateToWebServerFactoryCustomizer
displayName: Use `WebServerFactoryCustomizer`
description: Use `WebServerFactoryCustomizer` instead of the deprecated `EmbeddedServletContainerCustomizer` in Spring Boot 2.0 or higher. This recipe will replace look for any classes that implement `EmbeddedServletContainerCustomizer` and change the interface to `WebServerFactoryCustomizer<ConfigurableServletWebServerFactory>`. This recipe also adjusts the types used in the `customize()` method from `*EmbeddedServletContainerFactory` to their `*ServletWebServerFactory` counterparts.
recipeList:
- org.openrewrite.java.spring.boot2.ChangeEmbeddedServletContainerCustomizer
- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainer
newFullyQualifiedTypeName: org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory
- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainerFactory
newFullyQualifiedTypeName: org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory
- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: org.springframework.boot.context.embedded.jetty.JettyEmbeddedServletContainerFactory
newFullyQualifiedTypeName: org.springframework.boot.web.embedded.jetty.JettyServletWebServerFactory
- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: org.springframework.boot.context.embedded.undertow.UnderTowEmbeddedServletContainerFactory
newFullyQualifiedTypeName: org.springframework.boot.web.embedded.undertow.UnderTowServletWebServerFactory
- Tyler Van Gorder
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.