Package org.axonframework.extension.springboot

Class ConverterProperties

java.lang.Object

org.axonframework.extension.springboot.ConverterProperties

@ConfigurationProperties("axon.converter")
public class ConverterProperties
extends Object

A group of properties that allows easy configuration of the Converters used for different types of objects that Axon needs to convert.

The general Converter forms the baseline and is used to convert all objects that do not fall into more specific categories. Typical examples include snapshots and other internal data that is not expected to be shared with other systems. If no general Converter is specified, Axon defaults to the JacksonConverter.

The messages Converter, if specified, takes precedence over the general converter for all Messages and, where relevant, their return values. This includes commands, queries, and events, as well as CommandResultMessages and QueryResponseMessages. To ensure the messages Converter only applies to messages, it is wrapped in a DelegatingMessageConverter. When no message Converter is specified, it defaults back to the general converter.

The events Converter, if specified, takes precedence over both the messages and general converters, but applies only to the EventMessages stored in the event store and published on the event bus. To ensure it only applies to event messages, it is wrapped in a DelegatingEventConverter. When no event Converter is specified, it defaults back to the messages converter.

Since:

3.2.0

Author:

Allard Buijze, Steven van Beelen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConverterProperties.ConverterType	Enumerates different possible standard Converters available in Axon Framework.

Constructor Summary

Constructors

Constructor	Description
ConverterProperties()

Method Summary

Modifier and Type	Method	Description
ConverterProperties.ConverterType	getEvents()	The type of Converter to use to convert the Message.payload() of EventMessages.
ConverterProperties.ConverterType	getGeneral()	The type of Converter to use to convert any type for which no more specific Converter is configured.
ConverterProperties.ConverterType	getMessages()	The type of Converter to use to convert the Message.payload() of any type of Message.
void	setEvents(ConverterProperties.ConverterType converterType)	Sets the type of Converter to use to convert the Message.payload() of EventMessages.
void	setGeneral(ConverterProperties.ConverterType converterType)	Sets the type of Converter to use to convert any type for which no more specific Converter is configured.
void	setMessages(ConverterProperties.ConverterType converterType)	Sets the type of Converter to use to convert the Message.payload() of any type of Message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConverterProperties

public ConverterProperties()

Method Details

getGeneral

@Nonnull
public ConverterProperties.ConverterType getGeneral()

The type of Converter to use to convert any type for which no more specific Converter is configured.

Defaults to the default ConverterType.

Returns:

The Converter type to use for conversion of all kinds of objects

setGeneral

public void setGeneral(@Nonnull
 ConverterProperties.ConverterType converterType)

Sets the type of Converter to use to convert any type for which no more specific Converter is configured.

Defaults to the default ConverterType.

Parameters:

converterType - The converter type to use for converting any object.

getMessages

@Nonnull
public ConverterProperties.ConverterType getMessages()

The type of Converter to use to convert the Message.payload() of any type of Message.

The constructed Converter will always be wrapped in a DelegatingMessageConverter, ensuring the Converter only deals with Messages.

Defaults to the general Converter.

Returns:

The type of Converter to use for Message payloads.

setMessages

public void setMessages(@Nonnull
 ConverterProperties.ConverterType converterType)

Sets the type of Converter to use to convert the Message.payload() of any type of Message.

The constructed Converter will always be wrapped in a DelegatingMessageConverter, ensuring the Converter only deals with Messages.

Defaults to the general Converter.

Parameters:

converterType - The converter type to use for converting any Message Message.payload().

getEvents

@Nonnull
public ConverterProperties.ConverterType getEvents()

The type of Converter to use to convert the Message.payload() of EventMessages.

The constructed Converter will always be wrapped in a DelegatingEventConverter, ensuring the Converter only deals with EventMessages.

Defaults to the messages Converter when set, or otherwise the general Converter.

Returns:

The type of Converter to use for EventMessage payloads.

setEvents

public void setEvents(@Nonnull
 ConverterProperties.ConverterType converterType)

Sets the type of Converter to use to convert the Message.payload() of EventMessages.

The constructed Converter will always be wrapped in a DelegatingEventConverter, ensuring the Converter only deals with EventMessages.

Defaults to the messages Converter when set, or otherwise the general Converter.

Parameters:

converterType - The converter type to use for converting any EventMessage Message.payload().