Long-Term Support on Axon Framework 4 is now live for existing customers. Visit the resource center for instructions on setting it up. Access it here
  • Docs
  • Guides
  • Axon Framework
Axoniq Documentation
Axon Framework
  • developmentDev
  • 5.4Latest
  • 5.3
  • 5.2
  • 5.1
  • 5.0
  • 4.13
  • 4.12
  • 4.11
  • 4.10
  • older releasesDev
Axon Server
  • v2026.1Latest
  • v2026.0
  • v2025.2
  • v2025.1
  • v2025.0
  • v2024.2
  • v2024.1
  • older releasesDev
Axoniq Platform
  • defaultLatest
Extensions
Spring AMQP Reference
  • 4.12Latest
  • 4.11
  • 4.10
JGroups Extension Reference
  • 4.12Latest
  • 4.11
  • 4.10
JobRunr Pro Extension Reference
  • 4.12Latest
  • 4.11
  • 4.10
Kafka Extension Reference
  • 4.12Latest
  • 4.11
  • 4.10
Kotlin Extension Reference
  • 4.12Latest
  • 4.11
  • 4.10
MongoDB Extension Reference
  • mainDev
  • 4.12Latest
  • 4.11
  • 4.10
Multitenancy Extension Reference
  • developmentDev
  • 4.12Latest
  • 4.11
  • 4.10
Reactor Extension Reference
  • mainDev
  • 4.12Latest
  • 4.11
  • 4.10
Spring AOT Extension Guide
  • developmentDev
  • 4.12Latest
  • 4.11
  • 4.10
Spring Cloud Extension Guide
  • mainDev
  • 4.12Latest
  • 4.11
  • 4.10
Tracing Extension Guide
  • mainDev
  • 4.12Latest
  • 4.11
  • 4.10
Getting started
  • Basics
  • Guides
    • Axon Framework
    • Axon Server
  • Getting Started with Axon Framework 5
    • Introduction
    • University Domain
    • Project Structure
    • Feature: Course Creation
    • Feature: Subscribe Student
    • Connecting to Axon Server
    • Feature: Send Notification When Student Subscribed
    • Feature: Send Notification To The Administrator When All Courses Are Fully Booked
    • Feature: Build Course Statistics Read Model (Projection)
Reference guides
  • Axon Framework
    • Introduction
    • Axon 4 to Axon 5 Upgrade
      • Why Upgrade?
      • Prerequisites
      • OpenRewrite Code Conversion
      • Resolved Problems
      • Understanding Choices
      • Upgrade Paths
        • Messages
        • Aggregates
          • Configuration Migration
          • Event tagging
          • Multi-Entity Migration
          • Polymorphic Migration
        • Projectors and Event Processors
        • Token Store
        • Event Store
        • Snapshotting
        • Legacy Saga support
        • Sagas to workflows
        • Test Fixtures
        • Configuration Migration
        • Serializer Migration
        • Dead-Letter Queue Migration
        • Interceptor Migration
        • Sequencing Policy Migration
        • Timeout Migration
        • Distributed Tracing
        • Upcaster Migration
        • Multi-Tenancy Migration
        • Axon Framework 5.0 to Axoniq Framework Migration
        • Axoniq Framework 5.2.0 to 5.2.1 Migration
        • Data Protection Module Migration
    • Messaging Concepts
      • Anatomy of a Message
      • Message Intercepting
      • Supported Parameters for Annotated Handlers
      • Message Correlation
      • Component Message Intercepting
      • Exception Handling
      • Annotated Exception Handling
      • Processing Context
    • Commands
      • Handling
      • Dispatching
      • Entities
        • Event-sourced entities
          • Entity creator
        • Stateful command handlers
        • Entity hierarchies
        • Polymorphic entities
      • Infrastructure
      • Configuration
    • Events
      • Handling
      • Publishing
      • Event Processors
        • Subscribing Event Processor
        • Streaming Event Processor
        • Persistent Streams
        • Dead-Letter Queue
      • Infrastructure
        • Event Store Internals
      • Versioning
      • Event Transformation
        • Defining transformations
        • Configuring transformations
        • Example
    • Queries
      • Handling
      • Dispatching
      • Infrastructure
      • Configuration
    • Workflows
      • Primitive Steps
        • Execute Steps
        • Waiting for Events
        • Publishing Events
        • Understanding Steps
      • Workflow Lifecycle
      • Error Handling
      • Workflow Manager
      • Step Orchestration
      • Common Patterns
      • Payload & State
      • Configuration
      • Testing
      • Versioning
    • Testing
      • Basic Testing
      • Matchers and Field Filters
      • Advanced Testing
    • Conversion
    • Data Protection
      • Installation
      • Annotations
      • Configuration
      • Crypto engines
      • Java records
      • Advanced
    • Multi-Tenancy
      • Tenant management
      • Tenant sequencing
      • Tenant-scoped components
      • Tenant-aware command processing
      • Tenant-aware event storage
      • Data protection
      • Tenant-aware event processing
      • Tenant-aware dead-letter queues
      • Tenant-aware query processing
      • Example
    • Tuning
      • Command Processing
      • Snapshots
      • Caching
      • Event Processing
      • Relational Databases
    • Monitoring
      • Tracing
      • Metrics
      • Health Indicators
      • Event Processor Monitoring
      • Message Tracking
    • Configuration API
      • Application configurers
      • Component registry and lifecycle registry
      • Configuration enhancers
      • Modules
      • Configuration
      • Component factories
      • Spring Boot integration
    • Spring Boot Integration
    • Framework Comparison
    • Modules
    • Release Notes
      • Axon Framework
        • Major Releases
        • Minor Releases
      • Axoniq Framework
        • Major Releases
        • Minor Releases
      • Axoniq Data Protection
        • Major Releases
        • Minor Releases
      • Axoniq Workflow Engine
        • Major Releases
        • Minor Releases
    • Known Issues and Workarounds
  • Axon Server
    • Introduction
    • Installation
      • Local installation
      • Docker / K8s
    • Administration
      • Configuration
        • System properties
        • Command Line Interface
        • REST API
        • gRPC API
      • Monitoring
        • Actuator Endpoints
        • Axon Server Metrics
        • gRPC Metrics
        • Heartbeat Monitoring
        • Diagnostics
      • Multi-Context
      • Tiered Storage
      • Persistent Event Transformation
      • Tagging
      • Backups
      • Recovery
      • Axon Server Plugins
      • Persistent Streams
      • Logging
        • Logging Format
      • Error Codes
      • Integrations
        • Axon Server Integration HTTP API
        • Axon Server Outbound HTTP API
    • Clustering
      • Cluster Basics
      • Node Roles
      • Replication Groups
      • Replication Logs
    • Security
      • SSL
      • Access Control for Axon Server
      • Security for Axon Framework Client Applications
      • Access Control and the CLI
      • Access Control on the REST and gRPC APIs
      • LDAP Authentication
      • OAuth2 Authentication
    • Performance
      • Event Segments
      • Flow Control
    • Migration
      • Non-Axon Server to Axon Server
    • Architecture
      • Config Database
    • Troubleshooting
    • Release Notes
      • Major Releases
      • Patch Releases
  • Axoniq Platform
    • Introduction
    • Features
      • Framework Metrics
      • Processor Management
      • Dead-Letter Queues
      • Automatic Clustering
        • Node Restarts and Replacement
      • Development Agent
    • Monitoring
      • Inbox
      • Alert Rules
      • Exceptions
      • How Alerts Are Evaluated
      • Integrations
      • Reference
        • Default Rules
        • Subjects and Metrics
      • What Changed From the Previous Monitoring
    • Workspaces and Environments
      • Axoniq Platform Roles
    • Subscriptions
    • Billing
    • Licensing
      • License Sources
      • Running Without a Platform Connection
      • Rotation and Expiry
    • Authentication
    • Clients and Connectors
      • Axon Framework
        • Metric Collection
        • Operations
      • Axon Server
      • Access Tokens
      • Axon Framework 4 LTS Repository
Core concepts
  • Messaging Concepts
    • Anatomy of a Message
    • Message Intercepting
    • Supported Parameters for Annotated Handlers
    • Message Correlation
    • Component Message Intercepting
    • Exception Handling
    • Annotated Exception Handling
    • Processing Context
  • Commands
    • Handling
    • Dispatching
    • Entities
      • Event-sourced entities
        • Entity creator
      • Stateful command handlers
      • Entity hierarchies
      • Polymorphic entities
    • Infrastructure
    • Configuration
  • Events
    • Handling
    • Publishing
    • Event Processors
      • Subscribing Event Processor
      • Streaming Event Processor
      • Persistent Streams
      • Dead-Letter Queue
    • Infrastructure
      • Event Store Internals
    • Versioning
    • Event Transformation
      • Defining transformations
      • Configuring transformations
      • Example
  • Queries
    • Handling
    • Dispatching
    • Infrastructure
    • Configuration
Operations
  • Testing
    • Basic Testing
    • Matchers and Field Filters
    • Advanced Testing
  • Conversion
  • Tuning
    • Command Processing
    • Snapshots
    • Caching
    • Event Processing
    • Relational Databases
  • Monitoring
    • Tracing
    • Metrics
    • Health Indicators
    • Event Processor Monitoring
    • Message Tracking
  • Spring Boot Integration
  • Modules
Migration (AF4 → AF5)
  • Axon 4 to Axon 5 Upgrade
    • Why Upgrade?
    • Prerequisites
    • OpenRewrite Code Conversion
    • Resolved Problems
    • Understanding Choices
    • Upgrade Paths
      • Messages
      • Aggregates
        • Configuration Migration
        • Event tagging
        • Multi-Entity Migration
        • Polymorphic Migration
      • Projectors and Event Processors
      • Token Store
      • Event Store
      • Snapshotting
      • Legacy Saga support
      • Sagas to workflows
      • Test Fixtures
      • Configuration Migration
      • Serializer Migration
      • Dead-Letter Queue Migration
      • Interceptor Migration
      • Sequencing Policy Migration
      • Timeout Migration
      • Distributed Tracing
      • Upcaster Migration
      • Multi-Tenancy Migration
      • Axon Framework 5.0 to Axoniq Framework Migration
      • Axoniq Framework 5.2.0 to 5.2.1 Migration
      • Data Protection Module Migration
Guides
  • Message Scheduling
  • Long-running processes
  • Bike rental event model
  • Choosing an approach
  • Workflows
  • Vertical slices
  • State in a repository
  • State from context events
  • State from process events
  • Testing
  • Deadlines
  • Identifier Generation
  • Parameter Resolvers
  • Handler Enhancers
  • Meta Annotations
Extensions
  • Spring AMQP Reference
    • Introduction
    • Forwarding events to an AMQP exchange
    • Reading events from an AMQP Queue
    • Release notes
  • JGroups Extension Reference
    • Introduction
    • Configuration in SpringBoot
    • Release notes
  • JobRunr Pro Extension Reference
    • Introduction
    • Release Notes
  • Kafka Extension Reference
    • Introduction
    • Publishing Events to Kafka
    • Consuming Events From Kafka
    • Customizing Event Message Format
    • Configuration in SpringBoot
    • Release notes
  • Kotlin Extension Reference
    • Introduction
    • Commands
    • Events
    • Queries
    • Release notes
  • MongoDB Extension Reference
    • Introduction
    • Configuration of the Event Store with Spring
    • Configuration in SpringBoot
    • Configuration of the MongoDB Dead-Letter Queue with Spring
    • Release notes
  • Multitenancy Extension Reference
    • Introduction
    • Configuration
    • Supported Multi-Tenant Components
    • Disable Extension
    • Release notes
  • Reactor Extension Reference
    • Introduction
    • Reactor Gateways
    • Release notes
  • Spring AOT Extension Guide
    • Introduction
    • Compiling to Native
    • Performance Tips
    • Release notes
  • Spring Cloud Extension Guide
    • Introduction
    • Discovering Command Routes
    • Sending Commands between Nodes
    • Configuring This Extension
    • Release notes
  • Tracing Extension Guide
    • Introduction
    • Configuring the Extension
    • Release notes
Release notes
  • Release Notes
    • Axon Framework
      • Major Releases
      • Minor Releases
    • Axoniq Framework
      • Major Releases
      • Minor Releases
    • Axoniq Data Protection
      • Major Releases
      • Minor Releases
    • Axoniq Workflow Engine
      • Major Releases
      • Minor Releases
  • Known Issues and Workarounds
Axoniq Platform

Axon Framework Guides

This collection of guides help you with specific tasks when using Axon Framework.

Guide directory

Changing Identifier generation
Customizing message handlers
Deadlines guide
Message Scheduling
Meta annotations
Sagas and Process Managers
Guides Axon Server
ESC
↑↓ navigate ↵ open ESC close

Copyright © 2025 Axoniq BV. All Rights Reserved