Skip to main content

Apply Axon Framework 5 messaging module renames

org.axonframework.migration.Axon4ToAxon5Messaging

Migrates the messaging core (command, event, query handling) from org.axonframework.{command,event,query}handling into the org.axonframework.messaging.* namespace, relocates handler & interceptor annotations into their .annotation.* subpackages, renames EventBus to EventSink, fixes MetaData casing to Metadata, relocates the top-level messaging API (Message, Metadata, UnitOfWork, MessageHandlerInterceptor, MessageHandlerInterceptorChain, correlation.*) into messaging.core.*, moves the sequencing policy package out of eventhandling.async into messaging.core.sequencing, relocates tokenstore and the replay/reset annotations under their AF5 subpackages, and moves QueryGateway into its own gateway subpackage.

Recipe source​

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

info

This recipe is composed of more than one recipe. If you want to customize the set of recipes this is composed of, you can find and copy the GitHub source for the recipe from the link above.

This recipe is available under the Apache License Version 2.0.

Definition​

  • Rename package name
    • oldPackageName: org.axonframework.commandhandling
    • newPackageName: org.axonframework.messaging.commandhandling
    • recursive: true
  • Rename package name
    • oldPackageName: org.axonframework.eventhandling
    • newPackageName: org.axonframework.messaging.eventhandling
    • recursive: true
  • Rename package name
    • oldPackageName: org.axonframework.queryhandling
    • newPackageName: org.axonframework.messaging.queryhandling
    • recursive: true
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.commandhandling.CommandHandler
    • newFullyQualifiedTypeName: org.axonframework.messaging.commandhandling.annotation.CommandHandler
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.EventHandler
    • newFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.annotation.EventHandler
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.queryhandling.QueryHandler
    • newFullyQualifiedTypeName: org.axonframework.messaging.queryhandling.annotation.QueryHandler
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.MessageDispatchInterceptor
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.MessageDispatchInterceptor
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.interceptors.MessageHandlerInterceptor
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.annotation.interceptors.MessageHandlerInterceptor
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.interceptors.ExceptionHandler
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.annotation.interceptors.ExceptionHandler
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.interceptors.ResultHandler
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.annotation.interceptors.ResultHandler
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.interceptors.LoggingInterceptor
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.interception.LoggingInterceptor
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.EventBus
    • newFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.EventSink
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.PropagatingErrorHandler
    • newFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.processing.errorhandling.PropagatingErrorHandler
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.DisallowReplay
    • newFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.replay.annotation.DisallowReplay
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.ResetHandler
    • newFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.replay.annotation.ResetHandler
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.ReplayToken
    • newFullyQualifiedTypeName: org.axonframework.messaging.eventhandling.processing.streaming.token.ReplayToken
  • Rename package name
    • oldPackageName: org.axonframework.messaging.eventhandling.tokenstore
    • newPackageName: org.axonframework.messaging.eventhandling.processing.streaming.token.store
    • recursive: true
  • Rename package name
    • oldPackageName: org.axonframework.messaging.eventhandling.async
    • newPackageName: org.axonframework.messaging.core.sequencing
    • recursive: true
  • Migrate SequencingPolicy lambdas to the AF5 two-arg, Optional-returning shape
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.queryhandling.QueryGateway
    • newFullyQualifiedTypeName: org.axonframework.messaging.queryhandling.gateway.QueryGateway
  • Unwrap ResponseTypes wrappers on AF5-shape QueryGateway.query(...) calls
  • Remove unused imports
  • Change method name
    • methodPattern: org.axonframework.eventhandling.EventProcessor shutDown()
    • newMethodName: shutdown
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.eventhandling.EventProcessor shutDown()
    • newMethodName: shutdown
    • matchOverrides: true
  • Rename package name
    • oldPackageName: org.axonframework.messaging.correlation
    • newPackageName: org.axonframework.messaging.core.correlation
    • recursive: true
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.MetaData
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.Metadata
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.annotation.MetaDataValue
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.annotation.MetadataValue
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.unitofwork.UnitOfWork
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.unitofwork.UnitOfWork
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.InterceptorChain
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.MessageHandlerInterceptorChain
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.Message
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.Message
  • Change type
    • oldFullyQualifiedTypeName: org.axonframework.messaging.MessageHandlerInterceptor
    • newFullyQualifiedTypeName: org.axonframework.messaging.core.MessageHandlerInterceptor
  • Remove type arguments from a specific type
    • fullyQualifiedTypeName: org.axonframework.messaging.core.Message
  • Remove type arguments from a specific type
    • fullyQualifiedTypeName: org.axonframework.messaging.eventhandling.EventMessage
  • Remove type arguments from a specific type
    • fullyQualifiedTypeName: org.axonframework.messaging.commandhandling.CommandMessage
  • Remove type arguments from a specific type
    • fullyQualifiedTypeName: org.axonframework.messaging.queryhandling.QueryMessage
  • Remove type arguments from a specific type
    • fullyQualifiedTypeName: org.axonframework.messaging.queryhandling.QueryResponseMessage
  • Remove type arguments from a specific type
    • fullyQualifiedTypeName: org.axonframework.messaging.ResultMessage
  • Remove type arguments from a specific type
    • fullyQualifiedTypeName: org.axonframework.messaging.core.unitofwork.UnitOfWork
  • Migrate MessageHandlerInterceptor / MessageDispatchInterceptor signatures to AF5
  • Change method name
    • methodPattern: org.axonframework.messaging.Message getIdentifier()
    • newMethodName: identifier
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.core.Message getIdentifier()
    • newMethodName: identifier
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.eventhandling.EventMessage getIdentifier()
    • newMethodName: identifier
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.eventhandling.EventMessage getIdentifier()
    • newMethodName: identifier
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.Message getMetaData()
    • newMethodName: metadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.core.Message getMetaData()
    • newMethodName: metadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.Message getPayload()
    • newMethodName: payload
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.core.Message getPayload()
    • newMethodName: payload
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.Message getPayloadType()
    • newMethodName: payloadType
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.core.Message getPayloadType()
    • newMethodName: payloadType
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.Message withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.core.Message withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.eventhandling.EventMessage withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.eventhandling.EventMessage withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.commandhandling.CommandMessage withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.commandhandling.CommandMessage withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.queryhandling.QueryMessage withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.queryhandling.QueryMessage withMetaData(java.util.Map)
    • newMethodName: withMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.Message andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.core.Message andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.eventhandling.EventMessage andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.eventhandling.EventMessage andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.commandhandling.CommandMessage andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.commandhandling.CommandMessage andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.queryhandling.QueryMessage andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.queryhandling.QueryMessage andMetaData(java.util.Map)
    • newMethodName: andMetadata
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.eventhandling.EventMessage getTimestamp()
    • newMethodName: timestamp
    • matchOverrides: true
  • Change method name
    • methodPattern: org.axonframework.messaging.eventhandling.EventMessage getTimestamp()
    • newMethodName: timestamp
    • matchOverrides: true
  • Replace class-level CommandGateway with method-parameter CommandDispatcher in @EventHandler methods

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.Axon4ToAxon5Messaging")
        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.