Package org.axonframework.serialization.xml

Class XStreamSerializer.Builder

java.lang.Object

org.axonframework.serialization.AbstractXStreamSerializer.Builder

org.axonframework.serialization.xml.XStreamSerializer.Builder

Enclosing class:

XStreamSerializer

public static class XStreamSerializer.Builder
extends AbstractXStreamSerializer.Builder

Builder class to instantiate 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 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 XStreamSerializer.registerConverters(ChainingConverter) function will be called. This will register the Dom4JToByteArrayConverter, InputStreamToDom4jConverter, XomToStringConverter and InputStreamToXomConverter to the Converter chain.

Field Summary

Fields inherited from class org.axonframework.serialization.AbstractXStreamSerializer.Builder

xStream

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
XStreamSerializer	build()	Initializes a XStreamSerializer as specified through this Builder.
XStreamSerializer.Builder	charset(Charset charset)	Sets the Charset used for the in- and output streams required by XStream for the to and from xml function calls.
XStreamSerializer.Builder	classLoader(ClassLoader classLoader)	Sets the ClassLoader used as an override for default ClassLoader used in the XStream.
XStreamSerializer.Builder	converter(Converter converter)	Sets the Converter used as a converter factory providing converter instances utilized by upcasters to convert between different content types.
XStreamSerializer.Builder	disableAxonTypeSecurity()	Configures the underlying XStream instance to not include Axon's classes by default.
XStreamSerializer.Builder	disableCachingOfUnknownClasses()	Disables the caching of the names for classes which couldn't be resolved to a class.
XStreamSerializer.Builder	lenientDeserialization()	Configures the underlying XStream instance to be lenient when deserializing data into Java objects.
XStreamSerializer.Builder	revisionResolver(RevisionResolver revisionResolver)	Sets the RevisionResolver used to resolve the revision from an object to be serialized.
XStreamSerializer.Builder	xStream(com.thoughtworks.xstream.XStream xStream)	Sets the XStream used to perform the serialization of objects to XML, and vice versa.

Methods inherited from class org.axonframework.serialization.AbstractXStreamSerializer.Builder

validate

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

xStream

public XStreamSerializer.Builder xStream(@Nonnull
 com.thoughtworks.xstream.XStream xStream)

Sets the XStream used to perform the serialization of objects to XML, and vice versa. Defaults to a XStream(HierarchicalStreamDriver) call, providing the CompactDriver.

Overrides:

xStream in class AbstractXStreamSerializer.Builder

Parameters:

xStream - the XStream used to perform the serialization of objects to XML, and vice versa

Returns:

the current Builder instance, for fluent interfacing

charset

public XStreamSerializer.Builder charset(@Nonnull
 Charset charset)

Description copied from class: AbstractXStreamSerializer.Builder

Sets the Charset used for the in- and output streams required by XStream for the to and from xml function calls. Defaults to a Charset.forName(String) using the UTF-8 character set.

Overrides:

charset in class AbstractXStreamSerializer.Builder

Parameters:

charset - the Charset used for the in- and output streams required by XStream

Returns:

the current Builder instance, for fluent interfacing

revisionResolver

public XStreamSerializer.Builder revisionResolver(@Nonnull
 RevisionResolver revisionResolver)

Description copied from class: AbstractXStreamSerializer.Builder

Sets the RevisionResolver used to resolve the revision from an object to be serialized. Defaults to an AnnotationRevisionResolver which resolves the revision based on the contents of the Revision annotation on the serialized classes.

Overrides:

revisionResolver in class AbstractXStreamSerializer.Builder

Parameters:

revisionResolver - a RevisionResolver used to resolve the revision from an object to be serialized

Returns:

the current Builder instance, for fluent interfacing

converter

public XStreamSerializer.Builder converter(@Nonnull
 Converter converter)

Description copied from class: AbstractXStreamSerializer.Builder

Sets the Converter used as a converter factory providing converter instances utilized by upcasters to convert between different content types. Defaults to a ChainingConverter.

Overrides:

converter in class AbstractXStreamSerializer.Builder

Parameters:

converter - a Converter used as a converter factory providing converter instances utilized by upcasters to convert between different content types

Returns:

the current Builder instance, for fluent interfacing

classLoader

public XStreamSerializer.Builder classLoader(@Nonnull
 ClassLoader classLoader)

Description copied from class: AbstractXStreamSerializer.Builder

Sets the ClassLoader used as an override for default ClassLoader used in the XStream. The same solution could thus be achieved by configuring the `XStream` instance directly.

Overrides:

classLoader in class AbstractXStreamSerializer.Builder

Parameters:

classLoader - a ClassLoader used as a class loader in XStream

Returns:

the current Builder instance, for fluent interfacing

lenientDeserialization

public XStreamSerializer.Builder lenientDeserialization()

Description copied from class: AbstractXStreamSerializer.Builder

Configures the underlying XStream instance to be lenient when deserializing data into Java objects. Specifically sets the XStream.ignoreUnknownElements().

Overrides:

lenientDeserialization in class AbstractXStreamSerializer.Builder

Returns:

the current Builder instance, for fluent interfacing

disableAxonTypeSecurity

public XStreamSerializer.Builder disableAxonTypeSecurity()

Description copied from class: AbstractXStreamSerializer.Builder

Configures the underlying XStream instance to not include Axon's classes by default. Concretely, the XStream.allowTypesByWildcard(String[]) method will not be invoked with "org.axonframework.**".

It is recommended to disable this setting when complete control is required over the allowed types in this serializer's XStream instance.

Overrides:

disableAxonTypeSecurity in class AbstractXStreamSerializer.Builder

Returns:

the current Builder instance for fluent interfacing

disableCachingOfUnknownClasses

public XStreamSerializer.Builder disableCachingOfUnknownClasses()

Description copied from class: AbstractXStreamSerializer.Builder

Disables the caching of the names for classes which couldn't be resolved to a class.

It is recommended to disable this in case the class loading is dynamic, and classes that are not available at one point in time, may become available at any time later.

Overrides:

disableCachingOfUnknownClasses in class AbstractXStreamSerializer.Builder

Returns:

the current Builder instance, for fluent interfacing

build

public XStreamSerializer build()

Initializes a XStreamSerializer as specified through this Builder.

Returns:

a XStreamSerializer as specified through this Builder