You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2016/08/24 11:29:02 UTC
[1/3] camel git commit: Added Tokenize Language to Gitbook
Repository: camel
Updated Branches:
refs/heads/master 4df92933a -> 90ece0cce
Added Tokenize Language to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/35ea8de9
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/35ea8de9
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/35ea8de9
Branch: refs/heads/master
Commit: 35ea8de982f2567bfe090596d25e42eb76d2bcb0
Parents: 4df9293
Author: Andrea Cosentino <an...@gmail.com>
Authored: Wed Aug 24 12:59:46 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Wed Aug 24 12:59:46 2016 +0200
----------------------------------------------------------------------
camel-core/src/main/docs/tokenize-language.adoc | 41 ++++++++++++++++++++
components/readme.adoc | 3 --
docs/user-manual/en/SUMMARY.md | 1 -
3 files changed, 41 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/35ea8de9/camel-core/src/main/docs/tokenize-language.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/tokenize-language.adoc b/camel-core/src/main/docs/tokenize-language.adoc
new file mode 100644
index 0000000..77087d4
--- /dev/null
+++ b/camel-core/src/main/docs/tokenize-language.adoc
@@ -0,0 +1,41 @@
+[[Tokenizer-Tokenizer]]
+Tokenizer
+~~~~~~~~~
+
+The tokenizer language is a built-in language in camel-core, which is
+most often used only with the link:splitter.html[Splitter] EIP to split
+a message using a token-based strategy. +
+The tokenizer language is intended to tokenize text documents using a
+specified delimiter pattern. It can also be used to tokenize XML
+documents with some limited capability. For a truly XML-aware
+tokenization, the use of the link:xmltokenizer.html[XMLTokenizer]
+language is recommended�as it offers a faster, more efficient
+tokenization specifically for XML documents.�For more details
+see�link:splitter.html[Splitter].
+
+[[Tokenize-Options]]
+Tokenize Options
+^^^^^^^^^^^^^^^^
+
+// language options: START
+The Tokenize language supports 10 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2,1m,1m,6",options="header"]
+|=======================================================================
+| Name | Default | Java Type | Description
+| token | | String | The (start) token to use as tokenizer for example \n for a new line token. You can use simple language as the token to support dynamic tokens.
+| endToken | | String | The end token to use as tokenizer if using start/end token pairs. You can use simple language as the token to support dynamic tokens.
+| inheritNamespaceTagName | | String | To inherit namespaces from a root/parent tag name when using XML You can use simple language as the tag name to support dynamic names.
+| headerName | | String | Name of header to tokenize instead of using the message body.
+| regex | false | Boolean | If the token is a regular expression pattern. The default value is false
+| xml | false | Boolean | Whether the input is XML messages. This option must be set to true if working with XML payloads.
+| includeTokens | false | Boolean | Whether to include the tokens in the parts when using pairs The default value is false
+| group | | Integer | To group N parts together for example to split big files into chunks of 1000 lines.
+| skipFirst | false | Boolean | To skip the very first element
+| trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks
+|=======================================================================
+{% endraw %}
+// language options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/35ea8de9/components/readme.adoc
----------------------------------------------------------------------
diff --git a/components/readme.adoc b/components/readme.adoc
index 6b5ec75..9f44564 100644
--- a/components/readme.adoc
+++ b/components/readme.adoc
@@ -108,9 +108,6 @@ Components
| link:camel-consul/src/main/docs/consul-component.adoc[Consul] (camel-consul) +
`consul://apiEndpoint` | Camel Consul support
-| link:camel-couchdb/src/main/docs/couchdb-component.adoc[CouchDB] (camel-couchdb) +
-`couchdb:protocol:hostname:port/database` | The couchdb component is used for integrate with CouchDB databases.
-
| link:camel-crypto/src/main/docs/crypto-component.adoc[Crypto (JCE)] (camel-crypto) +
`crypto:cryptoOperation:name` | The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE).
http://git-wip-us.apache.org/repos/asf/camel/blob/35ea8de9/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index b3eda45..29ff1db 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -158,7 +158,6 @@
* [CoAP](coap-component.adoc)
* [CometD](cometd-component.adoc)
* [Consul](consul-component.adoc)
- * [CouchDB](couchdb-component.adoc)
* [Crypto (JCE)](crypto-component.adoc)
* [CXF](cxf-component.adoc)
* [CXF-RS](cxfrs-component.adoc)
[3/3] camel git commit: Automatic docs generation for CouchDB
component
Posted by ac...@apache.org.
Automatic docs generation for CouchDB component
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/90ece0cc
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/90ece0cc
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/90ece0cc
Branch: refs/heads/master
Commit: 90ece0cce9ea63b99c228caca60841ab60dd63ad
Parents: a13f062
Author: Andrea Cosentino <an...@gmail.com>
Authored: Wed Aug 24 13:27:53 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Wed Aug 24 13:27:53 2016 +0200
----------------------------------------------------------------------
.../src/main/docs/couchdb-component.adoc | 39 +++++++++++++-------
components/readme.adoc | 3 ++
docs/user-manual/en/SUMMARY.md | 1 +
3 files changed, 30 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/90ece0cc/components/camel-couchdb/src/main/docs/couchdb-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
index 080f501..53e43a0 100644
--- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc
+++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc
@@ -49,22 +49,35 @@ is optional and if not specified then defaults to 5984.
Options
^^^^^^^
-[width="100%",cols="10%,10%,80%",options="header",]
-|=======================================================================
-|Property |Default |Description
-
-|`deletes` |`true` |document deletes are published as events
-
-|`updates` |`true` |document inserts/updates are published as events
+// component options: START
+The CouchDB component has no options.
+// component options: END
-|`heartbeat` |`30000` |how often to send an empty message to keep socket alive in millis
+// endpoint options: START
+The CouchDB component supports 15 endpoint options which are listed below:
-|`createDatabase` |`true` |create the database if it does not already exist
-
-|`username` |`null` |username in case of authenticated databases
-
-|`password` |`null` |password for authenticated databases
+{% raw %}
+[width="100%",cols="2,1,1m,1m,5",options="header"]
+|=======================================================================
+| Name | Group | Default | Java Type | Description
+| protocol | common | | String | *Required* The protocol to use for communicating with the database.
+| hostname | common | | String | *Required* Hostname of the running couchdb instance
+| port | common | 5984 | int | Port number for the running couchdb instance
+| database | common | | String | *Required* Name of the database to use
+| createDatabase | common | false | boolean | Creates the database if it does not already exist
+| deletes | common | true | boolean | Document deletes are published as events
+| heartbeat | common | 30000 | long | How often to send an empty message to keep socket alive in millis
+| password | common | | String | Password for authenticated databases
+| style | common | main_only | String | Specifies how many revisions are returned in the changes array. The default main_only will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.)
+| updates | common | true | boolean | Document inserts/updates are published as events
+| username | common | | String | Username in case of authenticated databases
+| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored.
+| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange
+| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).
|=======================================================================
+{% endraw %}
+// endpoint options: END
[[CouchDB-Headers]]
Headers
http://git-wip-us.apache.org/repos/asf/camel/blob/90ece0cc/components/readme.adoc
----------------------------------------------------------------------
diff --git a/components/readme.adoc b/components/readme.adoc
index 9f44564..6b5ec75 100644
--- a/components/readme.adoc
+++ b/components/readme.adoc
@@ -108,6 +108,9 @@ Components
| link:camel-consul/src/main/docs/consul-component.adoc[Consul] (camel-consul) +
`consul://apiEndpoint` | Camel Consul support
+| link:camel-couchdb/src/main/docs/couchdb-component.adoc[CouchDB] (camel-couchdb) +
+`couchdb:protocol:hostname:port/database` | The couchdb component is used for integrate with CouchDB databases.
+
| link:camel-crypto/src/main/docs/crypto-component.adoc[Crypto (JCE)] (camel-crypto) +
`crypto:cryptoOperation:name` | The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE).
http://git-wip-us.apache.org/repos/asf/camel/blob/90ece0cc/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index 29ff1db..b3eda45 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -158,6 +158,7 @@
* [CoAP](coap-component.adoc)
* [CometD](cometd-component.adoc)
* [Consul](consul-component.adoc)
+ * [CouchDB](couchdb-component.adoc)
* [Crypto (JCE)](crypto-component.adoc)
* [CXF](cxf-component.adoc)
* [CXF-RS](cxfrs-component.adoc)
[2/3] camel git commit: Added XMLTokenizer language to Gitbook
Posted by ac...@apache.org.
Added XMLTokenizer language to Gitbook
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/a13f062f
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/a13f062f
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/a13f062f
Branch: refs/heads/master
Commit: a13f062f8ff70de904ee2d89c67be109db213047
Parents: 35ea8de
Author: Andrea Cosentino <an...@gmail.com>
Authored: Wed Aug 24 13:04:42 2016 +0200
Committer: Andrea Cosentino <an...@gmail.com>
Committed: Wed Aug 24 13:04:42 2016 +0200
----------------------------------------------------------------------
.../src/main/docs/xtokenize-language.adoc | 34 ++++++++++++++++++++
1 file changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/a13f062f/camel-core/src/main/docs/xtokenize-language.adoc
----------------------------------------------------------------------
diff --git a/camel-core/src/main/docs/xtokenize-language.adoc b/camel-core/src/main/docs/xtokenize-language.adoc
new file mode 100644
index 0000000..2171407
--- /dev/null
+++ b/camel-core/src/main/docs/xtokenize-language.adoc
@@ -0,0 +1,34 @@
+[[XMLTokenizer-XMLTokenizer]]
+XMLTokenizer
+~~~~~~~~~~~~
+
+The xml tokenizer language is a built-in language in camel-core, which
+is a truly XML-aware tokenizer that can be used with the Splitter as the
+conventional link:tokenizer.html[Tokenizer] to efficiently and
+effectively tokenize XML documents. XMLTokenizer is capable of not only
+recognizing XML namespaces and hierarchical structures of the document
+but also more efficiently tokenizing XML documents than the conventional
+Tokenizer.�
+
+For more details see link:splitter.html[Splitter].
+
+[[XMLTokenizer-Options]]
+XML Tokenizer Options
+^^^^^^^^^^^^^^^^^^^^^
+
+// language options: START
+The XML Tokenize language supports 4 options which are listed below.
+
+
+
+{% raw %}
+[width="100%",cols="2,1m,1m,6",options="header"]
+|=======================================================================
+| Name | Default | Java Type | Description
+| headerName | | String | Name of header to tokenize instead of using the message body.
+| mode | | String | The extraction mode. The available extraction modes are: i - injecting the contextual namespace bindings into the extracted token (default) w - wrapping the extracted token in its ancestor context u - unwrapping the extracted token to its child content t - extracting the text content of the specified element
+| group | | Integer | To group N parts together
+| trim | true | Boolean | Whether to trim the value to remove leading and trailing whitespaces and line breaks
+|=======================================================================
+{% endraw %}
+// language options: END