org.restlet.ext.xstream

Class XstreamRepresentation<T>

java.lang.Object

org.restlet.representation.Variant

org.restlet.representation.RepresentationInfo

org.restlet.representation.Representation

org.restlet.representation.CharacterRepresentation

org.restlet.representation.WriterRepresentation

org.restlet.ext.xstream.XstreamRepresentation<T>

Type Parameters:

T - The type to wrap.

Deprecated.

Use an XML serialization technology such as Jackson instead.

@Deprecated
public class XstreamRepresentation<T>
extends WriterRepresentation

Representation based on the XStream library. It can serialize and deserialize automatically in XML. It also supports a bridge to JSON leveraging the Jettison library.

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.
You can configure the Xstream object used by this representation (cf createXstream(MediaType) or getXstream()) and apply security permissions. You can find more documentation about the security fix and how to configure the XStream object from here: XStream security enhancements.

Author:

Jerome Louvel

See Also:

XStream project

Field Summary

Fields inherited from class org.restlet.representation.Representation

UNKNOWN_SIZE

Constructor Summary

Constructors

Constructor and Description
XstreamRepresentation(MediaType mediaType, T object) Deprecated. Constructor.
XstreamRepresentation(Representation representation, Class<T> targetClass) Deprecated. Constructor.
XstreamRepresentation(T object) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
protected com.thoughtworks.xstream.XStream	createXstream(MediaType mediaType) 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.
T	getObject() Deprecated. Returns the wrapped object, deserializing the representation with XStream if necessary.
Class<? extends com.thoughtworks.xstream.io.HierarchicalStreamDriver>	getXmlDriverClass() Deprecated. Returns the XStream XML driver class.
com.thoughtworks.xstream.XStream	getXstream() Deprecated. Returns the modifiable XStream object.
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.
void	setXstream(com.thoughtworks.xstream.XStream xstream) Deprecated. Sets the XStream object.
void	write(Writer writer) Deprecated. Writes the representation to a characters writer.

Methods inherited from class org.restlet.representation.WriterRepresentation

getReader

Methods inherited from class org.restlet.representation.CharacterRepresentation

getChannel, getStream, write, write

Methods inherited from class org.restlet.representation.Representation

append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, release, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient

Methods inherited from class org.restlet.representation.RepresentationInfo

getModificationDate, getTag, setModificationDate, setTag

Methods inherited from class org.restlet.representation.Variant

createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XstreamRepresentation

public XstreamRepresentation(MediaType mediaType,
                             T object)

Deprecated.

Constructor.

Parameters:

mediaType - The target media type.

object - The object to format.

XstreamRepresentation

public XstreamRepresentation(Representation representation,
                             Class<T> targetClass)

Deprecated.

Constructor.

Parameters:

representation - The representation to parse.

targetClass - The target class of the object to serialize.

XstreamRepresentation

public XstreamRepresentation(T object)

Deprecated.

Constructor. Uses the MediaType.APPLICATION_XML media type by default.

Parameters:

object - The object to format.

Method Detail

createXstream

protected com.thoughtworks.xstream.XStream createXstream(MediaType mediaType)
                                                  throws IOException

Deprecated.

Creates an XStream object based on a media type. By default, it creates a HierarchicalStreamDriver or a DomDriver.

Parameters:

mediaType - The serialization media type.

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.

getObject

public T getObject()
            throws IOException

Deprecated.

Returns the wrapped object, deserializing the representation with XStream if necessary.

Returns:

The wrapped object.

Throws:

IOException

getXmlDriverClass

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

Deprecated.

Returns the XStream XML driver class.

Returns:

The XStream XML driver class.

getXstream

public com.thoughtworks.xstream.XStream getXstream()
                                            throws IOException

Deprecated.

Returns the modifiable XStream object. Useful to customize mappings.

Returns:

The modifiable XStream object.

Throws:

IOException

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.

setXstream

public void setXstream(com.thoughtworks.xstream.XStream xstream)

Deprecated.

Sets the XStream object.

Parameters:

xstream - The XStream object.

write

public void write(Writer writer)
           throws IOException

Deprecated.

Description copied from class: Representation

Writes the representation to a characters writer. This method is ensured to write the full content for each invocation unless it is a transient representation, in which case an exception is thrown.

Note that the class implementing this method shouldn't flush or close the given Writer after writing to it as this will be handled by the Restlet connectors automatically.

Specified by:

write in class Representation

Parameters:

writer - The characters writer.

Throws:

IOException