Awesome

Axon Data Protection Maven Plugin

Axon Data Protection Maven Plugin is a Maven Plugin responsible to generate the config file to be used on the Axon Server Plugin Data Protection module. The config is generated based on Annotated Classes (using the Axon Data Protection Config API Annotations) and the output is a Json file, which is one of the inputs for the Axon Server Data Protection Plugin.

POM file

For having the properly Annotations scanned, the axon-dataprotection-config-api is needed, and you can configure it like so:

<dependency>
    <groupId>io.axoniq</groupId>
    <artifactId>axon-dataprotection-config-api</artifactId>
    <version>1.0</version>
    <scope>compile</scope>
</dependency>

This Plugin is hooked into the compile phase of the Maven Lifecycle and has a goal named generate.

Configuration

The mandatory configuration is a packages list where you can specify all packages where the plugin should scan for Annotated Classes.

The optional configurations are:

• outputConfig where you can specify the directory you want the output json to be created. By default, it creates a file named axon-data-protection-config.json in your target folder.

It has proven to be a good practice to make this json part of your git repository, so you can follow the evolving of your configuration as well as be notified (by git) when it changed to not forget to change it on the server.

• ignores where you can specify which classes or packages should be ignored when scanning. This is useful when you use types in your Events that are not part of the standard Java library. When using this property you should also specify the given dependency as a plugin dependency.

Basically, this is a complete example of what you need on your project:

<plugins>
    ...
    <plugin>
        <groupId>io.axoniq</groupId>
        <artifactId>axon-dataprotection-maven-plugin</artifactId>
        <version>${plugin.version}</version>
        <configuration>
            <!-- required -->
            <packages>
                <package>io.axoniq.package1</package>
                <package>io.axoniq.package2</package>
                <package>io.axoniq.package3</package>
            </packages>
            <!-- optional -->
            <outputConfig>output.json</outputConfig>
            <!-- optional -->
            <ignores>
                <ignore>org.joda.time.*</ignore>
                <ignore>org.joda.time.DurationFieldType</ignore>
            </ignores>
        </configuration>
        <!-- only needed in case you also use the `ignores` config -->
        <dependencies>
            <dependency>
                <groupId>joda-time</groupId>
                <artifactId>joda-time</artifactId>
                <version>${joda.version}</version>
            </dependency>
        </dependencies>
        <executions>
            <execution>
                <goals>
                    <goal>generate</goal>
                </goals>
            </execution>
        </executions>
    </plugin>
    ...
</plugins>

Versioning

As we know, Events evolve and the @Revision annotation from Axon Framework is taken into account when generating the configuration. For that reason, every time any event changes a @Revision, a new configuration should be generated and the end configuration should contain both versions of the Event - this is a similar to a merge process, and it is not automatic.

Created with :heart: by AxonIQ