Skip to main content

Replace class-level CommandGateway with method-parameter CommandDispatcher in @EventHandler methods

org.axonframework.migration.MigrateCommandGatewayInEventHandler

Inside every @EventHandler method in the class, rewrites calls of the form commandGateway.send(...) / commandGateway.sendAndWait(...) (where commandGateway is a class-level CommandGateway field) to commandDispatcher.send(...) on a method-level CommandDispatcher parameter — adding the parameter when missing. For void handlers whose body is a single dispatch expression or a single try/catch with one dispatch per branch, the return type is widened to CompletableFuture<?> and the dispatch is converted to return ... .getResultMessage();. Once no other references to the gateway field remain, the field, its constructor parameter, and the matching assignment are removed.

Recipe source​

GitHub: search?type=code&q=org.axonframework.migration.MigrateCommandGatewayInEventHandler, Issue Tracker, Maven Central

This recipe is available under the Apache License Version 2.0.

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):

  1. Add the following to your build.gradle file:
    build.gradle
    plugins {
        id("org.openrewrite.rewrite") version("latest.release")
    }

    rewrite {
        activeRecipe("org.axonframework.migration.MigrateCommandGatewayInEventHandler")
        setExportDatatables(true)
    }

    repositories {
        mavenCentral()
    }

    dependencies {
        rewrite("org.openrewrite.recipe:rewrite-third-party:0.40.1")
    }
  2. Run gradle rewriteRun to run the recipe.

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

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

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​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.