apachebase64tojavabase64.md

Prefer java.util.Base64

org.openrewrite.java.migrate.apache.commons.codec.ApacheBase64ToJavaBase64

Prefer the Java standard library's java.util.Base64 over third-party usage of apache's apache.commons.codec.binary.Base64.

Tags

• apache
• commons

Source

GitHub, Issue Tracker, Maven Central

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

Example

{% tabs %} {% tab title="Test.java" %}

Before

{% code title="Test.java" %}

import org.apache.commons.codec.binary.Base64;

class Test {
    static byte[] decodeBytes(byte[] encodedBytes) {
        return Base64.decodeBase64(encodedBytes);
    }
    static byte[] decodeToBytes(String encodedString) {
        return Base64.decodeBase64(encodedString);
    }
    static String encodeToString(byte[] decodedByteArr) {
        return Base64.encodeBase64String(decodedByteArr);
    }
    static byte[] encodeBase64(byte[] binaryData) {
        return Base64.encodeBase64(binaryData);
    }
    static byte[] encodeBytesUrlSafe(byte [] encodeBytes) {
        return Base64.encodeBase64URLSafe(encodeBytes);
    }
    static String encodeBytesUrlSafeString(byte [] encodeBytes) {
        return Base64.encodeBase64URLSafeString(encodeBytes);
    }
}

{% endcode %}

After

{% code title="Test.java" %}

import java.util.Base64;

class Test {
    static byte[] decodeBytes(byte[] encodedBytes) {
        return Base64.getDecoder().decode(encodedBytes);
    }
    static byte[] decodeToBytes(String encodedString) {
        return Base64.getDecoder().decode(encodedString);
    }
    static String encodeToString(byte[] decodedByteArr) {
        return Base64.getEncoder().encodeToString(decodedByteArr);
    }
    static byte[] encodeBase64(byte[] binaryData) {
        return Base64.getEncoder().encode(binaryData);
    }
    static byte[] encodeBytesUrlSafe(byte [] encodeBytes) {
        return Base64.getUrlEncoder().withoutPadding().encode(encodeBytes);
    }
    static String encodeBytesUrlSafeString(byte [] encodeBytes) {
        return Base64.getUrlEncoder().withoutPadding().encodeToString(encodeBytes);
    }
}

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- Test.java
+++ Test.java
@@ -1,1 +1,1 @@
-import org.apache.commons.codec.binary.Base64;
+import java.util.Base64;

@@ -5,1 +5,1 @@
class Test {
    static byte[] decodeBytes(byte[] encodedBytes) {
-       return Base64.decodeBase64(encodedBytes);
+       return Base64.getDecoder().decode(encodedBytes);
    }
@@ -8,1 +8,1 @@
    }
    static byte[] decodeToBytes(String encodedString) {
-       return Base64.decodeBase64(encodedString);
+       return Base64.getDecoder().decode(encodedString);
    }
@@ -11,1 +11,1 @@
    }
    static String encodeToString(byte[] decodedByteArr) {
-       return Base64.encodeBase64String(decodedByteArr);
+       return Base64.getEncoder().encodeToString(decodedByteArr);
    }
@@ -14,1 +14,1 @@
    }
    static byte[] encodeBase64(byte[] binaryData) {
-       return Base64.encodeBase64(binaryData);
+       return Base64.getEncoder().encode(binaryData);
    }
@@ -17,1 +17,1 @@
    }
    static byte[] encodeBytesUrlSafe(byte [] encodeBytes) {
-       return Base64.encodeBase64URLSafe(encodeBytes);
+       return Base64.getUrlEncoder().withoutPadding().encode(encodeBytes);
    }
@@ -20,1 +20,1 @@
    }
    static String encodeBytesUrlSafeString(byte [] encodeBytes) {
-       return Base64.encodeBase64URLSafeString(encodeBytes);
+       return Base64.getUrlEncoder().withoutPadding().encodeToString(encodeBytes);
    }

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

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.apache.commons.codec.ApacheBase64ToJavaBase64")
}

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.apache.commons.codec.ApacheBase64ToJavaBase64</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.apache.commons.codec.ApacheBase64ToJavaBase64

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

Contributors

• Patrick
• Tyler Van Gorder
• Sam Snyder
• Jonathan Schnéider
• Knut Wannheden

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.