org.restlet.ext.xstream

Class XstreamConverter

java.lang.Object

org.restlet.engine.Helper

org.restlet.engine.converter.ConverterHelper

org.restlet.ext.xstream.XstreamConverter

Deprecated.

Use an XML serialization technology such as Jackson instead.

@Deprecated
public class XstreamConverter
extends ConverterHelper

Converter between the XML/JSON and Representation classes based on XStream.

SECURITY WARNING: XStream applies various techniques under the hood to ensure it is able to handle all types of objects. This includes using undocumented Java features and reflection. The XML generated by XStream includes all information required to build objects of almost any type. This introduces a potential security problem.
The XML provided to XStream for conversion to a Java object can be manipulated to inject objects into the unmarshalled object graph, which were not present at marshalling time. An attacker could exploit this to execute arbitrary code or shell commands in the context of the server running the XStream process. This issue has been addressed and is clearly documented here: XStream Security Framework.
You can configure the Xstream object used by this converter by overriding the createXstream(MediaType, Class) method and apply your own security permissions, and provide this new converter to the Restlet Engine (see org.restlet.engine.Engine#getRegisteredConverters method).

Author:

Jerome Louvel

Constructor Summary

Constructors

Constructor and Description
XstreamConverter() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
protected <T> XstreamRepresentation<T>	create(MediaType mediaType, T source) Deprecated. Creates the marshaling XstreamRepresentation.
protected <T> XstreamRepresentation<T>	create(Representation source, Class<T> target) Deprecated. Creates the unmarshaling XstreamRepresentation.
<T> com.thoughtworks.xstream.XStream	createXstream(MediaType mediaType, Class<T> target) Deprecated. Creates an XStream object based on a media type.
Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver>	getJsonDriverClass() Deprecated. Returns the XStream JSON driver class.
List<Class<?>>	getObjectClasses(Variant source) Deprecated. Returns the list of object classes that can be converted from a given variant.
List<VariantInfo>	getVariants(Class<?> source) Deprecated. Returns the list of variants that can be converted from a given object class.
Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver>	getXmlDriverClass() Deprecated. Returns the XStream XML driver class.
float	score(Object source, Variant target, Resource resource) Deprecated. Scores the affinity of this helper with the source class.
<T> float	score(Representation source, Class<T> target, Resource resource) Deprecated. Scores the affinity of this helper with the source class.
void	setJsonDriverClass(Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver> jsonDriverClass) Deprecated. Sets the XStream JSON driver class.
void	setXmlDriverClass(Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver> xmlDriverClass) Deprecated. Sets the XStream XML driver class.
<T> T	toObject(Representation source, Class<T> target, Resource resource) Deprecated. Converts a Representation into a regular Java object.
Representation	toRepresentation(Object source, Variant target, Resource resource) Deprecated. Converts a regular Java object into a Representation.
<T> void	updatePreferences(List<Preference<MediaType>> preferences, Class<T> entity) Deprecated. Updates the preferences of the given ClientInfo object with conversion capabilities for the given entity class.

Methods inherited from class org.restlet.engine.converter.ConverterHelper

addObjectClass, addVariant, addVariants, getVariants, updatePreferences

Methods inherited from class java.lang.Object

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

Constructor Detail

XstreamConverter

public XstreamConverter()

Deprecated.

Constructor.

Method Detail

create

protected <T> XstreamRepresentation<T> create(MediaType mediaType,
                                              T source)

Deprecated.

Creates the marshaling XstreamRepresentation.

Type Parameters:

T -

Parameters:

mediaType - The target media type.

source - The source object to marshal.

Returns:

The marshaling XstreamRepresentation.

create

protected <T> XstreamRepresentation<T> create(Representation source,
                                              Class<T> target)
                                       throws IOException

Deprecated.

Creates the unmarshaling XstreamRepresentation.

Type Parameters:

T -

Parameters:

source - The source representation to unmarshal.

target - The expected class of the Java object.

Returns:

The unmarshaling XstreamRepresentation.

Throws:

IOException

createXstream

public <T> com.thoughtworks.xstream.XStream createXstream(MediaType mediaType,
                                                          Class<T> target)
                                                   throws IOException

Deprecated.

Creates an XStream object based on a media type. By default, it creates a HierarchicalStreamDriver or a DomDriver. To be overriden in order to customize security permissions.

Type Parameters:

T -

Parameters:

mediaType - The serialization media type.

target - The expected class of the Java object.

Returns:

The XStream object.

Throws:

IOException

getJsonDriverClass

public Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver> getJsonDriverClass()

Deprecated.

Returns the XStream JSON driver class.

Returns:

TXStream JSON driver class.

getObjectClasses

public List<Class<?>> getObjectClasses(Variant source)

Deprecated.

Description copied from class: ConverterHelper

Returns the list of object classes that can be converted from a given variant.

Specified by:

getObjectClasses in class ConverterHelper

Parameters:

source - The source variant.

Returns:

The list of object class that can be converted.

getVariants

public List<VariantInfo> getVariants(Class<?> source)

Deprecated.

Description copied from class: ConverterHelper

Returns the list of variants that can be converted from a given object class. The preferred variant should be set in first position.

Specified by:

getVariants in class ConverterHelper

Parameters:

source - The source object class.

Returns:

The list of variants that can be converted.

getXmlDriverClass

public Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver> getXmlDriverClass()

Deprecated.

Returns the XStream XML driver class.

Returns:

The XStream XML driver class.

score

public float score(Object source,
                   Variant target,
                   Resource resource)

Deprecated.

Description copied from class: ConverterHelper

Scores the affinity of this helper with the source class.

Specified by:

score in class ConverterHelper

Parameters:

source - The source object to convert.

target - The expected representation metadata.

resource - The calling resource.

Returns:

The affinity score of this helper.

score

public <T> float score(Representation source,
                       Class<T> target,
                       Resource resource)

Deprecated.

Description copied from class: ConverterHelper

Scores the affinity of this helper with the source class.

Specified by:

score in class ConverterHelper

Parameters:

source - The source representation to convert.

target - The expected class of the Java object.

resource - The calling resource.

Returns:

The affinity score of this helper.

setJsonDriverClass

public void setJsonDriverClass(Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver> jsonDriverClass)

Deprecated.

Sets the XStream JSON driver class.

Parameters:

jsonDriverClass - The XStream JSON driver class.

setXmlDriverClass

public void setXmlDriverClass(Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver> xmlDriverClass)

Deprecated.

Sets the XStream XML driver class.

Parameters:

xmlDriverClass - The XStream XML driver class.

toObject

public <T> T toObject(Representation source,
                      Class<T> target,
                      Resource resource)
               throws IOException

Deprecated.

Description copied from class: ConverterHelper

Converts a Representation into a regular Java object.

Specified by:

toObject in class ConverterHelper

Type Parameters:

T - The expected class of the Java object.

Parameters:

source - The source representation to convert.

target - The expected class of the Java object.

resource - The calling resource.

Returns:

The converted Java object.

Throws:

IOException

toRepresentation

public Representation toRepresentation(Object source,
                                       Variant target,
                                       Resource resource)

Deprecated.

Description copied from class: ConverterHelper

Converts a regular Java object into a Representation.

Specified by:

toRepresentation in class ConverterHelper

Parameters:

source - The source object to convert.

target - The expected representation metadata.

resource - The calling resource.

Returns:

The converted representation.

updatePreferences

public <T> void updatePreferences(List<Preference<MediaType>> preferences,
                                  Class<T> entity)

Deprecated.

Description copied from class: ConverterHelper

Updates the preferences of the given ClientInfo object with conversion capabilities for the given entity class.

Overrides:

updatePreferences in class ConverterHelper

Parameters:

preferences - The media type preferences.

entity - The entity class to convert.