XStreamMarshaller

<init>

Implementation of the Marshaller interface for XStream.

By default, XStream does not require any further configuration and can (un)marshal any class on the classpath. As such, it is not recommended to use the XStreamMarshaller to unmarshal XML from external sources (i.e. the Web), as this can result in security vulnerabilities. If you do use the XStreamMarshaller to unmarshal external XML, set the supportedClasses and converters properties (possibly using a CatchAllConverter) or override the #customizeXStream(XStream) method to make sure it only accepts the classes you want it to support.

Due to XStream's API, it is required to set the encoding used for writing to OutputStreams. It defaults to UTF-8.

NOTE: XStream is an XML serialization library, not a data binding library. Therefore, it has limited namespace support. As such, it is rather unsuitable for usage within Web Services.

This marshaller requires XStream 1.4.5 or higher, as of Spring 4.3. Note that XStream construction has been reworked in 4.0, with the stream driver and the class loader getting passed into XStream itself now.

DEFAULT_ENCODING

The default encoding used for stream access: UTF-8.

afterPropertiesSet

getXStream

Return the native XStream delegate used by this marshaller.

NOTE: This method has been marked as final as of Spring 4.0. It can be used to access the fully configured XStream for marshalling but not configuration purposes anymore.

marshalOutputStream

marshalWriter

setAliases

Set the alias/type map, consisting of string aliases mapped to classes.

Keys are aliases; values are either Class instances, or String class names.

setAliasesByType

Set the aliases by type map, consisting of string aliases mapped to classes.

Any class that is assignable to this type will be aliased to the same name. Keys are aliases; values are either Class instances, or String class names.

setAnnotatedClasses

Set annotated classes for which aliases will be read from class-level annotation metadata.

setAutodetectAnnotations

Activate XStream's autodetection mode.

Note: Autodetection implies that the XStream instance is being configured while it is processing the XML streams, and thus introduces a potential concurrency problem.

setBeanClassLoader

setConverterLookup

Set a custom XStream ConverterLookup to use. Also used as ConverterRegistry if the given reference implements it as well.

setConverterRegistry

Set a custom XStream ConverterRegistry to use.

setConverters

Set the Converters or SingleValueConverters to be registered with the XStream instance.

setEncoding

Set the encoding to be used for stream access.

setFieldAliases

Set the field alias/type map, consisting of field names.

setImplicitCollections

Specify implicit collection fields, as a Map consisting of Class instances mapped to comma separated collection field names.

setMapper

Set a custom XStream Mapper to use.

setMapperWrappers

Set one or more custom XStream MapperWrapper classes. Each of those classes needs to have a constructor with a single argument of type Mapper or MapperWrapper.

setMarshallingStrategy

Set a custom XStream MarshallingStrategy to use.

setMode

Set the XStream mode to use.

setNameCoder

Set a custom XStream NameCoder to use. The default is an XmlFriendlyNameCoder.

setOmittedFields

Specify omitted fields, as a Map consisting of Class instances mapped to comma separated field names.

setReflectionProvider

Set a custom XStream ReflectionProvider to use.

setStreamDriver

Set a XStream HierarchicalStreamDriver to be used for readers and writers.

As of Spring 4.0, this stream driver will also be passed to the XStream constructor and therefore used by streaming-related native API methods themselves.

setSupportedClasses

Set the classes supported by this marshaller.

If this property is empty (the default), all classes are supported.

setUseAttributeFor

Set the types to use XML attributes for. The given map can contain either <String, Class> pairs, in which case XStream#useAttributeFor(String, Class) is called. Alternatively, the map can contain <Class, String> or <Class, List<String>> pairs, which results in XStream#useAttributeFor(Class, String) calls.

setUseAttributeForTypes

Set types to use XML attributes for.

supports

unmarshalInputStream

unmarshalReader

isProcessExternalEntities

Returns the configured value for whether XML external entities are allowed.

isSupportDtd

Whether DTD parsing is supported.

marshal

Marshals the object graph with the given root into the provided javax.xml.transform.Result.

This implementation inspects the given result, and calls marshalDomResult, marshalSaxResult, or marshalStreamResult.

setProcessExternalEntities

Indicates whether external XML entities are processed when unmarshalling.

Default is false, meaning that external entities are not resolved. Note that processing of external entities will only be enabled/disabled when the Source passed to #unmarshal(Source) is a SAXSource or StreamSource. It has no effect for DOMSource or StAXSource instances.

Note: setting this option to true also automatically sets #setSupportDtd to true.

setSupportDtd

Indicates whether DTD parsing should be supported.

Default is false meaning that DTD is disabled.

unmarshal

Unmarshals the given provided javax.xml.transform.Source into an object graph.

This implementation inspects the given result, and calls unmarshalDomSource, unmarshalSaxSource, or unmarshalStreamSource.