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 6153504f45f3960188ae0680052cb1b867014de7
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Wed Aug 7 09:51:15 2019 +0200
Regen
---
.../camel-mail/src/main/docs/mail-component.adoc | 2 +-
.../modules/ROOT/pages/file-component.adoc | 3 +-
.../ROOT/pages/json-xstream-dataformat.adoc | 70 ++--------------------
.../modules/ROOT/pages/mail-component.adoc | 4 +-
.../modules/ROOT/pages/multicast-eip.adoc | 5 ++
.../modules/ROOT/pages/recipientList-eip.adoc | 25 ++------
docs/user-manual/modules/ROOT/pages/split-eip.adoc | 17 +++---
7 files changed, 26 insertions(+), 100 deletions(-)
diff --git a/components/camel-mail/src/main/docs/mail-component.adoc
b/components/camel-mail/src/main/docs/mail-component.adoc
index 946d9ff..9bbeac0 100644
--- a/components/camel-mail/src/main/docs/mail-component.adoc
+++ b/components/camel-mail/src/main/docs/mail-component.adoc
@@ -253,7 +253,7 @@ The component supports 49 options, which are listed below.
| *camel.component.mail.configuration.port* | The port number of the mail
server | | Integer
| *camel.component.mail.configuration.protocol* | The protocol for
communicating with the mail server | | String
| *camel.component.mail.configuration.reply-to* | The Reply-To recipients (the
receivers of the response mail). Separate multiple email addresses with a
comma. | | String
-| *camel.component.mail.configuration.session* | Specifies the mail session
that camel should use for all mail interactions. Useful in scenarios where mail
sessions are created and managed by some other resource, such as a JavaEE
container. If this is not specified, Camel automatically creates the mail
session for you. | | Session
+| *camel.component.mail.configuration.session* | Specifies the mail session
that camel should use for all mail interactions. Useful in scenarios where mail
sessions are created and managed by some other resource, such as a JavaEE
container. When using a custom mail session, then the hostname and port from
the mail session will be used (if configured on the session). | | Session
| *camel.component.mail.configuration.skip-failed-message* | If the mail
consumer cannot retrieve a given mail message, then this option allows to skip
the message and move on to retrieve the next mail message. <p/> The default
behavior would be the consumer throws an exception and no mails from the batch
would be able to be routed by Camel. | false | Boolean
| *camel.component.mail.configuration.ssl-context-parameters* | To configure
security using SSLContextParameters. | | SSLContextParameters
| *camel.component.mail.configuration.subject* | The Subject of the message
being sent. Note: Setting the subject in the header takes precedence over this
option. | | String
diff --git a/docs/components/modules/ROOT/pages/file-component.adoc
b/docs/components/modules/ROOT/pages/file-component.adoc
index d6536e6..56962cc 100644
--- a/docs/components/modules/ROOT/pages/file-component.adoc
+++ b/docs/components/modules/ROOT/pages/file-component.adoc
@@ -114,8 +114,7 @@ with the following path and query parameters:
| *processStrategy* (consumer) | A pluggable
org.apache.camel.component.file.GenericFileProcessStrategy allowing you to
implement your own readLock option or similar. Can also be used when special
conditions must be met before a file can be consumed, such as a special ready
file exists. If this option is set then the readLock option does not apply. |
| GenericFileProcess Strategy
| *startingDirectoryMustExist* (consumer) | Whether the starting directory
must exist. Mind that the autoCreate option is default enabled, which means the
starting directory is normally auto created if it doesn't exist. You can
disable autoCreate and enable this to ensure the starting directory must exist.
Will thrown an exception if the directory doesn't exist. | false | boolean
| *startingDirectoryMustHave Access* (consumer) | Whether the starting
directory has access permissions. Mind that the startingDirectoryMustExist
parameter must be set to true in order to verify that the directory exists.
Will thrown an exception if the directory doesn't have read and write
permissions. | false | boolean
-| *appendChars* (producer) | Used to append characters (text) after writing
files. This can for example be used to add new lines or other separators when
writing and appending to existing files. To specify new-line (
- or
) or tab ( ) characters then escape with an extra slash, eg \n | | String
+| *appendChars* (producer) | Used to append characters (text) after writing
files. This can for example be used to add new lines or other separators when
writing and appending to existing files. To specify new-line (slash-n or
slash-r) or tab (slash-t) characters then escape with an extra slash, eg
slash-slash-n | | String
| *fileExist* (producer) | What to do if a file already exists with the same
name. Override, which is the default, replaces the existing file. Append - adds
content to the existing file. Fail - throws a GenericFileOperationException,
indicating that there is already an existing file. Ignore - silently ignores
the problem and does not override the existing file, but assumes everything is
okay. Move - option requires to use the moveExisting option to be configured as
well. The option eager [...]
| *flatten* (producer) | Flatten is used to flatten the file name path to
strip any leading paths, so it's just the file name. This allows you to consume
recursively into sub-directories, but when you eg write the files to another
directory they will be written in a single directory. Setting this to true on
the producer enforces that any file name in CamelFileName header will be
stripped for any leading paths. | false | boolean
| *jailStartingDirectory* (producer) | Used for jailing (restricting) writing
files to the starting directory (and sub) only. This is enabled by default to
not allow Camel to write files to outside directories (to be more secured out
of the box). You can turn this off to allow writing files to directories
outside the starting directory, such as parent or root folders. | true | boolean
diff --git a/docs/components/modules/ROOT/pages/json-xstream-dataformat.adoc
b/docs/components/modules/ROOT/pages/json-xstream-dataformat.adoc
index ccc9a20..287be2e 100644
--- a/docs/components/modules/ROOT/pages/json-xstream-dataformat.adoc
+++ b/docs/components/modules/ROOT/pages/json-xstream-dataformat.adoc
@@ -5,7 +5,9 @@
XStream is a Data Format which uses the
http://xstream.codehaus.org/[XStream library] to marshal and unmarshal
-Java objects to and from XML.
+Java objects to and from JSon. However XStream was created primary for working
+with XML and therefore using JSon with XStream is not as popular as for example
+Jackson is for JSon.
To use XStream in your camel routes you need to add the a dependency
on *camel-xstream* which implements this data format.
@@ -62,7 +64,7 @@ The JSon XStream dataformat supports 19 options, which are
listed below.
-----------------------------------------------------------
// lets turn Object messages into XML then send to MQSeries
from("activemq:My.Queue").
- marshal().xstream().
+ marshal().json(JsonLibrary.XStream).
to("mqseries:Another.Queue");
-----------------------------------------------------------
@@ -83,67 +85,3 @@ from("direct:marshal").
to("mock:marshaled");
---------------------------------------------------------
-== XMLInputFactory and XMLOutputFactory
-
-http://xstream.codehaus.org/[The XStream library] uses the
-`javax.xml.stream.XMLInputFactory` and
-`javax.xml.stream.XMLOutputFactory`, you can control which
-implementation of this factory should be used.
-
-The Factory is discovered using this algorithm:
- 1. Use the `javax.xml.stream.XMLInputFactory` ,
-`javax.xml.stream.XMLOutputFactory` system property.
- 2. Use the `lib/xml.stream.properties` file in the `JRE_HOME`
-directory.
- 3. Use the Services API, if available, to determine the classname by
-looking in the `META-INF/services/javax.xml.stream.XMLInputFactory`,
-`META-INF/services/javax.xml.stream.XMLOutputFactory` files in jars
-available to the JRE.
- 4. Use the platform default XMLInputFactory,XMLOutputFactory instance.
-
-== How to set the XML encoding in Xstream DataFormat?
-
-You can set the encoding of XML in Xstream DataFormat
-by setting the Exchange's property with the key `Exchange.CHARSET_NAME`,
-or setting the encoding property on Xstream from DSL or Spring config.
-
-[source,java]
--------------------------------
-from("activemq:My.Queue").
- marshal().xstream("UTF-8").
- to("mqseries:Another.Queue");
--------------------------------
-
-== Setting the type permissions of Xstream DataFormat
-
-In Camel, one can always use its own processing step in the route to
-filter and block certain XML documents to be routed to the XStream's
-unmarhall step. You can set http://x-stream.github.io/security.html[XStream's
type
-permissions] to automatically allow or deny the instantiation of certain
-types.
-
-The default type permissions setting used by Camel denies all types
-except for those from java.lang and java.util packages. This setting can
-be changed by setting System property
-org.apache.camel.xstream.permissions. Its value is a string of
-comma-separated permission terms, each representing a type being allowed
-or denied, depending on whether the term is prefixed with '+' (note '+'
-may be omitted) or with '-', respectively.
-
-Each term may contain a wildcard character '*'. For example, value
-"-*,java.lang.*,java.util.*" indicates denying all types except for
-java.lang.* and java.util.* classes. Setting this value to an empty
-string "" reverts to the default XStream's type permissions handling
-which denies certain blacklisted classes and allow others.
-
-The type permissions setting can be extended at an individual XStream
-DataFormat instance by setting its type permissions property.
-
-[source,java]
--------------------------------------------------------------------
- <dataFormats>
- <xstream id="xstream-default"
- permissions="org.apache.camel.samples.xstream.*"/>
- ...
-
--------------------------------------------------------------------
diff --git a/docs/components/modules/ROOT/pages/mail-component.adoc
b/docs/components/modules/ROOT/pages/mail-component.adoc
index 1fe6255..9bbeac0 100644
--- a/docs/components/modules/ROOT/pages/mail-component.adoc
+++ b/docs/components/modules/ROOT/pages/mail-component.adoc
@@ -176,7 +176,7 @@ with the following path and query parameters:
| *headerFilterStrategy* (advanced) | To use a custom
org.apache.camel.spi.HeaderFilterStrategy to filter headers. | |
HeaderFilterStrategy
| *ignoreUnsupportedCharset* (advanced) | Option to let Camel ignore
unsupported charset in the local JVM when sending mails. If the charset is
unsupported then charset=XXX (where XXX represents the unsupported charset) is
removed from the content-type and it relies on the platform default instead. |
false | boolean
| *ignoreUriScheme* (advanced) | Option to let Camel ignore unsupported
charset in the local JVM when sending mails. If the charset is unsupported then
charset=XXX (where XXX represents the unsupported charset) is removed from the
content-type and it relies on the platform default instead. | false | boolean
-| *session* (advanced) | Specifies the mail session that camel should use for
all mail interactions. Useful in scenarios where mail sessions are created and
managed by some other resource, such as a JavaEE container. If this is not
specified, Camel automatically creates the mail session for you. | | Session
+| *session* (advanced) | Specifies the mail session that camel should use for
all mail interactions. Useful in scenarios where mail sessions are created and
managed by some other resource, such as a JavaEE container. When using a custom
mail session, then the hostname and port from the mail session will be used (if
configured on the session). | | Session
| *synchronous* (advanced) | Sets whether synchronous processing should be
strictly used, or Camel is allowed to use asynchronous processing (if
supported). | false | boolean
| *useInlineAttachments* (advanced) | Whether to use disposition inline or
attachment. | false | boolean
| *idempotentRepository* (filter) | A pluggable repository
org.apache.camel.spi.IdempotentRepository which allows to cluster consuming
from the same mailbox, and let the repository coordinate whether a mail message
is valid for the consumer to process. By default no repository is in use. | |
IdempotentRepository
@@ -253,7 +253,7 @@ The component supports 49 options, which are listed below.
| *camel.component.mail.configuration.port* | The port number of the mail
server | | Integer
| *camel.component.mail.configuration.protocol* | The protocol for
communicating with the mail server | | String
| *camel.component.mail.configuration.reply-to* | The Reply-To recipients (the
receivers of the response mail). Separate multiple email addresses with a
comma. | | String
-| *camel.component.mail.configuration.session* | Specifies the mail session
that camel should use for all mail interactions. Useful in scenarios where mail
sessions are created and managed by some other resource, such as a JavaEE
container. If this is not specified, Camel automatically creates the mail
session for you. | | Session
+| *camel.component.mail.configuration.session* | Specifies the mail session
that camel should use for all mail interactions. Useful in scenarios where mail
sessions are created and managed by some other resource, such as a JavaEE
container. When using a custom mail session, then the hostname and port from
the mail session will be used (if configured on the session). | | Session
| *camel.component.mail.configuration.skip-failed-message* | If the mail
consumer cannot retrieve a given mail message, then this option allows to skip
the message and move on to retrieve the next mail message. <p/> The default
behavior would be the consumer throws an exception and no mails from the batch
would be able to be routed by Camel. | false | Boolean
| *camel.component.mail.configuration.ssl-context-parameters* | To configure
security using SSLContextParameters. | | SSLContextParameters
| *camel.component.mail.configuration.subject* | The Subject of the message
being sent. Note: Setting the subject in the header takes precedence over this
option. | | String
diff --git a/docs/user-manual/modules/ROOT/pages/multicast-eip.adoc
b/docs/user-manual/modules/ROOT/pages/multicast-eip.adoc
index d08b278..2d699e7 100644
--- a/docs/user-manual/modules/ROOT/pages/multicast-eip.adoc
+++ b/docs/user-manual/modules/ROOT/pages/multicast-eip.adoc
@@ -59,6 +59,11 @@ from("direct:start")
.to("mock:result");
----
+NOTE: The Multicast, Recipient List, and Splitter EIPs have special support
for using `AggregationStrategy` with
+access to the original input exchange. You may want to use this when you
aggregate messages and
+there has been a failure in one of the messages, which you then want to enrich
on the original
+input message and return as response; its the aggregate method with 3 exchange
parameters.
+
== Stop processing in case of exception
The mutlicast EIP will by default continue to process
diff --git a/docs/user-manual/modules/ROOT/pages/recipientList-eip.adoc
b/docs/user-manual/modules/ROOT/pages/recipientList-eip.adoc
index 19203fe..da32e34 100644
--- a/docs/user-manual/modules/ROOT/pages/recipientList-eip.adoc
+++ b/docs/user-manual/modules/ROOT/pages/recipientList-eip.adoc
@@ -211,8 +211,12 @@ And in XML it is again an attribute on the recipient list
tag.
<bean id="myStrategy" class="com.mycompany.MyOwnAggregationStrategy"/>
----
+NOTE: The Multicast, Recipient List, and Splitter EIPs have special support
for using `AggregationStrategy` with
+access to the original input exchange. You may want to use this when you
aggregate messages and
+there has been a failure in one of the messages, which you then want to enrich
on the original
+input message and return as response; its the aggregate method with 3 exchange
parameters.
+
== Knowing which endpoint when using custom AggregationStrategy
-*Available as of Camel 2.12*
When using a custom `AggregationStrategy` then the `aggregate` method is
always invoked in sequential order
(also if parallel processing is enabled) of the endpoints the Recipient List
is using.
@@ -315,23 +319,7 @@ from("direct:c").to("mock:C").setBody(constant("C"));
This timeout feature is also supported by Splitter and both multicast and
recipientList.
===
-By default if a timeout occurs the `AggregationStrategy` is not invoked.
However you can implement a special version `TimeoutAwareAggregationStrategy`
-
-[source,java]
-----
-public interface TimeoutAwareAggregationStrategy extends AggregationStrategy {
-
- /**
- * A timeout occurred
- *
- * @param oldExchange the oldest exchange (is <tt>null</tt> on first
aggregation as we only have the new exchange)
- * @param index the index
- * @param total the total
- * @param timeout the timeout value in millis
- */
- void timeout(Exchange oldExchange, int index, int total, long timeout);
-----
-
+By default if a timeout occurs the `AggregationStrategy` is not invoked.
However you can implement the `timeout` method:
This allows you to deal with the timeout in the `AggregationStrategy` if you
really need to.
[NOTE]
@@ -345,7 +333,6 @@ The remainders will be cancelled. Camel will also only
invoke the `timeout` meth
See details at the Multicast EIP
== Using ExchangePattern in recipients
-*Available as of Camel 2.15*
The recipient list will by default use the current Exchange Pattern. Though
one can imagine use-cases where one wants to send
a message to a recipient using a different exchange pattern. For example you
may have a route that initiates as an `InOnly` route,
diff --git a/docs/user-manual/modules/ROOT/pages/split-eip.adoc
b/docs/user-manual/modules/ROOT/pages/split-eip.adoc
index 6109aef..f2ea37b 100644
--- a/docs/user-manual/modules/ROOT/pages/split-eip.adoc
+++ b/docs/user-manual/modules/ROOT/pages/split-eip.adoc
@@ -136,6 +136,12 @@ There is a sample on this page (Split aggregate
request/reply sample).
Notice its the same strategy as the Aggregate EIP supports.
This Splitter can be viewed as having a build in light weight Aggregate EIP.
+NOTE: The Multicast, Recipient List, and Splitter EIPs have special support
for using `AggregationStrategy` with
+access to the original input exchange. You may want to use this when you
aggregate messages and
+there has been a failure in one of the messages, which you then want to enrich
on the original
+input message and return as response; its the aggregate method with 3 exchange
parameters.
+
+
== Parallel execution of distinct parts
If you want to execute all parts in parallel you can use the
`parallelProcessing` option as show:
@@ -183,8 +189,6 @@ from("direct:streaming")
There are two tokenizers that can be used to tokenize an XML payload. The
first tokenizer uses the same principle as in the text tokenizer to scan the
XML payload and extract a sequence of tokens.
-*Available as of Camel 2.9*
-
If you have a big XML payload, from a file source, and want to split it in
streaming mode, then you can use the Tokenizer language with start/end tokens
to do this with low memory footprint.
[NOTE]
@@ -258,14 +262,10 @@ from("file:inbox")
.to("activemq:queue:order");
----
-Available as of Camel 2.13.1, you can set the above `inheritNamsepaceTagName`
property to `*` to include the preceding context in each token (i.e.,
generating each token enclosed in its ancestor elements). It is noted that each
token must share the same ancestor elements in this case.
-
+You can set the above `inheritNamsepaceTagName` property to `*` to include the
preceding context in each token (i.e., generating each token enclosed in its
ancestor elements). It is noted that each token must share the same ancestor
elements in this case.
The above tokenizer works well on simple structures but has some inherent
limitations in handling more complex XML structures.
-*Available as of Camel 2.14*
-
The second tokenizer uses a StAX parser to overcome these limitations. This
tokenizer recognizes XML namespaces and also handles simple and complex XML
structures more naturally and efficiently.
-
To split using this tokenizer at {urn:shop}order, we can write
[source,java]
@@ -344,7 +344,6 @@ it results in invalid xml snippets after the split. For
example the snippet coul
----
== Splitting files by grouping N lines together
-*Available as of Camel 2.10*
The Tokenizer language has a new option group that allows you to group N parts
together, for example to split big files into chunks of 1000 lines.
@@ -610,12 +609,10 @@ And using XML DSL you specify it as follows:
----
== Using onPrepare to execute custom logic when preparing messages
-*Available as of Camel 2.8*
See details at Multicast EIP
== Sharing unit of work
-*Available as of Camel 2.8*
The Splitter will by default not share unit of work between the parent
exchange and each split exchange.
This means each sub exchange has its own individual unit of work.
