camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [32/51] [partial] camel git commit: CAMEL-9541: Use -component as suffix for component docs.
Date Tue, 16 Aug 2016 08:03:56 GMT
http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-cometd/src/main/docs/cometd-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc
new file mode 100644
index 0000000..8135538
--- /dev/null
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -0,0 +1,207 @@
+[[Cometd-CometdComponent]]
+Cometd Component
+~~~~~~~~~~~~~~~~
+
+The *cometd:* component is a transport for working with the
+http://www.mortbay.org/jetty[jetty] implementation of the
+http://docs.codehaus.org/display/JETTY/Cometd+%28aka+Bayeux%29[cometd/bayeux
+protocol]. +
+ Using this component in combination with the dojo toolkit library it's
+possible to push Camel messages directly into the browser using an AJAX
+based mechanism.
+
+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-cometd</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[Cometd-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+----------------------------------------
+cometd://host:port/channelName[?options]
+----------------------------------------
+
+The *channelName* represents a topic that can be subscribed to by the
+Camel endpoints.
+
+[[Cometd-Examples]]
+Examples
+^^^^^^^^
+
+------------------------------------------
+cometd://localhost:8080/service/mychannel
+cometds://localhost:8443/service/mychannel
+------------------------------------------
+
+where `cometds:` represents an SSL configured endpoint.
+
+[[Cometd-Options]]
+Options
+^^^^^^^
+
+
+
+// component options: START
+The CometD component supports 6 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2s,1m,8",options="header"]
+|=======================================================================
+| Name | Java Type | Description
+| sslKeyPassword | String | The password for the keystore when using SSL.
+| sslPassword | String | The password when using SSL.
+| sslKeystore | String | The path to the keystore.
+| securityPolicy | SecurityPolicy | To use a custom configured SecurityPolicy to control authorization
+| extensions | List | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests.
+| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
+|=======================================================================
+{% endraw %}
+// component options: END
+
+
+
+
+
+// endpoint options: START
+The CometD component supports 19 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
+| port | common |  | int | *Required* Host port number
+| channelName | common |  | String | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints.
+| allowedOrigins | common | * | String | The origins domain that support to cross if the crosssOriginFilterOn is true
+| baseResource | common |  | String | The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar
+| crossOriginFilterOn | common | false | boolean | If true the server will support for cross-domain filtering
+| filterPath | common |  | String | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true
+| interval | common |  | int | The client side poll timeout in milliseconds. How long a client will wait between reconnects
+| jsonCommented | common | true | boolean | If true the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking.
+| logLevel | common | 1 | int | Logging level. 0=none 1=info 2=debug.
+| maxInterval | common | 30000 | int | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time.
+| multiFrameInterval | common | 1500 | int | The client side poll timeout if multiple connections are detected from the same browser.
+| timeout | common | 240000 | int | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding.
+| 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.
+| sessionHeadersEnabled | consumer | false | boolean | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests.
+| 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.
+| disconnectLocalSession | producer | false | boolean | Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD and therefore you can run out of memory.
+| 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
+
+
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+Here is some examples on How to pass the parameters
+
+For file (for webapp resources located in the Web Application directory
+--> cometd://localhost:8080?resourceBase=file./webapp +
+ For classpath (when by example the web resources are packaged inside
+the webapp folder -->
+cometd://localhost:8080?resourceBase=classpath:webapp
+
+[[Cometd-Authentication]]
+Authentication
+^^^^^^^^^^^^^^
+
+*Available as of Camel 2.8*
+
+You can configure custom `SecurityPolicy` and `Extension`'s to the
+`CometdComponent` which allows you to use authentication as
+http://cometd.org/documentation/howtos/authentication[documented here]
+
+[[Cometd-SettingupSSLforCometdComponent]]
+Setting up SSL for Cometd Component
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+[[Cometd-UsingtheJSSEConfigurationUtility]]
+Using the JSSE Configuration Utility
+++++++++++++++++++++++++++++++++++++
+
+As of Camel 2.9, the Cometd component supports SSL/TLS configuration
+through the link:camel-configuration-utilities.html[Camel JSSE
+Configuration Utility].  This utility greatly decreases the amount of
+component specific code you need to write and is configurable at the
+endpoint and component levels.  The following examples demonstrate how
+to use the utility with the Cometd component. You need to configure SSL
+on the CometdComponent.
+
+[[Cometd-Programmaticconfigurationofthecomponent]]
+Programmatic configuration of the component
+
+[source,java]
+-----------------------------------------------------------------------------------------------
+KeyStoreParameters ksp = new KeyStoreParameters();
+ksp.setResource("/users/home/server/keystore.jks");
+ksp.setPassword("keystorePassword");
+
+KeyManagersParameters kmp = new KeyManagersParameters();
+kmp.setKeyStore(ksp);
+kmp.setKeyPassword("keyPassword");
+
+TrustManagersParameters tmp = new TrustManagersParameters();
+tmp.setKeyStore(ksp);
+
+SSLContextParameters scp = new SSLContextParameters();
+scp.setKeyManagers(kmp);
+scp.setTrustManagers(tmp);
+
+CometdComponent commetdComponent = getContext().getComponent("cometds", CometdComponent.class);
+commetdComponent.setSslContextParameters(scp);
+-----------------------------------------------------------------------------------------------
+
+[[Cometd-SpringDSLbasedconfigurationofendpoint]]
+Spring DSL based configuration of endpoint
+
+[source,xml]
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+...
+  <camel:sslContextParameters
+      id="sslContextParameters">
+    <camel:keyManagers
+        keyPassword="keyPassword">
+      <camel:keyStore
+          resource="/users/home/server/keystore.jks"
+          password="keystorePassword"/>
+    </camel:keyManagers>
+    <camel:trustManagers>
+      <camel:keyStore
+          resource="/users/home/server/keystore.jks"
+          password="keystorePassword"/>
+    </camel:keyManagers>
+  </camel:sslContextParameters>...
+ 
+  <bean id="cometd" class="org.apache.camel.component.cometd.CometdComponent">
+    <property name="sslContextParameters" ref="sslContextParameters"/>
+  </bean>
+...
+  <to uri="cometds://127.0.0.1:443/service/test?baseResource=file:./target/test-classes/webapp&timeout=240000&interval=0&maxInterval=30000&multiFrameInterval=1500&jsonCommented=true&logLevel=2"/>...
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+[[Cometd-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/9c0b7baf/components/camel-cometd/src/main/docs/cometd.adoc
----------------------------------------------------------------------
diff --git a/components/camel-cometd/src/main/docs/cometd.adoc b/components/camel-cometd/src/main/docs/cometd.adoc
deleted file mode 100644
index 8135538..0000000
--- a/components/camel-cometd/src/main/docs/cometd.adoc
+++ /dev/null
@@ -1,207 +0,0 @@
-[[Cometd-CometdComponent]]
-Cometd Component
-~~~~~~~~~~~~~~~~
-
-The *cometd:* component is a transport for working with the
-http://www.mortbay.org/jetty[jetty] implementation of the
-http://docs.codehaus.org/display/JETTY/Cometd+%28aka+Bayeux%29[cometd/bayeux
-protocol]. +
- Using this component in combination with the dojo toolkit library it's
-possible to push Camel messages directly into the browser using an AJAX
-based mechanism.
-
-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-cometd</artifactId>
-    <version>x.x.x</version>
-    <!-- use the same version as your Camel core version -->
-</dependency>
-------------------------------------------------------------
-
-[[Cometd-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
-----------------------------------------
-cometd://host:port/channelName[?options]
-----------------------------------------
-
-The *channelName* represents a topic that can be subscribed to by the
-Camel endpoints.
-
-[[Cometd-Examples]]
-Examples
-^^^^^^^^
-
-------------------------------------------
-cometd://localhost:8080/service/mychannel
-cometds://localhost:8443/service/mychannel
-------------------------------------------
-
-where `cometds:` represents an SSL configured endpoint.
-
-[[Cometd-Options]]
-Options
-^^^^^^^
-
-
-
-// component options: START
-The CometD component supports 6 options which are listed below.
-
-
-
-{% raw %}
-[width="100%",cols="2s,1m,8",options="header"]
-|=======================================================================
-| Name | Java Type | Description
-| sslKeyPassword | String | The password for the keystore when using SSL.
-| sslPassword | String | The password when using SSL.
-| sslKeystore | String | The path to the keystore.
-| securityPolicy | SecurityPolicy | To use a custom configured SecurityPolicy to control authorization
-| extensions | List | To use a list of custom BayeuxServer.Extension that allows modifying incoming and outgoing requests.
-| sslContextParameters | SSLContextParameters | To configure security using SSLContextParameters
-|=======================================================================
-{% endraw %}
-// component options: END
-
-
-
-
-
-// endpoint options: START
-The CometD component supports 19 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
-| port | common |  | int | *Required* Host port number
-| channelName | common |  | String | *Required* The channelName represents a topic that can be subscribed to by the Camel endpoints.
-| allowedOrigins | common | * | String | The origins domain that support to cross if the crosssOriginFilterOn is true
-| baseResource | common |  | String | The root directory for the web resources or classpath. Use the protocol file: or classpath: depending if you want that the component loads the resource from file system or classpath. Classpath is required for OSGI deployment where the resources are packaged in the jar
-| crossOriginFilterOn | common | false | boolean | If true the server will support for cross-domain filtering
-| filterPath | common |  | String | The filterPath will be used by the CrossOriginFilter if the crosssOriginFilterOn is true
-| interval | common |  | int | The client side poll timeout in milliseconds. How long a client will wait between reconnects
-| jsonCommented | common | true | boolean | If true the server will accept JSON wrapped in a comment and will generate JSON wrapped in a comment. This is a defence against Ajax Hijacking.
-| logLevel | common | 1 | int | Logging level. 0=none 1=info 2=debug.
-| maxInterval | common | 30000 | int | The max client side poll timeout in milliseconds. A client will be removed if a connection is not received in this time.
-| multiFrameInterval | common | 1500 | int | The client side poll timeout if multiple connections are detected from the same browser.
-| timeout | common | 240000 | int | The server side poll timeout in milliseconds. This is how long the server will hold a reconnect request before responding.
-| 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.
-| sessionHeadersEnabled | consumer | false | boolean | Whether to include the server session headers in the Camel message when creating a Camel Message for incoming requests.
-| 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.
-| disconnectLocalSession | producer | false | boolean | Whether to disconnect local sessions after publishing a message to its channel. Disconnecting local session is needed as they are not swept by default by CometD and therefore you can run out of memory.
-| 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
-
-
-
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-Here is some examples on How to pass the parameters
-
-For file (for webapp resources located in the Web Application directory
---> cometd://localhost:8080?resourceBase=file./webapp +
- For classpath (when by example the web resources are packaged inside
-the webapp folder -->
-cometd://localhost:8080?resourceBase=classpath:webapp
-
-[[Cometd-Authentication]]
-Authentication
-^^^^^^^^^^^^^^
-
-*Available as of Camel 2.8*
-
-You can configure custom `SecurityPolicy` and `Extension`'s to the
-`CometdComponent` which allows you to use authentication as
-http://cometd.org/documentation/howtos/authentication[documented here]
-
-[[Cometd-SettingupSSLforCometdComponent]]
-Setting up SSL for Cometd Component
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-[[Cometd-UsingtheJSSEConfigurationUtility]]
-Using the JSSE Configuration Utility
-++++++++++++++++++++++++++++++++++++
-
-As of Camel 2.9, the Cometd component supports SSL/TLS configuration
-through the link:camel-configuration-utilities.html[Camel JSSE
-Configuration Utility].  This utility greatly decreases the amount of
-component specific code you need to write and is configurable at the
-endpoint and component levels.  The following examples demonstrate how
-to use the utility with the Cometd component. You need to configure SSL
-on the CometdComponent.
-
-[[Cometd-Programmaticconfigurationofthecomponent]]
-Programmatic configuration of the component
-
-[source,java]
------------------------------------------------------------------------------------------------
-KeyStoreParameters ksp = new KeyStoreParameters();
-ksp.setResource("/users/home/server/keystore.jks");
-ksp.setPassword("keystorePassword");
-
-KeyManagersParameters kmp = new KeyManagersParameters();
-kmp.setKeyStore(ksp);
-kmp.setKeyPassword("keyPassword");
-
-TrustManagersParameters tmp = new TrustManagersParameters();
-tmp.setKeyStore(ksp);
-
-SSLContextParameters scp = new SSLContextParameters();
-scp.setKeyManagers(kmp);
-scp.setTrustManagers(tmp);
-
-CometdComponent commetdComponent = getContext().getComponent("cometds", CometdComponent.class);
-commetdComponent.setSslContextParameters(scp);
------------------------------------------------------------------------------------------------
-
-[[Cometd-SpringDSLbasedconfigurationofendpoint]]
-Spring DSL based configuration of endpoint
-
-[source,xml]
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-...
-  <camel:sslContextParameters
-      id="sslContextParameters">
-    <camel:keyManagers
-        keyPassword="keyPassword">
-      <camel:keyStore
-          resource="/users/home/server/keystore.jks"
-          password="keystorePassword"/>
-    </camel:keyManagers>
-    <camel:trustManagers>
-      <camel:keyStore
-          resource="/users/home/server/keystore.jks"
-          password="keystorePassword"/>
-    </camel:keyManagers>
-  </camel:sslContextParameters>...
- 
-  <bean id="cometd" class="org.apache.camel.component.cometd.CometdComponent">
-    <property name="sslContextParameters" ref="sslContextParameters"/>
-  </bean>
-...
-  <to uri="cometds://127.0.0.1:443/service/test?baseResource=file:./target/test-classes/webapp&timeout=240000&interval=0&maxInterval=30000&multiFrameInterval=1500&jsonCommented=true&logLevel=2"/>...
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-
-[[Cometd-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/9c0b7baf/components/camel-consul/src/main/docs/consul-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc
new file mode 100644
index 0000000..167d209
--- /dev/null
+++ b/components/camel-consul/src/main/docs/consul-component.adoc
@@ -0,0 +1,112 @@
+[[Consul-ConsulComponent]]
+Consul Component
+~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.18*
+
+The *Consul* component is a component for integrating your application with Consul.
+
+Maven users will need to add the following dependency to their pom.xml
+for this component:
+
+[source,java]
+-------------------------------------------------
+    <dependency>
+        <groupId>org.apache.camel</groupId>
+        <artifactId>camel-consul</artifactId>
+        <version>${camel-version}</version>
+    </dependency>
+-------------------------------------------------
+
+[[Consul-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+---------------------------------------
+    consul://domain?[options]
+---------------------------------------
+
+You can append query options to the URI in the following format:
+
+---------------------------------------
+    ?option=value&option=value&...
+---------------------------------------
+
+[[Consul-Options]]
+Options
+^^^^^^^
+
+
+
+
+// component options: START
+The Consul component has no options.
+// component options: END
+
+
+
+
+
+
+// endpoint options: START
+The Consul component supports 22 endpoint options which are listed below:
+
+{% raw %}
+[width="100%",cols="2s,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| apiEndpoint | common |  | String | *Required* The API endpoint
+| connectTimeoutMillis | common |  | Long | Connect timeout for OkHttpClient
+| dc | common |  | String | The data center
+| key | common |  | String | The default key. Can be overridden by CamelConsulKey
+| pingInstance | common | true | boolean | Configure if the AgentClient should attempt a ping before returning the Consul instance
+| readTimeoutMillis | common |  | Long | Read timeout for OkHttpClient
+| tags | common |  | String | Set tags. You can separate multiple tags by comma.
+| url | common |  | String | The Consul agent URL
+| writeTimeoutMillis | common |  | Long | Write timeout for OkHttpClient
+| 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.
+| action | producer |  | String | The default action. Can be overridden by CamelConsulAction
+| valueAsString | producer | false | boolean | Default to transform values retrieved from Consul i.e. on KV endpoint to string.
+| 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).
+| blockSeconds | watch | 10 | Integer | The second to wait for a watch event default 10 seconds
+| firstIndex | watch | 0 | long | The first index for watch for default 0
+| recursive | watch | false | boolean | Recursively watch default false
+| aclToken | security |  | String | Sets the ACL token to be used with Consul
+| password | security |  | String | Sets the password to be used for basic authentication
+| sslContextParameters | security |  | SSLContextParameters | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance.
+| userName | security |  | String | Sets the username to be used for basic authentication
+|=======================================================================
+{% endraw %}
+// endpoint options: END
+
+
+
+
+[[Consul-Headers]]
+Headers
+^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Name |Type |Description
+|CamelConsulAction|String|The Producer action
+|CamelConsulKey|String|The Key on which the action should applied
+|CamelConsulEventId|String|The event id (consumer only)
+|CamelConsulEventName|String|The event name (consumer only)
+|CamelConsulEventLTime|Long|The event LTime
+|CamelConsulNodeFilter|String|The Node filter
+|CamelConsulTagFilter|String|The tag filter
+|CamelConsulSessionFilter|String|The session filter
+|CamelConsulVersion|int|The data version
+|CamelConsulFlags|Long|Flags associated with a value
+|CamelConsulCreateIndex|Long|The internal index value that represents when the entry was created
+|CamelConsulLockIndex|Long|The number of times this key has successfully been acquired in a lock
+|CamelConsulModifyIndex|Long|The last index that modified this key
+|CamelConsulOptions|Object|Options associated to the request
+|CamelConsulResult|boolean|true if the response has a result
+|CamelConsulSession|String|The session id
+|CamelConsulValueAsString|boolean|To transform values retrieved from Consul i.e. on KV endpoint to string.
+|=======================================================================

http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-consul/src/main/docs/consul.adoc
----------------------------------------------------------------------
diff --git a/components/camel-consul/src/main/docs/consul.adoc b/components/camel-consul/src/main/docs/consul.adoc
deleted file mode 100644
index 167d209..0000000
--- a/components/camel-consul/src/main/docs/consul.adoc
+++ /dev/null
@@ -1,112 +0,0 @@
-[[Consul-ConsulComponent]]
-Consul Component
-~~~~~~~~~~~~~~~~
-
-*Available as of Camel 2.18*
-
-The *Consul* component is a component for integrating your application with Consul.
-
-Maven users will need to add the following dependency to their pom.xml
-for this component:
-
-[source,java]
--------------------------------------------------
-    <dependency>
-        <groupId>org.apache.camel</groupId>
-        <artifactId>camel-consul</artifactId>
-        <version>${camel-version}</version>
-    </dependency>
--------------------------------------------------
-
-[[Consul-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
----------------------------------------
-    consul://domain?[options]
----------------------------------------
-
-You can append query options to the URI in the following format:
-
----------------------------------------
-    ?option=value&option=value&...
----------------------------------------
-
-[[Consul-Options]]
-Options
-^^^^^^^
-
-
-
-
-// component options: START
-The Consul component has no options.
-// component options: END
-
-
-
-
-
-
-// endpoint options: START
-The Consul component supports 22 endpoint options which are listed below:
-
-{% raw %}
-[width="100%",cols="2s,1,1m,1m,5",options="header"]
-|=======================================================================
-| Name | Group | Default | Java Type | Description
-| apiEndpoint | common |  | String | *Required* The API endpoint
-| connectTimeoutMillis | common |  | Long | Connect timeout for OkHttpClient
-| dc | common |  | String | The data center
-| key | common |  | String | The default key. Can be overridden by CamelConsulKey
-| pingInstance | common | true | boolean | Configure if the AgentClient should attempt a ping before returning the Consul instance
-| readTimeoutMillis | common |  | Long | Read timeout for OkHttpClient
-| tags | common |  | String | Set tags. You can separate multiple tags by comma.
-| url | common |  | String | The Consul agent URL
-| writeTimeoutMillis | common |  | Long | Write timeout for OkHttpClient
-| 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.
-| action | producer |  | String | The default action. Can be overridden by CamelConsulAction
-| valueAsString | producer | false | boolean | Default to transform values retrieved from Consul i.e. on KV endpoint to string.
-| 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).
-| blockSeconds | watch | 10 | Integer | The second to wait for a watch event default 10 seconds
-| firstIndex | watch | 0 | long | The first index for watch for default 0
-| recursive | watch | false | boolean | Recursively watch default false
-| aclToken | security |  | String | Sets the ACL token to be used with Consul
-| password | security |  | String | Sets the password to be used for basic authentication
-| sslContextParameters | security |  | SSLContextParameters | SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters instance.
-| userName | security |  | String | Sets the username to be used for basic authentication
-|=======================================================================
-{% endraw %}
-// endpoint options: END
-
-
-
-
-[[Consul-Headers]]
-Headers
-^^^^^^^
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Name |Type |Description
-|CamelConsulAction|String|The Producer action
-|CamelConsulKey|String|The Key on which the action should applied
-|CamelConsulEventId|String|The event id (consumer only)
-|CamelConsulEventName|String|The event name (consumer only)
-|CamelConsulEventLTime|Long|The event LTime
-|CamelConsulNodeFilter|String|The Node filter
-|CamelConsulTagFilter|String|The tag filter
-|CamelConsulSessionFilter|String|The session filter
-|CamelConsulVersion|int|The data version
-|CamelConsulFlags|Long|Flags associated with a value
-|CamelConsulCreateIndex|Long|The internal index value that represents when the entry was created
-|CamelConsulLockIndex|Long|The number of times this key has successfully been acquired in a lock
-|CamelConsulModifyIndex|Long|The last index that modified this key
-|CamelConsulOptions|Object|Options associated to the request
-|CamelConsulResult|boolean|true if the response has a result
-|CamelConsulSession|String|The session id
-|CamelConsulValueAsString|boolean|To transform values retrieved from Consul i.e. on KV endpoint to string.
-|=======================================================================

http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-context/src/main/docs/context-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-context/src/main/docs/context-component.adoc b/components/camel-context/src/main/docs/context-component.adoc
new file mode 100644
index 0000000..92f1a06
--- /dev/null
+++ b/components/camel-context/src/main/docs/context-component.adoc
@@ -0,0 +1,174 @@
+[[Context-ContextComponent]]
+Context Component
+~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.7*
+
+The *context* component allows you to create new Camel Components from a
+CamelContext with a number of routes which is then treated as a black
+box, allowing you to refer to the local endpoints within the component
+from other CamelContexts.
+
+It is similar to the link:routebox.html[Routebox] component in idea,
+though the Context component tries to be really simple for end users;
+just a simple convention over configuration approach to refer to local
+endpoints inside the CamelContext Component.
+
+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-context</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[Context-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+--------------------------------------------------
+context:camelContextId:localEndpointName[?options]
+--------------------------------------------------
+
+Or you can omit the "context:" prefix.
+
+[source,java]
+------------------------------------------
+camelContextId:localEndpointName[?options]
+------------------------------------------
+
+
+
+// component options: START
+The Camel Context component has no options.
+// component options: END
+
+
+
+// endpoint options: START
+The Camel Context 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
+| contextId | common |  | String | *Required* Is the ID you used to register the CamelContext into the Registry.
+| localEndpointUrl | common |  | String | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs.
+| 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
+
+
+You can append query options to the URI in the following format,
+`?option=value&option=value&...`
+
+[[Context-Example]]
+Example
+^^^^^^^
+
+In this example we'll create a black box context, then we'll use it from
+another CamelContext.
+
+[[Context-Definingthecontextcomponent]]
+Defining the context component
+++++++++++++++++++++++++++++++
+
+First you need to create a CamelContext, add some routes in it, start it
+and then register the CamelContext into the link:registry.html[Registry]
+(JNDI, Spring, Guice or OSGi etc).
+
+This can be done in the usual Camel way from this
+http://svn.apache.org/viewvc/camel/trunk/components/camel-context/src/test/java/org/apache/camel/component/context/JavaDslBlackBoxTest.java?revision=1069442&view=markup[test
+case] (see the createRegistry() method); this example shows Java and
+JNDI being used...
+
+[source,java]
+------------------------------------------------------------------------------------
+// lets create our black box as a camel context and a set of routes
+DefaultCamelContext blackBox = new DefaultCamelContext(registry);
+blackBox.setName("blackBox");
+blackBox.addRoutes(new RouteBuilder() {
+    @Override
+    public void configure() throws Exception {
+        // receive purchase orders, lets process it in some way then send an invoice
+        // to our invoice endpoint
+        from("direct:purchaseOrder").
+          setHeader("received").constant("true").
+          to("direct:invoice");
+    }
+});
+blackBox.start();
+
+registry.bind("accounts", blackBox);
+------------------------------------------------------------------------------------
+
+Notice in the above route we are using pure local endpoints (*direct*
+and *seda*). Also note we expose this CamelContext using the *accounts*
+ID. We can do the same thing in Spring via
+
+[source,xml]
+--------------------------------------------------------------------------
+<camelContext id="accounts" xmlns="http://camel.apache.org/schema/spring">
+  <route> 
+    <from uri="direct:purchaseOrder"/>
+    ...
+    <to uri="direct:invoice"/>
+  </route>
+</camelContext>
+--------------------------------------------------------------------------
+
+[[Context-Usingthecontextcomponent]]
+Using the context component
++++++++++++++++++++++++++++
+
+Then in another CamelContext we can then refer to this "accounts black
+box" by just sending to *accounts:purchaseOrder* and consuming from
+*accounts:invoice*.
+
+If you prefer to be more verbose and explicit you could use
+*context:accounts:purchaseOrder* or even
+*context:accounts:direct://purchaseOrder* if you prefer. But using
+logical endpoint URIs is preferred as it hides the implementation detail
+and provides a simple logical naming scheme.
+
+For example if we wish to then expose this accounts black box on some
+middleware (outside of the black box) we can do things like...
+
+[source,xml]
+--------------------------------------------------------------------------------
+<camelContext xmlns="http://camel.apache.org/schema/spring">
+  <route> 
+    <!-- consume from an ActiveMQ into the black box -->
+    <from uri="activemq:Accounts.PurchaseOrders"/>
+    <to uri="accounts:purchaseOrders"/>
+  </route>
+  <route> 
+    <!-- lets send invoices from the black box to a different ActiveMQ Queue -->
+    <from uri="accounts:invoice"/>
+    <to uri="activemq:UK.Accounts.Invoices"/>
+  </route>
+</camelContext>
+--------------------------------------------------------------------------------
+
+[[Context-Namingendpoints]]
+Naming endpoints
+++++++++++++++++
+
+A context component instance can have many public input and output
+endpoints that can be accessed from outside it's CamelContext. When
+there are many it is recommended that you use logical names for them to
+hide the middleware as shown above.
+
+However when there is only one input, output or error/dead letter
+endpoint in a component we recommend using the common posix shell names
+*in*, *out* and *err*

http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-context/src/main/docs/context.adoc
----------------------------------------------------------------------
diff --git a/components/camel-context/src/main/docs/context.adoc b/components/camel-context/src/main/docs/context.adoc
deleted file mode 100644
index 92f1a06..0000000
--- a/components/camel-context/src/main/docs/context.adoc
+++ /dev/null
@@ -1,174 +0,0 @@
-[[Context-ContextComponent]]
-Context Component
-~~~~~~~~~~~~~~~~~
-
-*Available as of Camel 2.7*
-
-The *context* component allows you to create new Camel Components from a
-CamelContext with a number of routes which is then treated as a black
-box, allowing you to refer to the local endpoints within the component
-from other CamelContexts.
-
-It is similar to the link:routebox.html[Routebox] component in idea,
-though the Context component tries to be really simple for end users;
-just a simple convention over configuration approach to refer to local
-endpoints inside the CamelContext Component.
-
-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-context</artifactId>
-    <version>x.x.x</version>
-    <!-- use the same version as your Camel core version -->
-</dependency>
-------------------------------------------------------------
-
-[[Context-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
---------------------------------------------------
-context:camelContextId:localEndpointName[?options]
---------------------------------------------------
-
-Or you can omit the "context:" prefix.
-
-[source,java]
-------------------------------------------
-camelContextId:localEndpointName[?options]
-------------------------------------------
-
-
-
-// component options: START
-The Camel Context component has no options.
-// component options: END
-
-
-
-// endpoint options: START
-The Camel Context 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
-| contextId | common |  | String | *Required* Is the ID you used to register the CamelContext into the Registry.
-| localEndpointUrl | common |  | String | *Required* Can be a valid Camel URI evaluated within the black box CamelContext. Or it can be a logical name which is mapped to any local endpoints. For example if you locally have endpoints like direct:invoices and seda:purchaseOrders inside a CamelContext of id supplyChain then you can just use the URIs supplyChain:invoices or supplyChain:purchaseOrders to omit the physical endpoint kind and use pure logical URIs.
-| 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
-
-
-You can append query options to the URI in the following format,
-`?option=value&option=value&...`
-
-[[Context-Example]]
-Example
-^^^^^^^
-
-In this example we'll create a black box context, then we'll use it from
-another CamelContext.
-
-[[Context-Definingthecontextcomponent]]
-Defining the context component
-++++++++++++++++++++++++++++++
-
-First you need to create a CamelContext, add some routes in it, start it
-and then register the CamelContext into the link:registry.html[Registry]
-(JNDI, Spring, Guice or OSGi etc).
-
-This can be done in the usual Camel way from this
-http://svn.apache.org/viewvc/camel/trunk/components/camel-context/src/test/java/org/apache/camel/component/context/JavaDslBlackBoxTest.java?revision=1069442&view=markup[test
-case] (see the createRegistry() method); this example shows Java and
-JNDI being used...
-
-[source,java]
-------------------------------------------------------------------------------------
-// lets create our black box as a camel context and a set of routes
-DefaultCamelContext blackBox = new DefaultCamelContext(registry);
-blackBox.setName("blackBox");
-blackBox.addRoutes(new RouteBuilder() {
-    @Override
-    public void configure() throws Exception {
-        // receive purchase orders, lets process it in some way then send an invoice
-        // to our invoice endpoint
-        from("direct:purchaseOrder").
-          setHeader("received").constant("true").
-          to("direct:invoice");
-    }
-});
-blackBox.start();
-
-registry.bind("accounts", blackBox);
-------------------------------------------------------------------------------------
-
-Notice in the above route we are using pure local endpoints (*direct*
-and *seda*). Also note we expose this CamelContext using the *accounts*
-ID. We can do the same thing in Spring via
-
-[source,xml]
---------------------------------------------------------------------------
-<camelContext id="accounts" xmlns="http://camel.apache.org/schema/spring">
-  <route> 
-    <from uri="direct:purchaseOrder"/>
-    ...
-    <to uri="direct:invoice"/>
-  </route>
-</camelContext>
---------------------------------------------------------------------------
-
-[[Context-Usingthecontextcomponent]]
-Using the context component
-+++++++++++++++++++++++++++
-
-Then in another CamelContext we can then refer to this "accounts black
-box" by just sending to *accounts:purchaseOrder* and consuming from
-*accounts:invoice*.
-
-If you prefer to be more verbose and explicit you could use
-*context:accounts:purchaseOrder* or even
-*context:accounts:direct://purchaseOrder* if you prefer. But using
-logical endpoint URIs is preferred as it hides the implementation detail
-and provides a simple logical naming scheme.
-
-For example if we wish to then expose this accounts black box on some
-middleware (outside of the black box) we can do things like...
-
-[source,xml]
---------------------------------------------------------------------------------
-<camelContext xmlns="http://camel.apache.org/schema/spring">
-  <route> 
-    <!-- consume from an ActiveMQ into the black box -->
-    <from uri="activemq:Accounts.PurchaseOrders"/>
-    <to uri="accounts:purchaseOrders"/>
-  </route>
-  <route> 
-    <!-- lets send invoices from the black box to a different ActiveMQ Queue -->
-    <from uri="accounts:invoice"/>
-    <to uri="activemq:UK.Accounts.Invoices"/>
-  </route>
-</camelContext>
---------------------------------------------------------------------------------
-
-[[Context-Namingendpoints]]
-Naming endpoints
-++++++++++++++++
-
-A context component instance can have many public input and output
-endpoints that can be accessed from outside it's CamelContext. When
-there are many it is recommended that you use logical names for them to
-hide the middleware as shown above.
-
-However when there is only one input, output or error/dead letter
-endpoint in a component we recommend using the common posix shell names
-*in*, *out* and *err*

http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-couchdb/src/main/docs/couchdb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
new file mode 100644
index 0000000..e5393a8
--- /dev/null
+++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
@@ -0,0 +1,133 @@
+[[CouchDB-CamelCouchDBcomponent]]
+Camel CouchDB component
+~~~~~~~~~~~~~~~~~~~~~~~
+
+*Available as of Camel 2.11*
+
+The *couchdb:* component allows you to treat
+http://couchdb.apache.org/[CouchDB] instances as a producer or consumer
+of messages. Using the lightweight LightCouch API, this camel component
+has the following features:
+
+* As a consumer, monitors couch changesets for inserts, updates and
+deletes and publishes these as messages into camel routes.
+* As a producer, can save or update documents into couch.
+* Can support as many endpoints as required, eg for multiple databases
+across multiple instances.
+* Ability to have events trigger for only deletes, only inserts/updates
+or all (default).
+* Headers set for sequenceId, document revision, document id, and HTTP
+method type.
+
+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-couchdb</artifactId>
+    <version>x.x.x</version>
+    <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+[[CouchDB-URIformat]]
+URI format
+^^^^^^^^^^
+
+[source,java]
+-------------------------------------------------
+couchdb:http://hostname[:port]/database?[options]
+-------------------------------------------------
+
+Where *hostname* is the hostname of the running couchdb instance. Port
+is optional and if not specified then defaults to 5984.
+
+[[CouchDB-Options]]
+Options
+^^^^^^^
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Property |Default |Description
+
+|`deletes` |`true` |document deletes are published as events
+
+|`updates` |`true` |document inserts/updates are published as events
+
+|`heartbeat` |`30000` |how often to send an empty message to keep socket alive in millis
+
+|`createDatabase` |`true` |create the database if it does not already exist
+
+|`username` |`null` |username in case of authenticated databases
+
+|`password` |`null` |password for authenticated databases
+|=======================================================================
+
+[[CouchDB-Headers]]
+Headers
+^^^^^^^
+
+The following headers are set on exchanges during message transport.
+
+[width="100%",cols="20%,80%",options="header",]
+|=======================================================================
+|Property |Value
+
+|`CouchDbDatabase` |the database the message came from
+
+|`CouchDbSeq` |the couchdb changeset sequence number of the update / delete message
+
+|`CouchDbId` |the couchdb document id
+
+|`CouchDbRev` |the couchdb document revision
+
+|`CouchDbMethod` |the method (delete / update)
+|=======================================================================
+
+Headers are set by the consumer once the message is received. The
+producer will also set the headers for downstream processors once the
+insert/update has taken place. Any headers set prior to the producer are
+ignored. That means for example, if you set CouchDbId as a header, it
+will not be used as the id for insertion, the id of the document will
+still be used.
+
+[[CouchDB-MessageBody]]
+Message Body
+^^^^^^^^^^^^
+
+The component will use the message body as the document to be inserted.
+If the body is an instance of String, then it will be marshalled into a
+GSON object before insert. This means that the string must be valid JSON
+or the insert / update will fail. If the body is an instance of a
+com.google.gson.JsonElement then it will be inserted as is. Otherwise
+the producer will throw an exception of unsupported body type.
+
+[[CouchDB-Samples]]
+Samples
+^^^^^^^
+
+For example if you wish to consume all inserts, updates and deletes from
+a CouchDB instance running locally, on port 9999 then you could use the
+following:
+
+[source,java]
+-------------------------------------------------------------
+from("couchdb:http://localhost:9999").process(someProcessor);
+-------------------------------------------------------------
+
+If you were only interested in deletes, then you could use the following
+
+[source,java]
+---------------------------------------------------------------------------
+from("couchdb:http://localhost:9999?updates=false").process(someProcessor);
+---------------------------------------------------------------------------
+
+If you wanted to insert a message as a document, then the body of the
+exchange is used
+
+[source,java]
+----------------------------------------------------------------------------------------
+from("someProducingEndpoint").process(someProcessor).to("couchdb:http://localhost:9999")
+----------------------------------------------------------------------------------------

http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-couchdb/src/main/docs/couchdb.adoc
----------------------------------------------------------------------
diff --git a/components/camel-couchdb/src/main/docs/couchdb.adoc b/components/camel-couchdb/src/main/docs/couchdb.adoc
deleted file mode 100644
index e5393a8..0000000
--- a/components/camel-couchdb/src/main/docs/couchdb.adoc
+++ /dev/null
@@ -1,133 +0,0 @@
-[[CouchDB-CamelCouchDBcomponent]]
-Camel CouchDB component
-~~~~~~~~~~~~~~~~~~~~~~~
-
-*Available as of Camel 2.11*
-
-The *couchdb:* component allows you to treat
-http://couchdb.apache.org/[CouchDB] instances as a producer or consumer
-of messages. Using the lightweight LightCouch API, this camel component
-has the following features:
-
-* As a consumer, monitors couch changesets for inserts, updates and
-deletes and publishes these as messages into camel routes.
-* As a producer, can save or update documents into couch.
-* Can support as many endpoints as required, eg for multiple databases
-across multiple instances.
-* Ability to have events trigger for only deletes, only inserts/updates
-or all (default).
-* Headers set for sequenceId, document revision, document id, and HTTP
-method type.
-
-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-couchdb</artifactId>
-    <version>x.x.x</version>
-    <!-- use the same version as your Camel core version -->
-</dependency>
-------------------------------------------------------------
-
-[[CouchDB-URIformat]]
-URI format
-^^^^^^^^^^
-
-[source,java]
--------------------------------------------------
-couchdb:http://hostname[:port]/database?[options]
--------------------------------------------------
-
-Where *hostname* is the hostname of the running couchdb instance. Port
-is optional and if not specified then defaults to 5984.
-
-[[CouchDB-Options]]
-Options
-^^^^^^^
-
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Property |Default |Description
-
-|`deletes` |`true` |document deletes are published as events
-
-|`updates` |`true` |document inserts/updates are published as events
-
-|`heartbeat` |`30000` |how often to send an empty message to keep socket alive in millis
-
-|`createDatabase` |`true` |create the database if it does not already exist
-
-|`username` |`null` |username in case of authenticated databases
-
-|`password` |`null` |password for authenticated databases
-|=======================================================================
-
-[[CouchDB-Headers]]
-Headers
-^^^^^^^
-
-The following headers are set on exchanges during message transport.
-
-[width="100%",cols="20%,80%",options="header",]
-|=======================================================================
-|Property |Value
-
-|`CouchDbDatabase` |the database the message came from
-
-|`CouchDbSeq` |the couchdb changeset sequence number of the update / delete message
-
-|`CouchDbId` |the couchdb document id
-
-|`CouchDbRev` |the couchdb document revision
-
-|`CouchDbMethod` |the method (delete / update)
-|=======================================================================
-
-Headers are set by the consumer once the message is received. The
-producer will also set the headers for downstream processors once the
-insert/update has taken place. Any headers set prior to the producer are
-ignored. That means for example, if you set CouchDbId as a header, it
-will not be used as the id for insertion, the id of the document will
-still be used.
-
-[[CouchDB-MessageBody]]
-Message Body
-^^^^^^^^^^^^
-
-The component will use the message body as the document to be inserted.
-If the body is an instance of String, then it will be marshalled into a
-GSON object before insert. This means that the string must be valid JSON
-or the insert / update will fail. If the body is an instance of a
-com.google.gson.JsonElement then it will be inserted as is. Otherwise
-the producer will throw an exception of unsupported body type.
-
-[[CouchDB-Samples]]
-Samples
-^^^^^^^
-
-For example if you wish to consume all inserts, updates and deletes from
-a CouchDB instance running locally, on port 9999 then you could use the
-following:
-
-[source,java]
--------------------------------------------------------------
-from("couchdb:http://localhost:9999").process(someProcessor);
--------------------------------------------------------------
-
-If you were only interested in deletes, then you could use the following
-
-[source,java]
----------------------------------------------------------------------------
-from("couchdb:http://localhost:9999?updates=false").process(someProcessor);
----------------------------------------------------------------------------
-
-If you wanted to insert a message as a document, then the body of the
-exchange is used
-
-[source,java]
-----------------------------------------------------------------------------------------
-from("someProducingEndpoint").process(someProcessor).to("couchdb:http://localhost:9999")
-----------------------------------------------------------------------------------------

http://git-wip-us.apache.org/repos/asf/camel/blob/9c0b7baf/components/camel-crypto/src/main/docs/crypto-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-crypto/src/main/docs/crypto-component.adoc b/components/camel-crypto/src/main/docs/crypto-component.adoc
new file mode 100644
index 0000000..b1c60f9
--- /dev/null
+++ b/components/camel-crypto/src/main/docs/crypto-component.adoc
@@ -0,0 +1,609 @@
+[[Crypto-Crypto]]
+Crypto
+~~~~~~
+
+*Available as of Camel 2.3* 
+*PGP Available as of Camel 2.9*
+
+The Crypto link:data-format.html[Data Format] integrates the Java
+Cryptographic Extension into Camel, allowing simple and flexible
+encryption and decryption of messages using Camel's familiar marshall
+and unmarshal formatting mechanism. It assumes marshalling to mean
+encryption to cyphertext and unmarshalling to mean decryption back to
+the original plaintext. This data format implements only symmetric
+(shared-key) encryption and decyption.
+
+[[Crypto-Options]]
+Options
+^^^^^^^
+[width="70%",cols="10%,10%,10%,70%",options="header",]
+|=======================================================================
+|Name |Type |Default |Description
+
+|`algorithm` |`String` |`DES/CBC/PKCS5Padding` |The JCE algorithm name indicating the cryptographic algorithm that will
+be used.
+
+|`algorithmParameterSpec` |`java.security.spec.AlgorithmParameterSpec` |`null` |A JCE AlgorithmParameterSpec used to initialize the Cipher.
+
+|`bufferSize` |`Integer` |`4096` |the size of the buffer used in the signature process.
+
+|`cryptoProvider` |`String` |`null` |The name of the JCE Security Provider that should be used.
+
+|`initializationVector` |`byte[]` |`null` |A byte array containing the Initialization Vector that will be used to
+initialize the Cipher.
+
+|`inline` |`boolean` |`false` |Flag indicating that the configured IV should be inlined into the
+encrypted data stream.
+
+|`macAlgorithm` |`String` |`null` |The JCE algorithm name indicating the Message Authentication algorithm.
+
+|`shouldAppendHMAC` |`boolean` |`null`
+|=======================================================================
+
+Flag indicating that a Message Authentication Code should be calculated
+and appended to the encrypted data.
+
+[[Crypto-BasicUsage]]
+Basic Usage
+^^^^^^^^^^^
+
+At its most basic all that is required to encrypt/decrypt an exchange is
+a shared secret key. If one or more instances of the Crypto data format
+are configured with this key the format can be used to encrypt the
+payload in one route (or part of one) and decrypted in another. For
+example, using the Java DSL as follows:
+
+In Spring the dataformat is configured first and then used in routes
+
+[source,xml]
+-----------------------------------------------------------------------
+<camelContext id="camel" xmlns="http://camel.apache.org/schema/spring">
+  <dataFormats>
+    <crypto id="basic" algorithm="DES" keyRef="desKey" />
+  </dataFormats>
+    ...
+  <route>
+    <from uri="direct:basic-encryption" />
+    <marshal ref="basic" />
+    <to uri="mock:encrypted" />
+    <unmarshal ref="basic" />
+    <to uri="mock:unencrypted" />
+  </route>
+</camelContext>
+-----------------------------------------------------------------------
+
+[[Crypto-SpecifyingtheEncryptionAlgorithm]]
+Specifying the Encryption Algorithm
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Changing the algorithm is a matter of supplying the JCE algorithm name.
+If you change the algorithm you will need to use a compatible key.
+
+A list of the available algorithms in Java 7 is available via the
+http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html[Java
+Cryptography Architecture Standard Algorithm Name Documentation].
+
+[[Crypto-SpecifyinganInitializationVector]]
+Specifying an Initialization Vector
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Some crypto algorithms, particularly block algorithms, require
+configuration with an initial block of data known as an Initialization
+Vector. In the JCE this is passed as an AlgorithmParameterSpec when the
+Cipher is initialized. To use such a vector with the CryptoDataFormat
+you can configure it with a byte[] containing the required data e.g.
+
+or with spring, suppling a reference to a byte[]
+
+The same vector is required in both the encryption and decryption
+phases. As it is not necessary to keep the IV a secret, the DataFormat
+allows for it to be inlined into the encrypted data and subsequently
+read out in the decryption phase to initialize the Cipher. To inline the
+IV set the /oinline flag.
+
+or with spring.
+
+For more information of the use of Initialization Vectors, consult
+
+*
+http://en.wikipedia.org/wiki/Initialization_vector[http://en.wikipedia.org/wiki/Initialization_vector]
+*
+http://www.herongyang.com/Cryptography/[http://www.herongyang.com/Cryptography/]
+*
+http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation[http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation]
+
+[[Crypto-HashedMessageAuthenticationCodes(HMAC)]]
+Hashed Message Authentication Codes (HMAC)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+To avoid attacks against the encrypted data while it is in transit the
+CryptoDataFormat can also calculate a Message Authentication Code for
+the encrypted exchange contents based on a configurable MAC algorithm.
+The calculated HMAC is appended to the stream after encryption. It is
+separated from the stream in the decryption phase. The MAC is
+recalculated and verified against the transmitted version to insure
+nothing was tampered with in transit.For more information on Message
+Authentication Codes see
+http://en.wikipedia.org/wiki/HMAC[http://en.wikipedia.org/wiki/HMAC]
+
+or with spring.
+
+By default the HMAC is calculated using the HmacSHA1 mac algorithm
+though this can be easily changed by supplying a different algorithm
+name. See
+https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=CAMEL&title=here&linkCreation=true&fromPageId=17268915[here]
+for how to check what algorithms are available through the configured
+security providers
+
+or with spring.
+
+[[Crypto-SupplyingKeysDynamically]]
+Supplying Keys Dynamically
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When using a Recipient list or similar EIP the recipient of an exchange
+can vary dynamically. Using the same key across all recipients may
+neither be feasible or desirable. It would be useful to be able to
+specify keys dynamically on a per exchange basis. The exchange could
+then be dynamically enriched with the key of its target recipient before
+being processed by the data format. To facilitate this the DataFormat
+allow for keys to be supplied dynamically via the message headers below
+
+* `CryptoDataFormat.KEY` `"CamelCryptoKey"`
+
+or with spring.
+
+[[Crypto-PGPMessage]]
+PGP Message
+^^^^^^^^^^^
+
+The PGP Data Formater can create and decrypt/verify PGP Messages of the
+following PGP packet structure (entries in brackets are optional and
+ellipses indicate repetition, comma represents  sequential composition,
+and vertical bar separates alternatives):
+
+    Public Key Encrypted Session Key ..., Symmetrically Encrypted Data |
+Sym. Encrypted and Integrity Protected Data, (Compressed Data,) (One
+Pass Signature ...,) Literal Data, (Signature ...,)
+
+*Since Camel 2.16*.*0* the Compressed Data packet is optional, before it
+was mandatory.
+
+ 
+
+[[Crypto-PGPDataFormatOptions]]
+PGPDataFormat Options
+^^^^^^^^^^^^^^^^^^^^^
+[width="70%",cols="10%,10%,10%,70%",options="header",]
+|=======================================================================
+|Name |Type |Default |Description
+
+|`keyUserid` |`String` |`null` |The user ID of the key in the PGP keyring used during encryption. See
+also option `keyUserids`. Can also be only a part of a user ID. For
+example, if the user ID is "Test User <test@camel.com>" then you can use
+the part "Test User" or "<test@camel.com>" to address the user ID.
+
+|`keyUserids` |`List<String>` |`null` |*Since camel 2.12.2*: PGP allows to encrypt the symmetric key by several
+asymmetric public receiver keys. You can specify here the User IDs or
+parts of User IDs of several public keys contained in the PGP keyring.
+If you just have one User ID, then you can also use the option
+`keyUserid`. The User ID specified in `keyUserid` and the User IDs in
+`keyUserids` will be merged together and the corresponding public keys
+will be used for the encryption.
+
+|`password` |`String` |`null` |Password used when opening the private key (not used for encryption).
+
+|`keyFileName` |`String` |`null` |Filename of the keyring; must be accessible as a classpath resource (but
+you can specify a location in the file system by using the "file:"
+prefix).
+
+|`encryptionKeyRing` |`byte[]` |`null` |*Since camel 2.12.1*: encryption keyring; you can not set the
+keyFileName and encryptionKeyRing at the same time.
+
+|`signatureKeyUserid` |`String` |`null` |*Since Camel 2.11.0*; optional User ID of the key in the PGP keyring
+used for signing (during encryption) or signature verification (during
+decryption). During the signature verification process the specified
+User ID restricts the public keys from the public keyring which can be
+used for the verification. If no User ID is specified for the signature
+verficiation then any public key in the public keyring can be used for
+the verification. Can also be only a part of a user ID. For example, if
+the user ID is "Test User <test@camel.com>" then you can use the part
+"Test User" or "<test@camel.com>" to address the User ID.
+
+|`signatureKeyUserids` |`List<String>` |`null` |*Since Camel 2.12.3*: optional list of User IDs of the key in the PGP
+keyring used for signing (during encryption) or signature verification
+(during decryption). You can specify here the User IDs or parts of User
+IDs of several keys contained in the PGP keyring. If you just have one
+User ID, then you can also use the option `keyUserid`. The User ID
+specified in `keyUserid` and the User IDs in `keyUserids` will be merged
+together and the corresponding keys will be used for the signing or
+signature verification. If the specified User IDs reference several keys
+then for each key a signature is added to the PGP result during the
+encryption-signing process. In the decryption-verifying process the list
+of User IDs restricts the list of public keys which can be used for
+signature verification. If the list of User IDs is empty then any public
+key in the public keyring can be used for the signature verification.
+
+|`signaturePassword` |`String` |`null` |*Since Camel 2.11.0*: optional password used when opening the private
+key used for signing (during encryption).
+
+|`signatureKeyFileName` |`String` |`null` |*Since Camel 2.11.0*: optional filename of the keyring to use for
+signing (during encryption) or for signature verification (during
+decryption); must be accessible as a classpath resource (but you can
+specify a location in the file system by using the "file:" prefix).
+
+|`signatureKeyRing` |`byte[]` |`null` |*Since camel 2.12.1*: signature keyring; you can not set the
+signatureKeyFileName and signatureKeyRing at the same time.
+
+|`algorithm` |`int` |`SymmetricKeyAlgorithmTags.CAST5` |*Since camel 2.12.2*: symmetric key encryption algorithm; possible
+values are defined in `org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags`;
+for example 2 (= TRIPLE DES), 3 (= CAST5), 4 (= BLOWFISH), 6 (= DES), 7
+(= AES_128). Only relevant for encrypting.
+
+|`compressionAlgorithm` |`int` |`CompressionAlgorithmTags.ZIP` |*Since camel 2.12.2*: compression algorithm; possible values are defined
+in `org.bouncycastle.bcpg.CompressionAlgorithmTags`; for example 0 (=
+UNCOMPRESSED), 1 (= ZIP), 2 (= ZLIB), 3 (= BZIP2). Only relevant for
+encrypting.
+
+|`hashAlgorithm` |`int` |`HashAlgorithmTags.SHA1` |*Since camel 2.12.2*: signature hash algorithm; possible values are
+defined in `org.bouncycastle.bcpg.HashAlgorithmTags`; for example 2 (=
+SHA1), 8 (= SHA256), 9 (= SHA384), 10 (= SHA512), 11 (=SHA224). Only
+relevant for signing.
+
+|`armored` |`boolean` |`false` |This option will cause PGP to base64 encode the encrypted text, making
+it available for copy/paste, etc.
+
+|`integrity` |`boolean` |`true` |Adds an integrity check/sign into the encryption file.
+
+|`passphraseAccessor` |`PGPPassphraseAccessor` |`null` |*Since Camel 2.12.2*: provides passphrases corresponding to user Ids. If
+no passpharase can be found from the option `password` or
+`signaturePassword` and from the headers `CamelPGPDataFormatKeyPassword`
+or `CamelPGPDataFormatSignatureKeyPassword` then the passphrase is
+fetched from the passphrase accessor. You provide a bean which
+implements the interface
+https://github.com/apache/camel/blob/master/components/camel-crypto/src/main/java/org/apache/camel/converter/crypto/PGPPassphraseAccessor.java[PGPPassphraseAccessor].
+A default implementation is given by
+https://github.com/apache/camel/blob/master/components/camel-crypto/src/main/java/org/apache/camel/converter/crypto/DefaultPGPPassphraseAccessor.java[DefaultPGPPassphraseAccessor].
+The passphrase accessor is especially useful in the decrypt case; see
+chapter 'PGP Decrypting/Verifying of Messages Encrypted/Signed by
+Different Private/Public Keys' below.
+
+|`signatureVerificationOption` |`String` |`"optional"` |*Since Camel 2.13.0*: controls the behavior for verifying the signature
+during unmarshaling. There are three values possible:
+
+* `"optional"`: The PGP message may or may not contain signatures; if it
+does contain signatures, then a signature verification is executed. Use
+the constant
+PGPKeyAccessDataFormat.SIGNATURE_VERIFICATION_OPTION_OPTIONAL.
+* `"required"`: The PGP message must contain at least one signature; if
+this is not the case an exception (PGPException) is thrown. A signature
+verification is executed. Use the constant
+PGPKeyAccessDataFormat.SIGNATURE_VERIFICATION_OPTION_REQUIRED.
+* `"ignore"`: Contained signatures in the PGP message are ignored; no
+signature verification is executed. Use the constant
+PGPKeyAccessDataFormat.SIGNATURE_VERIFICATION_OPTION_IGNORE.
+* `"no_signature_allowed"`: The PGP message must not contain a
+signature; otherwise an exception (PGPException) is thrown. Use the
+constant
+PGPKeyAccessDataFormat.SIGNATURE_VERIFICATION_OPTION_NO_SIGNATURE_ALLOWED.
+
+|`FileName` |`String` |`"_CONSOLE"` |*Since camel 2.15.0*: Sets the file name for the literal data packet.
+Can be overwritten by the  header \{@link Exchange#FILE_NAME}.
+
+"`_CONSOLE`" indicates that the message is considered to be "for your
+eyes only". This advises that the message data is unusually sensitive,
+and the receiving program should process it more carefully, perhaps
+avoiding storing the received data to disk, for example.Only used for
+marshaling.
+
+|`withCompressedDataPacket` |boolean |`true` |*Since Camel 2.16.0*: Indicator whether the PGP Message shall be created
+with or without a Compressed Data packet. If the value is set to false,
+then no Compressed Data packet is added and the compressionAlgorithm
+value is ignored. Only used for marshaling.
+|=======================================================================
+
+[[Crypto-PGPDataFormatMessageHeaders]]
+PGPDataFormat Message Headers
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can override the PGPDataFormat options by applying below headers
+into message dynamically.
+
+[width="70%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Name |Type |Description
+
+|`CamelPGPDataFormatKeyFileName` |`String` |*Since Camel 2.11.0*; filename of the keyring; will override existing
+setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatEncryptionKeyRing` |`byte[]` |*Since Camel 2.12.1*; the encryption keyring; will override existing
+setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatKeyUserid` |`String` |*Since Camel 2.11.0*; the User ID of the key in the PGP keyring; will
+override existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatKeyUserids` |`List<String>` |*Since camel 2.12.2*: the User IDs of the key in the PGP keyring; will
+override existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatKeyPassword` |`String` |*Since Camel 2.11.0*; password used when opening the private key; will
+override existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatSignatureKeyFileName` |`String` |*Since Camel 2.11.0*; filename of the signature keyring; will override
+existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatSignatureKeyRing` |`byte[]` |*Since Camel 2.12.1*; the signature keyring; will override existing
+setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatSignatureKeyUserid` |`String` |*Since Camel 2.11.0*; the User ID of the signature key in the PGP
+keyring; will override existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatSignatureKeyUserids` |`List<String>` |*Since Camel 2.12.3*; the User IDs of the signature keys in the PGP
+keyring; will override existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatSignatureKeyPassword` |`String` |*Since Camel 2.11.0*; password used when opening the signature private
+key; will override existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatEncryptionAlgorithm` |`int` |*Since Camel 2.12.2*; symmetric key encryption algorithm; will override
+existing setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatSignatureHashAlgorithm` |`int` |*Since Camel 2.12.2*; signature hash algorithm; will override existing
+setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatCompressionAlgorithm` |`int` |*Since Camel 2.12.2*; compression algorithm; will override existing
+setting directly on the PGPDataFormat.
+
+|`CamelPGPDataFormatNumberOfEncryptionKeys` |`Integer` |*Since* *Camel 2.12.3; *number of public keys used for encrypting the
+symmectric key, set by PGPDataFormat during encryptiion process
+
+|`CamelPGPDataFormatNumberOfSigningKeys` |`Integer` |*Since* *Camel 2.12.3; *number of private keys used for creating
+signatures, set by PGPDataFormat during signing process
+|=======================================================================
+
+[[Crypto-EncryptingwithPGPDataFormat]]
+Encrypting with PGPDataFormat
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The following sample uses the popular PGP format for
+encrypting/decrypting files using the
+http://www.bouncycastle.org/java.html[Bouncy Castle Java libraries]:
+
+The following sample performs signing + encryption, and then signature
+verification + decryption. It uses the same keyring for both signing and
+encryption, but you can obviously use different keys:
+
+Or using Spring:
+
+[[Crypto-Toworkwiththepreviousexampleyouneedthefollowing]]
+To work with the previous example you need the following
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+* A public keyring file which contains the public keys used to encrypt
+the data
+* A private keyring file which contains the keys used to decrypt the
+data
+* The keyring password
+
+[[Crypto-Managingyourkeyring]]
+Managing your keyring
++++++++++++++++++++++
+
+To manage the keyring, I use the command line tools, I find this to be
+the simplest approach in managing the keys. There are also Java
+libraries available from
+http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
+if you would prefer to do it that way.
+
+1.  Install the command line utilities on linux
+
+[source,java]
+---------------------
+apt-get install gnupg
+---------------------
+2.  Create your keyring, entering a secure password
+
+[source,java]
+-------------
+gpg --gen-key
+-------------
+3.  If you need to import someone elses public key so that you can
+encrypt a file for them.
+
+[source,java]
+--------------------------
+gpg --import <filename.key
+--------------------------
+4.  The following files should now exist and can be used to run the
+example
+
+[source,java]
+-----------------------------------------------
+ls -l ~/.gnupg/pubring.gpg ~/.gnupg/secring.gpg
+-----------------------------------------------
+
+[[Crypto-PGPDecrypting/VerifyingofMessagesEncrypted/SignedbyDifferentPrivate/PublicKeys]]
+PGP Decrypting/Verifying of Messages Encrypted/Signed by Different
+Private/Public Keys
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Since *Camel 2.12.2*.
+
+A PGP Data Formater can decrypt/verify messages which have been
+encrypted by different public keys or signed by different private keys.
+Just, provide the corresponding private keys in the secret keyring, the
+corresponding public keys in the public keyring, and the passphrases in
+the passphrase accessor.
+
+[source,java]
+------------------------------------------------------------------------------------------------------------------------------------------
+Map<String, String> userId2Passphrase = new HashMap<String, String>(2);
+// add passphrases of several private keys whose corresponding public keys have been used to encrypt the messages
+userId2Passphrase.put("UserIdOfKey1","passphrase1"); // you must specify the exact User ID!
+userId2Passphrase.put("UserIdOfKey2","passphrase2");
+PGPPassphraseAccessor passphraseAccessor = new PGPPassphraseAccessorDefault(userId2Passphrase);
+
+PGPDataFormat pgpVerifyAndDecrypt = new PGPDataFormat();
+pgpVerifyAndDecrypt.setPassphraseAccessor(passphraseAccessor);
+// the method getSecKeyRing() provides the secret keyring as byte array containing the private keys
+pgpVerifyAndDecrypt.setEncryptionKeyRing(getSecKeyRing()); // alternatively you can use setKeyFileName(keyfileName)
+// the method getPublicKeyRing() provides the public keyring as byte array containing the public keys
+pgpVerifyAndDecrypt.setSignatureKeyRing((getPublicKeyRing());  // alternatively you can use setSignatureKeyFileName(signatgureKeyfileName)
+// it is not necessary to specify the encryption or signer  User Id
+ 
+from("direct:start")
+         ...     
+        .unmarshal(pgpVerifyAndDecrypt) // can decrypt/verify messages encrypted/signed by different private/public keys
+        ...            
+------------------------------------------------------------------------------------------------------------------------------------------
+
+* The functionality is especially useful to support the key exchange. If
+you want to exchange the private key for decrypting you can accept for a
+period of time messages which are either encrypted with the old or new
+corresponding public key. Or if the sender wants to exchange his signer
+private key, you can accept for a period of time, the old or new signer
+key.
+* Technical background: The PGP encrypted data contains a Key ID of the
+public key which was used to encrypt the data. This Key ID can be used
+to locate the private key in the secret keyring to decrypt the data. The
+same mechanism is also used to locate the public key for verifying a
+signature. Therefore you no longer must specify User IDs for the
+unmarshaling.
+
+[[Crypto-RestrictingtheSignerIdentitiesduringPGPSignatureVerification]]
+Restricting the Signer Identities during PGP Signature Verification
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Since *Camel 2.12.3.*
+
+If you verify a signature you not only want to verify the correctness of
+the signature but you also want check that the signature comes from a
+certain identity or a specific set of identities. Therefore it is
+possible to restrict the number of public keys from the public keyring
+which can be used for the verification of a signature.  
+
+*Signature User IDs*
+
+[source,java]
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+// specify the User IDs of the expected signer identities
+ List<String> expectedSigUserIds = new ArrayList<String>();
+ expectedSigUserIds.add("Trusted company1");
+ expectedSigUserIds.add("Trusted company2");
+ 
+ PGPDataFormat pgpVerifyWithSpecificKeysAndDecrypt = new PGPDataFormat();
+ pgpVerifyWithSpecificKeysAndDecrypt.setPassword("my password"); // for decrypting with private key
+ pgpVerifyWithSpecificKeysAndDecrypt.setKeyFileName(keyfileName);
+ pgpVerifyWithSpecificKeysAndDecrypt.setSignatureKeyFileName(signatgureKeyfileName);
+ pgpVerifyWithSpecificKeysAndDecrypt.setSignatureKeyUserids(expectedSigUserIds); // if you have only one signer identity then you can also use setSignatureKeyUserid("expected Signer")
+ 
+from("direct:start")
+         ...     
+        .unmarshal(pgpVerifyWithSpecificKeysAndDecrypt)
+        ...      
+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+* If the PGP content has several signatures the verification is
+successful as soon as one signature can be verified.
+* If you do not want to restrict the signer identities for verification
+then do not specify the signature key User IDs. In this case all public
+keys in the public keyring are taken into account.
+
+[[Crypto-SeveralSignaturesinOnePGPDataFormat]]
+Several Signatures in One PGP Data Format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Since *Camel 2.12.3.*
+
+The PGP specification allows that one PGP data format can contain
+several signatures from different keys. Since Camel 2.13.3 it is
+possible to create such kind of PGP content via specifying signature
+User IDs which relate to several private keys in the secret keyring.
+
+*Several Signatures*
+
+[source,java]
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ PGPDataFormat pgpSignAndEncryptSeveralSignerKeys = new PGPDataFormat();
+ pgpSignAndEncryptSeveralSignerKeys.setKeyUserid(keyUserid); // for encrypting, you can also use setKeyUserids if you want to encrypt with several keys
+ pgpSignAndEncryptSeveralSignerKeys.setKeyFileName(keyfileName);
+ pgpSignAndEncryptSeveralSignerKeys.setSignatureKeyFileName(signatgureKeyfileName);
+ pgpSignAndEncryptSeveralSignerKeys.setSignaturePassword("sdude"); // here we assume that all private keys have the same password, if this is not the case then you can use setPassphraseAccessor
+
+ List<String> signerUserIds = new ArrayList<String>();
+ signerUserIds.add("company old key");
+ signerUserIds.add("company new key");
+ pgpSignAndEncryptSeveralSignerKeys.setSignatureKeyUserids(signerUserIds);
+ 
+from("direct:start")
+         ...     
+        .marshal(pgpSignAndEncryptSeveralSignerKeys)
+        ...      
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+
+[[Crypto-SupportofSub-KeysandKeyFlagsinPGPDataFormatMarshaler]]
+Support of Sub-Keys and Key Flags in PGP Data Format Marshaler
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Since *Camel 2.12.3. +
+*An https://tools.ietf.org/html/rfc4880#section-12.1[OpenPGP V4 key] can
+have a primary key and sub-keys. The usage of the keys is indicated by
+the so called https://tools.ietf.org/html/rfc4880#section-5.2.3.21[Key
+Flags]. For example, you can have a primary key with two sub-keys; the
+primary key shall only be used for certifying other keys (Key Flag
+0x01), the first sub-key  shall only be used for signing (Key Flag
+0x02), and the second sub-key shall only be used for encryption (Key
+Flag 0x04 or 0x08). The PGP Data Format marshaler takes into account
+these Key Flags of the primary key and sub-keys in order to determine
+the right key for signing and encryption. This is necessary because the
+primary key and its sub-keys have the same User IDs.
+
+[[Crypto-SupportofCustomKeyAccessors]]
+Support of Custom Key Accessors
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Since *Camel 2.13.0. +
+*You can implement custom key accessors for encryption/signing. The
+above PGPDataFormat class selects in a certain predefined way the keys
+which should be used for signing/encryption or verifying/decryption. If
+you have special requirements how your keys should be selected you
+should use the
+https://github.com/apache/camel/blob/master/components/camel-crypto/src/main/java/org/apache/camel/converter/crypto/PGPKeyAccessDataFormat.java[PGPKeyAccessDataFormat]
+class instead and implement the interfaces
+https://github.com/apache/camel/blob/master/components/camel-crypto/src/main/java/org/apache/camel/converter/crypto/PGPPublicKeyAccessor.java[PGPPublicKeyAccessor]
+and
+https://github.com/apache/camel/blob/master/components/camel-crypto/src/main/java/org/apache/camel/converter/crypto/PGPSecretKeyAccessor.java[PGPSecretKeyAccessor]
+as beans. There are default implementations
+https://github.com/apache/camel/blob/master/components/camel-crypto/src/main/java/org/apache/camel/converter/crypto/DefaultPGPPublicKeyAccessor.java[DefaultPGPPublicKeyAccessor]
+and
+https://github.com/apache/camel/blob/master/components/camel-crypto/src/main/java/org/apache/camel/converter/crypto/DefaultPGPSecretKeyAccessor.java[DefaultPGPSecretKeyAccessor]
+which cache the keys, so that not every time the keyring is parsed when
+the processor is called.
+
+PGPKeyAccessDataFormat has the same options as PGPDataFormat except
+password, keyFileName, encryptionKeyRing, signaturePassword,
+signatureKeyFileName, and signatureKeyRing.
+
+[[Crypto-Dependencies]]
+Dependencies
+^^^^^^^^^^^^
+
+To use the link:crypto.html[Crypto] dataformat in your camel routes you
+need to add the following dependency to your pom.
+
+[source,xml]
+----------------------------------------------------------
+<dependency>
+  <groupId>org.apache.camel</groupId>
+  <artifactId>camel-crypto</artifactId>
+  <version>x.x.x</version>
+  <!-- use the same version as your Camel core version -->
+</dependency>
+----------------------------------------------------------
+
+[[Crypto-SeeAlso]]
+See Also
+^^^^^^^^
+
+* link:data-format.html[Data Format]
+* link:crypto-digital-signatures.html[Crypto (Digital Signatures)]
+* http://www.bouncycastle.org/java.html[http://www.bouncycastle.org/java.html]
+


Mime
View raw message