This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
commit 50c2ab2c5db3488a526d9d9bd703a31a96abeaf5 Author: Alexandros Koufoudakis <akoufouda...@gmail.com> AuthorDate: Wed Jun 19 16:27:47 2019 +0200 Components "j... - n...". https://issues.apache.org/jira/browse/CAMEL-13480 --- .../camel-jaxb/src/main/docs/jaxb-dataformat.adoc | 11 ------ .../camel-jbpm/src/main/docs/jbpm-component.adoc | 2 +- .../src/main/docs/jcache-component.adoc | 2 +- .../camel-jcr/src/main/docs/jcr-component.adoc | 13 +------ .../camel-jdbc/src/main/docs/jdbc-component.adoc | 10 ++--- .../camel-jetty/src/main/docs/jetty-component.adoc | 10 ++--- .../src/main/docs/jgroups-raft-component.adoc | 28 +++++++------- .../src/main/docs/jgroups-component.adoc | 32 ++++------------ .../camel-jing/src/main/docs/jing-component.adoc | 4 +- .../camel-jms/src/main/docs/jms-component.adoc | 44 ++++++---------------- .../camel-jolt/src/main/docs/jolt-component.adoc | 2 +- .../camel-jpa/src/main/docs/jpa-component.adoc | 23 ++++------- .../camel-jsch/src/main/docs/scp-component.adoc | 2 +- .../src/main/docs/jsonApi-dataformat.adoc | 2 +- .../src/main/docs/jsonpath-language.adoc | 4 +- .../camel-jt400/src/main/docs/jt400-component.adoc | 9 ++--- .../camel-kafka/src/main/docs/kafka-component.adoc | 2 +- .../docs/kubernetes-config-maps-component.adoc | 2 +- .../docs/kubernetes-deployments-component.adoc | 2 +- .../src/main/docs/kubernetes-hpa-component.adoc | 2 +- .../src/main/docs/kubernetes-job-component.adoc | 2 +- .../main/docs/kubernetes-namespaces-component.adoc | 2 +- .../src/main/docs/kubernetes-nodes-component.adoc | 2 +- ...rnetes-persistent-volumes-claims-component.adoc | 2 +- .../kubernetes-persistent-volumes-component.adoc | 2 +- .../src/main/docs/kubernetes-pods-component.adoc | 2 +- ...bernetes-replication-controllers-component.adoc | 2 +- .../docs/kubernetes-resources-quota-component.adoc | 2 +- .../main/docs/kubernetes-secrets-component.adoc | 2 +- .../kubernetes-service-accounts-component.adoc | 2 +- .../main/docs/kubernetes-services-component.adoc | 2 +- .../camel-kubernetes/src/main/docs/kubernetes.adoc | 2 +- .../docs/openshift-build-configs-component.adoc | 2 +- .../src/main/docs/openshift-builds-component.adoc | 2 +- .../src/main/docs/language-component.adoc | 6 +-- .../camel-ldap/src/main/docs/ldap-component.adoc | 2 +- .../camel-ldif/src/main/docs/ldif-component.adoc | 2 +- .../camel-leveldb/src/main/docs/leveldb.adoc | 4 +- .../camel-log/src/main/docs/log-component.adoc | 6 +-- .../src/main/docs/lucene-component.adoc | 4 +- .../src/main/docs/lumberjack-component.adoc | 2 +- .../camel-mail/src/main/docs/mail-component.adoc | 8 ++-- .../src/main/docs/master-component.adoc | 2 +- .../src/main/docs/metrics-component.adoc | 2 +- .../src/main/docs/micrometer-component.adoc | 2 +- .../src/main/docs/milo-client-component.adoc | 2 +- .../src/main/docs/milo-server-component.adoc | 2 +- .../camel-mina2/src/main/docs/mina2-component.adoc | 2 +- .../camel-mock/src/main/docs/mock-component.adoc | 6 +-- .../src/main/docs/mongodb3-component.adoc | 9 ----- .../camel-mqtt/src/main/docs/mqtt-component.adoc | 2 +- .../src/main/docs/mustache-component.adoc | 2 +- .../camel-mvel/src/main/docs/mvel-component.adoc | 2 +- .../src/main/docs/mybatis-bean-component.adoc | 2 +- .../src/main/docs/mybatis-component.adoc | 2 +- .../src/main/docs/netty4-http-component.adoc | 2 +- .../src/main/docs/netty4-component.adoc | 10 ++--- .../camel-nsq/src/main/docs/nsq-component.adoc | 4 -- 58 files changed, 120 insertions(+), 201 deletions(-) diff --git a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc index 166841e..82dd07a 100644 --- a/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc +++ b/components/camel-jaxb/src/main/docs/jaxb-dataformat.adoc @@ -127,7 +127,6 @@ implementation and might change if you use different vendor than RI. ### Partial marshalling/unmarshalling -*This feature is new to Camel 2.2.0.* + JAXB 2 supports marshalling and unmarshalling XML tree fragments. By default JAXB looks for `@XmlRootElement` annotation on given class to operate on whole XML tree. This is useful but not always - sometimes @@ -156,7 +155,6 @@ note that you need to specify its value {[namespaceUri]}[localPart] ### Fragment -*This feature is new to Camel 2.8.0.* + JaxbDataFormat has new property fragment which can set the the `Marshaller.JAXB_FRAGMENT` encoding property on the JAXB Marshaller. If you don't want the JAXB Marshaller to generate the XML declaration, you @@ -165,7 +163,6 @@ false. ### Ignoring the NonXML Character -*This feature is new to Camel 2.2.0.* + JaxbDataFromat supports to ignore the http://www.w3.org/TR/2004/REC-xml-20040204/#NT-Char[NonXML Character], you just need to set the filterNonXmlChars property to be true, @@ -187,7 +184,6 @@ the Exchange property This feature has been tested with Woodstox 3.2.9 and Sun JDK 1.6 StAX implementation. -*New for Camel 2.12.1* + JaxbDataFormat now allows you to customize the XMLStreamWriter used to marshal the stream to XML. Using this configuration, you can add your own stream writer to completely remove, escape, or replace non-xml @@ -280,13 +276,6 @@ marshalling and unmarshalling from/to XML. Your can use the prefix resolved. You can separate multiple schema files by using the *','* character. -*Known issue* - -Camel 2.11.0 and 2.11.1 has a known issue by validation multiple -`Exchange`'s in parallel. See -https://issues.apache.org/jira/browse/CAMEL-6630[CAMEL-6630]. This is -fixed with Camel 2.11.2/2.12.0. - Using the Java DSL, you can configure it in the following way: [source,java] diff --git a/components/camel-jbpm/src/main/docs/jbpm-component.adoc b/components/camel-jbpm/src/main/docs/jbpm-component.adoc index b753410..a6defce 100644 --- a/components/camel-jbpm/src/main/docs/jbpm-component.adoc +++ b/components/camel-jbpm/src/main/docs/jbpm-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.6* -The *jbpm* component provides integration with Business Process +The JBPM component provides integration with Business Process Management http://www.jbpm.org/[jBPM]. It uses kie-server-client API to interact with jBPM instance over REST. The component supports both producer and consumer. diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc index 8443e17..70bdca8 100644 --- a/components/camel-jcache/src/main/docs/jcache-component.adoc +++ b/components/camel-jcache/src/main/docs/jcache-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation. +The JCache component enables you to perform caching operations using JSR107/JCache as cache implementation. ### URI Format diff --git a/components/camel-jcr/src/main/docs/jcr-component.adoc b/components/camel-jcr/src/main/docs/jcr-component.adoc index db542e9..d5f0a22 100644 --- a/components/camel-jcr/src/main/docs/jcr-component.adoc +++ b/components/camel-jcr/src/main/docs/jcr-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.3* -The *`jcr`* component allows you to add/read nodes to/from a JCR +The JCR component allows you to add/read nodes to/from a JCR compliant content repository (for example, http://jackrabbit.apache.org/[Apache Jackrabbit]) with its producer, or register an EventListener with the consumer. @@ -30,7 +30,7 @@ jcr://user:password@repository/path/to/node *Consumer added* -From *Camel 2.10* onwards you can use consumer as an EventListener in +You can use consumer as an EventListener in JCR or a producer to read a node by identifier. ### Usage @@ -130,15 +130,6 @@ The component supports 3 options, which are listed below. |=== // spring-boot-auto-configure options: END - - - - -Please note that the JCR Producer used message properties instead of -message headers in Camel versions earlier than 2.12.3. See -https://issues.apache.org/jira/browse/CAMEL-7067[https://issues.apache.org/jira/browse/CAMEL-7067] -for more details. - ### Example The snippet below creates a node named `node` under the `/home/test` diff --git a/components/camel-jdbc/src/main/docs/jdbc-component.adoc b/components/camel-jdbc/src/main/docs/jdbc-component.adoc index 39c7eeb..08818c6 100644 --- a/components/camel-jdbc/src/main/docs/jdbc-component.adoc +++ b/components/camel-jdbc/src/main/docs/jdbc-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.2* -The *jdbc* component enables you to access databases through JDBC, where +The JDBC component enables you to access databases through JDBC, where SQL queries (SELECT) and operations (INSERT, UPDATE, etc) are sent in the message body. This component uses the standard JDBC API, unlike the <<sql-component,SQL Component>> component, which uses @@ -154,15 +154,15 @@ header. |`CamelJdbcUpdateCount` |If the query is an `UPDATE`, query the update count is returned in this OUT header. -|`CamelGeneratedKeysRows` |*Camel 2.10:* Rows that contains the generated keys. +|`CamelGeneratedKeysRows` |Rows that contains the generated keys. -|`CamelGeneratedKeysRowCount` |*Camel 2.10:* The number of rows in the header that contains generated +|`CamelGeneratedKeysRowCount` |The number of rows in the header that contains generated keys. -|`CamelJdbcColumnNames` |*Camel 2.11.1:* The column names from the ResultSet as a `java.util.Set` +|`CamelJdbcColumnNames` |The column names from the ResultSet as a `java.util.Set` type. -|`CamelJdbcParametes` |*Camel 2.12:* A `java.util.Map` which has the headers to be used if +|`CamelJdbcParametes` |A `java.util.Map` which has the headers to be used if `useHeadersAsParameters` has been enabled. |=== diff --git a/components/camel-jetty/src/main/docs/jetty-component.adoc b/components/camel-jetty/src/main/docs/jetty-component.adoc index e17efb7..4ba791d 100644 --- a/components/camel-jetty/src/main/docs/jetty-component.adoc +++ b/components/camel-jetty/src/main/docs/jetty-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.2* -The *jetty* component provides HTTP-based endpoints +The Jetty component provides HTTP-based endpoints for consuming and producing HTTP requests. That is, the Jetty component behaves as a simple Web server. @@ -229,7 +229,7 @@ The component supports 35 options, which are listed below. Camel uses the same message headers as the <<http-component,HTTP>> component. -From Camel 2.2, it also uses (Exchange.HTTP_CHUNKED,CamelHttpChunked) +It also uses (Exchange.HTTP_CHUNKED,CamelHttpChunked) header to turn on or turn off the chuched encoding on the camel-jetty consumer. @@ -238,7 +238,7 @@ example, given a client request with the URL, `http://myserver/myserver?orderid=123`, the exchange will contain a header named `orderid` with the value 123. -Starting with Camel 2.2.0, you can get the request.parameter from the +You can get the request.parameter from the message header not only from Get Method, but also other HTTP method. === Usage @@ -325,8 +325,8 @@ public void process(Exchange exchange) throws Exception { [[Jetty-UsingtheJSSEConfigurationUtility]] Using the JSSE Configuration Utility -As of Camel 2.8, the Jetty component supports SSL/TLS configuration -through the xref:camel-configuration-utilities.adoc[Camel JSSE +The Jetty component supports SSL/TLS configuration +through the link:camel-configuration-utilities.adoc[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 diff --git a/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc b/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc index fa5fab7..2d568af 100644 --- a/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc +++ b/components/camel-jgroups-raft/src/main/docs/jgroups-raft-component.adoc @@ -123,35 +123,35 @@ The component supports 12 options, which are listed below. ### Headers -[width="100%",cols="10%,10%,10%,70%",options="header",] +[width="100%",cols="10%,10%,70%",options="header",] |======================================================================= |Header |Constant |Since version |Description -|`JGROUPSRAFT_COMMIT_INDEX` |`JGroupsRaftEndpoint.HEADER_JGROUPSRAFT_COMMIT_INDEX` |*2.24.0* | *Consumer* : The commit index (int). +|`JGROUPSRAFT_COMMIT_INDEX` |`JGroupsRaftEndpoint.HEADER_JGROUPSRAFT_COMMIT_INDEX` | *Consumer* : The commit index (int). -|`JGROUPSRAFT_CURRENT_TERM` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_CURRENT_TERM` |*2.24.0* | *Consumer* : The current raft term (int). +|`JGROUPSRAFT_CURRENT_TERM` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_CURRENT_TERM` | *Consumer* : The current raft term (int). -|`JGROUPSRAFT_IS_LEADER` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_IS_LEADER` |*2.24.0* | *Consumer*: Whether the node is the Raft Leader or not (boolean). +|`JGROUPSRAFT_IS_LEADER` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_IS_LEADER` | *Consumer*: Whether the node is the Raft Leader or not (boolean). -|`JGROUPSRAFT_LAST_APPLIED` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LAST_APPLIED` |*2.24.0* | *Consumer*: The index of the last log entry that was appended to the log (int). +|`JGROUPSRAFT_LAST_APPLIED` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LAST_APPLIED` | *Consumer*: The index of the last log entry that was appended to the log (int). -|`JGROUPSRAFT_LEADER_ADDRESS` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LEADER_ADDRESS` |*2.24.0* | *Consumer*: The Address ot Raft Leader or not (org.jgroups.Address). +|`JGROUPSRAFT_LEADER_ADDRESS` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LEADER_ADDRESS` | *Consumer*: The Address ot Raft Leader or not (org.jgroups.Address). -|`JGROUPSRAFT_LOG_SIZE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LOG_SIZE` |*2.24.0* | *Consumer*: The Raft log size in number of entries (int). +|`JGROUPSRAFT_LOG_SIZE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LOG_SIZE` | *Consumer*: The Raft log size in number of entries (int). -|`JGROUPSRAFT_LOG_SIZE_BYTE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LOG_SIZE_BYTE` |*2.24.0* | *Consumer*: The Raft log size in bytes (int). +|`JGROUPSRAFT_LOG_SIZE_BYTE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_LOG_SIZE_BYTE` | *Consumer*: The Raft log size in bytes (int). -|`JGROUPSRAFT_RAFT_ID` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_RAFT_ID` |*2.24.0* | *Consumer*: The Raft id of the node (String). +|`JGROUPSRAFT_RAFT_ID` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_RAFT_ID` | *Consumer*: The Raft id of the node (String). -|`JGROUPSRAFT_EVENT_TYPE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_EVENT_TYPE` |*2.24.0* | *Consumer*: The event type, one of org.apache.camel.component.jgroups.raft.JGroupsRaftEventType ENUM. +|`JGROUPSRAFT_EVENT_TYPE` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_EVENT_TYPE` | *Consumer*: The event type, one of org.apache.camel.component.jgroups.raft.JGroupsRaftEventType ENUM. -|`JGROUPSRAFT_SET_OFFSET` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_OFFSET` |*2.24.0* | *Producer*: Offset to use in the byte[] buffer to be set(). +|`JGROUPSRAFT_SET_OFFSET` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_OFFSET` | *Producer*: Offset to use in the byte[] buffer to be set(). -|`JGROUPSRAFT_SET_LENGTH` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_LENGTH` |*2.24.0* | *Producer*: Length to use in the byte[] buffer to be set(). +|`JGROUPSRAFT_SET_LENGTH` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_LENGTH` | *Producer*: Length to use in the byte[] buffer to be set(). -|`JGROUPSRAFT_SET_TIMEOUT` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_TIMEOUT` |*2.24.0* | *Producer*: Timeout to be used in set() operation. +|`JGROUPSRAFT_SET_TIMEOUT` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_TIMEOUT` | *Producer*: Timeout to be used in set() operation. -|`JGROUPSRAFT_SET_TIMEUNIT` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_TIMEUNIT` |*2.24.0* | *Producer*: Timeunit to be used in set() operation. +|`JGROUPSRAFT_SET_TIMEUNIT` |`JGroupsRaftEndpoint.`HEADER_JGROUPSRAFT_SET_TIMEUNIT` | *Producer*: Timeunit to be used in set() operation. |======================================================================= ### Usage diff --git a/components/camel-jgroups/src/main/docs/jgroups-component.adoc b/components/camel-jgroups/src/main/docs/jgroups-component.adoc index d4765a1..20fa34a 100644 --- a/components/camel-jgroups/src/main/docs/jgroups-component.adoc +++ b/components/camel-jgroups/src/main/docs/jgroups-component.adoc @@ -13,20 +13,6 @@ for this component. [source,xml] ------------------------------------------------------------ <dependency> - <groupId>org.apache-extras.camel-extra</groupId> - <artifactId>camel-jgroups</artifactId> - <!-- use the same version as your Camel core version --> - <version>x.y.z</version> -</dependency> ------------------------------------------------------------- - -Starting from the Camel *2.13.0*, JGroups component has been moved from -Camel Extra under the umbrella of the Apache Camel. If you are using -Camel *2.13.0* or higher, please use the following POM entry instead. - -[source,xml] ------------------------------------------------------------- -<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-jgroups</artifactId> <!-- use the same version as your Camel core version --> @@ -146,22 +132,22 @@ The component supports 10 options, which are listed below. ### Headers -[width="100%",cols="10%,10%,10%,70%",options="header",] +[width="100%",cols="10%,10%,70%",options="header",] |======================================================================= -|Header |Constant |Since version |Description +|Header |Constant |Description -|`JGROUPS_ORIGINAL_MESSAGE` |`JGroupsEndpoint.HEADER_JGROUPS_ORIGINAL_MESSAGE` |*2.13.0* |The original `org.jgroups.Message` instance from which the body of the +|`JGROUPS_ORIGINAL_MESSAGE` |`JGroupsEndpoint.HEADER_JGROUPS_ORIGINAL_MESSAGE` |The original `org.jgroups.Message` instance from which the body of the consumed message has been extracted. -|`JGROUPS_SRC` |`JGroupsEndpoint.`HEADER_JGROUPS_SRC |*2.10.0* | *Consumer* : The `org.jgroups.Address` instance extracted by +|`JGROUPS_SRC` |`JGroupsEndpoint.`HEADER_JGROUPS_SRC |*Consumer* : The `org.jgroups.Address` instance extracted by `org.jgroups.Message`.getSrc() method of the consumed message. *Producer*: The custom source `org.jgroups.Address` of the message to be sent. -|`JGROUPS_DEST` |`JGroupsEndpoint.`HEADER_JGROUPS_DEST |*2.10.0* |*Consumer*: The `org.jgroups.Address` instance extracted by +|`JGROUPS_DEST` |`JGroupsEndpoint.`HEADER_JGROUPS_DEST |*Consumer*: The `org.jgroups.Address` instance extracted by `org.jgroups.Message`.getDest() method of the consumed message. *Producer*: The custom destination `org.jgroups.Address` of the message to be sent. -|`JGROUPS_CHANNEL_ADDRESS` |`JGroupsEndpoint.`HEADER_JGROUPS_CHANNEL_ADDRESS |*2.13.0* |Address (`org.jgroups.Address`) of the channel associated with the +|`JGROUPS_CHANNEL_ADDRESS` |`JGroupsEndpoint.`HEADER_JGROUPS_CHANNEL_ADDRESS |Address (`org.jgroups.Address`) of the channel associated with the endpoint. |======================================================================= @@ -192,8 +178,7 @@ from("direct:start").to("jgroups:clusterName"); ### Predefined filters -Starting from version *2.13.0* of Camel, JGroups component comes with -predefined filters factory class named `JGroupsFilters.` +JGroups component comes with predefined filters factory class named `JGroupsFilters.` If you would like to consume only view changes notifications sent to coordinator of the cluster (and ignore these sent to the "slave" nodes), @@ -215,8 +200,7 @@ from("jgroups:clusterName?enableViewMessages=true"). ### Predefined expressions -Starting from version *2.13.0* of Camel, JGroups component comes with -predefined expressions factory class named `JGroupsExpressions.` +JGroups component comes with predefined expressions factory class named `JGroupsExpressions.` If you would like to create delayer that would affect the route only if the Camel context has not been started yet, use the diff --git a/components/camel-jing/src/main/docs/jing-component.adoc b/components/camel-jing/src/main/docs/jing-component.adoc index a660d94..9a4eb6c 100644 --- a/components/camel-jing/src/main/docs/jing-component.adoc +++ b/components/camel-jing/src/main/docs/jing-component.adoc @@ -27,14 +27,14 @@ for this component: Note that the <<msv-component,MSV>> component can also support RelaxNG XML syntax. -### URI format Camel 2.16 +### URI format [source,java] ------------------------------ jing:someLocalOrRemoteResource ------------------------------ -From Camel 2.16 the component use jing as name, and you can use the +The component uses jing as name, and you can use the option compactSyntax to turn on either RNG or RNC mode. ### Options diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index ce99320..e53c9e9 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -125,11 +125,7 @@ the XA transaction to not work properly. If you are *not* using XA, then you should consider caching as it speeds up performance, such as setting `cacheLevelName=CACHE_CONSUMER`. -Through Camel 2.7.x, the default setting for `cacheLevelName` is -`CACHE_CONSUMER`. You will need to explicitly set -`cacheLevelName=CACHE_NONE`. - -In Camel 2.8 onwards, the default setting for `cacheLevelName` is +The default setting for `cacheLevelName` is `CACHE_AUTO`. This default auto detects the mode and sets the cache level accordingly to: @@ -1186,14 +1182,14 @@ reply queue with an unique name per node, then you can run this in a clustered environment. As then the reply message will be sent back to that queue for the given node, that awaits the reply message. -|`concurrentConsumers` |Fast |Yes |*Camel 2.10.3:* Allows to process +|`concurrentConsumers` |Fast |Yes |Allows to process reply messages concurrently using concurrent message listeners in use. You can specify a range using the `concurrentConsumers` and `maxConcurrentConsumers` options. *Notice:* That using `Shared` reply queues may not work as well with concurrent listeners, so use this option with care. -|`maxConcurrentConsumers` |Fast |Yes |*Camel 2.10.3:* Allows to process +|`maxConcurrentConsumers` |Fast |Yes |Allows to process reply messages concurrently using concurrent message listeners in use. You can specify a range using the `concurrentConsumers` and `maxConcurrentConsumers` options. *Notice:* That using `Shared` reply @@ -1211,27 +1207,7 @@ so you should *not* do anything. + This consumer is a Spring `DefaultMessageListenerContainer` which listen for replies. However it's fixed to 1 concurrent consumer. + That means replies will be processed in sequence as there are only 1 -thread to process the replies. If you want to process replies faster, -then we need to use concurrency. But *not* using the -`concurrentConsumer` option. We should use the `threads` from the Camel -DSL instead, as shown in the route below: - -Instead of using threads, then use concurrentConsumers option if using -Camel 2.10.3 or better. See further below. - -[source,java] ---------------------------------- -from(xxx) -.inOut().to("activemq:queue:foo") -.threads(5) -.to(yyy) -.to(zzz); ---------------------------------- - -In this route we instruct Camel to route replies -asynchronously using a thread pool with 5 threads. - -From *Camel 2.10.3* onwards you can now configure the listener to use +thread to process the replies. You can configure the listener to use concurrent threads using the `concurrentConsumers` and `maxConcurrentConsumers` options. This allows you to easier configure this in Camel as shown below: @@ -1244,6 +1220,9 @@ from(xxx) .to(zzz); ------------------------------------------------------- +In this route we instruct Camel to route replies +asynchronously using a thread pool with 5 threads. + #### Request-reply over JMS and using a shared fixed reply queue If you use a fixed reply queue when doing @@ -1285,15 +1264,14 @@ broker more frequent, and thus require more network traffic. + In the previous example, Camel would anticipate the fixed reply queue named "bar" was shared, and thus it uses a `JMSSelector` to only consume reply messages which it expects. However there is a drawback doing this -as JMS selectos is slower. Also the consumer on the reply queue is +as the JMS selector is slower. Also the consumer on the reply queue is slower to update with new JMS selector ids. In fact it only updates when the `receiveTimeout` option times out, which by default is 1 second. So in theory the reply messages could take up till about 1 sec to be detected. On the other hand if the fixed reply queue is exclusive to the Camel reply consumer, then we can avoid using the JMS selectors, and -thus be more performant. In fact as fast as using temporary queues. So -in *Camel 2.9* onwards we introduced the `ReplyToType` option which you -can configure to `Exclusive` + +thus be more performant. In fact as fast as using temporary queues. There is +the `ReplyToType` option which you can configure to `Exclusive` + to tell Camel that the reply queue is exclusive as shown in the example below: @@ -1358,7 +1336,7 @@ live, then Camel will still use a timeout by 20 seconds (the So the two options `requestTimeout` and `disableTimeToLive` gives you fine grained control when doing request/reply. -From *Camel 2.13/2.12.3* onwards you can provide a header in the message +You can provide a header in the message to override and use as the request timeout value instead of the endpoint configured value. For example: diff --git a/components/camel-jolt/src/main/docs/jolt-component.adoc b/components/camel-jolt/src/main/docs/jolt-component.adoc index a245eb23..a05b592 100644 --- a/components/camel-jolt/src/main/docs/jolt-component.adoc +++ b/components/camel-jolt/src/main/docs/jolt-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.16* -The *jolt:* component allows you to process a JSON messages using an +The Jolt component allows you to process a JSON messages using an https://github.com/bazaarvoice/jolt[JOLT] specification. This can be ideal when doing JSON to JSON transformation. diff --git a/components/camel-jpa/src/main/docs/jpa-component.adoc b/components/camel-jpa/src/main/docs/jpa-component.adoc index f91846f..e3f5cfa 100644 --- a/components/camel-jpa/src/main/docs/jpa-component.adoc +++ b/components/camel-jpa/src/main/docs/jpa-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.0* -The *jpa* component enables you to store and retrieve Java objects from +The JPA component enables you to store and retrieve Java objects from persistent storage using EJB 3's Java Persistence Architecture (JPA), which is a standard interface layer that wraps Object/Relational Mapping (ORM) products such as OpenJPA, Hibernate, TopLink, and so on. @@ -37,7 +37,7 @@ If the body does not contain one of the previous listed types, put a Message Translator in front of the endpoint to perform the necessary conversion first. -From *Camel 2.19* onwards you can use `query`, `namedQuery` or `nativeQuery` +You can use `query`, `namedQuery` or `nativeQuery` for the producer as well. Also in the value of the `parameters`, you can use Simple expression which allows you to retrieve parameter values from Message body, header and etc. Those query can be used for retrieving a set of data with using `SELECT` @@ -65,8 +65,7 @@ http://camel.apache.org/maven/current/camel-jpa/apidocs/org/apache/camel/compone which will be invoked on your entity bean when the entity bean when it has been processed (and when routing is done). -From *Camel 2.13* onwards you can use -http://camel.apache.org/maven/current/camel-jpa/apidocs/org/apache/camel/component/jpa/PreConsumed.html[@PreConsumed] +You can use http://camel.apache.org/maven/current/camel-jpa/apidocs/org/apache/camel/component/jpa/PreConsumed.html[@PreConsumed] which will be invoked on your entity bean before it has been processed (before routing). @@ -235,17 +234,9 @@ Camel adds the following message headers to the exchange: |======================================================================= |Header |Type |Description -|`CamelJpaTemplate` |`JpaTemplate` |*Not supported anymore since Camel 2.12:* The `JpaTemplate` object that -is used to access the entity bean. You need this object in some -situations, for instance in a type converter or when you are doing some -custom processing. See -https://issues.apache.org/jira/browse/CAMEL-5932[CAMEL-5932] for the -reason why the support for this header has been dropped. +|`CamelEntityManager` |`EntityManager` |The JPA `EntityManager` object being used by `JpaConsumer` or `JpaProducer`. -|`CamelEntityManager` |`EntityManager` |*Camel 2.12: JPA consumer / Camel 2.12.2: JPA producer:* The JPA -`EntityManager` object being used by `JpaConsumer` or `JpaProducer`. - -|`CamelJpaParameters` |`Map<String, Object>` |*Camel 2.23: JPA producer:* Alternative way for passing query parameters as an Exchange header. +|`CamelJpaParameters` |`Map<String, Object>` |Alternative way for passing query parameters as an Exchange header. |======================================================================= @@ -266,7 +257,7 @@ For example, you can instantiate a JPA component that references the </bean> ------------------------------------------------------------------- -In *Camel 2.3* the `JpaComponent` will auto lookup the +The `JpaComponent` looks up automatically the `EntityManagerFactory` from the Registry which means you do not need to configure this on the `JpaComponent` as shown above. You only need to do so if there is ambiguity, in which case Camel will @@ -274,7 +265,7 @@ log a WARN. ### Configuring TransactionManager -Since *Camel 2.3* the `JpaComponent` will auto lookup the +The `JpaComponent` looks up automatically the `TransactionManager` from the Registry. If Camel won't find any `TransactionManager` instance registered, it will also look up for the `TransactionTemplate` and try to diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc index 849f27a..8ae445e 100644 --- a/components/camel-jsch/src/main/docs/scp-component.adoc +++ b/components/camel-jsch/src/main/docs/scp-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.10* -The *camel-jsch* component supports the +The Camel-Jsch component supports the http://en.wikipedia.org/wiki/Secure_copy[SCP protocol] using the Client API of the http://www.jcraft.com/jsch/[Jsch] project. Jsch is already used in camel by the <<ftp-component,FTP>> component for the *sftp:* diff --git a/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc b/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc index 568d1a4..6f0c409 100644 --- a/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc +++ b/components/camel-jsonapi/src/main/docs/jsonApi-dataformat.adoc @@ -7,7 +7,7 @@ *Available as of Camel version 3.0* // dataformat options: START -The jsonApi dataformat supports 3 options, which are listed below. +The JsonAPI dataformat supports 3 options, which are listed below. diff --git a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc index eeabc29..bc49192 100644 --- a/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc +++ b/components/camel-jsonpath/src/main/docs/jsonpath-language.adoc @@ -284,7 +284,7 @@ public class Foo { === Encoding Detection -*Since Camel version 2.16*, the encoding of the JSON document is +The encoding of the JSON document is detected automatically, if the document is encoded in unicode (UTF-8, UTF-16LE, UTF-16BE, UTF-32LE, UTF-32BE ) as specified in RFC-4627. If the encoding is a non-unicode encoding, you can either make sure that @@ -305,7 +305,7 @@ from("direct:start") Then each book is logged, however the message body is a `Map` instance. Sometimes you may want to output this as plain String JSon value instead, which can be done -from *Camel 2.20* onwards with the `writeAsString` option as shown: +with the `writeAsString` option as shown: [source,java] ---- diff --git a/components/camel-jt400/src/main/docs/jt400-component.adoc b/components/camel-jt400/src/main/docs/jt400-component.adoc index c48e6d2..e497cd1 100644 --- a/components/camel-jt400/src/main/docs/jt400-component.adoc +++ b/components/camel-jt400/src/main/docs/jt400-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.5* -The *`jt400`* component allows you to exchanges messages with an AS/400 +The JT400 component allows you to exchanges messages with an AS/400 system using data queues. Maven users will need to add the following dependency to their `pom.xml` @@ -26,7 +26,7 @@ for this component: jt400://user:password@system/QSYS.LIB/LIBRARY.LIB/QUEUE.DTAQ[?options] ---------------------------------------------------------------------- -To call remote program (*Camel 2.7*) +To call remote program [source,java] ----------------------------------------------------------------------- @@ -161,8 +161,7 @@ the data queue as either raw bytes or text. *Available as of Camel 2.10* -Connection pooling is in use from Camel 2.10 onwards. You can explicit -configure a connection pool on the Jt400Component, or as an uri option +You can explicit configure a connection pool on the Jt400Component, or as an uri option on the endpoint. #### Remote program call (*Camel 2.7*) @@ -195,7 +194,7 @@ public class Jt400RouteBuilder extends RouteBuilder { } ------------------------------------------------------------------------------------------------------- -#### Remote program call example (*Camel 2.7*) +#### Remote program call example In the snippet below, the data Exchange sent to the direct:work endpoint will contain three string that will be used as the arguments for the diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc b/components/camel-kafka/src/main/docs/kafka-component.adoc index 9e41edf..af35cc5 100644 --- a/components/camel-kafka/src/main/docs/kafka-component.adoc +++ b/components/camel-kafka/src/main/docs/kafka-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.13* -The *kafka:* component is used for communicating with +The Kafka component is used for communicating with http://kafka.apache.org/[Apache Kafka] message broker. Maven users will need to add the following dependency to their `pom.xml` diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc index 855dda6..a19029d 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-config-maps-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes ConfigMap* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes ConfigMap component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes ConfigMap operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc index 1cf4231..28093c7 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-deployments-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.20* -The *Kubernetes Deployments* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Deployments component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes secret operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc index 4aa5591..50ca486 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-hpa-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.23* -The *Kubernetes HPA* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes HPA component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes hpa operations and a consumer to consume kubernetes hpa events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc index a491eb3..0fb988d 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-job-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.23* -The *Kubernetes Job* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Job component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes job operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc index aa2a577..b2161a4 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-namespaces-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Namespaces* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Namespaces component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes namespace operations and a consumer to consume kubernetes namespace events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc index 0d8507e..9ea1467 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-nodes-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Nodes* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Nodes component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes node operations and a consumer to consume kubernetes node events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc index 97042d1..a37111b 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-claims-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Persistent Volume Claim* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Persistent Volume Claim component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes persistent volume claim operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc index 43fd599..24b3ce8 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-persistent-volumes-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Persistent Volume* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Persistent Volume component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes persistent volume operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc index c0c54fb..5bd87ef 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-pods-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Pods* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Pods component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes pod operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc index 69a6c14..afb115a 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-replication-controllers-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Replication Controller* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Replication Controller component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes replication controller operations and a consumer to consume kubernetes replication controller events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc index f46d3f6..184ecbf 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-resources-quota-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Resources Quota* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Resources Quota component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes resource quota operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc index 829b3ab..901d259 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-secrets-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Secrets* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Secrets component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes secret operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc index 363fb0c..ece061a 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-service-accounts-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Service Account* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Service Account component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes Service Account operations. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc index 5392a9d..1d5cdb8 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-services-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Services* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Services component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes service operations and a consumer to consume kubernetes service events. diff --git a/components/camel-kubernetes/src/main/docs/kubernetes.adoc b/components/camel-kubernetes/src/main/docs/kubernetes.adoc index 84f365b..b5f5fb0 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes.adoc @@ -2,7 +2,7 @@ *Available as of Camel version 2.17* -The *Kubernetes* components integrate your application with Kubernetes standalone or on top of Openshift. +The Kubernetes components integrate your application with Kubernetes standalone or on top of Openshift. The camel-kubernetes consists of 13 components: diff --git a/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc b/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc index 8aa6c38..a305ae9 100644 --- a/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc +++ b/components/camel-kubernetes/src/main/docs/openshift-build-configs-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *OpenShift Build Config* component is one of xref:kubernetes.adoc[Kubernetes Components] which +The OpenShift Build Config component is one of link:kubernetes.adoc[Kubernetes Components] which provides a producer to execute kubernetes build config operations. diff --git a/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc b/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc index 0b9ebb3..d143e94 100644 --- a/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc +++ b/components/camel-kubernetes/src/main/docs/openshift-builds-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.17* -The *Kubernetes Builds* component is one of <<kubernetes-component,Kubernetes Components>> which +The Kubernetes Builds component is one of <<kubernetes-component,Kubernetes Components>> which provides a producer to execute kubernetes build operations. diff --git a/components/camel-language/src/main/docs/language-component.adoc b/components/camel-language/src/main/docs/language-component.adoc index 2ab5c27..b4f9f07 100644 --- a/components/camel-language/src/main/docs/language-component.adoc +++ b/components/camel-language/src/main/docs/language-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.5* -The language component allows you to send Exchange +The Language component allows you to send Exchange to an endpoint which executes a script by any of the supported Languages in Camel. + By having a component to execute language scripts, it allows more @@ -24,7 +24,7 @@ components if the language of choice mandates it, such as using language://languageName[:script][?options] ---- -And from Camel 2.11 onwards you can refer to an external resource for +You can refer to an external resource for the script using same notation as supported by the other <<language-component,Language>>s in Camel @@ -168,6 +168,6 @@ evaluation. + For example if the file myscript.txt is changed on disk, then the updated script is used: -From *Camel 2.11* onwards you can refer to the resource similar to the +You can refer to the resource similar to the other <<language-component,Language>>s in Camel by prefixing with `"resource:"` as shown below: diff --git a/components/camel-ldap/src/main/docs/ldap-component.adoc b/components/camel-ldap/src/main/docs/ldap-component.adoc index 70eb123..2c90a8e 100644 --- a/components/camel-ldap/src/main/docs/ldap-component.adoc +++ b/components/camel-ldap/src/main/docs/ldap-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.5* -The *ldap* component allows you to perform searches in LDAP servers +The LDAP component allows you to perform searches in LDAP servers using filters as the message payload. + This component uses standard JNDI (`javax.naming` package) to access the server. diff --git a/components/camel-ldif/src/main/docs/ldif-component.adoc b/components/camel-ldif/src/main/docs/ldif-component.adoc index 5be8acb..6d1e663 100644 --- a/components/camel-ldif/src/main/docs/ldif-component.adoc +++ b/components/camel-ldif/src/main/docs/ldif-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.20* -The *ldif* component allows you to do updates on an LDAP server +The LDIF component allows you to do updates on an LDAP server from a LDIF body content. This component uses a basic URL syntax to access the server. It uses diff --git a/components/camel-leveldb/src/main/docs/leveldb.adoc b/components/camel-leveldb/src/main/docs/leveldb.adoc index df1866b..bcf2725 100644 --- a/components/camel-leveldb/src/main/docs/leveldb.adoc +++ b/components/camel-leveldb/src/main/docs/leveldb.adoc @@ -36,7 +36,7 @@ file is created. |`levelDBFile` |LevelDBFile |Use an existing configured `org.apache.camel.component.leveldb.LevelDBFile` instance. -|`sync` |boolean |*Camel 2.12:* Whether or not the LevelDBFile should sync on write or +|`sync` |boolean |Whether or not the LevelDBFile should sync on write or not. Default is false. By sync on write ensures that its always waiting for all writes to be spooled to disk and thus will not loose updates. See http://leveldb.googlecode.com/svn/trunk/doc/index.html[LevelDB docs] @@ -145,7 +145,7 @@ the download page for the latest versions). <dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-leveldb</artifactId> - <version>2.10.0</version> + <version>x.y.z</version> </dependency> ---------------------------------------- diff --git a/components/camel-log/src/main/docs/log-component.adoc b/components/camel-log/src/main/docs/log-component.adoc index 1d3feb6..3ecb61e 100644 --- a/components/camel-log/src/main/docs/log-component.adoc +++ b/components/camel-log/src/main/docs/log-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.1* -The *log:* component logs message exchanges to the underlying logging +The Log component logs message exchanges to the underlying logging mechanism. Camel uses http://www.slf4j.org/[sfl4j] which allows you to configure @@ -28,7 +28,7 @@ can append query options to the URI in the following format, ==== *Using Logger instance from the Registry* -As of *Camel 2.12.4/2.13.1*, if there's single instance +If there's single instance of `org.slf4j.Logger` found in the Registry, the *loggingCategory* is no longer used to create logger instance. The registered instance is used instead. Also it is possible to reference particular `Logger` instance @@ -323,7 +323,7 @@ that Camel Context*. If you need different ExchangeFormatters for different endpoints, just instantiate the LogComponent as many times as needed, and use the relevant bean name as the endpoint prefix. -From *Camel 2.11.2/2.12* onwards when using a custom log formatter, you +When using a custom log formatter, you can specify parameters in the log uri, which gets configured on the custom log formatter. Though when you do that you should define the "logFormatter" as prototype scoped so its not shared if you have diff --git a/components/camel-lucene/src/main/docs/lucene-component.adoc b/components/camel-lucene/src/main/docs/lucene-component.adoc index 715bd64..294ce93 100644 --- a/components/camel-lucene/src/main/docs/lucene-component.adoc +++ b/components/camel-lucene/src/main/docs/lucene-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.2* -The *lucene* component is based on the Apache Lucene project. Apache +The Lucene component is based on the Apache Lucene project. Apache Lucene is a powerful high-performance, full-featured text search engine library written entirely in Java. For more details about Lucene, please see the following links @@ -158,7 +158,7 @@ The component supports 12 options, which are listed below. |`QUERY` |The Lucene Query to performed on the index. The query may include wildcards and phrases -|`RETURN_LUCENE_DOCS` | *Camel 2.15:* Set this header to true to include the actual Lucene +|`RETURN_LUCENE_DOCS` |Set this header to true to include the actual Lucene documentation when returning hit information. |======================================================================= diff --git a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc index 53d908d..6f3da47 100644 --- a/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc +++ b/components/camel-lumberjack/src/main/docs/lumberjack-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.18* -The *Lumberjack* component retrieves logs sent over the network using the Lumberjack protocol, +The Lumberjack component retrieves logs sent over the network using the Lumberjack protocol, from https://www.elastic.co/fr/products/beats/filebeat[Filebeat] for instance. The network communication can be secured with SSL. diff --git a/components/camel-mail/src/main/docs/mail-component.adoc b/components/camel-mail/src/main/docs/mail-component.adoc index 5101e76..5d3cdbb 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 1.0* -The mail component provides access to Email via Spring's Mail support +The Mail component provides access to Email via Spring's Mail support and the underlying JavaMail system. Maven users will need to add the following dependency to their `pom.xml` @@ -342,8 +342,8 @@ configuration. ==== Using the JSSE Configuration Utility -As of *Camel 2.10*, the mail component supports SSL/TLS configuration -through the xref:camel-configuration-utilities.adoc[Camel JSSE +The mail component supports SSL/TLS configuration +through the link:camel-configuration-utilities.adoc[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 @@ -409,7 +409,7 @@ below demonstrates this: The same applies for other MimeMessage headers such as recipients, so you can use a header property as `To`: -*Since Camel 2.11* When using the MailProducer the send the mail to +When using the MailProducer the send the mail to server, you should be able to get the message id of the http://java.sun.com/javaee/5/docs/api/javax/mail/internet/MimeMessage.html[MimeMessage] with the key `CamelMailMessageId` from the Camel message header. diff --git a/components/camel-master/src/main/docs/master-component.adoc b/components/camel-master/src/main/docs/master-component.adoc index 2c00073..5207cdf 100644 --- a/components/camel-master/src/main/docs/master-component.adoc +++ b/components/camel-master/src/main/docs/master-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.20* -The **camel-master:** endpoint provides a way to ensure only a single consumer in a cluster consumes from a given endpoint; +The Camel-Master endpoint provides a way to ensure only a single consumer in a cluster consumes from a given endpoint; with automatic failover if that JVM dies. This can be very useful if you need to consume from some legacy back end which either doesn't support concurrent diff --git a/components/camel-metrics/src/main/docs/metrics-component.adoc b/components/camel-metrics/src/main/docs/metrics-component.adoc index 45dc261..29d449c 100644 --- a/components/camel-metrics/src/main/docs/metrics-component.adoc +++ b/components/camel-metrics/src/main/docs/metrics-component.adoc @@ -12,7 +12,7 @@ endif::[] ### Metrics Component -The **metrics:** component allows to collect various metrics directly +The Metrics component allows to collect various metrics directly from Camel routes. Supported metric types are xref:#MetricsComponent-counter[counter], xref:#MetricsComponent-histogram[histogram], xref:#MetricsComponent-meter[meter], xref:#MetricsComponent-timer[timer] and xref:#MetricsComponent-gauge[gauge]. http://metrics.dropwizard.io[Metrics] provides diff --git a/components/camel-micrometer/src/main/docs/micrometer-component.adoc b/components/camel-micrometer/src/main/docs/micrometer-component.adoc index a717ca8..45f60db 100644 --- a/components/camel-micrometer/src/main/docs/micrometer-component.adoc +++ b/components/camel-micrometer/src/main/docs/micrometer-component.adoc @@ -12,7 +12,7 @@ endif::[] ### Micrometer Component -The **micrometer:** component allows to collect various metrics directly +The Micrometer component allows to collect various metrics directly from Camel routes. Supported metric types are xref:#MicrometerComponent-counter[counter], xref:#MicrometerComponent-distributionSummary[summary], and xref:#MicrometerComponent-timer[timer]. http://micrometer.io/[Micrometer] provides diff --git a/components/camel-milo/src/main/docs/milo-client-component.adoc b/components/camel-milo/src/main/docs/milo-client-component.adoc index 4dc1dcf..b32b6ce 100644 --- a/components/camel-milo/src/main/docs/milo-client-component.adoc +++ b/components/camel-milo/src/main/docs/milo-client-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.19* -The *Milo Client* component provides access to OPC UA servers using the +The Milo Client component provides access to OPC UA servers using the http://eclipse.org/milo[Eclipse Milo™] implementation. Maven users will need to add the following dependency to their `pom.xml` diff --git a/components/camel-milo/src/main/docs/milo-server-component.adoc b/components/camel-milo/src/main/docs/milo-server-component.adoc index d6d8c5b..d4ec83b 100644 --- a/components/camel-milo/src/main/docs/milo-server-component.adoc +++ b/components/camel-milo/src/main/docs/milo-server-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.19* -The *Milo Server* component provides an OPC UA server using the +The Milo Server component provides an OPC UA server using the http://eclipse.org/milo[Eclipse Milo™] implementation. *Java 8*: This component requires Java 8 at runtime. diff --git a/components/camel-mina2/src/main/docs/mina2-component.adoc b/components/camel-mina2/src/main/docs/mina2-component.adoc index 16e6ea8..92a9792 100644 --- a/components/camel-mina2/src/main/docs/mina2-component.adoc +++ b/components/camel-mina2/src/main/docs/mina2-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.10* -The *mina2:* component is a transport for working with +The Mina2 component is a transport for working with http://mina.apache.org/[Apache MINA 2.x] TIP: Favor using <<netty-component,Netty>> as Netty is a much more active diff --git a/components/camel-mock/src/main/docs/mock-component.adoc b/components/camel-mock/src/main/docs/mock-component.adoc index efbd2b8..bf3993d 100644 --- a/components/camel-mock/src/main/docs/mock-component.adoc +++ b/components/camel-mock/src/main/docs/mock-component.adoc @@ -52,7 +52,7 @@ NotifyBuilder or AdviceWith in your tests instead of adding Mock endpoints to routes directly. + + -From Camel 2.10 onwards there are two new options `retainFirst`, and +There are two new options `retainFirst`, and `retainLast` that can be used to limit the number of messages the Mock endpoints keep in memory. @@ -380,7 +380,7 @@ in the constructor for the bean: Sometimes you want to easily mock and skip sending to a certain endpoints. So the message is detoured and send to the mock endpoint -only. From Camel 2.10 onwards you can now use the `mockEndpointsAndSkip` +only. You can now use the `mockEndpointsAndSkip` method using AdviceWith or the https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=CAMEL&title=Test+Kit&linkCreation=true&fromPageId=52081[Test Kit]. The example below will skip sending to the two endpoints @@ -407,7 +407,7 @@ include::../../../../components/camel-test/src/test/java/org/apache/camel/test/p The <<mock-component,Mock>> endpoints will by default keep a copy of every Exchange that it received. So if you test with a lot of messages, then it will consume memory. + -From Camel 2.10 onwards we have introduced two options `retainFirst` and +We have introduced two options `retainFirst` and `retainLast` that can be used to specify to only keep N'th of the first and/or last Exchanges. diff --git a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc index c5928f6..7c6cad3 100644 --- a/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc +++ b/components/camel-mongodb3/src/main/docs/mongodb3-component.adoc @@ -153,15 +153,6 @@ The component supports 3 options, which are listed below. // spring-boot-auto-configure options: END -Note on options of MongoDB component - -writeConcern *Remove in camel 2.19.* See Mongo client options <<MongoDB-ConfigurationofdatabaseinSpringXML>>. Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the link WriteConcernvalueOf(String) method. - -readPreference *Remove in camel 2.19.* See Mongo client options <<MongoDB-ConfigurationofdatabaseinSpringXML>>. Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The link com.mongodb.ReadPreferencevalueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest primary or secondary etc. - - - - [[MongoDB-ConfigurationofdatabaseinSpringXML]] === Configuration of database in Spring XML diff --git a/components/camel-mqtt/src/main/docs/mqtt-component.adoc b/components/camel-mqtt/src/main/docs/mqtt-component.adoc index 6da87ae..ba84f04 100644 --- a/components/camel-mqtt/src/main/docs/mqtt-component.adoc +++ b/components/camel-mqtt/src/main/docs/mqtt-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.10* -The *mqtt:* component is used for communicating with +The MQTT component is used for communicating with http://mqtt.org[MQTT] compliant message brokers, like http://activemq.apache.org[Apache ActiveMQ] or http://mosquitto.org[Mosquitto] diff --git a/components/camel-mustache/src/main/docs/mustache-component.adoc b/components/camel-mustache/src/main/docs/mustache-component.adoc index a0377f8..92cee3e 100644 --- a/components/camel-mustache/src/main/docs/mustache-component.adoc +++ b/components/camel-mustache/src/main/docs/mustache-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.12* -The *mustache:* component allows for processing a message using a +The Mustache component allows for processing a message using a http://mustache.github.io/[Mustache] template. This can be ideal when using Templating to generate responses for requests. diff --git a/components/camel-mvel/src/main/docs/mvel-component.adoc b/components/camel-mvel/src/main/docs/mvel-component.adoc index 1180603..825a112 100644 --- a/components/camel-mvel/src/main/docs/mvel-component.adoc +++ b/components/camel-mvel/src/main/docs/mvel-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.12* -The *mvel:* component allows you to process a message using an +The MVEL component allows you to process a message using an http://mvel.codehaus.org/[MVEL] template. This can be ideal when using Templating to generate responses for requests. diff --git a/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc index ea89d01..9a5870c 100644 --- a/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis-bean-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.22* -The *mybatis-bean:* component allows you to query, insert, update and +The MyBatis Bean component allows you to query, insert, update and delete data in a relational database using http://mybatis.org/[MyBatis] bean annotations. This component can **only** be used as a producer. If you want to consume diff --git a/components/camel-mybatis/src/main/docs/mybatis-component.adoc b/components/camel-mybatis/src/main/docs/mybatis-component.adoc index dc6875e..82f883f 100644 --- a/components/camel-mybatis/src/main/docs/mybatis-component.adoc +++ b/components/camel-mybatis/src/main/docs/mybatis-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.7* -The *mybatis:* component allows you to query, poll, insert, update and +The MyBatis component allows you to query, poll, insert, update and delete data in a relational database using http://mybatis.org/[MyBatis]. Maven users will need to add the following dependency to their `pom.xml` diff --git a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc index 2d817f2..d3b4231 100644 --- a/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc +++ b/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.14* -The *netty4-http* component is an extension to <<netty4-component,Netty4>> +The Netty4 HTTP component is an extension to <<netty4-component,Netty4>> component to facilitiate HTTP transport with <<netty4-component,Netty4>>. This camel component supports both producer and consumer endpoints. diff --git a/components/camel-netty4/src/main/docs/netty4-component.adoc b/components/camel-netty4/src/main/docs/netty4-component.adoc index f3cfe16..53187bc 100644 --- a/components/camel-netty4/src/main/docs/netty4-component.adoc +++ b/components/camel-netty4/src/main/docs/netty4-component.adoc @@ -3,7 +3,7 @@ *Available as of Camel version 2.14* -The *netty4* component in Camel is a socket communication component, +The Netty4 component in Camel is a socket communication component, based on the http://netty.io/[Netty] project version 4. + Netty is a NIO client server framework which enables quick and easy development of networkServerInitializerFactory applications such as @@ -300,12 +300,12 @@ not set |`trustStoreFile` |*deprecated:* Server side certificate keystore to be used for encryption -|`keyStoreResource` |*Camel 2.11.1:* Client side certificate keystore to be used for +|`keyStoreResource` |Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with `"classpath:"`, `"file:"`, or `"http:"` to load the resource from different systems. -|`trustStoreResource` |*Camel 2.11.1:* Server side certificate keystore to be used for +|`trustStoreResource` |Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with `"classpath:"`, `"file:"`, or `"http:"` to load the resource from different systems. @@ -405,8 +405,8 @@ RouteBuilder builder = new RouteBuilder() { [[Netty4-UsingtheJSSEConfigurationUtility]] Using the JSSE Configuration Utility -As of Camel 2.9, the Netty component supports SSL/TLS configuration -through the xref:camel-configuration-utilities.adoc[Camel JSSE +The Netty component supports SSL/TLS configuration +through the link:camel-configuration-utilities.adoc[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 diff --git a/components/camel-nsq/src/main/docs/nsq-component.adoc b/components/camel-nsq/src/main/docs/nsq-component.adoc index 04586d0..e1cb712 100644 --- a/components/camel-nsq/src/main/docs/nsq-component.adoc +++ b/components/camel-nsq/src/main/docs/nsq-component.adoc @@ -3,10 +3,6 @@ *Available as of Camel version 2.23* -*Available as of Camel version 2.23* - - - http://nsq.io/[NSQ] is a realtime distributed messaging platform. Maven users will need to add the following dependency to