org.axonframework.serialization.xml

Class XStreamSerializer

java.lang.Object

org.axonframework.serialization.AbstractXStreamSerializer

org.axonframework.serialization.xml.XStreamSerializer

All Implemented Interfaces:

Serializer

public class XStreamSerializer
extends AbstractXStreamSerializer

Serializer that uses XStream to serialize and deserialize arbitrary objects. The XStream instance is configured to deal with the Classes used in Axon Framework in the most compact fashion.

When running on a Sun JVM, XStream does not pose any restrictions on classes to serialize. On other JVM's, however, you need to either implement Serializable, or provide a default constructor (accessible under the JVM's security policy). That means that for portability, you should do either of these two.

Since:

1.2

Author:

Allard Buijze

See Also:

XStream

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static XStreamSerializer.Builder	builder() Instantiate a Builder to be able to create a XStreamSerializer.
static XStreamSerializer	defaultSerializer() Deprecated. in favor of using the builder() to construct an instance using a configured XStream instance. Using this shorthand still works, but will use an XStream instance that allows everything. Although this works, XStream expects the types or wildcards for the types to be defined to ensure the application stays secure. As such, it is highly recommended to follow their recommended approach.
Object	doDeserialize(SerializedObject serializedObject, com.thoughtworks.xstream.XStream xStream) Deserialize the given serializedObject.
protected <T> T	doSerialize(Object object, Class<T> expectedFormat, com.thoughtworks.xstream.XStream xStream) Serialize the given object to the given expectedFormat.
protected void	registerConverters(ChainingConverter converter) Registers any converters that are specific to the type of content written by this serializer.

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

XStreamSerializer

protected XStreamSerializer(XStreamSerializer.Builder builder)

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

Parameters:

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

Method Detail

builder

public static XStreamSerializer.Builder builder()

Instantiate a Builder to be able to create a XStreamSerializer.

The XStream is defaulted to a XStream(HierarchicalStreamDriver) call, providing a CompactDriver, 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. Lastly, the builder adds Axon types for XStream's security settings by including "org.axonframework.** as a wildcard type. This can be disabled with the XStreamSerializer.Builder.disableAxonTypeSecurity() operation when required.

Upon instantiation, several defaults aliases are added to the XStream instance, for example for the GenericDomainEventMessage, the GenericCommandMessage and the MetaData objects among others. Additionally, a MetaData Converter 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 Dom4JToByteArrayConverter, InputStreamToDom4jConverter, XomToStringConverter and InputStreamToXomConverter to the Converter chain.

Returns:

a Builder to be able to create a XStreamSerializer

defaultSerializer

@Deprecated
public static XStreamSerializer defaultSerializer()

Deprecated. in favor of using the builder() to construct an instance using a configured XStream instance. Using this shorthand still works, but will use an XStream instance that allows everything. Although this works, XStream expects the types or wildcards for the types to be defined to ensure the application stays secure. As such, it is highly recommended to follow their recommended approach.

Instantiate a default XStreamSerializer.

The XStream is defaulted to a XStream(HierarchicalStreamDriver) call, providing a CompactDriver, 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. Lastly, the builder adds Axon types for XStream's security settings by including "org.axonframework.** as a wildcard type.

Upon instantiation, several defaults aliases are added to the XStream instance, for example for the GenericDomainEventMessage, the GenericCommandMessage and the MetaData objects among others. Additionally, a MetaData Converter 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 Dom4JToByteArrayConverter, InputStreamToDom4jConverter, XomToStringConverter and InputStreamToXomConverter to the Converter chain.

Returns:

a XStreamSerializer

doSerialize

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

Description copied from class: AbstractXStreamSerializer

Serialize the given object to the given expectedFormat. The subclass may use AbstractXStreamSerializer.convert(Object, Class, Class) to convert the result of the serialization to the expected type.

Specified by:

doSerialize in class AbstractXStreamSerializer

Type Parameters:

T - The format in which the serialized object must be returned

Parameters:

object - The object to serialize

expectedFormat - The format in which the serialized object must be returned

xStream - The XStream instance to serialize with

Returns:

The serialized object

doDeserialize

public Object doDeserialize(SerializedObject serializedObject,
                            com.thoughtworks.xstream.XStream xStream)

Description copied from class: AbstractXStreamSerializer

Deserialize the given serializedObject.

Specified by:

doDeserialize in class AbstractXStreamSerializer

Parameters:

serializedObject - The instance containing the serialized format of the object

xStream - The XStream instance to deserialize with

Returns:

the deserialized object

registerConverters

protected void registerConverters(ChainingConverter converter)

Description copied from class: AbstractXStreamSerializer

Registers any converters that are specific to the type of content written by this serializer.

Specified by:

registerConverters in class AbstractXStreamSerializer

Parameters:

converter - the Converter to register the converters with