Remove getComment and getVersion methods

org.openrewrite.java.migrate.jakarta.ServletCookieBehaviorChangeRFC6265

Jakarta Servlet methods have been deprecated for removal in Jakarta Servlet 6.0 to align with RFC 6265. In addition, the behavior of these methods has been changed so the setters no longer have any effect, the getComment methods return null, and the getVersion method returns 0. The deprecated methods are removed.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe

• artifactId: rewrite-migrate-java

• version: 2.12.0

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.12.0 in your build file or by running a shell command (in which case no build changes are needed):

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

rewrite {
    activeRecipe("org.openrewrite.java.migrate.jakarta.ServletCookieBehaviorChangeRFC6265")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
}

2. Run gradle rewriteRun to run the recipe.

Gradle init script

1. Create a file named init.gradle in the root of your project.

init.gradle

initscript {
    repositories {
        maven { url "https://plugins.gradle.org/m2" }
    }
    dependencies { classpath("org.openrewrite:plugin:6.12.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-migrate-java:2.12.0")
    }
    rewrite {
        activeRecipe("org.openrewrite.java.migrate.jakarta.ServletCookieBehaviorChangeRFC6265")
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

2. Run gradle --init-script init.gradle rewriteRun to run the recipe.

Maven POM

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>org.openrewrite.java.migrate.jakarta.ServletCookieBehaviorChangeRFC6265</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-migrate-java</artifactId>
            <version>2.12.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Maven Command Line

shell

mvn -U org.openrewrite.maven:rewrite-maven-plugin:run -Drewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-migrate-java:RELEASE -Drewrite.activeRecipes=org.openrewrite.java.migrate.jakarta.ServletCookieBehaviorChangeRFC6265

Moderne CLI

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

shell

mod run . --recipe ServletCookieBehaviorChangeRFC6265

Definition

Recipe List

• Remove methods calls

  • methodPattern: jakarta.servlet.http.Cookie getComment()

• Remove methods calls

  • methodPattern: jakarta.servlet.http.Cookie getVersion()

• Remove methods calls

  • methodPattern: jakarta.servlet.http.Cookie setComment(String)

• Remove methods calls

  • methodPattern: jakarta.servlet.http.Cookie setVersion(int)

• Remove methods calls

  • methodPattern: jakarta.servlet.SessionCookieConfig getComment()

• Remove methods calls

  • methodPattern: jakarta.servlet.SessionCookieConfig setComment(String)

Yaml Recipe List

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.ServletCookieBehaviorChangeRFC6265
displayName: Remove `getComment` and `getVersion` methods
description: Jakarta Servlet methods have been deprecated for removal in Jakarta Servlet 6.0 to align with RFC 6265.  In addition, the behavior of these methods has been changed so the setters no longer have any effect, the getComment methods return null, and the getVersion method returns 0. The deprecated methods are removed.

recipeList:
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: jakarta.servlet.http.Cookie getComment()
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: jakarta.servlet.http.Cookie getVersion()
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: jakarta.servlet.http.Cookie setComment(String)
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: jakarta.servlet.http.Cookie setVersion(int)
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: jakarta.servlet.SessionCookieConfig getComment()
  - org.openrewrite.java.migrate.RemoveMethodInvocation:
      methodPattern: jakarta.servlet.SessionCookieConfig setComment(String)

See how this recipe works across multiple open-source repositories

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.

Contributors

Satvika Eda, Sam Snyder, Jonathan Schnéider