Rename Camel header(s) across all DSLs

Name: OpenRewrite
Author: Moderne

org.apache.camel.upgrade.camel418_3.RenameHeaders

Renames Camel header(s) from old name(s) to new name(s) across all DSL types: Java method calls (.setHeader, .getHeader), Simple expressions (${header.name}), XML DSL (<setHeader name="...">), and YAML DSL (setHeader.name). Supports both single header rename (oldHeaderName/newHeaderName) and bulk rename (headerMappings). Only migrates safe contexts to avoid false positives.

Recipe source

GitHub: search?type=code&q=org.apache.camel.upgrade.camel418_3.RenameHeaders, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

Options

Type	Name	Description	Example
`Map`	headerMappings	Optional. Map of old header names to new header names (for bulk rename)	`kafka.TOPIC: CamelKafkaTopic`
`String`	oldHeaderName	Optional. The old header name to replace (for single rename)	`kafka.TOPIC`
`String`	newHeaderName	Optional. The new header name to use (for single rename)	`CamelKafkaTopic`

Used by

This recipe is used as part of the following composite recipes:

Usage

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

Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.apache.camel.upgrade.camel418_3.RenameHeaders")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-third-party:0.44.0")
}

Run gradle rewriteRun to run the recipe.

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:7.37.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin)
    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-third-party:0.44.0")
    }
    rewrite {
        activeRecipe("org.apache.camel.upgrade.camel418_3.RenameHeaders")
    setExportDatatables(true)
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

Run the recipe.

shell
gradle --init-script init.gradle rewriteRun

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

init.gradle.kts
initscript {
    repositories {
        maven { url = uri("https://plugins.gradle.org/m2") }
    }
    dependencies { classpath("org.openrewrite:plugin:7.37.0") }
}
rootProject {
    plugins.apply(org.openrewrite.gradle.RewritePlugin::class.java)
    dependencies {
        add("rewrite", "org.openrewrite.recipe:rewrite-third-party:0.44.0")
    }
    extensions.configure<org.openrewrite.gradle.RewriteExtension> {
        activeRecipe("org.apache.camel.upgrade.camel418_3.RenameHeaders")
    setExportDatatables(true)
    }
    afterEvaluate {
        if (repositories.isEmpty()) {
            repositories {
                mavenCentral()
            }
        }
    }
}

Run the recipe.

shell
gradle --init-script init.gradle.kts rewriteRun

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>6.44.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>org.apache.camel.upgrade.camel418_3.RenameHeaders</recipe>
          </activeRecipes>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>org.openrewrite.recipe</groupId>
            <artifactId>rewrite-third-party</artifactId>
            <version>0.44.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

Run mvn rewrite:run to run the recipe.

You will need to have Maven installed on your machine before you can run the following command.

shell
mvn -U org.openrewrite.maven:rewrite-maven-plugin:run --define rewrite.recipeArtifactCoordinates=org.openrewrite.recipe:rewrite-third-party:RELEASE --define rewrite.activeRecipes=org.apache.camel.upgrade.camel418_3.RenameHeaders --define rewrite.exportDatatables=true

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

shell
mod run . --recipe RenameHeaders

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-third-party:0.44.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

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.

Data Tables

SourcesFileResults
SearchResults
SourcesFileErrors
RecipeRunStats

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run. `null` when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. `null` when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column Name	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. `null` when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.

Recipe source​

Options​

Used by​

Usage​

See how this recipe works across multiple open-source repositories​

Data Tables​

Source files that had results​

Source files that had search results​

Source files that errored on a recipe​

Recipe performance​