org.apache.camel.model.dataformat

Class XStreamDataFormat

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

org.apache.camel.model.dataformat.XStreamDataFormat

All Implemented Interfaces:

OtherAttributesAware

@Metadata(firstVersion="1.3.0",
          label="dataformat,transformation,xml,json",
          title="XStream")
public class XStreamDataFormat
extends DataFormatDefinition

XSTream data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload.

Version:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XStreamDataFormat.AliasAdapter
static class	XStreamDataFormat.AliasEntry
static class	XStreamDataFormat.AliasList
static class	XStreamDataFormat.ConverterEntry
static class	XStreamDataFormat.ConverterList
static class	XStreamDataFormat.ConvertersAdapter
static class	XStreamDataFormat.ImplicitCollectionEntry
static class	XStreamDataFormat.ImplicitCollectionList
static class	XStreamDataFormat.ImplicitCollectionsAdapter
static class	XStreamDataFormat.OmitFieldEntry
static class	XStreamDataFormat.OmitFieldList
static class	XStreamDataFormat.OmitFieldsAdapter

Constructor Summary

Constructors

Constructor and Description
XStreamDataFormat()
XStreamDataFormat(String encoding)

Method Summary

Modifier and Type	Method and Description
protected void	configureDataFormat(DataFormat dataFormat, CamelContext camelContext) Allows derived classes to customize the data format
protected DataFormat	createDataFormat(RouteContext routeContext) Factory method to create the data format instance
Map<String,String>	getAliases()
List<String>	getConverters()
String	getDriver()
String	getDriverRef()
String	getEncoding()
Map<String,String[]>	getImplicitCollections()
String	getMode()
Map<String,String[]>	getOmitFields()
String	getPermissions()
void	setAliases(Map<String,String> aliases) Alias a Class to a shorter name to be used in XML elements.
void	setConverters(List<String> converters) List of class names for using custom XStream converters.
void	setDriver(String driver) To use a custom XStream driver.
void	setDriverRef(String driverRef) To refer to a custom XStream driver to lookup in the registry.
void	setEncoding(String encoding) Sets the encoding to use
void	setImplicitCollections(Map<String,String[]> implicitCollections) Adds a default implicit collection which is used for any unmapped XML tag.
void	setMode(String mode) Mode for dealing with duplicate references The possible values are: NO_REFERENCES ID_REFERENCES XPATH_RELATIVE_REFERENCES XPATH_ABSOLUTE_REFERENCES SINGLE_NODE_XPATH_RELATIVE_REFERENCES SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES
void	setOmitFields(Map<String,String[]> omitFields) Prevents a field from being serialized.
void	setPermissions(Class<?>... type) To add permission for the given pojo classes.
void	setPermissions(String permissions) Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans.

Methods inherited from class org.apache.camel.model.DataFormatDefinition

configureDataFormat, getContentTypeHeader, getDataFormat, getDataFormat, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes, setProperty, setProperty

Methods inherited from class org.apache.camel.model.IdentifiedType

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

XStreamDataFormat

public XStreamDataFormat()

XStreamDataFormat

public XStreamDataFormat(String encoding)

Method Detail

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

Sets the encoding to use

getDriver

public String getDriver()

setDriver

public void setDriver(String driver)

To use a custom XStream driver. The instance must be of type com.thoughtworks.xstream.io.HierarchicalStreamDriver

getDriverRef

public String getDriverRef()

setDriverRef

public void setDriverRef(String driverRef)

To refer to a custom XStream driver to lookup in the registry. The instance must be of type com.thoughtworks.xstream.io.HierarchicalStreamDriver

getMode

public String getMode()

setMode

public void setMode(String mode)

Mode for dealing with duplicate references The possible values are:

• NO_REFERENCES
• ID_REFERENCES
• XPATH_RELATIVE_REFERENCES
• XPATH_ABSOLUTE_REFERENCES
• SINGLE_NODE_XPATH_RELATIVE_REFERENCES
• SINGLE_NODE_XPATH_ABSOLUTE_REFERENCES

getConverters

public List<String> getConverters()

setConverters

public void setConverters(List<String> converters)

List of class names for using custom XStream converters. The classes must be of type com.thoughtworks.xstream.converters.Converter

getAliases

public Map<String,String> getAliases()

setAliases

public void setAliases(Map<String,String> aliases)

Alias a Class to a shorter name to be used in XML elements.

getOmitFields

public Map<String,String[]> getOmitFields()

setOmitFields

public void setOmitFields(Map<String,String[]> omitFields)

Prevents a field from being serialized. To omit a field you must always provide the declaring type and not necessarily the type that is converted.

getImplicitCollections

public Map<String,String[]> getImplicitCollections()

setImplicitCollections

public void setImplicitCollections(Map<String,String[]> implicitCollections)

Adds a default implicit collection which is used for any unmapped XML tag.

getPermissions

public String getPermissions()

setPermissions

public void setPermissions(String permissions)

Adds permissions that controls which Java packages and classes XStream is allowed to use during unmarshal from xml/json to Java beans.

A permission must be configured either here or globally using a JVM system property. The permission can be specified in a syntax where a plus sign is allow, and minus sign is deny.
Wildcards is supported by using .* as prefix. For example to allow com.foo and all subpackages then specfy +com.foo.*. Multiple permissions can be configured separated by comma, such as +com.foo.*,-com.foo.bar.MySecretBean.
The following default permission is always included: "-*,java.lang.*,java.util.*" unless its overridden by specifying a JVM system property with they key org.apache.camel.xstream.permissions.

setPermissions

public void setPermissions(Class<?>... type)

To add permission for the given pojo classes.

Parameters:

type - the pojo class(es) xstream should use as allowed permission

See Also:

setPermissions(String)

createDataFormat

protected DataFormat createDataFormat(RouteContext routeContext)

Description copied from class: DataFormatDefinition

Factory method to create the data format instance

Overrides:

createDataFormat in class DataFormatDefinition

configureDataFormat

protected void configureDataFormat(DataFormat dataFormat,
                                   CamelContext camelContext)

Description copied from class: DataFormatDefinition

Allows derived classes to customize the data format

Overrides:

configureDataFormat in class DataFormatDefinition