org.axonframework.extensions.mongo.serialization

Class DBObjectXStreamSerializer

java.lang.Object

org.axonframework.serialization.AbstractXStreamSerializer

org.axonframework.extensions.mongo.serialization.DBObjectXStreamSerializer

All Implemented Interfaces:

org.axonframework.serialization.Serializer

public class DBObjectXStreamSerializer
extends org.axonframework.serialization.AbstractXStreamSerializer

XStream based serializer implementation that serializes objects into a Binary JSON structure. This serializer is originally meant for use with a MongoDB based Event Store. It escapes BSON Node names to prevent them containing periods (".").

Since:

2.0

Author:

Allard Buijze

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DBObjectXStreamSerializer.Builder Builder class to instantiate a DBObjectXStreamSerializer.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DBObjectXStreamSerializer(DBObjectXStreamSerializer.Builder builder) Instantiate a DBObjectXStreamSerializer based on the fields contained in the DBObjectXStreamSerializer.Builder.

Method Summary

Modifier and Type	Method and Description
static DBObjectXStreamSerializer.Builder	builder() Instantiate a Builder to be able to create a DBObjectXStreamSerializer.
protected Object	doDeserialize(org.axonframework.serialization.SerializedObject serializedObject, com.thoughtworks.xstream.XStream xStream)
protected <T> T	doSerialize(Object object, Class<T> expectedFormat, com.thoughtworks.xstream.XStream xStream)
protected void	registerConverters(org.axonframework.serialization.ChainingConverter converter)

Methods inherited from class org.axonframework.serialization.AbstractXStreamSerializer

addAlias, addFieldAlias, addPackageAlias, canSerializeTo, classForType, convert, deserialize, getCharset, getConverter, getXStream, serialize, typeForClass

Methods inherited from class java.lang.Object

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

Constructor Detail

DBObjectXStreamSerializer

protected DBObjectXStreamSerializer(DBObjectXStreamSerializer.Builder builder)

Instantiate a DBObjectXStreamSerializer based on the fields contained in the DBObjectXStreamSerializer.Builder. The XStream instance is configured with several converters for the most common types in Axon.

Parameters:

builder - the DBObjectXStreamSerializer.Builder used to instantiate a DBObjectXStreamSerializer instance

Method Detail

builder

public static DBObjectXStreamSerializer.Builder builder()

Instantiate a Builder to be able to create a DBObjectXStreamSerializer.

The Charset is defaulted to a Charset.forName(String) using the UTF-8 character set, the RevisionResolver defaults to an AnnotationRevisionResolver and the Converter defaults to a ChainingConverter.

Upon instantiation, several defaults aliases are added to the XStream instance, for example for the GenericDomainEventMessage, the org.axonframework.commandhandling.GenericCommandMessage and the org.axonframework.messaging.MetaData objects among others. Additionally, a MetaDataConverter is registered too. Lastly, if the provided Converter instance is of type ChainingConverter, then the registerConverters(ChainingConverter) function will be called. This will register the DBObjectToStringContentTypeConverter, DocumentToStringContentTypeConverter and StringToDBObjectContentTypeConverter to the Converter chain.

Returns:

a Builder to be able to create a DBObjectXStreamSerializer

registerConverters

protected void registerConverters(org.axonframework.serialization.ChainingConverter converter)

Specified by:

registerConverters in class org.axonframework.serialization.AbstractXStreamSerializer

doSerialize

protected <T> T doSerialize(Object object,
                            Class<T> expectedFormat,
                            com.thoughtworks.xstream.XStream xStream)

Specified by:

doSerialize in class org.axonframework.serialization.AbstractXStreamSerializer

doDeserialize

protected Object doDeserialize(org.axonframework.serialization.SerializedObject serializedObject,
                               com.thoughtworks.xstream.XStream xStream)

Specified by:

doDeserialize in class org.axonframework.serialization.AbstractXStreamSerializer