You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2019/06/06 13:46:00 UTC
[camel] branch master updated: More documentation cleaned up
("camel-b..." and "camel-c...").
https://issues.apache.org/jira/browse/CAMEL-13480
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
The following commit(s) were added to refs/heads/master by this push:
new ef15d80 More documentation cleaned up ("camel-b..." and "camel-c..."). https://issues.apache.org/jira/browse/CAMEL-13480
ef15d80 is described below
commit ef15d807b4ffae97175313ec4ca1ebf2f824d66d
Author: Alexandros Koufoudakis <ak...@gmail.com>
AuthorDate: Thu Jun 6 15:32:28 2019 +0200
More documentation cleaned up ("camel-b..." and "camel-c..."). https://issues.apache.org/jira/browse/CAMEL-13480
---
.../src/main/docs/barcode-dataformat.adoc | 2 +-
.../src/main/docs/bean-validator-component.adoc | 5 +-
.../camel-bean/src/main/docs/bean-component.adoc | 2 +-
.../camel-bean/src/main/docs/class-component.adoc | 14 +---
.../src/main/docs/beanstalk-component.adoc | 5 +-
.../src/main/docs/bindy-dataformat.adoc | 96 ++++++++--------------
.../src/main/docs/caffeine-cache-component.adoc | 2 +-
.../main/docs/caffeine-loadcache-component.adoc | 2 +-
components/camel-cdi/src/main/docs/cdi.adoc | 5 +-
.../src/main/docs/chatscript-component.adoc | 5 +-
.../camel-chunk/src/main/docs/chunk-component.adoc | 2 +-
.../camel-coap/src/main/docs/coap-component.adoc | 4 +-
.../src/main/docs/cometd-component.adoc | 4 +-
.../src/main/docs/consul-component.adoc | 2 +-
.../src/main/docs/controlbus-component.adoc | 13 +--
.../camel-corda/src/main/docs/corda-component.adoc | 2 +-
.../src/main/docs/couchdb-component.adoc | 4 +-
.../camel-crypto/src/main/docs/pgp-dataformat.adoc | 38 ++++-----
.../camel-csv/src/main/docs/csv-dataformat.adoc | 8 --
.../src/main/docs/cxf-transport.adoc | 19 ++---
.../camel-cxf/src/main/docs/cxf-component.adoc | 29 +++----
.../camel-cxf/src/main/docs/cxfrs-component.adoc | 8 +-
22 files changed, 90 insertions(+), 181 deletions(-)
diff --git a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc
index fcd59bc..0e2c284 100644
--- a/components/camel-barcode/src/main/docs/barcode-dataformat.adoc
+++ b/components/camel-barcode/src/main/docs/barcode-dataformat.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.14*
-The barcode data format is based on the
+The Barcode data format is based on the
https://github.com/zxing/zxing[zxing library]. The goal of this
component is to create a barcode image from a String (marshal) and a
String from a barcode image (unmarshal). You're free to use all features
diff --git a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc
index 49724f4..6145ea9 100644
--- a/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc
+++ b/components/camel-bean-validator/src/main/docs/bean-validator-component.adoc
@@ -129,9 +129,8 @@ The component supports 3 options, which are listed below.
To use Hibernate Validator in the OSGi environment use dedicated
`ValidationProviderResolver` implementation, just as
`org.apache.camel.component.bean.validator.HibernateValidationProviderResolver`.
-The snippet below demonstrates this approach. Keep in mind that you can
-use `HibernateValidationProviderResolver` starting from the Camel
-2.13.0.
+The snippet below demonstrates this approach. You can also
+use `HibernateValidationProviderResolver`.
*Using HibernateValidationProviderResolver*
diff --git a/components/camel-bean/src/main/docs/bean-component.adoc b/components/camel-bean/src/main/docs/bean-component.adoc
index 98722e5..10807ed 100644
--- a/components/camel-bean/src/main/docs/bean-component.adoc
+++ b/components/camel-bean/src/main/docs/bean-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 1.0*
-The *bean:* component binds beans to Camel message exchanges.
+The Bean component binds beans to Camel message exchanges.
=== URI format
diff --git a/components/camel-bean/src/main/docs/class-component.adoc b/components/camel-bean/src/main/docs/class-component.adoc
index 919bb65..c87b9c1 100644
--- a/components/camel-bean/src/main/docs/class-component.adoc
+++ b/components/camel-bean/src/main/docs/class-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.4*
-The *class:* component binds beans to Camel message exchanges. It works
+The Class component binds beans to Camel message exchanges. It works
in the same way as the <<bean-component,Bean>> component but instead of
looking up beans from a Registry it creates the bean
based on the class name.
@@ -97,15 +97,9 @@ instance, for example if it has a `setPrefix` method:
[source,java]
---------------------------------------------------------------------------------
- // Camel 2.17 onwards
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?bean.prefix=Bye")
.to("mock:result");
-
- // Camel 2.16 and older
- from("direct:start")
- .to("class:org.apache.camel.component.bean.MyPrefixBean?prefix=Bye")
- .to("mock:result");
---------------------------------------------------------------------------------
And you can also use the `#` syntax to refer to properties to be looked
@@ -113,15 +107,9 @@ up in the Registry.
[source,java]
--------------------------------------------------------------------------------
- // Camel 2.17 onwards
from("direct:start")
.to("class:org.apache.camel.component.bean.MyPrefixBean?bean.cool=#foo")
.to("mock:result");
-
- // Camel 2.16 and older
- from("direct:start")
- .to("class:org.apache.camel.component.bean.MyPrefixBean?cool=#foo")
- .to("mock:result");
--------------------------------------------------------------------------------
Which will lookup a bean from the Registry with the
diff --git a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
index 2f72bfb..bf1c691 100644
--- a/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
+++ b/components/camel-beanstalk/src/main/docs/beanstalk-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.15*
-camel-beanstalk project provides a Camel component for job retrieval and
+Camel Beanstalk project provides a Camel component for job retrieval and
post-processing of Beanstalk jobs.
You can find the detailed explanation of Beanstalk job lifecycle
@@ -23,8 +23,7 @@ Maven users need to add the following dependency to their `pom.xml`
</dependency>
------------------------------------------
-where `${camel-version`} must be replaced by the actual version of Camel
-(2.15.0 or higher).
+where `${camel-version`} must be replaced by the actual version of Camel.
### URI format
diff --git a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc
index 4a79052..a39a824 100644
--- a/components/camel-bindy/src/main/docs/bindy-dataformat.adoc
+++ b/components/camel-bindy/src/main/docs/bindy-dataformat.adoc
@@ -46,12 +46,8 @@ the Class or field.
*Multiple models*
-If you use multiple models, each model has to be placed in it's own
-package to prevent unpredictable results.
-
-From *Camel 2.16* onwards this is no longer the case, as you can safely
-have multiple models in the same package, as you configure bindy using
-class names instead of package names now.
+As you configure bindy using class names instead of package names
+you can put multiple models in the same package.
=== Options
@@ -130,8 +126,8 @@ the POJO like :
financial messages),
* Section (to identify header, body and footer section),
* OneToMany,
-* BindyConverter (since 2.18.0),
-* FormatFactories (since 2.18.0)
+* BindyConverter,
+* FormatFactories
This section will describe them :
@@ -168,7 +164,7 @@ specify a value other than the three listed before, the value you enter
|generateHeaderColumns |boolean |optional - default value = false - uses to generate the header columns
of the CSV generates
-|autospanLine |boolean |*Camel 2.13/2.12.2:* optional - default value = false - if enabled then
+|autospanLine |boolean |optional - default value = false - if enabled then
the last column is auto spanned to end of line, for example if its a
comment, etc this allows the line to contain all characters, also the
delimiter char.
@@ -176,14 +172,14 @@ delimiter char.
|isOrdered |boolean |optional - default value = false - allow to change the order of the
fields when CSV is generated
-|quote |String |*Camel 2.8.3/2.9:* option - allow to specify a quote character of the
+|quote |String |optional - allow to specify a quote character of the
fields when CSV is generated. This annotation is associated to the root class of the model and must be
declared one time.
-|quoting |boolean |*Camel 2.11:*optional - default value = false - Indicate if the values (and headers)
+|quoting |boolean |optional - default value = false - Indicate if the values (and headers)
must be quoted when marshaling when CSV is generated.
-|endWithLineBreak |boolean |*Camel 2.21:* optional - default value = true - Indicate if the CSV generated file
+|endWithLineBreak |boolean |optional - default value = true - Indicate if the CSV generated file
should end with a line break.
|
@@ -264,7 +260,7 @@ public Class Order {
}
----
-From *Camel 2.8.3/2.9 or never* bindy will automatic detect if the
+Bindy automatically detects if the
record is enclosed with either single or double quotes and automatic
remove those quotes when unmarshalling from CSV to Object. Therefore do
*not* include the quotes in the separator, but simple do as below:
@@ -472,7 +468,7 @@ will be formatted/parsed
(SimpleDateFormat by example) to format/validate data. If using pattern,
then setting locale on bindy data format is recommended. Either set to a
known locale such as "us" or use "default" to use platform default
-locale. Notice that "default" requires Camel 2.14/2.13.3/2.12.5.
+locale.
|position |int |optional - must be used when the position of the field in the CSV
generated (output message) must be different compare to input position
@@ -482,19 +478,19 @@ generated (output message) must be different compare to input position
|trim |boolean |optional - default value = "false"
-|defaultValue |string |*Camel 2.10:* optional - default value = "" - defines the field's
+|defaultValue |string |optional - default value = "" - defines the field's
default value when the respective CSV field is empty/not available
-|impliedDecimalSeparator |boolean |*Camel 2.11:* optional - default value = "false" - Indicates if there is
+|impliedDecimalSeparator |boolean |optional - default value = "false" - Indicates if there is
a decimal point implied at a specified location
-|lengthPos |int |*Camel 2.11*: optional - can be used to identify a data field in a
+|lengthPos |int |optional - can be used to identify a data field in a
fixed-length record that defines the fixed length for this field
|align |string |optional - default value = "R" - Align the text to the right or left within a fixed-length field.
Use values 'R' or 'L'
-|delimiter |string |*Camel 2.11:* optional - can be used to demarcate the end of a variable-length field within a fixed-length record
+|delimiter |string |optional - can be used to demarcate the end of a variable-length field within a fixed-length record
|===
*case 1 : pos*
@@ -771,28 +767,28 @@ provided line delimiter as "WINDOWS" unless any other value is provided
|length |int |mandatory = size of the fixed length record
-|hasHeader |boolean |*Camel 2.11* - optional - Indicates that the record(s) of this type may
+|hasHeader |boolean |optional - Indicates that the record(s) of this type may
be preceded by a single header record at the beginning of the file /
stream
-|hasFooter |boolean |*Camel 2.11* - optional - Indicates that the record(s) of this type may
+|hasFooter |boolean |optional - Indicates that the record(s) of this type may
be followed by a single footer record at the end of the file / stream
-|skipHeader |boolean |*Camel 2.11* - optional - Configures the data format to skip marshalling
+|skipHeader |boolean |optional - Configures the data format to skip marshalling
/ unmarshalling of the header record. Configure this parameter on the
primary record (e.g., not the header or footer).
-|skipFooter |boolean |*Camel 2.11* - optional - Configures the data format to skip marshalling
+|skipFooter |boolean |optional - Configures the data format to skip marshalling
/ unmarshalling of the footer record Configure this parameter on the
primary record (e.g., not the header or footer)..
-|isHeader |boolean |*Camel 2.11* - optional - Identifies this FixedLengthRecord as a header
+|isHeader |boolean |optional - Identifies this FixedLengthRecord as a header
record
-|isFooter |boolean |*Camel 2.11* - optional - Identifies this FixedLengthRecords as a footer
+|isFooter |boolean |optional - Identifies this FixedLengthRecords as a footer
record
-|ignoreTrailingChars |boolean |*Camel 2.11.1* - optional - Indicates that characters beyond the last
+|ignoreTrailingChars |boolean |optional - Indicates that characters beyond the last
mapped filed can be ignored when unmarshalling / parsing. This annotation is associated to the root class of the model and must be
declared one time.
|===
@@ -1009,7 +1005,7 @@ public static class Order {
}
----
-As of *Camel 2.11* the 'pos' value(s) in a fixed-length record may
+The 'pos' value(s) in a fixed-length record may
optionally be defined using ordinal, sequential values instead of
precise column numbers.
@@ -1145,8 +1141,7 @@ public class OrderFooter {
}
----
-*case 7 : Skipping content when parsing a fixed length record. (Camel
-2.11.1)*
+*case 7 : Skipping content when parsing a fixed length record.
It is common to integrate with systems that provide fixed-length records
containing more information than needed for the target use case. It is
@@ -1666,9 +1661,9 @@ FormattingOptions:
* Enums
* Float
* Integer
-* LocalDate (java 8, since 2.18.0)
-* LocalDateTime (java 8, since 2.18.0)
-* LocalTime (java 8, since 2.18.0)
+* LocalDate
+* LocalDateTime
+* LocalTime
* Long
* Short
* String
@@ -1678,22 +1673,16 @@ FactoryRegistry in the registry in use (e.g. spring or JNDI).
=== Using the Java DSL
-The next step consists in instantiating the DataFormat _bindy_ class
-associated with this record type and providing Java package name(s) as
-parameter.
+The next step instantiates the DataFormat _bindy_ class
+associated with this record type and providing a class as a parameter.
-For example the following uses the class `BindyCsvDataFormat` (who
-correspond to the class associated with the CSV record type) which is
-configured with `com.acme.model` package name to initialize the model objects
+For example the following uses the class `BindyCsvDataFormat` (which
+corresponds to the class associated with the CSV record type) which is
+configured with _com.acme.model.MyModel.class_ to initialize the model objects
configured in this package.
[source,java]
----
-// Camel 2.15 or older (configure by package name)
-DataFormat bindy = new BindyCsvDataFormat("com.acme.model");
-
-
-// Camel 2.16 onwards (configure by class name)
DataFormat bindy = new BindyCsvDataFormat(com.acme.model.MyModel.class);
----
@@ -1703,39 +1692,21 @@ Bindy supports configuring the locale on the dataformat, such as
[source,java]
----
-// Camel 2.15 or older (configure by package name)
-BindyCsvDataFormat bindy = new BindyCsvDataFormat("com.acme.model");
-// Camel 2.16 onwards (configure by class name)
BindyCsvDataFormat bindy = new BindyCsvDataFormat(com.acme.model.MyModel.class);
bindy.setLocale("us");
----
Or to use the platform default locale then use "default" as the locale
-name. Notice this requires Camel 2.14/2.13.3/2.12.5.
+name.
[source,java]
----
-// Camel 2.15 or older (configure by package name)
-BindyCsvDataFormat bindy = new BindyCsvDataFormat("com.acme.model");
-// Camel 2.16 onwards (configure by class name)
BindyCsvDataFormat bindy = new BindyCsvDataFormat(com.acme.model.MyModel.class);
bindy.setLocale("default");
----
-for older releases you can set it using Java code as shown
-
-[source,java]
-----
-// Camel 2.15 or older (configure by package name)
-BindyCsvDataFormat bindy = new BindyCsvDataFormat("com.acme.model");
-// Camel 2.16 onwards (configure by class name)
-BindyCsvDataFormat bindy = new BindyCsvDataFormat(com.acme.model.MyModel.class);
-
-bindy.setLocale(Locale.getDefault().getISO3Country());
-----
-
==== Unmarshaling
[source,java]
@@ -1841,8 +1812,7 @@ unmarshal the content and bind it to their model. The result is then
send to a pojo (doing nothing special) and place them into a queue.
The second route will extract the pojos from the queue and marshal the
-content to generate a file containing the csv record. The example above
-is for using Camel 2.16 onwards.
+content to generate a file containing the csv record.
*spring dsl*
diff --git a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc
index eacf4de..07715b8 100644
--- a/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc
+++ b/components/camel-caffeine/src/main/docs/caffeine-cache-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.20*
-The *caffeine-cache* component enables you to perform caching operations using
+The Caffeine Cache component enables you to perform caching operations using
the simple cache from Caffeine.
Maven users will need to add the following dependency to
diff --git a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc
index 3bbe68f..a21f89e 100644
--- a/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc
+++ b/components/camel-caffeine/src/main/docs/caffeine-loadcache-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.20*
-The *caffeine-loadcache* component enables you to perform caching operations using
+The Caffeine Loadcache component enables you to perform caching operations using
The Load cache from Caffeine.
Maven users will need to add the following dependency to
diff --git a/components/camel-cdi/src/main/docs/cdi.adoc b/components/camel-cdi/src/main/docs/cdi.adoc
index 9b5bfbc..77e54d0 100644
--- a/components/camel-cdi/src/main/docs/cdi.adoc
+++ b/components/camel-cdi/src/main/docs/cdi.adoc
@@ -280,10 +280,7 @@ user-defined `@MyOtherQualifier` qualifier does not get added to any
Camel contexts. That may be useful, for example, for Camel routes that
may be required to be added later during the application execution.
-NOTE: Since Camel version 2.17.0, Camel CDI is capable of managing any kind of
-`CamelContext` beans (e.g. `DefaultCamelContext`). In previous versions,
-it is only capable of managing beans of type `CdiCamelContext` so it is
-required to extend it.
+Camel CDI is capable of managing any kind of `CamelContext` beans (e.g. `DefaultCamelContext`).
The CDI qualifiers declared on the `CamelContext` beans are also used to
bind the corresponding Camel primitives, e.g.:
diff --git a/components/camel-chatscript/src/main/docs/chatscript-component.adoc b/components/camel-chatscript/src/main/docs/chatscript-component.adoc
index 6d7d547..e5c6336 100644
--- a/components/camel-chatscript/src/main/docs/chatscript-component.adoc
+++ b/components/camel-chatscript/src/main/docs/chatscript-component.adoc
@@ -1,12 +1,9 @@
[[chatscript-component]]
== ChatScript Component
-== ChatScript Component
-*Available as of Camel version 3.0.0*
-
*Available as of Camel version 3.0.0*
-The *ChatScript:* component allows you to interact with ChatScript Server and have conversations. This component is stateless and relies on ChatScript to maintain chat history.
+The ChatScript component allows you to interact with ChatScript Server and have conversations. This component is stateless and relies on ChatScript to maintain chat history.
Original ChatScript is available here : https://github.com/bwilcox-1234/ChatScript
diff --git a/components/camel-chunk/src/main/docs/chunk-component.adoc b/components/camel-chunk/src/main/docs/chunk-component.adoc
index 27d4ff6..fcb0a9d 100644
--- a/components/camel-chunk/src/main/docs/chunk-component.adoc
+++ b/components/camel-chunk/src/main/docs/chunk-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.15*
-The *chunk:* component allows for processing a message using a
+The Chunk component allows for processing a message using a
http://www.x5software.com/chunk/examples/ChunkExample?loc=en_US[Chunk] template.
This can be ideal when using Templating to
generate responses for requests.
diff --git a/components/camel-coap/src/main/docs/coap-component.adoc b/components/camel-coap/src/main/docs/coap-component.adoc
index 1114eda..37989a5 100644
--- a/components/camel-coap/src/main/docs/coap-component.adoc
+++ b/components/camel-coap/src/main/docs/coap-component.adoc
@@ -3,12 +3,12 @@
*Available as of Camel version 2.16*
-*Camel-CoAP* is an http://camel.apache.org/[Apache Camel] component that
+Camel-CoAP is an http://camel.apache.org/[Apache Camel] component that
allows you to work with CoAP, a lightweight REST-type protocol for machine-to-machine operation.
http://coap.technology/[CoAP], Constrained Application Protocol is a specialized web transfer protocol
for use with constrained nodes and constrained networks and it is based on RFC 7252.
-From Camel 3.0.0, Camel supports the DTLS, TCP and TLS protocols via the following URI schemes:
+Camel supports the DTLS, TCP and TLS protocols via the following URI schemes:
[width="100%",cols="2,5",options="header"]
|===
diff --git a/components/camel-cometd/src/main/docs/cometd-component.adoc b/components/camel-cometd/src/main/docs/cometd-component.adoc
index 9fa0766..1e35594 100644
--- a/components/camel-cometd/src/main/docs/cometd-component.adoc
+++ b/components/camel-cometd/src/main/docs/cometd-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.0*
-The *cometd:* component is a transport for working with the
+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]. +
@@ -181,7 +181,7 @@ http://cometd.org/documentation/howtos/authentication[documented here]
#### Using the JSSE Configuration Utility
-As of Camel 2.9, the Cometd component supports SSL/TLS configuration
+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
diff --git a/components/camel-consul/src/main/docs/consul-component.adoc b/components/camel-consul/src/main/docs/consul-component.adoc
index 61d3ce3..3fcce93 100644
--- a/components/camel-consul/src/main/docs/consul-component.adoc
+++ b/components/camel-consul/src/main/docs/consul-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.18*
-The *Consul* component is a component for integrating your application with Consul.
+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:
diff --git a/components/camel-controlbus/src/main/docs/controlbus-component.adoc b/components/camel-controlbus/src/main/docs/controlbus-component.adoc
index ddac7c5..d81b792 100644
--- a/components/camel-controlbus/src/main/docs/controlbus-component.adoc
+++ b/components/camel-controlbus/src/main/docs/controlbus-component.adoc
@@ -1,7 +1,7 @@
[[controlbus-component]]
== Control Bus Component
-*Available as of Camel version 2.11*
+*Available as of Camel 2.11*
The http://www.eaipatterns.com/ControlBus.html[Control Bus] from the
EIP patterns allows for the
@@ -21,16 +21,7 @@ by using a Java API from the `CamelContext`, or from the
or use the event notifier which has an example
here.
-From Camel 2.11 onwards we have introduced a new
-<<controlbus-component,ControlBus Component>> that allows you to
-send messages to a control bus Endpoint that reacts
-accordingly.
-
-=== ControlBus Component
-
-*Available as of Camel 2.11*
-
-The *controlbus:* component provides easy management of Camel
+The ControlBus component provides easy management of Camel
applications based on the <<controlbus-component,Control Bus>> EIP
pattern.
For example, by sending a message to an Endpoint
diff --git a/components/camel-corda/src/main/docs/corda-component.adoc b/components/camel-corda/src/main/docs/corda-component.adoc
index effbc9e..79ede3d 100644
--- a/components/camel-corda/src/main/docs/corda-component.adoc
+++ b/components/camel-corda/src/main/docs/corda-component.adoc
@@ -4,7 +4,7 @@
*Available as of Camel version 2.23*
-The *Corda* blockchain component uses the https://www.corda.net/[corda] rpc client
+The Corda blockchain component uses the https://www.corda.net/[corda] rpc client
Maven users will need to add the following dependency to their `pom.xml`
for this component:
diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
index f0abc7a..7928b6a 100644
--- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc
+++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
@@ -10,8 +10,8 @@ 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, update, from Camel 2.18 delete (by using CouchDbMethod with DELETE value)
-documents and from Camel 2.22 get document by id (by using CouchDbMethod with GET value) into couch.
+* As a producer, can save, update, delete (by using CouchDbMethod with DELETE value)
+documents and get documents by id (by using CouchDbMethod with GET value) 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
diff --git a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc
index 896784e..2fd348e 100644
--- a/components/camel-crypto/src/main/docs/pgp-dataformat.adoc
+++ b/components/camel-crypto/src/main/docs/pgp-dataformat.adoc
@@ -48,49 +48,49 @@ into message dynamically.
|=======================================================================
|Name |Type |Description
-|`CamelPGPDataFormatKeyFileName` |`String` |*Since Camel 2.11.0*; filename of the keyring; will override existing
+|`CamelPGPDataFormatKeyFileName` |`String` |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
+|`CamelPGPDataFormatEncryptionKeyRing` |`byte[]` |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
+|`CamelPGPDataFormatKeyUserid` |`String` |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
+|`CamelPGPDataFormatKeyUserids` |`List<String>` |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
+|`CamelPGPDataFormatKeyPassword` |`String` |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
+|`CamelPGPDataFormatSignatureKeyFileName` |`String` |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
+|`CamelPGPDataFormatSignatureKeyRing` |`byte[]` |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
+|`CamelPGPDataFormatSignatureKeyUserid` |`String` |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
+|`CamelPGPDataFormatSignatureKeyUserids` |`List<String>` |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
+|`CamelPGPDataFormatSignatureKeyPassword` |`String` |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
+|`CamelPGPDataFormatEncryptionAlgorithm` |`int` |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
+|`CamelPGPDataFormatSignatureHashAlgorithm` |`int` |signature hash algorithm; will override existing
setting directly on the PGPDataFormat.
-|`CamelPGPDataFormatCompressionAlgorithm` |`int` |*Since Camel 2.12.2*; compression algorithm; will override existing
+|`CamelPGPDataFormatCompressionAlgorithm` |`int` |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
+|`CamelPGPDataFormatNumberOfEncryptionKeys` |`Integer` |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
+|`CamelPGPDataFormatNumberOfSigningKeys` |`Integer` |number of private keys used for creating
signatures, set by PGPDataFormat during signing process
|=======================================================================
@@ -151,8 +151,6 @@ ls -l ~/.gnupg/pubring.gpg ~/.gnupg/secring.gpg
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
@@ -196,8 +194,6 @@ unmarshaling.
### 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
@@ -233,8 +229,6 @@ keys in the public keyring are taken into account.
### 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
@@ -263,7 +257,6 @@ from("direct:start")
### 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
@@ -278,7 +271,6 @@ primary key and its sub-keys have the same User IDs.
### 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
diff --git a/components/camel-csv/src/main/docs/csv-dataformat.adoc b/components/camel-csv/src/main/docs/csv-dataformat.adoc
index b57af14..b1e2547 100644
--- a/components/camel-csv/src/main/docs/csv-dataformat.adoc
+++ b/components/camel-csv/src/main/docs/csv-dataformat.adoc
@@ -240,14 +240,6 @@ and this Java route definition
[source,java]
-------------------------------------------------------
-// Camel version < 2.15
-CsvDataFormat oldCSV = new CsvDataFormat();
-oldCSV.setDelimiter("|");
-from("direct:start")
- .marshal(oldCSV)
- .to("mock:result")
-
-// Camel version >= 2.15
from("direct:start")
.marshal(new CsvDataFormat().setDelimiter('|'))
.to("mock:result")
diff --git a/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc b/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc
index 9595072..b0d5355 100644
--- a/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc
+++ b/components/camel-cxf-transport/src/main/docs/cxf-transport.adoc
@@ -20,7 +20,7 @@ with your CXF services.
[[CamelTransportforCXF-IntegrateCamelintoCXFtransportlayer]]
=== Integrate Camel into CXF transport layer
-To include the Camel Tranport into your CXF bus you use the
+To include the Camel Transport into your CXF bus you use the
CamelTransportFactory. You can do this in Java as well as in Spring.
[[CamelTransportforCXF-SettinguptheCamelTransportinSpring]]
@@ -29,8 +29,7 @@ CamelTransportFactory. You can do this in Java as well as in Spring.
You can use the following snippet in your applicationcontext if you want
to configure anything special. If you only want to activate the camel
transport you do not have to do anything in your application context. As
-soon as you include the camel-cxf-transport jar (or camel-cxf.jar if
-your camel version is less than 2.7.x) in your app, cxf will scan the
+soon as you include the camel-cxf-transport.jar in your app, cxf will scan the
jar and load a CamelTransportFactory for you.
[source,xml]
@@ -39,7 +38,6 @@ jar and load a CamelTransportFactory for you.
<bean class="org.apache.camel.component.cxf.transport.CamelTransportFactory">
<property name="bus" ref="cxf" />
<property name="camelContext" ref="camelContext" />
- <!-- checkException new added in Camel 2.1 and Camel 1.6.2 -->
<!-- If checkException is true , CamelDestination will check the outMessage's
exception and set it into camel exchange. You can also override this value
in CamelDestination's configuration. The default value is false.
@@ -95,7 +93,7 @@ BusFactory.setDefaultBus(bus);
[[CamelTransportforCXF-Namespace]]
==== Namespace
-The elements used to configure an Camel transport endpoint are defined
+The elements used to configure a Camel transport endpoint are defined
in the namespace `http://cxf.apache.org/transports/camel`. It is
commonly referred to using the prefix `camel`. In order to use the Camel
transport configuration elements, you will need to add the lines shown
@@ -119,7 +117,7 @@ the `xsi:schemaLocation` attribute.
[[CamelTransportforCXF-Thedestinationelement]]
==== The `destination` element
-You configure an Camel transport server endpoint using the
+You configure a Camel transport server endpoint using the
`camel:destination` element and its children. The `camel:destination`
element takes a single attribute, `name`, that specifies the WSDL port
element that corresponds to the endpoint. The value for the `name`
@@ -143,7 +141,6 @@ endpoint's target namespace was `http://widgets.widgetvendor.net`.
</camelContext>
</camel:destination>
- <!-- new added feature since Camel 2.11.x
<camel:destination name="{http://widgets/widgetvendor.net}widgetSOAPPort.camel-destination" camelContextId="context" />
...
@@ -190,11 +187,6 @@ endpoint's target namespace was `http://widgets.widgetvendor.net`.
</route>
</camelContext>
- <camel:conduit name="{http://widgets/widgetvendor.net}widgetSOAPPort.camel-conduit">
- <camel:camelContextRef>conduit_context</camel:camelContextRef>
- </camel:conduit>
-
- <!-- new added feature since Camel 2.11.x
<camel:conduit name="{http://widgets/widgetvendor.net}widgetSOAPPort.camel-conduit" camelContextId="conduit_context" />
@@ -223,8 +215,7 @@ The camel context id which you want inject into the camel conduit
[[CamelTransportforCXF-ConfigurethedestinationandconduitwithBlueprint]]
=== Configure the destination and conduit with Blueprint
-From *Camel 2.11.x*, Camel Transport supports to be configured with
-Blueprint.
+Camel Transport for CXF supports configuration with Blueprint.
If you are using blueprint, you should use the namespace
`http://cxf.apache.org/transports/camel/blueprint` and import the schema
diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc
index d504329..ac656d0 100644
--- a/components/camel-cxf/src/main/docs/cxf-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxf-component.adoc
@@ -13,7 +13,7 @@ fastest method to implement web services using Camel and CXF.
TIP: When using CXF in streaming modes (see DataFormat option), then also
read about Stream caching.
-The *cxf:* component provides integration with
+The CXF component provides integration with
http://cxf.apache.org[Apache CXF] for connecting to http://cxf.apache.org/docs/jax-ws.html[JAX-WS] services
hosted in CXF.
@@ -254,7 +254,7 @@ interceptors will be removed if you are using this kind of DataFormat so
you can't see any soap headers after the camel-cxf consumer and JAX-WS
handler is not supported.
-|`CXF_MESSAGE` |New in *Camel 2.8.2*, `CXF_MESSAGE` allows for invoking the full
+|`CXF_MESSAGE` |`CXF_MESSAGE` allows for invoking the full
capabilities of CXF interceptors by converting the message from the
transport layer into a raw SOAP message
|=======================================================================
@@ -355,9 +355,6 @@ headers here:
https://github.com/apache/camel/blob/master/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest.java[https://github.com/apache/camel/blob/master/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/soap/headers/CxfMessageHeadersRelayTest.java]
-
-#### Changes since Camel Release 2.0
-
* `POJO` and `PAYLOAD` modes are supported. In `POJO` mode, only
out-of-band message headers are available for filtering as the in-band
headers have been processed and removed from header list by CXF. The
@@ -566,7 +563,7 @@ and setDefaultBus properties from spring configuration file.
### Configuring the CXF Endpoints with Apache Aries Blueprint
-Since Camel 2.8 there is support for utilizing aries blueprint
+The component is capable of utilizing aries blueprint
dependency injection for your CXF endpoints.
The schema utilized is very similar to the spring schema so the
transition is fairly transparent.
@@ -664,10 +661,7 @@ To resolved this issue, you just need to tell StaxOutInterceptor to
write the XML start document for you.
You can add a customer interceptor like this and configure it into you
-camel-cxf endpont
-
-Or adding a message header for it like this if you are using *Camel
-2.4*.
+camel-cxf endpont or add a message header for it like
[source,java]
-------------------------------------------------------------------
@@ -764,7 +758,7 @@ Once you obtain a CxfPayload object, you can invoke the
CxfPayload.getHeaders() method that returns a List of DOM Elements (SOAP
headers).
-Since Camel 2.16.0, you can also use the same way as described in
+You can also use the same way as described in
sub-chapter "How to get and set SOAP headers in POJO mode" to set or get
the SOAP headers. So, you can use now the
header "org.apache.cxf.headers.Header.list" to get and set a list of
@@ -837,7 +831,7 @@ example in Payload Mode for enabling MTOM). However, SOAP with
Attachment is not tested. Since attachments are marshalled and
unmarshalled into POJOs, users typically do not need to deal with the
attachment themself. Attachments are propagated to Camel message's
-attachments if the MTOM is not enabled, since Camel 2.12.3. So, it is
+attachments if the MTOM is not enabled. So, it is
possible to retrieve attachments by Camel Message API
[source,java]
@@ -845,9 +839,9 @@ possible to retrieve attachments by Camel Message API
DataHandler Message.getAttachment(String id)
--------------------------------------------
-*Payload Mode:* MTOM is supported since Camel 2.1. Attachments can be
+*Payload Mode:* MTOM is supported by the component. Attachments can be
retrieved by Camel Message APIs mentioned above. SOAP with Attachment
-(SwA) is supported and attachments can be retrieved since Camel 2.5. SwA is
+(SwA) is supported and attachments can be retrieved. SwA is
the default (same as setting the CXF endpoint property "mtom-enabled" to
false).
@@ -873,11 +867,10 @@ for you.
### Streaming Support in PAYLOAD mode
-In Camel 2.8.2, the camel-cxf component now supports streaming of incoming
+The camel-cxf component now supports streaming of incoming
messages when using PAYLOAD mode. Previously, the incoming messages
would have been completely DOM parsed. For large messages, this is time
-consuming and uses a significant amount of memory. Starting in Camel 2.8.2,
-the incoming messages can remain as a javax.xml.transform.Source while
+consuming and uses a significant amount of memory. The incoming messages can remain as a javax.xml.transform.Source while
being routed and, if nothing modifies the payload, can then be directly
streamed out to the target destination. For common "simple proxy" use
cases (example: from("cxf:...").to("cxf:...")), this can provide very
@@ -905,7 +898,7 @@ will override this value for that endpoint.
### Using the generic CXF Dispatch mode
-From Camel 2.8.0, the camel-cxf component supports the generic
+The camel-cxf component supports the generic
https://cxf.apache.org/docs/jax-ws-dispatch-api.html[CXF dispatch
mode] that can transport messages of arbitrary structures (i.e., not
bound to a specific XML schema). To use this mode, you simply omit
diff --git a/components/camel-cxf/src/main/docs/cxfrs-component.adoc b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
index e464397..28ca7bf 100644
--- a/components/camel-cxf/src/main/docs/cxfrs-component.adoc
+++ b/components/camel-cxf/src/main/docs/cxfrs-component.adoc
@@ -3,7 +3,7 @@
*Available as of Camel version 2.0*
-The *cxfrs:* component provides integration with
+The CXFRS component provides integration with
http://cxf.apache.org[Apache CXF] for connecting to JAX-RS 1.1 and 2.0
services hosted in CXF.
@@ -382,11 +382,11 @@ the endpoint. Instead, it is the responsibility of the route to do all
processing.
====
-Note that starting from Camel 2.15 it is also sufficient to provide an
+It is sufficient to provide an
interface only as opposed to a no-op service implementation class for
the default mode.
-Starting from Camel 2.15, if a *performInvocation* option is enabled,
+If a *performInvocation* option is enabled,
the service implementation will be invoked first, the response will be
set on the Camel exchange and the route execution will continue as
usual. This can be useful for integrating the existing JAX-RS implementations into Camel routes and
@@ -495,7 +495,7 @@ Exchange exchange = template.send("direct://http", new Processor() {
}
});
----
-From Camel 2.1, we also support to specify the query parameters from
+We also support to specify the query parameters from
cxfrs URI for the CXFRS http centric client.
[source,java]
----