You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/06/09 12:19:50 UTC
[1/8] camel git commit: Added camel-xmpp docs to Gitbook
Repository: camel
Updated Branches:
refs/heads/master 3bb6b4d4d -> 02a6a4ded
Added camel-xmpp docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/fc826723
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fc826723
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fc826723
Branch: refs/heads/master
Commit: fc82672354fa4e7e4907c724602d0c1ad56f55f5
Parents: 3bb6b4d
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 9 13:00:48 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 9 13:00:48 2016 +0200
----------------------------------------------------------------------
components/camel-xmpp/src/main/docs/xmpp.adoc | 165 +++++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 166 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/fc826723/components/camel-xmpp/src/main/docs/xmpp.adoc
----------------------------------------------------------------------
diff --git a/components/camel-xmpp/src/main/docs/xmpp.adoc b/components/camel-xmpp/src/main/docs/xmpp.adoc
new file mode 100644
index 0000000..62ffcc4
--- /dev/null
+++ b/components/camel-xmpp/src/main/docs/xmpp.adoc
@@ -0,0 +1,165 @@
+[[XMPP-XMPPComponent]]
+XMPP Component
+~~~~~~~~~~~~~~
+
+The *xmpp:* component implements an XMPP (Jabber) transport.
+
+Maven users will need to add the following dependency to their `pom.xml`
+for this component:
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-xmpp</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[XMPP-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,text]
+------------------------------------------------------
+xmpp://[login@]hostname[:port][/participant][?Options]
+------------------------------------------------------
+
+The component supports both room based and private person-person
+conversations. +
+ The component supports both producer and consumer (you can get messages
+from XMPP or send messages to XMPP). Consumer mode supports rooms
+starting.
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[XMPP-Options]]
+Options
+^^^^^^^
+
+
+// component options: START
+The XMPP component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The XMPP component supports 21 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| host | common | | String | *Required* Hostname for the chat server
+| port | common | | int | *Required* Port number for the chat server
+| participant | common | | String | JID (Jabber ID) of person to receive messages. room parameter has precedence over participant.
+| login | common | true | boolean | Whether to login the user.
+| nickname | common | | String | Use nickname when joining room. If room is specified and nickname is not user will be used for the nickname.
+| pubsub | common | false | boolean | Accept pubsub packets on input default is false
+| room | common | | String | If this option is specified the component will connect to MUC (Multi User Chat). Usually the domain name for MUC is different from the login domain. For example if you are supermanjabber.org and want to join the krypton room then the room URL is kryptonconference.jabber.org. Note the conference part. It is not a requirement to provide the full room JID. If the room parameter does not contain the symbol the domain part will be discovered and added by Camel
+| serviceName | common | | String | The name of the service you are connecting to. For Google Talk this would be gmail.com.
+| testConnectionOnStartup | common | true | boolean | Specifies whether to test the connection on startup. This is used to ensure that the XMPP client has a valid connection to the XMPP server when the route starts. Camel throws an exception on startup if a connection cannot be established. When this option is set to false Camel will attempt to establish a lazy connection when needed by a producer and will poll for a consumer connection until the connection is established. Default is true.
+| createAccount | common (advanced) | false | boolean | If true an attempt to create an account will be made. Default is false.
+| resource | common (advanced) | Camel | String | XMPP resource. The default is Camel.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| connectionPollDelay | consumer | 10 | int | The amount of time in seconds between polls (in seconds) to verify the health of the XMPP connection or between attempts to establish an initial consumer connection. Camel will try to re-establish a connection if it has become inactive. Default is 10 seconds.
+| doc | consumer | false | boolean | Set a doc header on the IN message containing a Document form of the incoming packet; default is true if presence or pubsub are true otherwise false
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| connectionConfig | advanced | | ConnectionConfiguration | To use an existing connection configuration
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+| password | security | | String | Password for login
+| user | security | | String | User name (without server name). If not specified anonymous login will be attempted.
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[XMPP-HeadersandsettingSubjectorLanguage]]
+Headers and setting Subject or Language
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Camel sets the message IN headers as properties on the XMPP message. You
+can configure a `HeaderFilterStategy` if you need custom filtering of
+headers.
+The *Subject* and *Language* of the XMPP message are also set if they
+are provided as IN headers.
+
+[[XMPP-Examples]]
+Examples
+^^^^^^^^
+
+User `superman` to join room `krypton` at `jabber` server with password,
+`secret`:
+
+[source,text]
+------------------------------------------------------------------------------
+xmpp://superman@jabber.org/?room=krypton@conference.jabber.org&password=secret
+------------------------------------------------------------------------------
+
+User `superman` to send messages to `joker`:
+
+[source,text]
+-----------------------------------------------------------
+xmpp://superman@jabber.org/joker@jabber.org?password=secret
+-----------------------------------------------------------
+
+Routing example in Java:
+
+[source,java]
+------------------------------------------------------------------
+from("timer://kickoff?period=10000").
+setBody(constant("I will win!\n Your Superman.")).
+to("xmpp://superman@jabber.org/joker@jabber.org?password=secret");
+------------------------------------------------------------------
+
+Consumer configuration, which writes all messages from `joker` into the
+queue, `evil.talk`.
+
+[source,java]
+--------------------------------------------------------------------
+from("xmpp://superman@jabber.org/joker@jabber.org?password=secret").
+to("activemq:evil.talk");
+--------------------------------------------------------------------
+
+Consumer configuration, which listens to room messages:
+
+[source,java]
+---------------------------------------------------------------------------------------
+from("xmpp://superman@jabber.org/?password=secret&room=krypton@conference.jabber.org").
+to("activemq:krypton.talk");
+---------------------------------------------------------------------------------------
+
+Room in short notation (no domain part):
+
+[source,java]
+-----------------------------------------------------------------
+from("xmpp://superman@jabber.org/?password=secret&room=krypton").
+to("activemq:krypton.talk");
+-----------------------------------------------------------------
+
+When connecting to the Google Chat service, you'll need to specify the
+`serviceName` as well as your credentials:
+
+[source,java]
+---------------------------------------------------------------------------------------------------------
+from("direct:start").
+ to("xmpp://talk.google.com:5222/touser@gmail.com?serviceName=gmail.com&user=fromuser&password=secret").
+ to("mock:result");
+---------------------------------------------------------------------------------------------------------
+
+�
+
+[[XMPP-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:configuring-camel.html[Configuring Camel]
+* link:component.html[Component]
+* link:endpoint.html[Endpoint]
+* link:getting-started.html[Getting Started]
+
http://git-wip-us.apache.org/repos/asf/camel/blob/fc826723/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index deeab44..4377518 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -273,6 +273,7 @@
* [Weather](weather.adoc)
* [Websocket](websocket.adoc)
* [XML Security](xmlsecurity.adoc)
+ * [XMPP](xmpp.adoc)
* [Yammer](yammer.adoc)
* [ZooKeeper](zookeeper.adoc)
[2/8] camel git commit: Added camel-xstream docs to Gitbook
Posted by ac...@apache.org.
Added camel-xstream docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/879fa603
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/879fa603
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/879fa603
Branch: refs/heads/master
Commit: 879fa6031660b589134ae3e08ba33f8b7a268c90
Parents: fc82672
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 9 13:06:29 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 9 13:06:29 2016 +0200
----------------------------------------------------------------------
.../camel-xstream/src/main/docs/xstream.adoc | 124 +++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 125 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/879fa603/components/camel-xstream/src/main/docs/xstream.adoc
----------------------------------------------------------------------
diff --git a/components/camel-xstream/src/main/docs/xstream.adoc b/components/camel-xstream/src/main/docs/xstream.adoc
new file mode 100644
index 0000000..14ce541
--- /dev/null
+++ b/components/camel-xstream/src/main/docs/xstream.adoc
@@ -0,0 +1,124 @@
+[[XStream-XStream]]
+XStream
+~~~~~~~
+
+XStream is a link:data-format.html[Data Format] which uses the
+http://xstream.codehaus.org/[XStream library] to marshal and unmarshal
+Java objects to and from XML.
+
+To use XStream in your camel routes you need to add the a dependency
+on�*camel-xstream*�which implements this data format.
+
+Maven users will need to add the following dependency to their
+`pom.xml`�for this component:
+
+[source,xml]
+----------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-xstream</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+----------------------------------------------------------
+
+[[XStream-UsingtheJavaDSL]]
+Using the Java DSL
+^^^^^^^^^^^^^^^^^^
+
+[source,java]
+-----------------------------------------------------------
+// lets turn Object messages into XML then send to MQSeries
+from("activemq:My.Queue").
+ marshal().xstream().
+ to("mqseries:Another.Queue");
+-----------------------------------------------------------
+
+If you would like to configure the `XStream` instance used by the Camel
+for the message transformation, you can simply pass a reference to that
+instance on the DSL level.
+
+[source,java]
+---------------------------------------------------------
+XStream xStream = new XStream();
+xStream.aliasField("money", PurchaseOrder.class, "cash");
+// new Added setModel option since Camel 2.14
+xStream.setModel("NO_REFERENCES");
+...
+
+from("direct:marshal").
+ marshal(new XStreamDataFormat(xStream)).
+ to("mock:marshaled");
+---------------------------------------------------------
+
+[[XStream-XMLInputFactoryandXMLOutputFactory]]
+XMLInputFactory and XMLOutputFactory
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+http://xstream.codehaus.org/[The XStream library] uses the
+`javax.xml.stream.XMLInputFactory` and
+`javax.xml.stream.XMLOutputFactory`, you can control which
+implementation of this factory should be used.
+
+The Factory is discovered using this algorithm:
+ 1. Use the `javax.xml.stream.XMLInputFactory` ,
+`javax.xml.stream.XMLOutputFactory` system property.
+ 2. Use the `lib/xml.stream.properties` file in the `JRE_HOME`
+directory.
+ 3. Use the Services API, if available, to determine the classname by
+looking in the `META-INF/services/javax.xml.stream.XMLInputFactory`,
+`META-INF/services/javax.xml.stream.XMLOutputFactory` files in jars
+available to the JRE.
+ 4. Use the platform default XMLInputFactory,XMLOutputFactory instance.
+
+[[XStream-HowtosettheXMLencodinginXstreamDataFormat]]
+How to set the XML encoding in Xstream DataFormat?
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+From Camel 2.2.0, you can set the encoding of XML in Xstream DataFormat
+by setting the Exchange's property with the key `Exchange.CHARSET_NAME`,
+or setting the encoding property on Xstream from DSL or Spring config.
+
+[source,java]
+-------------------------------
+from("activemq:My.Queue").
+ marshal().xstream("UTF-8").
+ to("mqseries:Another.Queue");
+-------------------------------
+
+[[XStream-SettingthetypepermissionsofXstreamDataFormat]]
+Setting the type permissions of Xstream DataFormat
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In Camel, one can always use its own processing step in the route to
+filter and block certain XML documents to be routed to the XStream's
+unmarhall step. From Camel 2.16.1, 2.15.5, you can
+set�http://x-stream.github.io/security.html[XStream's type
+permissions]�to automatically allow or deny the instantiation of certain
+types.
+
+The default type permissions setting used by Camel denies all types
+except for those from java.lang and java.util packages. This setting can
+be changed by setting System property
+org.apache.camel.xstream.permissions. Its value is a string of
+comma-separated permission terms, each representing a type being allowed
+or denied, depending on whether the term is prefixed with '+' (note '+'
+may be omitted) or with '-', respectively.
+
+Each term may contain a wildcard character '*'. For example, value
+"-*,java.lang.*,java.util.*" indicates denying all types except for
+java.lang.* and java.util.* classes. Setting this value to an empty
+string "" reverts to the default XStream's type permissions handling
+which denies certain blacklisted classes and allow others.
+
+The type permissions setting can be extended at an individual XStream
+DataFormat instance by setting its type permissions property.
+
+[source,java]
+-------------------------------------------------------------------
+ <dataFormats>
+ <xstream id="xstream-default"
+ permissions="org.apache.camel.samples.xstream.*"/>
+ ...
+
+-------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/879fa603/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 4377518..209a5dc 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -302,6 +302,7 @@
* [XML Beans](xmlbeans.adoc)
* [XML JSON](xmljson.adoc)
* [XML Rpc](xmlrpc.adoc)
+ * [XStream](xstream.adoc)
* [YAML](yaml.adoc)
* User Guide
[7/8] camel git commit: Components/Endpoints docs updated
Posted by ac...@apache.org.
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-cache/src/main/docs/cache.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cache/src/main/docs/cache.adoc b/components/camel-cache/src/main/docs/cache.adoc
index c0c2d6e..0183d48 100644
--- a/components/camel-cache/src/main/docs/cache.adoc
+++ b/components/camel-cache/src/main/docs/cache.adoc
@@ -45,12 +45,57 @@ You can append query options to the URI in the following format,
Options
^^^^^^^
+
// component options: START
+The EHCache component supports 3 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| cacheManagerFactory | CacheManagerFactory | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used.
+| configuration | CacheConfiguration | Sets the Cache configuration
+| configurationFile | String | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml
+|=======================================================================
+{% endraw %}
// component options: END
+
+
// endpoint options: START
+The EHCache component supports 20 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| cacheName | common | | String | *Required* Name of the cache
+| diskExpiryThreadIntervalSeconds | common | | long | The number of seconds between runs of the disk expiry thread.
+| diskPersistent | common | false | boolean | Whether the disk store persists between restarts of the application.
+| diskStorePath | common | | String | This parameter is ignored. CacheManager sets it using setter injection.
+| eternal | common | false | boolean | Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires.
+| key | common | | String | The default key to use. If a key is provided in the message header then the key from the header takes precedence.
+| maxElementsInMemory | common | 1000 | int | The number of elements that may be stored in the defined cache in memory.
+| memoryStoreEvictionPolicy | common | LFU | MemoryStoreEvictionPolicy | Which eviction strategy to use when maximum number of elements in memory is reached. The strategy defines which elements to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out
+| objectCache | common | false | boolean | Whether to turn on allowing to store non serializable objects in the cache. If this option is enabled then overflow to disk cannot be enabled as well.
+| operation | common | | String | The default cache operation to use. If an operation in the message header then the operation from the header takes precedence.
+| overflowToDisk | common | true | boolean | Specifies whether cache may overflow to disk
+| timeToIdleSeconds | common | 300 | long | The maximum amount of time between accesses before an element expires
+| timeToLiveSeconds | common | 300 | long | The maximum time between creation time and when an element expires. Is used only if the element is not eternal
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| cacheLoaderRegistry | advanced | | CacheLoaderRegistry | To configure cache loader using the CacheLoaderRegistry
+| cacheManagerFactory | advanced | | CacheManagerFactory | To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory configured on the component is used.
+| eventListenerRegistry | advanced | | CacheEventListenerRegistry | To configure event listeners using the CacheEventListenerRegistry
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
[[Cache-SendingReceivingMessagestofromthecache]]
Sending/Receiving Messages to/from the cache
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-chunk/src/main/docs/chunk.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chunk/src/main/docs/chunk.adoc b/components/camel-chunk/src/main/docs/chunk.adoc
index c0996b7..97b2efe 100644
--- a/components/camel-chunk/src/main/docs/chunk.adoc
+++ b/components/camel-chunk/src/main/docs/chunk.adoc
@@ -40,12 +40,34 @@ format,�`?option=value&option=value&...`
Options
^^^^^^^
+
// component options: START
+The Chunk component has no options.
// component options: END
+
+
// endpoint options: START
+The Chunk component supports 9 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| resourceUri | producer | | String | *Required* Path to the resource or a reference to lookup a bean in the Registry to use as the resource
+| contentCache | producer | false | boolean | Sets whether to use resource content cache or not
+| encoding | producer | | String | Define the encoding of the body
+| extension | producer | | String | Define the file extension of the template
+| themeFolder | producer | | String | Define the themes folder to scan
+| themeLayer | producer | | String | Define the theme layer to elaborate
+| themeSubfolder | producer | | String | Define the themes subfolder to scan
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
Chunk component will look for a specific template in _themes_ folder
with extensions _.chtml_ or _.cxml.�_If you need to specify a different
folder or extensions, you will need to use the specific options listed
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-cmis/src/main/docs/cmis.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cmis/src/main/docs/cmis.adoc b/components/camel-cmis/src/main/docs/cmis.adoc
index 3fc8bab..725bcfe 100644
--- a/components/camel-cmis/src/main/docs/cmis.adoc
+++ b/components/camel-cmis/src/main/docs/cmis.adoc
@@ -24,12 +24,31 @@ You can append query options to the URI in the following format,
CMIS Options
^^^^^^^^^^^^
+
// component options: START
+The CMIS component has no options.
// component options: END
+
+
// endpoint options: START
+The CMIS component supports 6 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| url | common | | String | *Required* the cmis url
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| queryMode | producer | false | boolean | If true will execute the cmis query from the message body and return result otherwise will create a node in the cmis repository
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
[[CMIS-Usage]]
Usage
^^^^^
[6/8] camel git commit: Added missing placeholder for options in
asciidoc files
Posted by ac...@apache.org.
Added missing placeholder for options in asciidoc files
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f4b66541
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f4b66541
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f4b66541
Branch: refs/heads/master
Commit: f4b66541376c1314d710dc0d25e7b453fec9efe4
Parents: b668016
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 9 14:11:36 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 9 14:11:36 2016 +0200
----------------------------------------------------------------------
.../camel-ahc-ws/src/main/docs/ahc-ws.adoc | 6 +
components/camel-amqp/src/main/docs/amqp.adoc | 6 +
components/camel-apns/src/main/docs/apns.adoc | 33 +--
.../src/main/docs/atmosphere-websocket.adoc | 10 +
components/camel-atom/src/main/docs/atom.adoc | 45 +---
components/camel-avro/src/main/docs/avro.adoc | 19 +-
.../camel-base64/src/main/docs/base64.adoc | 15 +-
.../src/main/docs/bean-validator.adoc | 21 +-
.../camel-beanio/src/main/docs/beanio.adoc | 22 +-
.../src/main/docs/beanstalk.adoc | 61 +----
components/camel-box/src/main/docs/box.adoc | 54 +++++
.../src/main/docs/braintree.adoc | 48 ++++
components/camel-cache/src/main/docs/cache.adoc | 78 +------
.../src/main/docs/cassandra.adoc | 213 -----------------
.../camel-cassandraql/src/main/docs/cql.adoc | 233 +++++++++++++++++++
.../camel-castor/src/main/docs/castor.adoc | 19 +-
components/camel-chunk/src/main/docs/chunk.adoc | 18 +-
components/camel-cmis/src/main/docs/cmis.adoc | 32 +--
18 files changed, 406 insertions(+), 527 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc b/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
index 0476bfb..326abaf 100644
--- a/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
+++ b/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
@@ -44,6 +44,12 @@ AHC-WS Options
As the AHC-WS component is based on the AHC component, you can use the
various configuration options of the AHC component.
+// component options: START
+// component options: END
+
+// endpoint options: START
+// endpoint options: END
+
[[AHC-WS-WritingandReadingDataoverWebsocket]]
Writing and Reading Data over Websocket
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-amqp/src/main/docs/amqp.adoc
----------------------------------------------------------------------
diff --git a/components/camel-amqp/src/main/docs/amqp.adoc b/components/camel-amqp/src/main/docs/amqp.adoc
index 1b84680..aa21287 100644
--- a/components/camel-amqp/src/main/docs/amqp.adoc
+++ b/components/camel-amqp/src/main/docs/amqp.adoc
@@ -38,6 +38,12 @@ AMQP Options
You can specify all of the various configuration options of the
link:../../../../camel-jms/src/main/docs/readme.html[JMS] component after the destination name.
+// component options: START
+// component options: END
+
+// endpoint options: START
+// endpoint options: END
+
[[AMQP-Usage]]
Usage
^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-apns/src/main/docs/apns.adoc
----------------------------------------------------------------------
diff --git a/components/camel-apns/src/main/docs/apns.adoc b/components/camel-apns/src/main/docs/apns.adoc
index ada0bae..b460d7e 100644
--- a/components/camel-apns/src/main/docs/apns.adoc
+++ b/components/camel-apns/src/main/docs/apns.adoc
@@ -54,36 +54,11 @@ apns:consumer[?options]
Options
^^^^^^^
-[[APNS-Producer]]
-Producer
-++++++++
+// component options: START
+// component options: END
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Property |Default |Description
-|`tokens` | |Empty by default. Configure this property in case you want to statically
-declare tokens related to devices you want to notify. Tokens are
-separated by comma.
-|=======================================================================
-
-[[APNS-Consumer]]
-Consumer
-++++++++
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Property |Default |Description
-|`delay` |`3600` |Delay in seconds between each poll.
-
-|`initialDelay` |`10` |Seconds before polling starts.
-
-|`timeUnit` |`SECONDS` |Time Unit for polling.
-
-|`userFixedDelay` |`true` |If `true`, use fixed delay between pools, otherwise fixed rate is used.
-See
-http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html[ScheduledExecutorService]
-in JDK for details.
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
You can append query options to the URI in the following format,
`?option=value&option=value&...`
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
index f0e7c33..6c4b111 100644
--- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
+++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
@@ -31,6 +31,16 @@ their�`pom.xml`�for this component:
</dependency>
------------------------------------------------------------
+[[Atmosphere-Websocket-Options]]
+Atmosphere-Websocket Options
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+// component options: START
+// component options: END
+
+// endpoint options: START
+// endpoint options: END
+
[[Atmosphere-Websocket-URIFormat]]
URI Format
^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-atom/src/main/docs/atom.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atom/src/main/docs/atom.adoc b/components/camel-atom/src/main/docs/atom.adoc
index 26f7cf7..7c50308 100644
--- a/components/camel-atom/src/main/docs/atom.adoc
+++ b/components/camel-atom/src/main/docs/atom.adoc
@@ -36,48 +36,11 @@ Where *atomUri* is the URI to the Atom feed to poll.
Options
^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Property |Default |Description
-|`splitEntries` |`true` |If `true` Camel will poll the feed and for the subsequent polls return
-each entry poll by poll. If the feed contains 7 entries then Camel will
-return the first entry on the first poll, the 2nd entry on the next
-poll, until no more entries where as Camel will do a new update on the
-feed. If `false` then Camel will poll a fresh feed on every invocation.
-
-|`filter` |`true` |Is only used by the split entries to filter the entries to return. Camel
-will default use the `UpdateDateFilter` that only return new entries
-from the feed. So the client consuming from the feed never receives the
-same entry more than once. The filter will return the entries ordered by
-the newest last.
-
-|`lastUpdate` |`null` |Is only used by the filter, as the starting timestamp for selection
-never entries (uses the `entry.updated` timestamp). Syntax format is:
-`yyyy-MM-ddTHH:MM:ss`. Example: `2007-12-24T17:45:59`.
-
-|`throttleEntries` |`true` |*Camel 2.5:* Sets whether all entries identified in a single feed poll
-should be delivered immediately. If `true`, only one entry is processed
-per `consumer.delay`. Only applicable when `splitEntries` is set to
-`true`.
-
-|`feedHeader` |`true` |Sets whether to add the Abdera Feed object as a header.
+// component options: START
+// component options: END
-|`sortEntries` |`false` |If `splitEntries` is `true`, this sets whether to sort those entries by
-updated date.
-
-|`consumer.delay` |`500` |Delay in millis between each poll.
-
-|`consumer.initialDelay` |`1000` |Millis before polling starts.
-
-|`consumer.userFixedDelay` |`false` |If `true`, use fixed delay between pools, otherwise fixed rate is used.
-See
-http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html[ScheduledExecutorService]
-in JDK for details.
-
-|`username` | | *Camel 2.16:* For basic authentication when polling from a HTTP feed
-
-|`password` | | *Camel 2.16:* For basic authentication when polling from a HTTP feed
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
You can append query options to the URI in the following format,
`?option=value&option=value&...`
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-avro/src/main/docs/avro.adoc
----------------------------------------------------------------------
diff --git a/components/camel-avro/src/main/docs/avro.adoc b/components/camel-avro/src/main/docs/avro.adoc
index 2bd0f77..540e4cf 100644
--- a/components/camel-avro/src/main/docs/avro.adoc
+++ b/components/camel-avro/src/main/docs/avro.adoc
@@ -176,22 +176,11 @@ wrapping.
Avro RPC URI Options
^^^^^^^^^^^^^^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Version |Description
-|`protocolClassName`| | The class name of the avro protocol.
-
-|`singleParameter` |2.12 |If true, consumer parameter won't be wrapped into array. Will fail if
-protocol specifies more then 1 parameter for the message
+// component options: START
+// component options: END
-|`protocol` | | Avro protocol object. Can be used instead of `protocolClassName` when
-complex protocol needs to be created. One cane used #name notation to
-refer beans from the Registry
-
-|`reflectionProtocol` |2.12 |If protocol object provided is reflection protocol. Should be used only
-with `protocol` parameter because for `protocolClassName` protocol type
-will be autodetected
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
[[avro-AvroRPCHeaders]]
Avro RPC Headers
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-base64/src/main/docs/base64.adoc
----------------------------------------------------------------------
diff --git a/components/camel-base64/src/main/docs/base64.adoc b/components/camel-base64/src/main/docs/base64.adoc
index 4931808..dec53c5 100644
--- a/components/camel-base64/src/main/docs/base64.adoc
+++ b/components/camel-base64/src/main/docs/base64.adoc
@@ -10,18 +10,11 @@ http://en.wikipedia.org/wiki/Base64[base64 encoding and decoding].
Options
^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Option |Default |Description
+// component options: START
+// component options: END
-|lineLength |76 |To specific a maximum line length for the encoded data.
-
-|lineSeparator |\r\n |The line separators to use.
-
-|urlSafe |`false` |Instead of emitting '+' and '/' we emit '-' and '_' respectively.
-urlSafe is only applied to encode operations. Decoding seamlessly
-handles both modes.
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
In Spring DSL, you configure the data format using this tag:
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-bean-validator/src/main/docs/bean-validator.adoc
----------------------------------------------------------------------
diff --git a/components/camel-bean-validator/src/main/docs/bean-validator.adoc b/components/camel-bean-validator/src/main/docs/bean-validator.adoc
index bd19b79..9d8c515 100644
--- a/components/camel-bean-validator/src/main/docs/bean-validator.adoc
+++ b/components/camel-bean-validator/src/main/docs/bean-validator.adoc
@@ -47,25 +47,12 @@ Where *label* is an arbitrary text value describing the endpoint. +
[[BeanValidator-URIOptions]]
URI Options
^^^^^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Option |Default |Description
-|`group` |`javax.validation.groups.Default` |The custom validation group to use.
+// component options: START
+// component options: END
-|`validationProviderResolver` |Depends on JSR303 jar provided. |Camel *2.13.0*: Reference to a custom
-`javax.validation.ValidationProviderResolver` in the
-link:registry.html[Registry].
-
-|`messageInterpolator` |`org.hibernate.validator.engine.ResourceBundleMessageInterpolator` |Reference to a custom `javax.validation.MessageInterpolator` in the
-link:registry.html[Registry].
-
-|`traversableResolver` |`org.hibernate.validator.engine.resolver.DefaultTraversableResolver` |Reference to a custom `javax.validation.TraversableResolver` in the
-link:registry.html[Registry].
-
-|`constraintValidatorFactory` |`org.hibernate.validator.engine.ConstraintValidatorFactoryImpl` |Reference to a custom `javax.validation.ConstraintValidatorFactory` in
-the link:registry.html[Registry].
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
[[BeanValidator-OSGideployment]]
OSGi deployment
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-beanio/src/main/docs/beanio.adoc
----------------------------------------------------------------------
diff --git a/components/camel-beanio/src/main/docs/beanio.adoc b/components/camel-beanio/src/main/docs/beanio.adoc
index 6d5b4a1..93f45d7 100644
--- a/components/camel-beanio/src/main/docs/beanio.adoc
+++ b/components/camel-beanio/src/main/docs/beanio.adoc
@@ -16,26 +16,12 @@ XML] file where you define the mapping from the flat format to Objects
[[BeanIO-Options]]
Options
^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Option |Default |Description
-|mapping | | The BeanIO mapping file. The option is mandatory. Is by default loaded
-from the classpath. You can prefix with `file:`, `http:`, or
-`classpath:` to denote from where to load the mapping file.
+// component options: START
+// component options: END
-|streamName | |The name of the stream to use. This option is mandatory.
-
-|ignoreUnidentifiedRecords |`false` |Whether to ignore unidentified records.
-
-|ignoreUnexpectedRecords |`false` |Whether to ignore unexpected records.
-
-|ignoreInvalidRecords |`false` |Whether to ignore invalid records.
-
-|encoding |Platform default |The charset to use.
-
-|beanReaderErrorHandler | |A custom BeanReaderErrorHandler implementation to use in your dataformat definition
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
[[BeanIO-Usage]]
Usage
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-beanstalk/src/main/docs/beanstalk.adoc
----------------------------------------------------------------------
diff --git a/components/camel-beanstalk/src/main/docs/beanstalk.adoc b/components/camel-beanstalk/src/main/docs/beanstalk.adoc
index a1df59b..8f6b2c3 100644
--- a/components/camel-beanstalk/src/main/docs/beanstalk.adoc
+++ b/components/camel-beanstalk/src/main/docs/beanstalk.adoc
@@ -58,54 +58,19 @@ details here].
By the way, you cannot specify several tubes when you are writing jobs
into Beanstalk.
-[[Beanstalk-CommonURIoptions]]
-Common URI options
-^^^^^^^^^^^^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Default value |Description
-
-|jobPriority |1000 |Job priority. (0 is the highest,
-see�http://github.com/kr/beanstalkd/blob/v1.3/doc/protocol.txt[Beanstalk
-protocol])
-
-|jobDelay |0 |Job delay in seconds.
-
-|jobTimeToRun |60 |Job time to run in seconds. (when 0, the beanstalkd daemon raises it to
-1 automatically,
-see�http://github.com/kr/beanstalkd/blob/v1.3/doc/protocol.txt[Beanstalk
-protocol])
+[[Beanstalk-options]]
+Beanstalk options
+^^^^^^^^^^^^^^^^^
-|=======================================================================
-�
+// component options: START
+// component options: END
-[[Beanstalk-ProducerUIRoptions]]
-Producer URI options
-^^^^^^^^^^^^^^^^^^^^
+// endpoint options: START
+// endpoint options: END
Producer�behavior�is affected by the�`command`�parameter which tells
what to do with the job, it can be
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Default value |Description
-
-|command |put |* `put`�means to put the job into Beanstalk. Job body is specified in
-the Camel message body. Job ID will be returned
-in�_beanstalk.jobId_�message header.
-* `delete`,�`release`,�`touch`�or�`bury`�expect Job ID in the message
-header�_beanstalk.jobId_. Result of the operation is returned
-in�_beanstalk.result_�message header
-* `kick`�expects the number of jobs to kick in the message body and
-returns the number of jobs actually kicked out in the message
-header�_beanstalk.result_.
-|=======================================================================
-�
-
-[[Beanstalk-ConsumerUIRoptions]]
-Consumer UIR options
-^^^^^^^^^^^^^^^^^^^^
-
The consumer may delete the job immediately after reserving it or wait
until Camel routes process it. While the first scenario is more like a
\u201cmessage queue\u201d, the second is similar to \u201cjob queue\u201d. This behavior is
@@ -126,18 +91,6 @@ Be careful when specifying�`release`, as the failed job will immediately
become available in the same tube and your consumer will try to acquire
it again. You can�`release`�and specify�_jobDelay_�though.
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Default value |Description
-
-|onFailure |bury |Command to use when processing failed. You can choose among: bury,
-delete or release.
-
-|useBlockIO |true |Whether to use blockIO.
-
-|awaitJob |true |Whether to wait for job to complete before ack the job from beanstalk
-|=======================================================================
-
The beanstalk consumer is a�Scheduled�link:polling-consumer.html[Polling
Consumer] which means there is more options you can configure, such as
how frequent the consumer should poll. For more details
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-box/src/main/docs/box.adoc
----------------------------------------------------------------------
diff --git a/components/camel-box/src/main/docs/box.adoc b/components/camel-box/src/main/docs/box.adoc
index 5414704..dc28888 100644
--- a/components/camel-box/src/main/docs/box.adoc
+++ b/components/camel-box/src/main/docs/box.adoc
@@ -33,6 +33,60 @@ for this component:
</dependency>
-------------------------------------------
+[[Box-Options]]
+Box Options
+^^^^^^^^^^^
+
+
+// component options: START
+The Box component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| configuration | BoxConfiguration | To use the shared configuration
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+// endpoint options: START
+The Box component supports 21 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| apiName | common | | BoxApiName | *Required* What kind of operation to perform
+| methodName | common | | String | *Required* What sub operation to use for the selected operation
+| clientId | common | | String | Box application client ID
+| clientSecret | common | | String | Box application client secret
+| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body
+| loginTimeout | common | 30 | int | Amount of time the component will wait for a response from Box.com default is 30 seconds
+| revokeOnShutdown | common | false | boolean | Flag to revoke OAuth refresh token on route shutdown default false. Will require a fresh refresh token on restart using either a custom IAuthSecureStorage or automatic component login by providing a user password
+| sharedLink | common | | String | Box shared link for shared endpoints can be a link for a shared comment file or folder
+| sharedPassword | common | | String | Password associated with the shared link MUST be provided with sharedLink
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| boxConfig | advanced | | IBoxConfig | Custom Box SDK configuration not required normally
+| connectionManagerBuilder | advanced | | BoxConnectionManagerBuilder | Custom Box connection manager builder used to override default settings like max connections for underlying HttpClient.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| httpParams | advanced | | Map | Custom HTTP params for settings like proxy host
+| refreshListener | advanced | | OAuthRefreshListener | OAuth listener for token updates if the Camel application needs to use the access token outside the route
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| authSecureStorage | security | | IAuthSecureStorage | OAuth Secure Storage callback can be used to provide and or save OAuth tokens. The callback may return null on first call to allow the component to login and authorize application and obtain an OAuth token which can then be saved in the secure storage. For the component to be able to create a token automatically a user password must be provided.
+| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters.
+| userName | security | | String | Box user name MUST be provided
+| userPassword | security | | String | Box user password MUST be provided if authSecureStorage is not set or returns null on first call
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
[[Box-URIformat]]
URI format
^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-braintree/src/main/docs/braintree.adoc
----------------------------------------------------------------------
diff --git a/components/camel-braintree/src/main/docs/braintree.adoc b/components/camel-braintree/src/main/docs/braintree.adoc
index ee8f2ea..3d5e435 100644
--- a/components/camel-braintree/src/main/docs/braintree.adoc
+++ b/components/camel-braintree/src/main/docs/braintree.adoc
@@ -31,6 +31,54 @@ for this component:
�
+[[Braintree-Options]]
+Braintree Options
+^^^^^^^^^^^^^^^^^
+
+
+// component options: START
+The Braintree component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| configuration | BraintreeConfiguration | To use the shared configuration
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+// endpoint options: START
+The Braintree component supports 15 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| apiName | common | | BraintreeApiName | *Required* What kind of operation to perform
+| methodName | common | | String | What sub operation to use for the selected operation
+| environment | common | | String | *Required* The environment Either SANDBOX or PRODUCTION
+| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body
+| merchantId | common | | String | *Required* The merchant id provided by Braintree.
+| privateKey | common | | String | *Required* The private key provided by Braintree.
+| publicKey | common | | String | *Required* The public key provided by Braintree.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| httpReadTimeout | advanced | | Integer | Set read timeout for http calls.
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| httpLogLevel | logging | | String | Set logging level for http calls see java.util.logging.Level
+| proxyHost | proxy | | String | The proxy host
+| proxyPort | proxy | | Integer | The proxy port
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
[[Braintree-URIformat]]
URI format
^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-cache/src/main/docs/cache.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cache/src/main/docs/cache.adoc b/components/camel-cache/src/main/docs/cache.adoc
index 7e19032..c0c2d6e 100644
--- a/components/camel-cache/src/main/docs/cache.adoc
+++ b/components/camel-cache/src/main/docs/cache.adoc
@@ -45,81 +45,11 @@ You can append query options to the URI in the following format,
Options
^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Default Value |Description
-
-|`maxElementsInMemory` |`1000` |The number of elements that may be stored in the defined cache
-
-|`memoryStoreEvictionPolicy` |`MemoryStoreEvictionPolicy.LFU` |The number of elements that may be stored in the defined cache. Options
-include
-
-* MemoryStoreEvictionPolicy.LFU - Least frequently used
-* MemoryStoreEvictionPolicy.LRU - Least recently used
-* MemoryStoreEvictionPolicy.FIFO - first in first out, the oldest
-element by creation time
-
-|`overflowToDisk` |`true` |Specifies whether cache may overflow to disk
-
-|`eternal` |`false` |Sets whether elements are eternal. If eternal, timeouts are ignored and
-the +
- element never expires.
-
-|`timeToLiveSeconds` |`300` |The maximum time between creation time and when an element expires. +
- Is used only if the element is not eternal
-
-|`timeToIdleSeconds` |`300` |The maximum amount of time between accesses before an element expires
-
-|`diskPersistent` |`false` |Whether the disk store persists between restarts of the Virtual Machine.
-
-|`diskExpiryThreadIntervalSeconds` |`120` |The number of seconds between runs of the disk expiry thread.
-
-|`cacheManagerFactory` |`null` |*Camel 2.8:* If you want to use a custom factory which instantiates and
-creates the EHCache `net.sf.ehcache.CacheManager`.
- _Type:_ abstract org.apache.camel.component.cache.CacheManagerFactory
-
-|`eventListenerRegistry` |`null` |*Camel 2.8:* Sets a list of EHCache
-`net.sf.ehcache.event.CacheEventListener` for all new caches- no need to
-define it per cache in EHCache xml config anymore.
- _Type:_ org.apache.camel.component.cache.CacheEventListenerRegistry
+// component options: START
+// component options: END
-|`cacheLoaderRegistry` |`null` |*Camel 2.8:* Sets a list of
-`org.apache.camel.component.cache.CacheLoaderWrapper` that extends
-EHCache `net.sf.ehcache.loader.CacheLoader` for all new caches- no need
-to define it per cache in EHCache xml config anymore.
- _Type:_ org.apache.camel.component.cache.CacheLoaderRegistry
-
-|`key` |`null` |*Camel 2.10:* To configure using a cache key by default. If a key is
-provided in the message header, then the key from the header takes
-precedence.
-
-|`operation` |`null` |*Camel 2.10:* To configure using an cache operation by default. If an
-operation in the message header, then the operation from the header
-takes precedence.
-
-|`objectCache` |`false` |*Camel 2.15:* Whether to turn on allowing to store non serializable
-objects in the cache. If this option is enabled then overflow to disk
-cannot be enabled as well.
-|=======================================================================
-
-[[Cache-CacheComponentoptions]]
-Cache Component options
-^^^^^^^^^^^^^^^^^^^^^^^
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Default Value |Description
-
-|`configuration` | | To use a custom `org.apache.camel.component.cache.CacheConfiguration`
-configuration.
-
-|`cacheManagerFactory` | | To use a custom `org.apache.camel.component.cache.CacheManagerFactory`.
-
-|`configurationFile` | | *Camel 2.13/2.12.3:* To configure the location of the `ehcache.xml` file
-to use, such as `classpath:com/foo/mycache.xml` to load from classpath.
-If no configuration is given, then the default settings from EHCache is
-used.
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
[[Cache-SendingReceivingMessagestofromthecache]]
Sending/Receiving Messages to/from the cache
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-cassandraql/src/main/docs/cassandra.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cassandraql/src/main/docs/cassandra.adoc b/components/camel-cassandraql/src/main/docs/cassandra.adoc
deleted file mode 100644
index fe0aad1..0000000
--- a/components/camel-cassandraql/src/main/docs/cassandra.adoc
+++ /dev/null
@@ -1,213 +0,0 @@
-[[Cassandra-CamelCassandraComponent]]
-Camel Cassandra Component
--------------------------
-
-*Available as of Camel 2.15*
-
-http://cassandra.apache.org[Apache Cassandra] is an open source NoSQL
-database designed to handle large amounts on commodity hardware. Like
-Amazon's DynamoDB, Cassandra has a peer-to-peer and master-less
-architecture to avoid single point of failure and garanty high
-availability. Like Google's BigTable, Cassandra data is structured using
-column families which can be accessed through the Thrift RPC API or a
-SQL-like API called CQL.
-
-This component aims at integrating Cassandra 2.0+ using the CQL3 API
-(not the Thrift API). It's based on
-https://github.com/datastax/java-driver[Cassandra Java Driver] provided
-by DataStax.
-
-Maven users will need to add the following dependency to their
-`pom.xml`:
-
-*pom.xml*
-
-[source,xml]
-------------------------------------------------------------
-<dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-cassandraql</artifactId>
- <version>x.y.z</version>
- <!-- use the same version as your Camel core version -->
-</dependency>
-------------------------------------------------------------
-
-[[Cassandra-URIformat]]
-URI format
-~~~~~~~~~~
-
-The endpoint can initiate the Cassandra connection or use an existing
-one.
-
-[cols="<,<",options="header",]
-|======================================================================
-|URI |Description
-|`cql:localhost/keyspace` |Single host, default port, usual for testing
-|`cql:host1,host2/keyspace` |Multi host, default port
-|`cql:host1,host2:9042/keyspace` |Multi host, custom port
-|`cql:host1,host2` |Default port and keyspace
-|`cql:bean:sessionRef` |Provided Session reference
-|`cql:bean:clusterRef/keyspace` |Provided Cluster reference
-|======================================================================
-
-To fine tune the Cassandra connection (SSL options, pooling options,
-load balancing policy, retry policy, reconnection policy...), create
-your own Cluster instance and give it to the Camel endpoint.
-
-[[Cassandra-EndpointOptions]]
-Endpoint Options
-~~~~~~~~~~~~~~~~
-
-[width="100%",cols="<34%,<33%,<33%",options="header",]
-|=======================================================================
-|Option |Default |Description
-|`clusterName` |� |Cluster name
-
-|`username and password` |� |Session authentication
-
-|`cql` |� |CQL query. Can be overriden with a message header.
-
-|`consistencyLevel` |� |`ANY`, `ONE`, `TWO`, `QUORUM`, `LOCAL_QUORUM`...
-
-|`prepareStatements` |`true` |Use prepared statement (default) or not
-
-|`resultSetConversionStrategy` |`ALL` |How is ResultSet converted
-transformed into message body `ALL`, `ONE`, `LIMIT_10`, `LIMIT_100`...
-|=======================================================================
-
-[[Cassandra-Messages]]
-Messages
-~~~~~~~~
-
-[[Cassandra-IncomingMessage]]
-Incoming Message
-^^^^^^^^^^^^^^^^
-
-The Camel Cassandra endpoint expects a bunch of simple objects (`Object`
-or `Object[]` or `Collection<Object>`) which will be bound to the CQL
-statement as query parameters. If message body is null or empty, then�
-CQL query will be executed without binding parameters.
-
-Headers:
-
-* `CamelCqlQuery` (optional, `String` or `RegularStatement`): CQL query
-either as a plain String or built using the `QueryBuilder`.
-
-[[Cassandra-OutgoingMessage]]
-Outgoing Message
-^^^^^^^^^^^^^^^^
-
-The Camel Cassandra endpoint produces one or many a Cassandra Row
-objects depending on the�`resultSetConversionStrategy`:
-
-�
-
-* `List<Row>` if `resultSetConversionStrategy` is `ALL` or
-`LIMIT_[0-9]+`
-* Single` Row` if `resultSetConversionStrategy` is `ONE`
-* Anything else, if `resultSetConversionStrategy` is a custom
-implementation of the `ResultSetConversionStrategy`
-
-[[Cassandra-Repositories]]
-Repositories
-~~~~~~~~~~~~
-
-Cassandra can be used to store message keys or messages for the
-idempotent and aggregation EIP.
-
-Cassandra might not be the best tool for queuing use cases yet, read
-http://www.datastax.com/dev/blog/cassandra-anti-patterns-queues-and-queue-like-datasets[Cassandra
-anti-patterns queues and queue like datasets]. It's advised to use
-LeveledCompaction and a small GC grace setting for these tables to allow
-tombstoned rows to be removed quickly.
-
-[[Cassandra-Idempotentrepository]]
-Idempotent repository
-^^^^^^^^^^^^^^^^^^^^^
-
-The `NamedCassandraIdempotentRepository` stores messages keys in a
-Cassandra table like this:
-
-*CAMEL_IDEMPOTENT.cql*
-
-[source,sql]
----------------------------------------------------------
-CREATE TABLE CAMEL_IDEMPOTENT (
- NAME varchar, -- Repository name
- KEY varchar, -- Message key
- PRIMARY KEY (NAME, KEY)
-) WITH compaction = {'class':'LeveledCompactionStrategy'}
- AND gc_grace_seconds = 86400;
----------------------------------------------------------
-
-This repository implementation uses lightweight transactions (also known
-as Compare and Set) and requires Cassandra 2.0.7+.
-
-Alternatively, the `CassandraIdempotentRepository` does not have a
-`NAME` column and can be extended to use a different data model.
-
-[width="100%",cols="<34%,<33%,<33%",options="header",]
-|=======================================================================
-|Option |Default |Description
-
-|`table` |`CAMEL_IDEMPOTENT` |Table name
-
-|`pkColumns` |`NAME`,` KEY` |Primary key columns
-
-|`name` | | Repository name, value used for `NAME` column
-
-|`ttl` | | Key time to live
-
-|`writeConsistencyLevel` | | Consistency level used to insert/delete key: `ANY`, `ONE`, `TWO`,
-`QUORUM`, `LOCAL_QUORUM`\u2026
-
-|`readConsistencyLevel` | | Consistency level used to read/check key: `ONE`, `TWO`, `QUORUM`,
-`LOCAL_QUORUM`\u2026
-|=======================================================================
-
-[[Cassandra-Aggregationrepository]]
-Aggregation repository
-^^^^^^^^^^^^^^^^^^^^^^
-
-The `NamedCassandraAggregationRepository` stores exchanges by
-correlation key in a Cassandra table like this:
-
-*CAMEL_AGGREGATION.cql*
-
-[source,sql]
----------------------------------------------------------
-CREATE TABLE CAMEL_AGGREGATION (
- NAME varchar, -- Repository name
- KEY varchar, -- Correlation id
- EXCHANGE_ID varchar, -- Exchange id
- EXCHANGE blob, -- Serialized exchange
- PRIMARY KEY (NAME, KEY)
-) WITH compaction = {'class':'LeveledCompactionStrategy'}
- AND gc_grace_seconds = 86400;
----------------------------------------------------------
-
-Alternatively, the `CassandraAggregationRepository` does not have a
-`NAME` column and can be extended to use a different data model.
-
-[width="100%",cols="<34%,<33%,<33%",options="header",]
-|=======================================================================
-|Option |Default |Description
-
-|`table` |`CAMEL_AGGREGATION` |Table name
-
-|`pkColumns` |`NAME`,`KEY` |Primary key columns
-
-|`exchangeIdColumn` |`EXCHANGE_ID` |Exchange Id column
-
-|`exchangeColumn` |`EXCHANGE` |Exchange content column
-
-|`name` | | Repository name, value used for `NAME` column
-
-|`ttl` | | Exchange time to live
-
-|`writeConsistencyLevel` | | Consistency level used to insert/delete exchange: `ANY`, `ONE`, `TWO`,
-`QUORUM`, `LOCAL_QUORUM`\u2026
-
-|`readConsistencyLevel` | | Consistency level used to read/check exchange: `ONE`, `TWO`, `QUORUM`,
-`LOCAL_QUORUM`\u2026
-|=======================================================================
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-cassandraql/src/main/docs/cql.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cassandraql/src/main/docs/cql.adoc b/components/camel-cassandraql/src/main/docs/cql.adoc
new file mode 100644
index 0000000..f166cac
--- /dev/null
+++ b/components/camel-cassandraql/src/main/docs/cql.adoc
@@ -0,0 +1,233 @@
+[[Cassandra-CamelCassandraComponent]]
+Camel Cassandra Component
+-------------------------
+
+*Available as of Camel 2.15*
+
+http://cassandra.apache.org[Apache Cassandra] is an open source NoSQL
+database designed to handle large amounts on commodity hardware. Like
+Amazon's DynamoDB, Cassandra has a peer-to-peer and master-less
+architecture to avoid single point of failure and garanty high
+availability. Like Google's BigTable, Cassandra data is structured using
+column families which can be accessed through the Thrift RPC API or a
+SQL-like API called CQL.
+
+This component aims at integrating Cassandra 2.0+ using the CQL3 API
+(not the Thrift API). It's based on
+https://github.com/datastax/java-driver[Cassandra Java Driver] provided
+by DataStax.
+
+Maven users will need to add the following dependency to their
+`pom.xml`:
+
+*pom.xml*
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-cassandraql</artifactId>
+ <version>x.y.z</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[Cassandra-URIformat]]
+URI format
+~~~~~~~~~~
+
+The endpoint can initiate the Cassandra connection or use an existing
+one.
+
+[cols="<,<",options="header",]
+|======================================================================
+|URI |Description
+|`cql:localhost/keyspace` |Single host, default port, usual for testing
+|`cql:host1,host2/keyspace` |Multi host, default port
+|`cql:host1,host2:9042/keyspace` |Multi host, custom port
+|`cql:host1,host2` |Default port and keyspace
+|`cql:bean:sessionRef` |Provided Session reference
+|`cql:bean:clusterRef/keyspace` |Provided Cluster reference
+|======================================================================
+
+To fine tune the Cassandra connection (SSL options, pooling options,
+load balancing policy, retry policy, reconnection policy...), create
+your own Cluster instance and give it to the Camel endpoint.
+
+[[Cassandra-Options]]
+Cassandra Options
+~~~~~~~~~~~~~~~~~
+
+
+// component options: START
+The Cassandra CQL component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The Cassandra CQL component supports 18 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| beanRef | common | | String | beanRef is defined using bean:id
+| hosts | common | | String | Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma.
+| port | common | | Integer | Port number of cassansdra server(s)
+| keyspace | common | | String | Keyspace to use
+| cluster | common | | Cluster | To use the Cluster instance (you would normally not use this option)
+| clusterName | common | | String | Cluster name
+| consistencyLevel | common | | ConsistencyLevel | Consistency level to use
+| cql | common | | String | CQL query to perform. Can be overridden with the message header with key CamelCqlQuery.
+| loadBalancingPolicy | common | | String | To use a specific LoadBalancingPolicy
+| password | common | | String | Password for session authentication
+| prepareStatements | common | true | boolean | Whether to use PreparedStatements or regular Statements
+| resultSetConversionStrategy | common | | String | To use a custom class that implements logic for converting ResultSet into message body ALL ONE LIMIT_10 LIMIT_100...
+| session | common | | Session | To use the Session instance (you would normally not use this option)
+| username | common | | String | Username for session authentication
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+[[Cassandra-Messages]]
+Messages
+~~~~~~~~
+
+[[Cassandra-IncomingMessage]]
+Incoming Message
+^^^^^^^^^^^^^^^^
+
+The Camel Cassandra endpoint expects a bunch of simple objects (`Object`
+or `Object[]` or `Collection<Object>`) which will be bound to the CQL
+statement as query parameters. If message body is null or empty, then�
+CQL query will be executed without binding parameters.
+
+Headers:
+
+* `CamelCqlQuery` (optional, `String` or `RegularStatement`): CQL query
+either as a plain String or built using the `QueryBuilder`.
+
+[[Cassandra-OutgoingMessage]]
+Outgoing Message
+^^^^^^^^^^^^^^^^
+
+The Camel Cassandra endpoint produces one or many a Cassandra Row
+objects depending on the�`resultSetConversionStrategy`:
+
+�
+
+* `List<Row>` if `resultSetConversionStrategy` is `ALL` or
+`LIMIT_[0-9]+`
+* Single` Row` if `resultSetConversionStrategy` is `ONE`
+* Anything else, if `resultSetConversionStrategy` is a custom
+implementation of the `ResultSetConversionStrategy`
+
+[[Cassandra-Repositories]]
+Repositories
+~~~~~~~~~~~~
+
+Cassandra can be used to store message keys or messages for the
+idempotent and aggregation EIP.
+
+Cassandra might not be the best tool for queuing use cases yet, read
+http://www.datastax.com/dev/blog/cassandra-anti-patterns-queues-and-queue-like-datasets[Cassandra
+anti-patterns queues and queue like datasets]. It's advised to use
+LeveledCompaction and a small GC grace setting for these tables to allow
+tombstoned rows to be removed quickly.
+
+[[Cassandra-Idempotentrepository]]
+Idempotent repository
+^^^^^^^^^^^^^^^^^^^^^
+
+The `NamedCassandraIdempotentRepository` stores messages keys in a
+Cassandra table like this:
+
+*CAMEL_IDEMPOTENT.cql*
+
+[source,sql]
+---------------------------------------------------------
+CREATE TABLE CAMEL_IDEMPOTENT (
+ NAME varchar, -- Repository name
+ KEY varchar, -- Message key
+ PRIMARY KEY (NAME, KEY)
+) WITH compaction = {'class':'LeveledCompactionStrategy'}
+ AND gc_grace_seconds = 86400;
+---------------------------------------------------------
+
+This repository implementation uses lightweight transactions (also known
+as Compare and Set) and requires Cassandra 2.0.7+.
+
+Alternatively, the `CassandraIdempotentRepository` does not have a
+`NAME` column and can be extended to use a different data model.
+
+[width="100%",cols="<34%,<33%,<33%",options="header",]
+|=======================================================================
+|Option |Default |Description
+
+|`table` |`CAMEL_IDEMPOTENT` |Table name
+
+|`pkColumns` |`NAME`,` KEY` |Primary key columns
+
+|`name` | | Repository name, value used for `NAME` column
+
+|`ttl` | | Key time to live
+
+|`writeConsistencyLevel` | | Consistency level used to insert/delete key: `ANY`, `ONE`, `TWO`,
+`QUORUM`, `LOCAL_QUORUM`\u2026
+
+|`readConsistencyLevel` | | Consistency level used to read/check key: `ONE`, `TWO`, `QUORUM`,
+`LOCAL_QUORUM`\u2026
+|=======================================================================
+
+[[Cassandra-Aggregationrepository]]
+Aggregation repository
+^^^^^^^^^^^^^^^^^^^^^^
+
+The `NamedCassandraAggregationRepository` stores exchanges by
+correlation key in a Cassandra table like this:
+
+*CAMEL_AGGREGATION.cql*
+
+[source,sql]
+---------------------------------------------------------
+CREATE TABLE CAMEL_AGGREGATION (
+ NAME varchar, -- Repository name
+ KEY varchar, -- Correlation id
+ EXCHANGE_ID varchar, -- Exchange id
+ EXCHANGE blob, -- Serialized exchange
+ PRIMARY KEY (NAME, KEY)
+) WITH compaction = {'class':'LeveledCompactionStrategy'}
+ AND gc_grace_seconds = 86400;
+---------------------------------------------------------
+
+Alternatively, the `CassandraAggregationRepository` does not have a
+`NAME` column and can be extended to use a different data model.
+
+[width="100%",cols="<34%,<33%,<33%",options="header",]
+|=======================================================================
+|Option |Default |Description
+
+|`table` |`CAMEL_AGGREGATION` |Table name
+
+|`pkColumns` |`NAME`,`KEY` |Primary key columns
+
+|`exchangeIdColumn` |`EXCHANGE_ID` |Exchange Id column
+
+|`exchangeColumn` |`EXCHANGE` |Exchange content column
+
+|`name` | | Repository name, value used for `NAME` column
+
+|`ttl` | | Exchange time to live
+
+|`writeConsistencyLevel` | | Consistency level used to insert/delete exchange: `ANY`, `ONE`, `TWO`,
+`QUORUM`, `LOCAL_QUORUM`\u2026
+
+|`readConsistencyLevel` | | Consistency level used to read/check exchange: `ONE`, `TWO`, `QUORUM`,
+`LOCAL_QUORUM`\u2026
+|=======================================================================
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-castor/src/main/docs/castor.adoc
----------------------------------------------------------------------
diff --git a/components/camel-castor/src/main/docs/castor.adoc b/components/camel-castor/src/main/docs/castor.adoc
index 0c930f5..f09723d 100644
--- a/components/camel-castor/src/main/docs/castor.adoc
+++ b/components/camel-castor/src/main/docs/castor.adoc
@@ -112,22 +112,11 @@ on multiple routes. You have to set the <castor> element directly in
Options
^^^^^^^
-Castor supports the following options
+// component options: START
+// component options: END
-[width="100%",cols="10%,10%,10%,70%",options="header",]
-|=======================================================================
-|Option |Type |Default |Description
-
-|encoding |String |UTF-8 |Encoding to use when marshalling an Object to XML
-
-|validation |Boolean |false |Whether validation is turned on or off.
-
-|mappingFile |String |null |Path to a Castor mapping file to load from the classpath.
-
-|packages |String[] |null |Add additional packages to Castor XmlContext
-
-|classNames |String[] |null |Add additional class names to Castor XmlContext
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
[[Castor-Dependencies]]
Dependencies
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-chunk/src/main/docs/chunk.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chunk/src/main/docs/chunk.adoc b/components/camel-chunk/src/main/docs/chunk.adoc
index 2690a4d..c0996b7 100644
--- a/components/camel-chunk/src/main/docs/chunk.adoc
+++ b/components/camel-chunk/src/main/docs/chunk.adoc
@@ -39,22 +39,12 @@ format,�`?option=value&option=value&...`
[[Chunk-Options]]
Options
^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Option |Default |Description
-
-|`encoding` |`null` |Character encoding of the resource content.
-
-|themesFolder |`null` |Alternative folder to scan for a template name.
-|themeSubfolder |`null` |Alternative subfolder to scan for a template name if themeFolder
-parameter is set.
+// component options: START
+// component options: END
-|`themeLayer` |`null` |A specific layer of a template file to use as template.
-
-|`extension` |`null` |Alternative extension to scan for a template name if themeFolder and
-themeSubfolder are set.
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
Chunk component will look for a specific template in _themes_ folder
with extensions _.chtml_ or _.cxml.�_If you need to specify a different
http://git-wip-us.apache.org/repos/asf/camel/blob/f4b66541/components/camel-cmis/src/main/docs/cmis.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cmis/src/main/docs/cmis.adoc b/components/camel-cmis/src/main/docs/cmis.adoc
index 2d865f2..3fc8bab 100644
--- a/components/camel-cmis/src/main/docs/cmis.adoc
+++ b/components/camel-cmis/src/main/docs/cmis.adoc
@@ -21,34 +21,14 @@ You can append query options to the URI in the following format,
?options=value&option2=value&...
[[CMIS-URIOptions]]
-URI Options
-^^^^^^^^^^^
-
-[width="100%",cols="10%,10%,10%,70%",options="header",]
-|=======================================================================
-|Name |Default Value |Context |Description
-
-|queryMode |`false` |Producer |If true, will execute the cmis query from the message body and return
-result, otherwise will create a node in the cmis repository
-
-|query |`String` |Consumer |The cmis query to execute against the repository. If not specified, the
-consumer will retrieve every node from the content repository by
-iterating the content tree recursively
-
-|username |`null` |Both |Username for the cmis repository
-
-|password |`null` |Both |Password for the cmis repository
-
-|repositoryId |`null` |Both |The Id of the repository to use. If not specified the first available
-repository is used
-
-|pageSize |`100` |Both |Number of nodes to retrieve per page
+CMIS Options
+^^^^^^^^^^^^
-|readCount |`0` |Both |Max number of nodes to read
+// component options: START
+// component options: END
-|readContent |`false` |Both |If set to true, the content of document node will be retrieved in
-addition to the properties
-|=======================================================================
+// endpoint options: START
+// endpoint options: END
[[CMIS-Usage]]
Usage
[3/8] camel git commit: Added camel-zipfile docs to Gitbook
Posted by ac...@apache.org.
Added camel-zipfile docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/4be5d543
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4be5d543
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4be5d543
Branch: refs/heads/master
Commit: 4be5d54320f22bdcafd399b229a64eb4bb23ba90
Parents: 879fa60
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 9 13:10:01 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 9 13:10:01 2016 +0200
----------------------------------------------------------------------
docs/user-manual/en/SUMMARY.md | 1 +
1 file changed, 1 insertion(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/4be5d543/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 209a5dc..66369a6 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -304,6 +304,7 @@
* [XML Rpc](xmlrpc.adoc)
* [XStream](xstream.adoc)
* [YAML](yaml.adoc)
+ * [Zipfile](zipfile.adoc)
* User Guide
* [Karaf](karaf.adoc)
[4/8] camel git commit: Forget to add the zipfile docs directory to
repo
Posted by ac...@apache.org.
Forget to add the zipfile docs directory to repo
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/4c3c058a
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4c3c058a
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4c3c058a
Branch: refs/heads/master
Commit: 4c3c058adf8fc39fae58dec5de9f02fa009056e2
Parents: 4be5d54
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 9 13:10:21 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 9 13:10:21 2016 +0200
----------------------------------------------------------------------
.../camel-zipfile/src/main/docs/zipfile.adoc | 159 +++++++++++++++++++
1 file changed, 159 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/4c3c058a/components/camel-zipfile/src/main/docs/zipfile.adoc
----------------------------------------------------------------------
diff --git a/components/camel-zipfile/src/main/docs/zipfile.adoc b/components/camel-zipfile/src/main/docs/zipfile.adoc
new file mode 100644
index 0000000..0f61ea6
--- /dev/null
+++ b/components/camel-zipfile/src/main/docs/zipfile.adoc
@@ -0,0 +1,159 @@
+[[ZipFileDataFormat-ZipFile]]
+Zip File
+~~~~~~~~
+
+TIP:*Available since Camel 2.11.0*
+
+The Zip File link:data-format.html[Data Format] is a message compression
+and de-compression format. Messages can be marshalled (compressed) to
+Zip files containing a single entry, and Zip files containing a single
+entry can be unmarshalled (decompressed) to the original file contents.
+This data format supports ZIP64, as long as
+https://blogs.oracle.com/xuemingshen/entry/zip64_support_for_4g_zipfile[Java
+7 or later is being used].
+
+Since Camel 2.12.3 there is also a aggregation strategy that can
+aggregate multiple messages into a single Zip file.
+
+[[ZipFileDataFormat-Marshal]]
+Marshal
+^^^^^^^
+
+In this example we marshal a regular text/XML payload to a compressed
+payload using Zip file compression, and send it to an ActiveMQ queue
+called MY_QUEUE.
+
+[source,java]
+-----------------------------------------------------------------------
+from("direct:start").marshal().zipFile().to("activemq:queue:MY_QUEUE");
+-----------------------------------------------------------------------
+
+The name of the Zip entry inside the created Zip file is based on the
+incoming `CamelFileName` message header, which is the standard message
+header used by the link:file2.html[file component]. Additionally, the
+outgoing `CamelFileName` message header is automatically set to the
+value of the incoming `CamelFileName` message header, with the ".zip"
+suffix. So for example, if the following route finds a file named
+"test.txt" in the input directory, the output will be a Zip file named
+"test.txt.zip" containing a single Zip entry named "test.txt":
+
+[source,java]
+-----------------------------------------------------------------------------------------------
+from("file:input/directory?antInclude=*/.txt").marshal().zipFile().to("file:output/directory");
+-----------------------------------------------------------------------------------------------
+
+If there is no incoming `CamelFileName` message header (for example, if
+the link:file2.html[file component] is not the consumer), then the
+message ID is used by default, and since the message ID is normally a
+unique generated ID, you will end up with filenames like
+`ID-MACHINENAME-2443-1211718892437-1-0.zip`. If you want to override
+this behavior, then you can set the value of the `CamelFileName` header
+explicitly in your route:
+
+[source,java]
+---------------------------------------------------------------------------------------------------------------------------
+from("direct:start").setHeader(Exchange.FILE_NAME, constant("report.txt")).marshal().zipFile().to("file:output/directory");
+---------------------------------------------------------------------------------------------------------------------------
+
+This route would result in a Zip file named "report.txt.zip" in the
+output directory, containing a single Zip entry named "report.txt".
+
+[[ZipFileDataFormat-Unmarshal]]
+Unmarshal
+^^^^^^^^^
+
+In this example we unmarshal a Zip file payload from an ActiveMQ queue
+called MY_QUEUE to its original format, and forward it for processing to
+the `UnZippedMessageProcessor`.
+
+[source,java]
+-----------------------------------------------------------------------------------------------
+from("activemq:queue:MY_QUEUE").unmarshal().zipFile().process(new UnZippedMessageProcessor());�
+-----------------------------------------------------------------------------------------------
+
+If the zip file has more then one entry, the usingIterator option of
+ZipFileDataFormat to be true, and you can use splitter to do the further
+work.
+
+[source,java]
+----------------------------------------------------------------------------------------------------
+ ZipFileDataFormat zipFile = new ZipFileDataFormat();
+ zipFile.setUsingIterator(true);
+ from("file:src/test/resources/org/apache/camel/dataformat/zipfile/?consumer.delay=1000&noop=true")
+ .unmarshal(zipFile)
+ .split(body(Iterator.class))
+ .streaming()
+ .process(new UnZippedMessageProcessor())
+ .end();
+----------------------------------------------------------------------------------------------------
+
+Or you can use the ZipSplitter as an expression for splitter directly
+like this
+
+[source,java]
+----------------------------------------------------------------------------------------------------
+ from("file:src/test/resources/org/apache/camel/dataformat/zipfile?consumer.delay=1000&noop=true")
+ .split(new ZipSplitter())
+ .streaming()
+ .process(new UnZippedMessageProcessor())
+ .end();
+----------------------------------------------------------------------------------------------------
+
+[[ZipFileDataFormat-Aggregate]]
+Aggregate
+^^^^^^^^^
+
+TIP:*Available since Camel 2.12.3*
+
+INFO:Please note that this aggregation strategy requires eager completion
+check to work properly.
+
+In this example we aggregate all text files found in the input directory
+into a single Zip file that is stored in the output directory.�
+
+[source,java]
+-------------------------------------------------
+ from("file:input/directory?antInclude=*/.txt")
+ .aggregate(new ZipAggregationStrategy())
+ .constant(true)
+ .completionFromBatchConsumer()
+ .eagerCheckCompletion()
+ .to("file:output/directory");
+-------------------------------------------------
+
+The outgoing�`CamelFileName`�message header is created using
+java.io.File.createTempFile, with the ".zip" suffix.�If you want to
+override this behavior, then you can set the value of
+the�`CamelFileName`�header explicitly in your route:
+
+[source,java]
+------------------------------------------------------------
+ from("file:input/directory?antInclude=*/.txt")
+ .aggregate(new ZipAggregationStrategy())
+ .constant(true)
+ .completionFromBatchConsumer()
+ .eagerCheckCompletion()
+ .setHeader(Exchange.FILE_NAME, constant("reports.zip"))
+ .to("file:output/directory");
+------------------------------------------------------------
+
+[[ZipFileDataFormat-Dependencies]]
+Dependencies
+^^^^^^^^^^^^
+
+To use Zip files in your camel routes you need to add a dependency on
+*camel-zipfile* which implements this data format.
+
+If you use Maven you can just add the following to your `pom.xml`,
+substituting the version number for the latest & greatest release (see
+link:download.html[the download page for the latest versions]).
+
+[source,xml]
+----------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-zipfile</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+----------------------------------------------------------
[5/8] camel git commit: Added camel-zipkin docs to Gitbook
Posted by ac...@apache.org.
Added camel-zipkin docs to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/b6680168
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/b6680168
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/b6680168
Branch: refs/heads/master
Commit: b6680168d8c77be7a7ad8af666c5733b58f902b7
Parents: 4c3c058
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 9 13:18:45 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 9 13:18:45 2016 +0200
----------------------------------------------------------------------
.../camel-zipkin/src/main/docs/zipkin.adoc | 257 +++++++++++++++++++
docs/user-manual/en/SUMMARY.md | 1 +
2 files changed, 258 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/b6680168/components/camel-zipkin/src/main/docs/zipkin.adoc
----------------------------------------------------------------------
diff --git a/components/camel-zipkin/src/main/docs/zipkin.adoc b/components/camel-zipkin/src/main/docs/zipkin.adoc
new file mode 100644
index 0000000..369517b
--- /dev/null
+++ b/components/camel-zipkin/src/main/docs/zipkin.adoc
@@ -0,0 +1,257 @@
+[[Zipkin-ZipkinComponent]]
+Zipkin Component
+~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.18*
+
+The camel-zipkin component is used for tracing and timing incoming and
+outgoing Camel messages using http://zipkin.io/[zipkin].
+
+Events (span) are captured for incoming and outgoing messages being sent
+to/from Camel.
+
+This means you need to configure which which Camel endpoints that maps
+to zipkin service names.
+
+The mapping can be configured using:
+
+* route id - A Camel route id
+* endpoint url - A Camel endpoint url
+
+For both kinds you can use wildcards and regular expressions to match,
+which is using the rules from�link:intercept.html[Intercept].
+
+To match all Camel messages you can use * in the pattern and configure
+that to the same service name.
+
+If no mapping has been configured then Camel will fallback and use
+endpoint uri's as service names.� +
+However its recommended to configure service mappings so you can use
+human logic names instead of Camel�endpoint uris in the names.
+
+Camel will auto-configure a ScribeSpanCollector if no SpanCollector
+explicit has been configured, and�if the hostname and port to the span
+collector has been configured as environment variables:
+
+* ZIPKIN_COLLECTOR_THRIFT_SERVICE_HOST - The hostname
+* ZIPKIN_COLLECTOR_THRIFT_SERVICE_PORT - The port number
+
+This makes it easy to use camel-zipkin in container platforms where the
+platform can run your application in a linux container where service
+configurations are provided as environment variables.
+
+[[camel-zipkin-Options]]
+Options
+^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Option |Default |Description
+
+|rate |1.0f |Configures a rate that decides how many events should be traced by
+zipkin. The rate is expressed as a percentage (1.0f = 100%, 0.5f is 50%, 0.1f is
+10%).
+
+|spanCollector | |*Mandatory:* The collector to use for sending zipkin span events to the
+zipkin server.
+
+|serviceName | | To use a global service name that matches all Camel events
+
+|clientServiceMappings | | Sets the *client* service mappings that matches Camel events to the
+given zipkin service name. The content is a Map<String, String> where the key is a pattern and the
+value is the service name. The pattern uses the rules from link:intercept.html[Intercept].
+
+|serverServiceMappings | | Sets the *server* service mappings that matches Camel events to the
+given zipkin service name. The content is a Map<String, String> where the key is a pattern and the
+value is the service name. The pattern uses the rules from link:intercept.html[Intercept].
+
+|excludePatterns | | Sets exclude pattern(s) that will disable tracing with zipkin for Camel
+messages that matches the pattern. The content is a Set<String> where the key is a pattern. The pattern
+uses the rules from link:intercept.html[Intercept].
+
+|includeMessageBody |false |Whether to include the Camel message body in the zipkin traces.
+This is not recommended for production usage, or when having big
+payloads. You can limit the size by configuring the
+link:how-do-i-set-the-max-chars-when-debug-logging-messages-in-camel.html[max
+debug log size].�
+
+|includeMessageBodyStreams |false |Whether to include message bodies that are stream based in the zipkin
+traces. This requires enabling streamlink:stream-caching.html[caching] on the
+routes or globally on the CamelContext. This is not recommended for production usage, or when having big
+payloads. You can limit the size by configuring the
+link:how-do-i-set-the-max-chars-when-debug-logging-messages-in-camel.html[max
+debug log size].��
+|=======================================================================
+
+[[camel-zipkin-Example]]
+Example
+^^^^^^^
+
+To enable camel-zipkin you need to configure first
+
+[source,java]
+--------------------------------------------------------------------------------------------------
+ZipkinTracer zipkin = new ZipkinTracer();
+// configure the scribe span collector with the hostname and port for the Zipkin Collector Server
+zipkin.setSpanCollector(new ScribeSpanCollector("192.168.90.100", 9410);
+// and then add zipkin to the CamelContext
+zipkin.init(camelContext);
+--------------------------------------------------------------------------------------------------
+
+The configuration about will the trace all incoming and outgoing
+messages in Camel routes.�
+
+To use ZipinTracer in XML all you need to do is to setup scribe an the
+zipkin tracer as <bean> and then they are automatic discovered and used
+by Camel.
+
+[source,xml]
+---------------------------------------------------------------------------------------------------------
+ <!-- configure the scribe span collector with the hostname and port for the Zipkin Collector Server -->
+ <bean id="scribe" class="com.github.kristofa.brave.scribe.ScribeSpanCollector">
+ <constructor-arg index="0" value="192.168.90.100"/>
+ <constructor-arg index="1" value="9410"/>
+ </bean>
+
+ <!-- setup zipkin tracer -->
+ <bean id="zipkinTracer" class="org.apache.camel.zipkin.ZipkinTracer">
+ <property name="serviceName" value="dude"/>
+ <property name="spanCollector" ref="scribe"/>
+ </bean>
+---------------------------------------------------------------------------------------------------------
+
+[[camel-zipkin-ServiceName]]
+ServiceName
++++++++++++
+
+However if you want to map Camel endpoints to human friendly logical
+names, you can add mappings
+
+* ServiceName *
+
+You can configure a global service name that all events will fallback
+and use, such as:
+
+[source,java]
+----------------------------------
+zipkin.setServiceName("invoices");
+----------------------------------
+
+This will use the same service name for all incoming and outgoing zipkin
+traces. So if your application uses different services, you need to map
+them more fine grained into client vs server mappings
+
+[[camel-zipkin-ClientandServerServiceMappings]]
+Client and Server Service Mappings
+++++++++++++++++++++++++++++++++++
+
+* ClientServiceMappings
+* ServerServiceMappings
+
+So if your application hosts a service that others can call, you can map
+the Camel route endpoint to a server service mapping. For example
+support your Camel application has the following route
+
+[source,java]
+----------------------------------
+from("activemq:queue:inbox")
+ ...
+ .to("http:someserver/somepath");
+----------------------------------
+
+And you want to make that as a server service, you can add the following
+mapping
+
+[source,java]
+-----------------------------------------------------------------
+zipkin.addServerServiceMapping("activemq:queue:inbox", "orders");
+-----------------------------------------------------------------
+
+Then when a message is consumed from that inbox queue, it becomes a
+zipkin server event with the service name orders.
+
+Now suppose that the call to http:someserver/somepath is also a service,
+which you want to map to a client service name, which can be done as:
+
+[source,java]
+--------------------------------------------------------------------
+zipkin.addClientServiceMapping("http:someserver/somepath", "audit");
+--------------------------------------------------------------------
+
+Then in the same Camel application you have mapped incoming and outgoing
+endpoints to different zipkin service names.
+
+You can use wildcards in the service mapping, so to match all outgoing
+calls the same HTTP server you can do
+
+------------------------------------------------------------
+zipkin.addClientServiceMapping("http:someserver*", "audit");
+------------------------------------------------------------
+
+[[camel-zipkin-Mappingrules]]
+Mapping rules
++++++++++++++
+
+The service name mapping for server occurs using the following rules
+
+1. Is there an exclude pattern that matches the endpoint uri of the
+from endpoint? If yes then skip.
+2. Is there a match in the serviceServiceMapping that matches the
+endpoint uri of the from endpoint? If yes the use the found service name
+3. Is there a match in the serviceServiceMapping that matches the route
+id of the current route? If yes the use the found service name
+4. Is there a match in the serviceServiceMapping that matches the
+original route id where the exchange started? If yes the use the found
+service name
+5. No service name was found, the exchange is not traced by zipkin
+
+The service name mapping for client occurs using the following rules
+
+1. Is there an exclude pattern that matches the endpoint uri of the
+from endpoint? If yes then skip.
+2. Is there a match in the clientServiceMapping that matches the
+endpoint uri of endpoint where the message is being sent to? If yes the
+use the found service name
+3. Is there a match in the clientServiceMapping that matches the route
+id of the current route? If yes the use the found service name
+4. Is there a match in the clientServiceMapping that matches the
+original route id where the exchange started? If yes the use the found
+service name
+5. No service name was found, the exchange is not traced by zipkin
+
+[[camel-zipkin-Noclientorservermappings]]
+No client or server mappings
+++++++++++++++++++++++++++++
+
+If there has been no configuration of client or server service mappings,
+then CamelZipkin runs in a fallback mode, where it uses the endpoint
+uris as the service name.
+
+So in the example above that would mean the service names would be, as
+if you add the following code yourself:
+
+[source,java]
+---------------------------------------------------------------------------------------
+zipkin.addServerServiceMapping("activemq:queue:inbox", "activemq:queue:inbox");
+zipkin.addClientServiceMapping("http:someserver/somepath", "http:someserver/somepath");
+---------------------------------------------------------------------------------------
+
+This is not a recommended approach but gets you up and running quickly
+without doing any service name mappings. However when you have multiple
+systems across your infrastructure, then you should consider using human
+logic service names, that you map to instead of using the camel endpoint
+uris.
+
+[[camel-zipkin-camel-zipin-starter]]
+camel-zipin-starter
+^^^^^^^^^^^^^^^^^^^
+
+If you are using�link:spring-boot.html[Spring Boot] then you can add
+the�`camel-zipkin-starter` dependency, and turn on zipkin by annotating
+the main class with `@CamelZipkin`. You can then configure camel-zipkin
+in the�`application.properties` file where you can configure the
+hostname and port number for the Zipkin Server, and all the other
+options as listed in the options table above.
+
+You can find an example of this in
+the�https://github.com/apache/camel/tree/master/examples/camel-example-zipkin[camel-example-zipkin]
http://git-wip-us.apache.org/repos/asf/camel/blob/b6680168/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 66369a6..7e0f244 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -275,6 +275,7 @@
* [XML Security](xmlsecurity.adoc)
* [XMPP](xmpp.adoc)
* [Yammer](yammer.adoc)
+ * [Zipkin](zipkin.adoc)
* [ZooKeeper](zookeeper.adoc)
* [Expression Languages](languages.adoc)
[8/8] camel git commit: Components/Endpoints docs updated
Posted by ac...@apache.org.
Components/Endpoints docs updated
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/02a6a4de
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/02a6a4de
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/02a6a4de
Branch: refs/heads/master
Commit: 02a6a4dede00e69466c90eef04cad58e622a1aab
Parents: f4b6654
Author: Andrea Cosentino <an...@gmail.com>
Authored: Thu Jun 9 14:18:18 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Thu Jun 9 14:18:18 2016 +0200
----------------------------------------------------------------------
.../camel-ahc-ws/src/main/docs/ahc-ws.adoc | 45 +++++
components/camel-amqp/src/main/docs/amqp.adoc | 173 +++++++++++++++++++
components/camel-apns/src/main/docs/apns.adoc | 44 +++++
.../src/main/docs/atmosphere-websocket.adoc | 63 +++++++
components/camel-atom/src/main/docs/atom.adoc | 41 +++++
components/camel-avro/src/main/docs/avro.adoc | 37 ++++
.../src/main/docs/bean-validator.adoc | 21 +++
.../src/main/docs/beanstalk.adoc | 50 ++++++
components/camel-cache/src/main/docs/cache.adoc | 45 +++++
components/camel-chunk/src/main/docs/chunk.adoc | 22 +++
components/camel-cmis/src/main/docs/cmis.adoc | 19 ++
11 files changed, 560 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc b/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
index 326abaf..3a9cc36 100644
--- a/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
+++ b/components/camel-ahc-ws/src/main/docs/ahc-ws.adoc
@@ -44,12 +44,57 @@ AHC-WS Options
As the AHC-WS component is based on the AHC component, you can use the
various configuration options of the AHC component.
+
// component options: START
+The AHC Websocket component supports 6 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| client | AsyncHttpClient | To use a custom AsyncHttpClient
+| binding | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
+| clientConfig | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
+| sslContextParameters | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
+| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+|=======================================================================
+{% endraw %}
// component options: END
+
+
// endpoint options: START
+The AHC Websocket component supports 17 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| httpUri | common | | URI | *Required* The URI to use such as http://hostname:port/path
+| binding | common | | AhcBinding | To use a custom AhcBinding which allows to control how to bind between AHC and Camel.
+| bridgeEndpoint | common | false | boolean | If the option is true then the Exchange.HTTP_URI header is ignored and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the AhcProducer send all the fault response back.
+| bufferSize | common | 4096 | int | The initial in-memory buffer size used when transferring data between Camel and AHC Client.
+| headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+| throwExceptionOnFailure | common | true | boolean | Option to disable throwing the AhcOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.
+| transferException | common | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using Jetty or Servlet Camel components). On the producer side the exception will be deserialized and thrown as is instead of the AhcOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| sendMessageOnError | consumer | false | boolean | Whether to send an message if the web-socket listener received an error.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| connectionClose | producer | false | boolean | Define if the Connection Close header has to be added to HTTP Request. This parameter is false by default
+| useStreaming | producer | false | boolean | To enable streaming to send data as multiple text fragments.
+| clientConfig | advanced | | AsyncHttpClientConfig | To configure the AsyncHttpClient to use a custom com.ning.http.client.AsyncHttpClientConfig instance.
+| clientConfigOptions | advanced | | Map | To configure the AsyncHttpClientConfig using the key/values from the Map.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| sslContextParameters | security | | SSLContextParameters | Reference to a org.apache.camel.util.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. See Using the JSSE Configuration Utility. Note that configuring this option will override any SSL/TLS configuration options provided through the clientConfig option at the endpoint or component level.
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
[[AHC-WS-WritingandReadingDataoverWebsocket]]
Writing and Reading Data over Websocket
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-amqp/src/main/docs/amqp.adoc
----------------------------------------------------------------------
diff --git a/components/camel-amqp/src/main/docs/amqp.adoc b/components/camel-amqp/src/main/docs/amqp.adoc
index aa21287..4fccc8c 100644
--- a/components/camel-amqp/src/main/docs/amqp.adoc
+++ b/components/camel-amqp/src/main/docs/amqp.adoc
@@ -38,12 +38,185 @@ AMQP Options
You can specify all of the various configuration options of the
link:../../../../camel-jms/src/main/docs/readme.html[JMS] component after the destination name.
+
// component options: START
+The AMQP component supports 72 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| configuration | JmsConfiguration | To use a shared JMS configuration
+| acceptMessagesWhileStopping | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option.
+| allowReplyManagerQuickStop | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag.
+| acknowledgementMode | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead.
+| eagerLoadingOfProperties | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
+| acknowledgementModeName | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
+| autoStartup | boolean | Specifies whether the consumer container should auto-startup.
+| cacheLevel | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.
+| cacheLevelName | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
+| replyToCacheLevelName | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.
+| clientId | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
+| concurrentConsumers | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| replyToConcurrentConsumers | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| connectionFactory | ConnectionFactory | Sets the default connection factory to be use
+| deliveryPersistent | boolean | Specifies whether persistent delivery is used by default.
+| deliveryMode | Integer | Specifies the delivery mode to be used. Possible values are Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
+| durableSubscriptionName | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
+| exceptionListener | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
+| errorHandler | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
+| errorHandlerLoggingLevel | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
+| errorHandlerLogStackTrace | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
+| explicitQosEnabled | boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
+| exposeListenerSession | boolean | Specifies whether the listener session should be exposed when consuming messages.
+| idleTaskExecutionLimit | int | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring.
+| idleConsumerLimit | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
+| maxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| replyToMaxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| replyOnTimeoutToMaxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
+| maxMessagesPerTask | int | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required.
+| messageConverter | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.
+| mapJmsMessage | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details.
+| messageIdEnabled | boolean | When sending specifies whether message IDs should be added.
+| messageTimestampEnabled | boolean | Specifies whether timestamps should be enabled by default on sending messages.
+| alwaysCopyMessage | boolean | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set)
+| useMessageIDAsCorrelationID | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
+| priority | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect.
+| pubSubNoLocal | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
+| receiveTimeout | long | The timeout for receiving messages (in milliseconds).
+| recoveryInterval | long | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds.
+| subscriptionDurable | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId.
+| taskExecutor | TaskExecutor | Allows you to specify a custom task executor for consuming messages.
+| timeToLive | long | When sending messages specifies the time-to-live of the message (in milliseconds).
+| transacted | boolean | Specifies whether to use transacted mode
+| lazyCreateTransactionManager | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
+| transactionManager | PlatformTransactionManager | The Spring transaction manager to use.
+| transactionName | String | The name of the transaction to use.
+| transactionTimeout | int | The timeout value of the transaction (in seconds) if using transacted mode.
+| testConnectionOnStartup | boolean | Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well.
+| asyncStartListener | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
+| asyncStopListener | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
+| forceSendOriginalMessage | boolean | When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received.
+| requestTimeout | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option.
+| requestTimeoutCheckerInterval | long | Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs then you can lower this interval to check more frequently. The timeout is determined by the option requestTimeout.
+| transferExchange | boolean | You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body Out body Fault body In headers Out headers Fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side so Camel knows the payloads is an Exchange and not a regular payload.
+| transferException | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer.
+| transferFault | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on link org.apache.camel.MessageisFault() will be send back in the response as a JMS header with the key link JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
+| jmsOperations | JmsOperations | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs.
+| destinationResolver | DestinationResolver | A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example to lookup the real destination in a JNDI registry).
+| replyToType | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.
+| preserveMessageQos | boolean | Set to true if you want to send message using the QoS settings specified on the message instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority JMSDeliveryMode and JMSExpiration. You can provide all or only some of them. If not provided Camel will fall back to use the values from the endpoint instead. So when using this option the headers override the values from the endpoint. The explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header.
+| asyncConsumer | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
+| allowNullBody | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
+| includeSentJMSMessageID | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination.
+| includeAllJMSXProperties | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
+| defaultTaskExecutorType | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
+| jmsKeyFormatStrategy | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
+| applicationContext | ApplicationContext | Sets the Spring ApplicationContext to use
+| queueBrowseStrategy | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+| messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
+| waitForProvisionCorrelationToBeUpdatedCounter | int | Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled.
+| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
+|=======================================================================
+{% endraw %}
// component options: END
+
+
// endpoint options: START
+The AMQP component supports 79 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| destinationType | common | queue | String | The kind of destination to use
+| destinationName | common | | String | *Required* Name of the queue or topic to use as destination
+| clientId | common | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead.
+| disableReplyTo | common | false | boolean | If true a producer will behave like a InOnly exchange with the exception that JMSReplyTo header is sent out and not be suppressed like in the case of InOnly. Like InOnly the producer will not wait for a reply. A consumer with this flag will behave like InOnly. This feature can be used to bridge InOut requests to another queue so that a route on the other queue will send its response directly back to the original JMSReplyTo.
+| durableSubscriptionName | common | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.
+| jmsMessageType | common | | JmsMessageType | Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes Map Object Stream Text. By default Camel would determine which JMS message type to use from the In body type. This option allows you to specify it.
+| testConnectionOnStartup | common | false | boolean | Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well.
+| acknowledgementModeName | consumer | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE
+| asyncConsumer | consumer | false | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions).
+| autoStartup | consumer | true | boolean | Specifies whether the consumer container should auto-startup.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| cacheLevelName | consumer | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information.
+| concurrentConsumers | consumer | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| maxConcurrentConsumers | consumer | | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener.
+| replyTo | consumer | | String | Provides an explicit ReplyTo destination which overrides any incoming value of Message.getJMSReplyTo().
+| replyToDeliveryPersistent | consumer | true | boolean | Specifies whether to use persistent delivery by default for replies.
+| selector | consumer | | String | Sets the JMS selector to use
+| acceptMessagesWhileStopping | consumer (advanced) | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option.
+| allowReplyManagerQuickStop | consumer (advanced) | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag.
+| consumerType | consumer (advanced) | Default | ConsumerType | The consumer type to use which can be one of: Simple Default or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use.
+| defaultTaskExecutorType | consumer (advanced) | | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor with optimal values - cached threadpool-like). If not set it defaults to the previous behaviour which uses a cached thread pool for consumer endpoints and SimpleAsync for reply consumers. The use of ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers.
+| eagerLoadingOfProperties | consumer (advanced) | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exposeListenerSession | consumer (advanced) | false | boolean | Specifies whether the listener session should be exposed when consuming messages.
+| replyToSameDestinationAllowed | consumer (advanced) | false | boolean | Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from. This prevents an endless loop by consuming and sending back the same message to itself.
+| deliveryMode | producer | | Integer | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.
+| deliveryPersistent | producer | true | boolean | Specifies whether persistent delivery is used by default.
+| explicitQosEnabled | producer | false | Boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers.
+| preserveMessageQos | producer | false | boolean | Set to true if you want to send message using the QoS settings specified on the message instead of the QoS settings on the JMS endpoint. The following three headers are considered JMSPriority JMSDeliveryMode and JMSExpiration. You can provide all or only some of them. If not provided Camel will fall back to use the values from the endpoint instead. So when using this option the headers override the values from the endpoint. The explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header.
+| priority | producer | 4 | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect.
+| replyToConcurrentConsumers | producer | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| replyToMaxConcurrentConsumers | producer | | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads.
+| replyToOnTimeoutMaxConcurrentConsumers | producer | 1 | int | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
+| replyToOverride | producer | | String | Provides an explicit ReplyTo destination in the JMS message which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination.
+| replyToType | producer | | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive.
+| requestTimeout | producer | 20000 | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option.
+| timeToLive | producer | -1 | long | When sending messages specifies the time-to-live of the message (in milliseconds).
+| allowNullBody | producer (advanced) | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown.
+| alwaysCopyMessage | producer (advanced) | false | boolean | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set)
+| disableTimeToLive | producer (advanced) | false | boolean | Use this option to force disabling time to live. For example when you do request/reply over JMS then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details.
+| forceSendOriginalMessage | producer (advanced) | false | boolean | When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received.
+| includeSentJMSMessageID | producer (advanced) | false | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination.
+| replyToCacheLevelName | producer (advanced) | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION.
+| replyToDestinationSelectorName | producer (advanced) | | String | Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is if you are not using a temporary reply queue).
+| asyncStartListener | advanced | false | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry.
+| asyncStopListener | advanced | false | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route.
+| errorHandler | advanced | | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler.
+| errorHandlerLoggingLevel | advanced | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions.
+| errorHandlerLogStackTrace | advanced | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler.
+| exceptionListener | advanced | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+| idleConsumerLimit | advanced | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time.
+| idleTaskExecutionLimit | advanced | 1 | int | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring.
+| includeAllJMSXProperties | advanced | false | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply.
+| jmsKeyFormatStrategy | advanced | | String | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation.
+| mapJmsMessage | advanced | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc.
+| maxMessagesPerTask | advanced | -1 | int | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required.
+| messageConverter | advanced | | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.
+| messageCreatedStrategy | advanced | | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.
+| messageIdEnabled | advanced | true | boolean | When sending specifies whether message IDs should be added.
+| messageListenerContainerFactory | advanced | | MessageListenerContainerFactory | Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom.
+| messageTimestampEnabled | advanced | true | boolean | Specifies whether timestamps should be enabled by default on sending messages.
+| pubSubNoLocal | advanced | false | boolean | Specifies whether to inhibit the delivery of messages published by its own connection.
+| receiveTimeout | advanced | 1000 | long | The timeout for receiving messages (in milliseconds).
+| recoveryInterval | advanced | 5000 | long | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds.
+| requestTimeoutCheckerInterval | advanced | 1000 | long | Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS. By default Camel checks once per second. But if you must react faster when a timeout occurs then you can lower this interval to check more frequently. The timeout is determined by the option requestTimeout.
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| transferException | advanced | false | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer.
+| transferExchange | advanced | false | boolean | You can transfer the exchange over the wire instead of just the body and headers. The following fields are transferred: In body Out body Fault body In headers Out headers Fault headers exchange properties exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. You must enable this option on both the producer and consumer side so Camel knows the payloads is an Exchange and not a regular payload.
+| transferFault | advanced | false | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on MessageisFault() will be send back in the response as a JMS header with the key JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws.
+| useMessageIDAsCorrelationID | advanced | false | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
+| waitForProvisionCorrelationToBeUpdatedCounter | advanced | 50 | int | Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled.
+| waitForProvisionCorrelationToBeUpdatedThreadSleepingTime | advanced | 100 | long | Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
+| transacted | transaction | false | boolean | Specifies whether to use transacted mode
+| lazyCreateTransactionManager | transaction (advanced) | true | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true.
+| transactionManager | transaction (advanced) | | PlatformTransactionManager | The Spring transaction manager to use.
+| transactionName | transaction (advanced) | | String | The name of the transaction to use.
+| transactionTimeout | transaction (advanced) | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode.
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
[[AMQP-Usage]]
Usage
^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-apns/src/main/docs/apns.adoc
----------------------------------------------------------------------
diff --git a/components/camel-apns/src/main/docs/apns.adoc b/components/camel-apns/src/main/docs/apns.adoc
index b460d7e..6d6b8bf 100644
--- a/components/camel-apns/src/main/docs/apns.adoc
+++ b/components/camel-apns/src/main/docs/apns.adoc
@@ -54,12 +54,56 @@ apns:consumer[?options]
Options
^^^^^^^
+
// component options: START
+The APNS component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| apnsService | ApnsService | To use a custom link ApnsService
+|=======================================================================
+{% endraw %}
// component options: END
+
+
// endpoint options: START
+The APNS component supports 21 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| name | common | | String | Name of the endpoint
+| tokens | common | | String | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
+| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
+| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
+| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
+| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
+| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
+| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
+| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
+| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started.
+| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
+| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
You can append query options to the URI in the following format,
`?option=value&option=value&...`
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
index 6c4b111..d4fdbac 100644
--- a/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
+++ b/components/camel-atmosphere-websocket/src/main/docs/atmosphere-websocket.adoc
@@ -35,12 +35,75 @@ their�`pom.xml`�for this component:
Atmosphere-Websocket Options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
// component options: START
+The Atmosphere Websocket component supports 7 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| servletName | String | Default name of servlet to use. The default name is CamelServlet.
+| httpRegistry | HttpRegistry | To use a custom org.apache.camel.component.servlet.HttpRegistry.
+| attachmentMultipartBinding | boolean | Whether to automatic bind multipart/form-data as attachments on the Camel Exchange. This is turn off by default as this may require servet specific configuration to enable this when using Servlet's.
+| httpBinding | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| httpConfiguration | HttpConfiguration | To use the shared HttpConfiguration as base configuration.
+| allowJavaSerializedObject | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+|=======================================================================
+{% endraw %}
// component options: END
+
+
// endpoint options: START
+The Atmosphere Websocket component supports 34 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| servicePath | common | | String | *Required* Name of websocket endpoint
+| chunked | common | true | boolean | If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response
+| disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca
che the response body stream but use the response stream as-is as the message body.
+| headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message.
+| httpBinding | common | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient.
+| sendToAll | common | false | boolean | Whether to send to all (broadcast) or send to a single receiver.
+| transferException | common | false | boolean | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.
+| useStreaming | common | false | boolean | To enable streaming to send data as multiple text fragments.
+| async | consumer | false | boolean | Configure the consumer to work in async mode
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| eagerCheckContentAvailable | consumer | false | boolean | Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. This can be turned on in case HTTP clients do not send streamed data.
+| httpMethodRestrict | consumer | | String | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma.
+| matchOnUriPrefix | consumer | false | boolean | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found.
+| optionsEnabled | consumer | false | boolean | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off.
+| responseBufferSize | consumer | | Integer | To use a custom buffer size on the javax.servlet.ServletResponse.
+| servletName | consumer | CamelServlet | String | Name of the servlet to use
+| traceEnabled | consumer | false | boolean | Specifies whether to enable HTTP TRACE for this Servlet consumer. By default TRACE is turned off.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| authMethodPriority | producer | | String | Authentication method for proxy either as Basic Digest or NTLM.
+| bridgeEndpoint | producer | false | boolean | If the option is true HttpProducer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back.
+| connectionClose | producer | false | boolean | Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.
+| copyHeaders | producer | true | boolean | If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false allows to only include the headers from the HTTP response (not propagating IN headers).
+| ignoreResponseBody | producer | false | boolean | If this option is true The http producer won't read response body and cache the input stream
+| okStatusCodeRange | producer | 200-299 | String | The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.
+| preserveHostHeader | producer | false | boolean | If the option is true HttpProducer will set the Host header to the value contained in the current exchange Host header useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client this allows applications which use the Host header to generate accurate URL's for a proxied service
+| proxyHost | producer | | String | The proxy host name
+| proxyPort | producer | | int | The proxy port number
+| throwExceptionOnFailure | producer | true | boolean | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.
+| urlRewrite | producer (advanced) | | UrlRewrite | Refers to a custom org.apache.camel.component.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at http://camel.apache.org/urlrewrite.html
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| mapHttpMessageBody | advanced | true | boolean | If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping.
+| mapHttpMessageFormUrlEncodedBody | advanced | true | boolean | If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping.
+| mapHttpMessageHeaders | advanced | true | boolean | If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping.
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
[[Atmosphere-Websocket-URIFormat]]
URI Format
^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-atom/src/main/docs/atom.adoc
----------------------------------------------------------------------
diff --git a/components/camel-atom/src/main/docs/atom.adoc b/components/camel-atom/src/main/docs/atom.adoc
index 7c50308..7b50e21 100644
--- a/components/camel-atom/src/main/docs/atom.adoc
+++ b/components/camel-atom/src/main/docs/atom.adoc
@@ -36,12 +36,53 @@ Where *atomUri* is the URI to the Atom feed to poll.
Options
^^^^^^^
+
// component options: START
+The Atom component has no options.
// component options: END
+
+
// endpoint options: START
+The Atom component supports 28 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| feedUri | consumer | | String | *Required* The URI to the feed to poll.
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| feedHeader | consumer | true | boolean | Sets whether to add the feed object as a header
+| filter | consumer | true | boolean | Sets whether to use filtering or not of the entries.
+| lastUpdate | consumer | | Date | Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries.
+| password | consumer | | String | Sets the password to be used for basic authentication when polling from a HTTP feed
+| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
+| sortEntries | consumer | false | boolean | Sets whether to sort entries by published date. Only works when splitEntries = true.
+| splitEntries | consumer | true | boolean | Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message
+| throttleEntries | consumer | true | boolean | Sets whether all entries identified in a single feed poll should be delivered immediately. If true only one entry is processed per consumer.delay. Only applicable when splitEntries = true.
+| username | consumer | | String | Sets the username to be used for basic authentication when polling from a HTTP feed
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
+| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
+| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
+| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
+| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
+| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
+| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
+| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
+| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started.
+| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
+| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
You can append query options to the URI in the following format,
`?option=value&option=value&...`
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-avro/src/main/docs/avro.adoc
----------------------------------------------------------------------
diff --git a/components/camel-avro/src/main/docs/avro.adoc b/components/camel-avro/src/main/docs/avro.adoc
index 540e4cf..c3b8ba4 100644
--- a/components/camel-avro/src/main/docs/avro.adoc
+++ b/components/camel-avro/src/main/docs/avro.adoc
@@ -176,12 +176,49 @@ wrapping.
Avro RPC URI Options
^^^^^^^^^^^^^^^^^^^^
+
// component options: START
+The Avro component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| configuration | AvroConfiguration | To use a shared AvroConfiguration to configure options once
+|=======================================================================
+{% endraw %}
// component options: END
+
+
// endpoint options: START
+The Avro component supports 14 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| transport | common | | AvroTransport | *Required* Transport to use
+| port | common | | int | *Required* Port number to use
+| host | common | | String | *Required* Hostname to use
+| messageName | common | | String | The name of the message to send.
+| protocol | common | | Protocol | Avro protocol to use
+| protocolClassName | common | | String | Avro protocol to use defined by the FQN class name
+| protocolLocation | common | | String | Avro protocol location
+| reflectionProtocol | common | false | boolean | If protocol object provided is reflection protocol. Should be used only with protocol parameter because for protocolClassName protocol type will be auto detected
+| singleParameter | common | false | boolean | If true consumer parameter won't be wrapped into array. Will fail if protocol specifies more then 1 parameter for the message
+| uriAuthority | common | | String | Authority to use (username and password)
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
[[avro-AvroRPCHeaders]]
Avro RPC Headers
^^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-bean-validator/src/main/docs/bean-validator.adoc
----------------------------------------------------------------------
diff --git a/components/camel-bean-validator/src/main/docs/bean-validator.adoc b/components/camel-bean-validator/src/main/docs/bean-validator.adoc
index 9d8c515..9ed8142 100644
--- a/components/camel-bean-validator/src/main/docs/bean-validator.adoc
+++ b/components/camel-bean-validator/src/main/docs/bean-validator.adoc
@@ -48,12 +48,33 @@ Where *label* is an arbitrary text value describing the endpoint. +
URI Options
^^^^^^^^^^^
+
// component options: START
+The Bean Validator component has no options.
// component options: END
+
+
// endpoint options: START
+The Bean Validator component supports 8 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| label | producer | | String | *Required* Where label is an arbitrary text value describing the endpoint
+| constraintValidatorFactory | producer | | ConstraintValidatorFactory | To use a custom ConstraintValidatorFactory
+| group | producer | javax.validation.groups.Default | String | To use a custom validation group
+| messageInterpolator | producer | | MessageInterpolator | To use a custom MessageInterpolator
+| traversableResolver | producer | | TraversableResolver | To use a custom TraversableResolver
+| validationProviderResolver | producer | | ValidationProviderResolver | To use a a custom ValidationProviderResolver
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
[[BeanValidator-OSGideployment]]
OSGi deployment
^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/camel/blob/02a6a4de/components/camel-beanstalk/src/main/docs/beanstalk.adoc
----------------------------------------------------------------------
diff --git a/components/camel-beanstalk/src/main/docs/beanstalk.adoc b/components/camel-beanstalk/src/main/docs/beanstalk.adoc
index 8f6b2c3..01b097d 100644
--- a/components/camel-beanstalk/src/main/docs/beanstalk.adoc
+++ b/components/camel-beanstalk/src/main/docs/beanstalk.adoc
@@ -62,12 +62,62 @@ into Beanstalk.
Beanstalk options
^^^^^^^^^^^^^^^^^
+
// component options: START
+The Beanstalk component supports 1 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| connectionSettingsFactory | ConnectionSettingsFactory | Custom ConnectionSettingsFactory. Specify which ConnectionSettingsFactory to use to make connections to Beanstalkd. Especially useful for unit testing without beanstalkd daemon (you can mock ConnectionSettings)
+|=======================================================================
+{% endraw %}
// component options: END
+
+
// endpoint options: START
+The Beanstalk component supports 27 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| connectionSettings | common | | String | Connection settings host:port/tube
+| command | common | | BeanstalkCommand | put means to put the job into Beanstalk. Job body is specified in the Camel message body. Job ID will be returned in beanstalk.jobId message header. delete release touch or bury expect Job ID in the message header beanstalk.jobId. Result of the operation is returned in beanstalk.result message header kick expects the number of jobs to kick in the message body and returns the number of jobs actually kicked out in the message header beanstalk.result.
+| jobDelay | common | 0 | int | Job delay in seconds.
+| jobPriority | common | 1000 | long | Job priority. (0 is the highest see Beanstalk protocol)
+| jobTimeToRun | common | 60 | int | Job time to run in seconds. (when 0 the beanstalkd daemon raises it to 1 automatically see Beanstalk protocol)
+| awaitJob | consumer | true | boolean | Whether to wait for job to complete before ack the job from beanstalk
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| onFailure | consumer | | BeanstalkCommand | Command to use when processing failed.
+| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead.
+| useBlockIO | consumer | true | boolean | Whether to use blockIO.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
+| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
+| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
+| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured.
+| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages.
+| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour).
+| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that.
+| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool.
+| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component
+| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler.
+| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started.
+| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options.
+| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.
+|=======================================================================
+{% endraw %}
// endpoint options: END
+
Producer�behavior�is affected by the�`command`�parameter which tells
what to do with the job, it can be