Convert Log4j 1.x MDC.getContext() to getCopyOfContextMap()
org.openrewrite.java.logging.slf4j.Log4j1MdcGetContextToCopyOfContextMapArtifactorg.openrewrite.recipe:rewrite-logging-frameworksRenames Log4j 1.x org.apache.log4j.MDC.getContext() (returns Hashtable) to getCopyOfContextMap() (returns Map) at every call site, and retypes any Hashtable declaration — local variable, field, method parameter, or method return type — that receives the result, whether initialized directly from the call, directly assigned it in a later statement, or returning it, to Map<String, String>, since Map is not assignable to Hashtable. Retyping a parameter or return type changes the method's signature; overriding methods are left unchanged to avoid breaking the override, so they need a manual fix. Does not change the org.apache.log4j.MDC type; compose with a ChangeType to complete the migration.
Add to your build
~/.gradle/gradle.properties
codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN
build.gradle.kts
plugins {
id("org.openrewrite.rewrite") version("latest.release")
}
rewrite {
activeRecipe("org.openrewrite.java.logging.slf4j.Log4j1MdcGetContextToCopyOfContextMap")
}
repositories {
mavenCentral()
maven {
url = uri("https://artifacts.codegenomeproject.org/maven")
credentials {
username = providers.gradleProperty("codeGenomeUsername").get()
password = providers.gradleProperty("codeGenomeToken").get()
}
}
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-logging-frameworks:3.34.0")
}
Then run
./gradlew rewriteRunUsage
This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.logging.slf4j.Log4j1MdcGetContextToCopyOfContextMapIf the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite.recipe:rewrite-logging-frameworks:RELEASEData tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats