javaloggingapis.md

Use modernized java.util.logging APIs

org.openrewrite.java.migrate.logging.JavaLoggingAPIs

Certain Java logging APIs have become deprecated and their usages changed, necessitating usage changes.

Tags

• logging

Source

GitHub, Issue Tracker, Maven Central

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

Examples

Example 1

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

Before

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

import java.util.logging.LoggingMXBean;

class Test {
    static void method() {
        LoggingMXBean loggingBean = null;
    }
}

{% endcode %}

After

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

import java.lang.management.PlatformLoggingMXBean;

class Test {
    static void method() {
        PlatformLoggingMXBean loggingBean = null;
    }
}

{% endcode %}

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

--- Test.java
+++ Test.java
@@ -1,1 +1,1 @@
-import java.util.logging.LoggingMXBean;
+import java.lang.management.PlatformLoggingMXBean;

@@ -5,1 +5,1 @@
class Test {
    static void method() {
-       LoggingMXBean loggingBean = null;
+       PlatformLoggingMXBean loggingBean = null;
    }

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

---

Example 2

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

Before

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

import java.util.logging.LoggingMXBean;

class Test {
    static void method() {
        LoggingMXBean loggingBean = null;
    }
}

{% endcode %}

After

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

import java.lang.management.PlatformLoggingMXBean;

class Test {
    static void method() {
        PlatformLoggingMXBean loggingBean = null;
    }
}

{% endcode %}

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

--- Test.java
+++ Test.java
@@ -1,1 +1,1 @@
-import java.util.logging.LoggingMXBean;
+import java.lang.management.PlatformLoggingMXBean;

@@ -5,1 +5,1 @@
class Test {
    static void method() {
-       LoggingMXBean loggingBean = null;
+       PlatformLoggingMXBean loggingBean = null;
    }

{% 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.logging.JavaLoggingAPIs")
}

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.logging.JavaLoggingAPIs</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.logging.JavaLoggingAPIs

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

Definition

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

• Use ManagementFactory#getPlatformMXBean(PlatformLoggingMXBean.class)
• Use Logger#getGlobal()
• Use Logger#logrb(.., ResourceBundle bundleName, ..)
• Use LogRecord#setInstant(Instant)
• Use java.lang.management.PlatformLoggingMXBean

{% endtab %}

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

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.logging.JavaLoggingAPIs
displayName: Use modernized `java.util.logging` APIs
description: Certain Java logging APIs have become deprecated and their usages changed, necessitating usage changes.
tags:
  - logging
recipeList:
  - org.openrewrite.java.migrate.logging.MigrateGetLoggingMXBeanToGetPlatformMXBean
  - org.openrewrite.java.migrate.logging.MigrateLoggerGlobalToGetGlobal
  - org.openrewrite.java.migrate.logging.MigrateLoggerLogrbToUseResourceBundle
  - org.openrewrite.java.migrate.logging.MigrateLogRecordSetMillisToSetInstant
  - org.openrewrite.java.migrate.logging.MigrateInterfaceLoggingMXBeanToPlatformLoggingMXBean

{% endtab %} {% endtabs %}

Contributors

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

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.