javaxauthenticationmigrationtojakartaauthentication.md

Migrate deprecated javax.security.auth.message packages to jakarta.security.auth.message

org.openrewrite.java.migrate.jakarta.JavaxAuthenticationMigrationToJakartaAuthentication

Java EE has been rebranded to Jakarta EE, necessitating a package relocation.

Tags

• security
• javax
• jakarta
• authentication

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite.recipe
• artifactId: rewrite-migrate-java
• version: 2.0.1

Usage

This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-migrate-java:2.0.1 in your build file or by running a shell command (in which case no build changes are needed): {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

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

repositories {
    mavenCentral()
}

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

{% endcode %} {% endtab %} {% tab title="Maven POM" %} {% code title="pom.xml" %}

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

{% endcode %} {% endtab %}

{% tab title="Maven Command Line" %} {% code title="shell" %} You will need to have Maven installed on your machine before you can run the following command.

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.JavaxAuthenticationMigrationToJakartaAuthentication

{% endcode %} {% endtab %} {% endtabs %}

Definition

{% tabs %} {% tab title="Recipe List" %}

• Add Gradle or Maven dependency
  • groupId: jakarta.authentication
  • artifactId: jakarta.authentication-api
  • version: latest.release
  • onlyIfUsing: javax.security.auth.message..*
  • acceptTransitive: true
• Add Gradle or Maven dependency
  • groupId: jakarta.authentication
  • artifactId: jakarta.authentication-api
  • version: latest.release
  • onlyIfUsing: javax.authentication.*
  • acceptTransitive: true
• Upgrade Gradle or Maven dependency versions
  • groupId: jakarta.authentication
  • artifactId: jakarta.authentication-api
  • newVersion: latest.release
• Rename package name
  • oldPackageName: javax.security.auth.message
  • newPackageName: jakarta.security.auth.message
  • recursive: true
• Remove a Gradle or Maven dependency
  • groupId: javax.security.auth.message
  • artifactId: javax.security.auth.message-api

{% endtab %}

{% tab title="Yaml Recipe List" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.JavaxAuthenticationMigrationToJakartaAuthentication
displayName: Migrate deprecated `javax.security.auth.message` packages to `jakarta.security.auth.message`
description: Java EE has been rebranded to Jakarta EE, necessitating a package relocation.
tags:
  - security
  - javax
  - jakarta
  - authentication
recipeList:
  - org.openrewrite.java.dependencies.AddDependency:
      groupId: jakarta.authentication
      artifactId: jakarta.authentication-api
      version: latest.release
      onlyIfUsing: javax.security.auth.message..*
      acceptTransitive: true
  - org.openrewrite.java.dependencies.AddDependency:
      groupId: jakarta.authentication
      artifactId: jakarta.authentication-api
      version: latest.release
      onlyIfUsing: javax.authentication.*
      acceptTransitive: true
  - org.openrewrite.java.dependencies.UpgradeDependencyVersion:
      groupId: jakarta.authentication
      artifactId: jakarta.authentication-api
      newVersion: latest.release
  - org.openrewrite.java.ChangePackage:
      oldPackageName: javax.security.auth.message
      newPackageName: jakarta.security.auth.message
      recursive: true
  - org.openrewrite.java.dependencies.RemoveDependency:
      groupId: javax.security.auth.message
      artifactId: javax.security.auth.message-api

{% endtab %} {% endtabs %}

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.