Installation and Setup

This guide covers how to install and configure Axon Data Protection in your project.

Requirements

  • Java 21 or higher - The module requires Java 21 as the minimum version

  • Framework 5.x - Compatible only with Framework 5.1 and later

  • Spring Boot 3.x (optional) - For Spring-based configuration

Breaking Change: Axon Data Protection 5.1 and up is NOT backward compatible with Axon Framework 4.x or earlier versions. If you’re using an older version of Axon Framework, you must use Data Protection 4.x.

Maven dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.axoniq.framework</groupId>
    <artifactId>axoniq-data-protection</artifactId>
</dependency>

Licensing

Axoniq Framework features, like the Data Protection module, are commercial offerings requiring a license for production use. Licenses can be obtained through the AxonIQ Platform. Once you have platform credentials, configure them in your application:

  • Spring Boot

  • Plain Java

axoniq.platform.credentials=<environment-id>:<access-token>
import org.axonframework.config.EventSourcingConfigurer;
import io.axoniq.platform.framework.AxoniqPlatformConfiguration;

// Create and configure your application
AxoniqPlatformConfiguration platformConfig = new AxoniqPlatformConfiguration(
        "<environment-id>",
        "<access-token>",
        "<application-name>"
);

EventSourcingConfigurer configurer = EventSourcingConfigurer.create()
    .componentRegistry(cr -> cr.registerComponent(
        AxoniqPlatformConfiguration.class,
        c -> platformConfig
    ));

// Build and start the configuration
org.axonframework.config.Configuration configuration = configurer.buildConfiguration();
configuration.start();

During evaluation, Axoniq Framework modules start without credentials and log a warning. Continued production use without a valid license is not permitted under the Axoniq Terms of Service.

For more information on pricing, visit our pricing information page.

Note that smaller organizations may be eligible for complimentary access to Axoniq Framework components. For details about that, reach out to our sales team.

Next steps

After adding the dependency, you need to:

  1. Choose and configure a crypto engine (JPA, JDBC, Vault, or others)

  2. Set up Spring and Axon configuration

  3. Add annotations to your domain objects