Component docs

Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/62e03a73
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/62e03a73
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/62e03a73

Branch: refs/heads/master
Commit: 62e03a732166cce6dc88603ae30dce21c76c0781
Parents: 9d0c661
Author: Claus Ibsen <davscl...@apache.org>
Authored: Sat Aug 20 11:26:37 2016 +0200
Committer: Claus Ibsen <davscl...@apache.org>
Committed: Sat Aug 20 11:26:37 2016 +0200

----------------------------------------------------------------------
 .../src/main/docs/xstream-dataformat.adoc       | 27 ++++++++++++++++++++
 1 file changed, 27 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/62e03a73/components/camel-xstream/src/main/docs/xstream-dataformat.adoc
----------------------------------------------------------------------
diff --git a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc 
b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc
index 14ce541..ea7e217 100644
--- a/components/camel-xstream/src/main/docs/xstream-dataformat.adoc
+++ b/components/camel-xstream/src/main/docs/xstream-dataformat.adoc
@@ -22,6 +22,33 @@ Maven users will need to add the following dependency to 
their
 </dependency>
 ----------------------------------------------------------
 
+[[XStream-Options]]
+Options
+^^^^^^^
+
+// dataformat options: START
+The XStream dataformat supports 9 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,1m,6",options="header"]
+|=======================================================================
+| Name | Default | Java Type | Description
+| permissions |  | String | 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.
+| encoding |  | String | Sets the encoding to use
+| driver |  | String | To use a custom XStream driver. The instance must be of 
type com.thoughtworks.xstream.io.HierarchicalStreamDriver
+| driverRef |  | String | To refer to a custom XStream driver to lookup in the 
registry. The instance must be of type 
com.thoughtworks.xstream.io.HierarchicalStreamDriver
+| mode |  | String | 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
+| converters |  | List | List of class names for using custom XStream 
converters. The classes must be of type 
com.thoughtworks.xstream.converters.Converter
+| aliases |  | Map | Alias a Class to a shorter name to be used in XML 
elements.
+| omitFields |  | Map | 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.
+| implicitCollections |  | Map | Adds a default implicit collection which is 
used for any unmapped XML tag.
+|=======================================================================
+{% endraw %}
+// dataformat options: END
+
+
 [[XStream-UsingtheJavaDSL]]
 Using the Java DSL
 ^^^^^^^^^^^^^^^^^^

Reply via email to