[2/2] camel git commit: Component docs as valid ascii doc. This closes #2004
Component docs as valid ascii doc. This closes #2004 Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f4e3ec1a Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f4e3ec1a Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f4e3ec1a Branch: refs/heads/master Commit: f4e3ec1ac4fbec6eec308d41d48ed37f1297a027 Parents: 2c1c1b6 Author: Claus IbsenAuthored: Sat Oct 7 11:11:51 2017 +0200 Committer: Claus Ibsen Committed: Sat Oct 7 11:12:14 2017 +0200 -- .../src/main/docs/dropbox-component.adoc| 174 ++- 1 file changed, 95 insertions(+), 79 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/f4e3ec1a/components/camel-dropbox/src/main/docs/dropbox-component.adoc -- diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc index 0e8db8a..beae12f 100644 --- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc +++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc @@ -26,17 +26,17 @@ for this component: -### URI format +=== URI format -[source,java] +[source] + dropbox://[operation]?[options] + Where *operation* is the specific action (typically is a CRUD action) to perform on Dropbox remote folder. -### Operations +=== Operations [width="100%",cols="40%,60%",options="header",] |=== @@ -56,7 +56,7 @@ perform on Dropbox remote folder. *Operations* require additional options to work, some are mandatory for the specific operation. -### Options +=== Options In order to work with Dropbox API you need to obtain an *accessToken* and a *clientIdentifier.* + @@ -105,7 +105,7 @@ with the following path and query parameters: |=== // endpoint options: END -### Del operation +=== Del operation Delete files on Dropbox. @@ -114,44 +114,48 @@ Works only as Camel producer. Below are listed the options for this operation: [width="100%",cols="20%,20%,60%",options="header",] -|=== +|=== |Property |Mandatory |Description |`remotePath` |`true` |Folder or file to delete on Dropbox -|=== +|=== - Samples + Samples [source,java] -from("direct:start").to("dropbox://del?accessToken=XXX=XXX=/root/folder1").to("mock:result"); + +from("direct:start") + .to("dropbox://del?accessToken=XXX=XXX=/root/folder1") + .to("mock:result"); -from("direct:start").to("dropbox://del?accessToken=XXX=XXX=/root/folder1/file1.tar.gz").to("mock:result"); +from("direct:start") + .to("dropbox://del?accessToken=XXX=XXX=/root/folder1/file1.tar.gz") + .to("mock:result"); + - Result Message Headers + Result Message Headers The following headers are set on message result: [width="100%",cols="50%,50%",options="header",] -|=== +|=== |Property |Value |`DELETED_PATH` |name of the path deleted on dropbox -|=== +|=== - Result Message Body + Result Message Body The following objects are set on message body result: [width="100%",cols="50%,50%",options="header",] -|=== +|=== |Object type |Description |`String` |name of the path deleted on dropbox -|=== +|=== -### Get (download) operation +=== Get (download) operation Download files from Dropbox. @@ -160,42 +164,47 @@ Works as Camel producer or Camel consumer. Below are listed the options for this operation: [width="100%",cols="20%,20%,60%",options="header",] -|=== +|=== |Property |Mandatory |Description |`remotePath` |`true` |Folder or file to download from Dropbox -|=== +|=== - Samples + Samples [source,java] -from("direct:start").to("dropbox://get?accessToken=XXX=XXX=/root/folder1/file1.tar.gz").to("file:///home/kermit/?fileName=file1.tar.gz"); + +from("direct:start") + .to("dropbox://get?accessToken=XXX=XXX=/root/folder1/file1.tar.gz") +
camel git commit: Component docs - We now have docs for those
Repository: camel Updated Branches: refs/heads/master 97c55d46f -> fec4e1bdc Component docs - We now have docs for those Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/fec4e1bd Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fec4e1bd Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fec4e1bd Branch: refs/heads/master Commit: fec4e1bdcb2b1ccb1e0eef3e435ab03ee40d2a59 Parents: 97c55d4 Author: Claus IbsenAuthored: Thu Apr 13 14:03:54 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 14:03:54 2017 +0200 -- .../org/apache/camel/maven/packaging/PrepareCatalogMojo.java | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/fec4e1bd/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java index 34f73a8..39df2e2 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/PrepareCatalogMojo.java @@ -57,9 +57,7 @@ public class PrepareCatalogMojo extends AbstractMojo { private static final String[] EXCLUDE_DOC_FILES = { "camel-core-osgi", "camel-core-xml", -"camel-spring-dm", -"camel-http-common", "camel-jetty", "camel-jetty-common", "camel-jetty8", -"camel-test-karaf", "camel-test-spring", "camel-testng", "camel-test-spring3", "camel-test-spring40", "camel-zipkin-starter" +"camel-http-common", "camel-jetty", "camel-jetty-common" }; private static final Pattern LABEL_PATTERN = Pattern.compile("\\\"label\\\":\\s\\\"([\\w,]+)\\\"");
camel git commit: Component docs
Repository: camel Updated Branches: refs/heads/master 8075724b7 -> 97c55d46f Component docs Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/97c55d46 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/97c55d46 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/97c55d46 Branch: refs/heads/master Commit: 97c55d46ffdeeaa5a0ad990e3e2c4e455d43ee03 Parents: 8075724 Author: Claus IbsenAuthored: Thu Apr 13 13:38:34 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 13:38:41 2017 +0200 -- components/camel-bonita/src/main/docs/bonita-component.adoc| 2 +- .../java/org/apache/camel/component/bonita/BonitaEndpoint.java | 3 +++ .../java/org/apache/camel/component/pubnub/PubNubEndpoint.java | 3 +++ components/camel-zendesk/src/main/docs/zendesk-component.adoc | 2 +- .../org/apache/camel/component/zendesk/ZendeskEndpoint.java| 2 +- components/readme.adoc | 6 +++--- .../zendesk/springboot/ZendeskComponentConfiguration.java | 2 +- 7 files changed, 13 insertions(+), 7 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/97c55d46/components/camel-bonita/src/main/docs/bonita-component.adoc -- diff --git a/components/camel-bonita/src/main/docs/bonita-component.adoc b/components/camel-bonita/src/main/docs/bonita-component.adoc index 5443f2c..f2905d1 100644 --- a/components/camel-bonita/src/main/docs/bonita-component.adoc +++ b/components/camel-bonita/src/main/docs/bonita-component.adoc @@ -2,7 +2,7 @@ *Available as of Camel version 2.19* -This Camel component allow you to communicate with a remote Bonita engine. +Used for communicating with a remote Bonita BPM process engine. ### URI format http://git-wip-us.apache.org/repos/asf/camel/blob/97c55d46/components/camel-bonita/src/main/java/org/apache/camel/component/bonita/BonitaEndpoint.java -- diff --git a/components/camel-bonita/src/main/java/org/apache/camel/component/bonita/BonitaEndpoint.java b/components/camel-bonita/src/main/java/org/apache/camel/component/bonita/BonitaEndpoint.java index 1c2637d..e2d26f8 100644 --- a/components/camel-bonita/src/main/java/org/apache/camel/component/bonita/BonitaEndpoint.java +++ b/components/camel-bonita/src/main/java/org/apache/camel/component/bonita/BonitaEndpoint.java @@ -26,6 +26,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * Used for communicating with a remote Bonita BPM process engine. + */ @UriEndpoint(firstVersion = "2.19.0", scheme = "bonita", title = "Bonita", syntax = "bonita:operation", consumerOnly = true, label = "process") public class BonitaEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/97c55d46/components/camel-pubnub/src/main/java/org/apache/camel/component/pubnub/PubNubEndpoint.java -- diff --git a/components/camel-pubnub/src/main/java/org/apache/camel/component/pubnub/PubNubEndpoint.java b/components/camel-pubnub/src/main/java/org/apache/camel/component/pubnub/PubNubEndpoint.java index 70e5f5b..2540f8e 100644 --- a/components/camel-pubnub/src/main/java/org/apache/camel/component/pubnub/PubNubEndpoint.java +++ b/components/camel-pubnub/src/main/java/org/apache/camel/component/pubnub/PubNubEndpoint.java @@ -27,6 +27,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.util.ObjectHelper; +/** + * To send and receive messages to PubNub data stream network for connected devices. + */ @UriEndpoint(firstVersion = "2.19.0", scheme = "pubnub", title = "PubNub", syntax = "pubnub:channel", consumerClass = PubNubConsumer.class, label = "cloud,iot,messaging") public class PubNubEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/97c55d46/components/camel-zendesk/src/main/docs/zendesk-component.adoc -- diff --git a/components/camel-zendesk/src/main/docs/zendesk-component.adoc b/components/camel-zendesk/src/main/docs/zendesk-component.adoc index d60e0d7..6c135bc 100644 --- a/components/camel-zendesk/src/main/docs/zendesk-component.adoc +++ b/components/camel-zendesk/src/main/docs/zendesk-component.adoc @@ -4,7 +4,7 @@ The Zendesk component provides access to all of the zendesk.com APIs accessible using https://github.com/cloudbees/zendesk-java-client[zendesk-java-client]. It -allows producing messages to manage Zendesk ticket, user, organization and etc.
[2/2] camel git commit: Component docs
Component docs Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6063f395 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6063f395 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6063f395 Branch: refs/heads/master Commit: 6063f395e75d6a2128135f2182c149702593eed0 Parents: e692350 Author: Claus IbsenAuthored: Thu Apr 13 11:22:36 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 11:22:36 2017 +0200 -- components/camel-rx/src/main/docs/rx.adoc | 7 +-- components/camel-scr/src/main/docs/scr.adoc | 5 ++--- 2 files changed, 7 insertions(+), 5 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/6063f395/components/camel-rx/src/main/docs/rx.adoc -- diff --git a/components/camel-rx/src/main/docs/rx.adoc b/components/camel-rx/src/main/docs/rx.adoc index 6c37663..2235f61 100644 --- a/components/camel-rx/src/main/docs/rx.adoc +++ b/components/camel-rx/src/main/docs/rx.adoc @@ -1,10 +1,13 @@ [[ConfluenceContent]] [[RX-CamelRX]] -Camel RX - +Camel RX (deprecated) +- *Available as of Camel 2.11* +This component is deprecated. +We suggest to use the newer `camel-reactive-streams` component. + The camel-rx library provides Camel support for the https://rx.codeplex.com/[Reactive Extensions]Â (RX) using the https://github.com/Netflix/RxJava/wiki[RxJava] library so that: http://git-wip-us.apache.org/repos/asf/camel/blob/6063f395/components/camel-scr/src/main/docs/scr.adoc -- diff --git a/components/camel-scr/src/main/docs/scr.adoc b/components/camel-scr/src/main/docs/scr.adoc index 451af6a..3adca16 100644 --- a/components/camel-scr/src/main/docs/scr.adoc +++ b/components/camel-scr/src/main/docs/scr.adoc @@ -1,6 +1,6 @@ -## Working with Camel and SCR +## Camel SCR (deprecated) -**deprecated** +*Available as of Camel 2.15* SCR stands for Service Component Runtime and is an implementation of OSGi Declarative Services specification. SCR enables any plain old Java @@ -19,7 +19,6 @@ of choice knows exactly what is going on in your project. ### Camel SCR support -INFO: *Available as of Camel 2.15.0*. Camel-scr bundle is not included in Apache Camel versions prior 2.15.0, but the artifact itself can be used with any Camel version since 2.12.0.
[1/2] camel git commit: Component docs
Repository: camel Updated Branches: refs/heads/master be222a503 -> 6063f395e Component docs Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/e6923508 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e6923508 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e6923508 Branch: refs/heads/master Commit: e6923508addf4eb79caffc4a58ef92571ef406db Parents: be222a5 Author: Claus IbsenAuthored: Thu Apr 13 11:17:04 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 11:17:04 2017 +0200 -- components/camel-kura/src/main/docs/kura.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/e6923508/components/camel-kura/src/main/docs/kura.adoc -- diff --git a/components/camel-kura/src/main/docs/kura.adoc b/components/camel-kura/src/main/docs/kura.adoc index f8cf9ad..1bf7973 100644 --- a/components/camel-kura/src/main/docs/kura.adoc +++ b/components/camel-kura/src/main/docs/kura.adoc @@ -2,7 +2,7 @@ Eclipse Kura component ~~ -INFO: Kura component is available starting from Camel *2.15*. +*Available as of Camel 2.15* This documentation page covers the integration options of Camel with the https://eclipse.org/kura/[Eclipse Kura] M2M gateway. The common reason
camel git commit: Component docs
Repository: camel Updated Branches: refs/heads/master 69df7d388 -> be222a503 Component docs Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/be222a50 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/be222a50 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/be222a50 Branch: refs/heads/master Commit: be222a503131e06bd1a605d9a7b75b72a1de3b27 Parents: 69df7d3 Author: Claus IbsenAuthored: Thu Apr 13 11:14:53 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 11:14:53 2017 +0200 -- components/camel-spring-dm/src/main/docs/spring-dm.adoc | 4 +--- components/camel-test-karaf/src/main/docs/test-karaf.adoc | 10 ++ .../camel-test-spring/src/main/docs/test-spring.adoc | 8 components/camel-testng/src/main/docs/testng.adoc | 7 +++ 4 files changed, 26 insertions(+), 3 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/be222a50/components/camel-spring-dm/src/main/docs/spring-dm.adoc -- diff --git a/components/camel-spring-dm/src/main/docs/spring-dm.adoc b/components/camel-spring-dm/src/main/docs/spring-dm.adoc index d949b42..0144664 100644 --- a/components/camel-spring-dm/src/main/docs/spring-dm.adoc +++ b/components/camel-spring-dm/src/main/docs/spring-dm.adoc @@ -1,6 +1,4 @@ -## Spring DM - -*deprecated* +## Spring DM (deprecated) Spring Dynamic Modules for OSGi allows to use Spring XML files in OSGi containers such as Apache Karaf. http://git-wip-us.apache.org/repos/asf/camel/blob/be222a50/components/camel-test-karaf/src/main/docs/test-karaf.adoc -- diff --git a/components/camel-test-karaf/src/main/docs/test-karaf.adoc b/components/camel-test-karaf/src/main/docs/test-karaf.adoc new file mode 100644 index 000..fcb5ec7 --- /dev/null +++ b/components/camel-test-karaf/src/main/docs/test-karaf.adoc @@ -0,0 +1,10 @@ +## Test Karaf + +*Available since Camel 2.18* + +Camel testing using Apache Karaf with Pax-Exam. + +This component allows to perform integration testing by running Karaf containers using Pax-Exam. + +The component is in development and needs some more polish to be ready. +In addition there is also need for documentation. http://git-wip-us.apache.org/repos/asf/camel/blob/be222a50/components/camel-test-spring/src/main/docs/test-spring.adoc -- diff --git a/components/camel-test-spring/src/main/docs/test-spring.adoc b/components/camel-test-spring/src/main/docs/test-spring.adoc new file mode 100644 index 000..daf59bf --- /dev/null +++ b/components/camel-test-spring/src/main/docs/test-spring.adoc @@ -0,0 +1,8 @@ +## Test Spring + +*Available since 2.10* + +Allows to test Camel with Spring applications such as Spring XML files or Spring-Boot. + +The documentation needs to be updated but you can look at the old online documentation at: + http://camel.apache.org/spring-testing.html[http://camel.apache.org/spring-testing.html] \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/be222a50/components/camel-testng/src/main/docs/testng.adoc -- diff --git a/components/camel-testng/src/main/docs/testng.adoc b/components/camel-testng/src/main/docs/testng.adoc new file mode 100644 index 000..607061d --- /dev/null +++ b/components/camel-testng/src/main/docs/testng.adoc @@ -0,0 +1,7 @@ +## TestNG (deprecated) + +*Available since Camel 2.8* + +Camel testing using TestNG. + +This component has been deprecated and we recommend using `camel-test` instead which is using JUnit.
camel git commit: Component docs
Repository: camel Updated Branches: refs/heads/master 81f7515e5 -> 69df7d388 Component docs Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/69df7d38 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/69df7d38 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/69df7d38 Branch: refs/heads/master Commit: 69df7d388b2c32482c32b4271e4b7e2a4ac6f2ac Parents: 81f7515 Author: Claus IbsenAuthored: Thu Apr 13 11:00:46 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 11:00:46 2017 +0200 -- components/camel-spring-dm/src/main/docs/spring-dm.adoc | 8 1 file changed, 8 insertions(+) -- http://git-wip-us.apache.org/repos/asf/camel/blob/69df7d38/components/camel-spring-dm/src/main/docs/spring-dm.adoc -- diff --git a/components/camel-spring-dm/src/main/docs/spring-dm.adoc b/components/camel-spring-dm/src/main/docs/spring-dm.adoc new file mode 100644 index 000..d949b42 --- /dev/null +++ b/components/camel-spring-dm/src/main/docs/spring-dm.adoc @@ -0,0 +1,8 @@ +## Spring DM + +*deprecated* + +Spring Dynamic Modules for OSGi allows to use Spring XML files in OSGi containers such as Apache Karaf. + +However Spring DM is EOL and its highly recommended not to use. +Use OSGi Blueprint instead which you can find in the `camel-blueprint` component.
[1/2] camel git commit: Component docs for scala
Repository: camel Updated Branches: refs/heads/master 578ae7e9b -> 81f7515e5 Component docs for scala Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/26f1e959 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/26f1e959 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/26f1e959 Branch: refs/heads/master Commit: 26f1e959d4f87257763703ff3a4f8b7f75897ceb Parents: 578ae7e Author: Claus IbsenAuthored: Thu Apr 13 10:53:07 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 10:53:17 2017 +0200 -- .../apache/camel/model/ProcessDefinition.java | 2 +- .../model/cloud/ServiceCallDefinition.java | 2 +- .../src/main/docs/scala-dsl-eip.adoc| 224 --- .../main/docs/scala-dsl-getting-started.adoc| 59 - .../docs/scala-dsl-supported-languages.adoc | 30 --- .../camel-scala/src/main/docs/scala-dsl.adoc| 76 --- .../camel-scala/src/main/docs/scala-eip.adoc| 224 +++ .../src/main/docs/scala-getting-started.adoc| 59 + .../main/docs/scala-supported-languages.adoc| 30 +++ components/camel-scala/src/main/docs/scala.adoc | 78 +++ components/readme.adoc | 4 +- 11 files changed, 395 insertions(+), 393 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/26f1e959/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java -- diff --git a/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java index 7d2b818..fef9c5b 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ProcessDefinition.java @@ -32,7 +32,7 @@ import org.apache.camel.spi.RouteContext; import org.apache.camel.util.ObjectHelper; /** - * Calls a Camel processor. + * Calls a Camel processor * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/26f1e959/camel-core/src/main/java/org/apache/camel/model/cloud/ServiceCallDefinition.java -- diff --git a/camel-core/src/main/java/org/apache/camel/model/cloud/ServiceCallDefinition.java b/camel-core/src/main/java/org/apache/camel/model/cloud/ServiceCallDefinition.java index 53821ff..efaf03e 100644 --- a/camel-core/src/main/java/org/apache/camel/model/cloud/ServiceCallDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/cloud/ServiceCallDefinition.java @@ -56,7 +56,7 @@ import static org.apache.camel.util.CamelContextHelper.findByType; import static org.apache.camel.util.CamelContextHelper.lookup; /** - * Remote service call definition + * To call remote services */ @Metadata(label = "eip,routing") @XmlRootElement(name = "serviceCall") http://git-wip-us.apache.org/repos/asf/camel/blob/26f1e959/components/camel-scala/src/main/docs/scala-dsl-eip.adoc -- diff --git a/components/camel-scala/src/main/docs/scala-dsl-eip.adoc b/components/camel-scala/src/main/docs/scala-dsl-eip.adoc deleted file mode 100644 index f8d52e6..000 --- a/components/camel-scala/src/main/docs/scala-dsl-eip.adoc +++ /dev/null @@ -1,224 +0,0 @@ -[[ScalaDSL-SupportedDSL]] -Scala Supported DSL -^^^ - -The link:scala-dsl.html[Scala DSL] supports *every* DSL from the -link:dsl.html[Java DSL]. - -On this page we have examples for a number of the link:eip.html[EIP]s. + - You can check the -https://svn.apache.org/repos/asf/camel/trunk/components/camel-scala/src/test/scala/[unit -test source code] for the Scala Component to find more examples. - -* 1 link:#ScalaDSL-EIP-Messagingsystems[Messaging systems] -** 1.1 link:#ScalaDSL-EIP-Pipelinepipeline[Pipeline] -** 1.2 link:#ScalaDSL-EIP-Filterfilter[Filter] -* 2 link:#ScalaDSL-EIP-Messagingchannels[Messaging channels] -** 2.1 link:#ScalaDSL-EIP-Deadletterchannel[Dead letter channel] -* 3 link:#ScalaDSL-EIP-Messagerouting[Message routing] -** 3.1 link:#ScalaDSL-EIP-Aggregator[Aggregator] -** 3.2 link:#ScalaDSL-EIP-Contentbasedrouter[Content based router] -** 3.3 link:#ScalaDSL-EIP-Delayer[Delayer] -** 3.4 link:#ScalaDSL-EIP-Loadbalancer[Load balancer] -** 3.5 link:#ScalaDSL-EIP-Multicast[Multicast] -** 3.6 link:#ScalaDSL-EIP-Recipientlist[Recipient list] -** 3.7 link:#ScalaDSL-EIP-Resequencer[Resequencer] -** 3.8 link:#ScalaDSL-EIP-Splitter[Splitter] -** 3.9 link:#ScalaDSL-EIP-Throttler[Throttler] -* 4 link:#ScalaDSL-EIP-Messagetransformation[Message transformation] -** 4.1 link:#ScalaDSL-EIP-Contentenricher[Content enricher] -
[1/2] camel git commit: Component docs - Fixed
Repository: camel Updated Branches: refs/heads/master f8e590c67 -> 3bb4b5a49 Component docs - Fixed Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/46cbdbd5 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/46cbdbd5 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/46cbdbd5 Branch: refs/heads/master Commit: 46cbdbd5d8564c800457c4fc97bde7fad377c397 Parents: f8e590c Author: Claus IbsenAuthored: Thu Apr 13 10:14:32 2017 +0200 Committer: Claus Ibsen Committed: Thu Apr 13 10:14:32 2017 +0200 -- .../src/main/docs/ribbon-component.adoc | 79 .../camel-ribbon/src/main/docs/ribbon.adoc | 79 2 files changed, 79 insertions(+), 79 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/46cbdbd5/components/camel-ribbon/src/main/docs/ribbon-component.adoc -- diff --git a/components/camel-ribbon/src/main/docs/ribbon-component.adoc b/components/camel-ribbon/src/main/docs/ribbon-component.adoc deleted file mode 100644 index c4b968d..000 --- a/components/camel-ribbon/src/main/docs/ribbon-component.adoc +++ /dev/null @@ -1,79 +0,0 @@ -## Ribbon Component - -*Available as of Camel version 2.18* - -The ribbon component provides use of Netflix Ribbon for client side load balancing. - -Maven users will need to add the following dependency to their `pom.xml` -for this component: - -[source,xml] - - -org.apache.camel -camel-ribbon -x.x.x - - - - -This component helps applying load balancing feature at the client side when using http://camel.apache.org/servicecall-eip.html[ServiceCall EIP]. - - Configuration - -* *Programmatic* -+ -[source,java] - -RibbonConfiguration configuration = new RibbonConfiguration(); -configuration.setClientConfig(Collections.singletonMap("ServerListRefreshInterval", "250")); - -RibbonLoadBalancer loadBalancer = new RibbonLoadBalancer(configuration); - -from("direct:start") -.serviceCall() -.name("myService") -.loadBalancer(loadBalancer) -.consulServiceDiscovery() -.end() -.to("mock:result"); - - -* *Spring Boot* -+ -[source,properties] -.application.properties - -camel.cloud.ribbon.client-config[ServerListRefreshInterval] = 250 - -+ -[source,java] -.routes - -from("direct:start") -.serviceCall() -.name("myService") -.ribbonLoadBalancer() -.consulServiceDiscovery() -.end() -.to("mock:result"); - - -* *XML* -+ -[source,xml] - - - - - - - - - - - - - See Also - -* link:http://camel.apache.org/servicecall-eip.html[ServiceCall EIP] http://git-wip-us.apache.org/repos/asf/camel/blob/46cbdbd5/components/camel-ribbon/src/main/docs/ribbon.adoc -- diff --git a/components/camel-ribbon/src/main/docs/ribbon.adoc b/components/camel-ribbon/src/main/docs/ribbon.adoc new file mode 100644 index 000..ceb2e0e --- /dev/null +++ b/components/camel-ribbon/src/main/docs/ribbon.adoc @@ -0,0 +1,79 @@ +## Ribbon Component + +*Available as of Camel version 2.18* + +The ribbon component provides use of Netflix Ribbon for client side load balancing. + +Maven users will need to add the following dependency to their `pom.xml` +for this component: + +[source,xml] + + +org.apache.camel +camel-ribbon +x.x.x + + + + +This component helps applying load balancing feature at the client side when using http://camel.apache.org/servicecall-eip.html[ServiceCall EIP]. + +### Configuration + +* *Programmatic* ++ +[source,java] + +RibbonConfiguration configuration = new RibbonConfiguration(); +configuration.setClientConfig(Collections.singletonMap("ServerListRefreshInterval", "250")); + +RibbonLoadBalancer loadBalancer = new RibbonLoadBalancer(configuration); + +from("direct:start") +.serviceCall() +.name("myService") +.loadBalancer(loadBalancer) +.consulServiceDiscovery() +.end() +.to("mock:result"); + + +* *Spring Boot* ++ +[source,properties] +.application.properties + +camel.cloud.ribbon.client-config[ServerListRefreshInterval] = 250 + ++ +[source,java] +.routes + +from("direct:start") +.serviceCall() +.name("myService") +.ribbonLoadBalancer() +.consulServiceDiscovery() +.end() +.to("mock:result"); + + +* *XML* ++ +[source,xml] + + + + + + + + + + + + +### See Also + +* link:http://camel.apache.org/servicecall-eip.html[ServiceCall EIP]
[1/2] camel git commit: Component docs - apt compiler plugin should support @Metadata enums for eip/data formats as well.
Repository: camel Updated Branches: refs/heads/master ab1842307 -> fbd8d65fd Component docs - apt compiler plugin should support @Metadata enums for eip/data formats as well. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/2213f719 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2213f719 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2213f719 Branch: refs/heads/master Commit: 2213f71944aec8020c1023b5a389aec84e685893 Parents: ab18423 Author: Claus IbsenAuthored: Tue Apr 11 20:18:47 2017 +0200 Committer: Claus Ibsen Committed: Tue Apr 11 20:18:47 2017 +0200 -- .../ProtobufDataFormatConfiguration.java| 1 + .../tools/apt/CoreEipAnnotationProcessor.java | 66 +--- 2 files changed, 44 insertions(+), 23 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/2213f719/platforms/spring-boot/components-starter/camel-protobuf-starter/src/main/java/org/apache/camel/dataformat/protobuf/springboot/ProtobufDataFormatConfiguration.java -- diff --git a/platforms/spring-boot/components-starter/camel-protobuf-starter/src/main/java/org/apache/camel/dataformat/protobuf/springboot/ProtobufDataFormatConfiguration.java b/platforms/spring-boot/components-starter/camel-protobuf-starter/src/main/java/org/apache/camel/dataformat/protobuf/springboot/ProtobufDataFormatConfiguration.java index 7b693cc..85a6319 100644 --- a/platforms/spring-boot/components-starter/camel-protobuf-starter/src/main/java/org/apache/camel/dataformat/protobuf/springboot/ProtobufDataFormatConfiguration.java +++ b/platforms/spring-boot/components-starter/camel-protobuf-starter/src/main/java/org/apache/camel/dataformat/protobuf/springboot/ProtobufDataFormatConfiguration.java @@ -16,6 +16,7 @@ */ package org.apache.camel.dataformat.protobuf.springboot; +import org.apache.camel.dataformat.protobuf.ProtobufDataFormat; import org.springframework.boot.context.properties.ConfigurationProperties; /** http://git-wip-us.apache.org/repos/asf/camel/blob/2213f719/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java -- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java index 73eb1bf..2a0b720 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/CoreEipAnnotationProcessor.java @@ -337,6 +337,8 @@ public class CoreEipAnnotationProcessor { } } +Metadata metadata = fieldElement.getAnnotation(Metadata.class); + name = prefix + name; TypeMirror fieldType = fieldElement.asType(); String fieldTypeName = fieldType.toString(); @@ -350,16 +352,25 @@ public class CoreEipAnnotationProcessor { // gather enums Set enums = new TreeSet(); -boolean isEnum = fieldTypeElement != null && fieldTypeElement.getKind() == ElementKind.ENUM; -if (isEnum) { -TypeElement enumClass = findTypeElement(processingEnv, roundEnv, fieldTypeElement.asType().toString()); -if (enumClass != null) { -// find all the enum constants which has the possible enum value that can be used -List fields = ElementFilter.fieldsIn(enumClass.getEnclosedElements()); -for (VariableElement var : fields) { -if (var.getKind() == ElementKind.ENUM_CONSTANT) { -String val = var.toString(); -enums.add(val); +boolean isEnum; +if (metadata != null && !Strings.isNullOrEmpty(metadata.enums())) { +isEnum = true; +String[] values = metadata.enums().split(","); +for (String val : values) { +enums.add(val); +} +} else { +isEnum = fieldTypeElement != null && fieldTypeElement.getKind() == ElementKind.ENUM; +if (isEnum) { +TypeElement enumClass = findTypeElement(processingEnv, roundEnv, fieldTypeElement.asType().toString()); +if (enumClass != null) { +// find all the enum constants which has the possible enum value that can be used +List fields = ElementFilter.fieldsIn(enumClass.getEnclosedElements()); +for (VariableElement var : fields) { +if (var.getKind() == ElementKind.ENUM_CONSTANT) { +String val = var.toString(); +
[1/3] camel git commit: Component docs - Adjust tables, lets try with description sooner
Repository: camel Updated Branches: refs/heads/camel-2.18.x 49adc55b7 -> 21ea24d6d refs/heads/doc-table bb3764e39 -> 59fbe44de refs/heads/master 42c26f1d9 -> f1737ded8 Component docs - Adjust tables, lets try with description sooner Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/59fbe44d Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/59fbe44d Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/59fbe44d Branch: refs/heads/doc-table Commit: 59fbe44dee94a5cc44e2c942b9f7861d1611866a Parents: bb3764e Author: Claus IbsenAuthored: Fri Mar 17 16:34:28 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 16:34:28 2017 +0100 -- .../src/main/resources/component-options.mvel | 6 +++--- .../src/main/resources/endpoint-options.mvel| 12 ++-- 2 files changed, 9 insertions(+), 9 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/59fbe44d/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index 26e9e91..bd0e92d 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -5,9 +5,9 @@ The @{title} component supports @{componentOptions.size()} options which are lis @end{} @if{!componentOptions.isEmpty()} -[width="100%",cols="2,6,1,1",options="header"] +[width="100%",cols="2,^1,5,2",options="header"] |=== -| Name | Description | Default | Type -@foreach{row : componentOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +| Name | Default | Description | Type +@foreach{row : componentOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/59fbe44d/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index 84b24f7..bb743a8 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -6,16 +6,16 @@ with the following path and query parameters: Path Parameters (@{endpointPathOptions.size()} parameters): -[width="100%",cols="2,6,1,1",options="header"] +[width="100%",cols="2,^1,5,2",options="header"] |=== -| Name | Description | Default | Type -@foreach{row : endpointPathOptions}| **@{row.getShortName(30)}** | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +| Name | Default | Description | Type +@foreach{row : endpointPathOptions}| **@{row.getShortName(25)}** | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|=== Query Parameters (@{endpointOptions.size()} parameters): -[width="100%",cols="2,6,1,1",options="header"] +[width="100%",cols="2,^1,5,2",options="header"] |=== -| Name | Description | Default | Type -@foreach{row : endpointOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +| Name | Default | Description | Type +@foreach{row : endpointOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|===
[24/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc -- diff --git a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc index 1882a07..d59412d 100644 --- a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc +++ b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc @@ -43,21 +43,19 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| streamName | | String | *Required* Name of the stream +| Name | Description | Default | Type +| **streamName** | *Required* Name of the stream | | String |=== Query Parameters (2 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| amazonKinesisFirehoseClient | | AmazonKinesisFirehose | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **amazonKinesisFirehoseClient** (producer) | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint | | AmazonKinesisFirehose +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-aws/src/main/docs/aws-s3-component.adoc -- diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc index 7c68df7..f893a9f 100644 --- a/components/camel-aws/src/main/docs/aws-s3-component.adoc +++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc @@ -57,97 +57,57 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| bucketNameOrArn | | String | *Required* Bucket name or ARN +| Name | Description | Default | Type +| **bucketNameOrArn** | *Required* Bucket name or ARN | | String |=== Query Parameters (40 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| accessKey | | String | Amazon AWS Access Key - -| amazonS3Client | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. - -| amazonS3Endpoint | | String | The region with which the AWS-S3 client wants to work with. - -| pathStyleAccess | false | boolean | Whether or not the S3 client should use path style access - -| policy | | String | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. - -| proxyHost | | String | Camel 2.16: To define a proxy host when instantiating the SQS client - -| proxyPort | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition. - -| secretKey | | String | Amazon AWS Secret Key - 4+^s| consumer -| autocloseBody | true | boolean | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. - -| bridgeErrorHandler | 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
[02/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-twitter/src/main/docs/twitter-component.adoc -- diff --git a/components/camel-twitter/src/main/docs/twitter-component.adoc b/components/camel-twitter/src/main/docs/twitter-component.adoc index fb9be54..e05ab1c 100644 --- a/components/camel-twitter/src/main/docs/twitter-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-component.adoc @@ -47,27 +47,18 @@ The Twitter component supports 9 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| security -| accessToken | | String | The access token - -| accessTokenSecret | | String | The access token secret - -| consumerKey | | String | The consumer key - -| consumerSecret | | String | The consumer secret - 4+^s| proxy -| httpProxyHost | | String | The http proxy host which can be used for the camel-twitter. - -| httpProxyUser | | String | The http proxy user which can be used for the camel-twitter. - -| httpProxyPassword | | String | The http proxy password which can be used for the camel-twitter. - -| httpProxyPort | | int | The http proxy port which can be used for the camel-twitter. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **accessToken** (security) | The access token | | String +| **accessTokenSecret** (security) | The access token secret | | String +| **consumerKey** (security) | The consumer key | | String +| **consumerSecret** (security) | The consumer secret | | String +| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. | | String +| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. | | String +| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. | | String +| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. | | int +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -147,101 +138,59 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| kind | | String | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. +| Name | Description | Default | Type +| **kind** | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. | | String |=== Query Parameters (42 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| user | | String | Username used for user timeline consumption direct message production etc. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| type | polling | EndpointType | Endpoint type to use. Only streaming supports event type. - 4+^s| consumer (advanced) -| distanceMetric | km | String | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. - -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the
[29/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/file-component.adoc -- diff --git a/camel-core/src/main/docs/file-component.adoc b/camel-core/src/main/docs/file-component.adoc index 4e870ad..0416228 100644 --- a/camel-core/src/main/docs/file-component.adoc +++ b/camel-core/src/main/docs/file-component.adoc @@ -68,177 +68,97 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| directoryName | | File | *Required* The starting directory +| Name | Description | Default | Type +| **directoryName** | *Required* The starting directory | | File |=== Query Parameters (80 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| charset | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. - -| doneFileName | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. - -| fileName | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary s tore CamelFileName and have to restore it afterwards. - 4+^s| consumer -| bridgeErrorHandler | 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. - -| delete | false | boolean | If true the file will be deleted after it is processed successfully. - -| moveFailed | | String | Sets the move failure expression based on Simple language. For example to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. - -| noop | false | boolean | If true the file is not moved or deleted in any way. This option is good for readonly data or for ETL type requirements. If noop=true Camel will set idempotent=true as well to avoid consuming the same files over and over again. - -| preMove | | String | Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. - -| recursive | false | boolean | If a directory will look for files in all
[13/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jsch/src/main/docs/scp-component.adoc -- diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc index 24fc3df..44acfe3 100644 --- a/components/camel-jsch/src/main/docs/scp-component.adoc +++ b/components/camel-jsch/src/main/docs/scp-component.adoc @@ -45,13 +45,11 @@ The SCP component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| producer -| verboseLogging | false | boolean | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **verboseLogging** (producer) | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again. | false | boolean +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -72,57 +70,38 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the FTP server -| port | | int | Port of the FTP server -| directoryName | | String | The starting directory +| Name | Description | Default | Type +| **host** | *Required* Hostname of the FTP server | | String +| **port** | Port of the FTP server | | int +| **directoryName** | The starting directory | | String |=== Query Parameters (19 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| disconnect | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. - 4+^s| producer -| chmod | 664 | String | Allows you to set chmod on the stored file. For example chmod=664. - -| fileName | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary s tore CamelFileName and have to restore it afterwards. - -| flatten | false | boolean | 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. - -| strictHostKeyChecking | no | String | Sets whether to use strict host key checking. Possible values are: no yes - 4+^s| producer (advanced) -| allowNullBody | false | boolean | Used to specify if a null body is allowed during file writing. If set to true then
[09/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc -- 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 d687bdf..364c7e4 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 @@ -79,23 +79,16 @@ The Netty4 HTTP component supports 7 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. - 4+^s| common -| configuration | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. - 4+^s| advanced -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. - 4+^s| security -| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. - 4+^s| advanced -| maximumPoolSize | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. - -| executorService | | EventExecutorGroup | To use the given EventExecutorGroup - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding +| **configuration** (common) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyHttpConfiguration +| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy +| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration +| **maximumPoolSize** (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int +| **executorService** (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -117,178 +110,99 @@ with the following path and query parameters: Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use which is either http or https -| host | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. -| port | | int | The host port number -| path | | String | Resource path +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use which is either http or https | | String +| **host** | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String +| **port** | The host port number | | int +| **path** | Resource path | | String |=== Query Parameters (79 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| bridgeEndpoint | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and
[23/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-box/camel-box-component/src/main/docs/box-component.adoc -- diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc index 0cfa410..2f2aff4 100644 --- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc +++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc @@ -51,13 +51,11 @@ The Box component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| configuration | | BoxConfiguration | To use the shared configuration - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (common) | To use the shared configuration | | BoxConfiguration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -70,58 +68,38 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| apiName | | BoxApiName | *Required* What kind of operation to perform -| methodName | | String | *Required* What sub operation to use for the selected operation +| Name | Description | Default | Type +| **apiName** | *Required* What kind of operation to perform | | BoxApiName +| **methodName** | *Required* What sub operation to use for the selected operation | | String |=== Query Parameters (20 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] -|=== -| Name | Default | Java Type | Description - -| clientId | | String | Box application client ID - -| enterpriseId | | String | The enterprise ID to use for an App Enterprise. - -| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body - -| userId | | String | The user ID to use for an App User. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| httpParams | | Map | Custom HTTP params for settings like proxy host - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| accessTokenCache | | IAccessTokenCache | Custom Access Token Cache for storing and retrieving access tokens. - -| clientSecret | | String | Box application client secret - -| encryptionAlgorithm | RSA_SHA_256 | EncryptionAlgorithm | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 - -| maxCacheEntries | 100 | int | The maximum number of access tokens in cache. - 4+^s| authentication -| authenticationType | APP_USER_AUTHENTICATION | String | The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens - 4+^s| security -| privateKeyFile | | String | The private key for generating the JWT signature. - -| privateKeyPassword | | String | The password for the private key. - -| publicKeyId | | String | The ID for public key for validating the
[20/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-freemarker/src/main/docs/freemarker-component.adoc -- diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc index cc69077..dd6025e 100644 --- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc +++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc @@ -43,13 +43,11 @@ The Freemarker component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | Configuration | To use an existing freemarker.template.Configuration instance as the configuration. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use an existing freemarker.template.Configuration instance as the configuration. | | Configuration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -66,27 +64,22 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +| Name | Description | Default | Type +| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String |=== Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| configuration | | Configuration | Sets the Freemarker configuration to use - -| contentCache | false | boolean | Sets whether to use resource content cache or not - -| encoding | | String | Sets the encoding to be used for loading the template file. - -| templateUpdateDelay | | int | Number of seconds the loaded template resource will remain in the cache. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **configuration** (producer) | Sets the Freemarker configuration to use | | Configuration +| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean +| **encoding** (producer) | Sets the encoding to be used for loading the template file. | | String +| **templateUpdateDelay** (producer) | Number of seconds the loaded template resource will remain in the cache. | | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ftp/src/main/docs/ftp-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc index 498acfb..23cc21a 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -87,223 +87,121 @@ with the following path and query
[27/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/xslt-component.adoc -- diff --git a/camel-core/src/main/docs/xslt-component.adoc b/camel-core/src/main/docs/xslt-component.adoc index 4deb512..67ab2ff 100644 --- a/camel-core/src/main/docs/xslt-component.adoc +++ b/camel-core/src/main/docs/xslt-component.adoc @@ -71,27 +71,18 @@ The XSLT component supports 9 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| xmlConverter | | XmlConverter | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter - -| uriResolverFactory | | XsltUriResolverFactory | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver). - -| uriResolver | | URIResolver | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory). - 4+^s| producer -| contentCache | false | boolean | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. - -| saxon | false | boolean | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. - -| saxonExtensionFunctions | | List | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry where you can comma to separate multiple values to lookup. - -| saxonConfiguration | true | Object | To use a custom Saxon configuration - 4+^s| advanced -| saxonConfigurationProperties | | Map | To set custom Saxon configuration properties - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **xmlConverter** (advanced) | To use a custom implementation of org.apache.camel.converter.jaxp.XmlConverter | | XmlConverter +| **uriResolverFactory** (advanced) | To use a custom javax.xml.transform.URIResolver which depends on a dynamic endpoint resource URI or which is a subclass of XsltUriResolver. Do not use in combination with uriResolver. See also link setUriResolver(URIResolver). | | XsltUriResolverFactory +| **uriResolver** (advanced) | To use a custom javax.xml.transform.URIResolver. Do not use in combination with uriResolverFactory. See also link setUriResolverFactory(XsltUriResolverFactory). | | URIResolver +| **contentCache** (producer) | Cache for the resource content (the stylesheet file) when it is loaded. If set to false Camel will reload the stylesheet file on each message processing. This is good for development. A cached stylesheet can be forced to reload at runtime via JMX using the clearCachedStylesheet operation. | false | boolean +| **saxon** (producer) | Whether to use Saxon as the transformerFactoryClass. If enabled then the class net.sf.saxon.TransformerFactoryImpl. You would need to add Saxon to the classpath. | false | boolean +| **saxonExtensionFunctions** (producer) | Allows you to use a custom net.sf.saxon.lib.ExtensionFunctionDefinition. You would need to add camel-saxon to the classpath. The function is looked up in the registry where you can comma to separate multiple values to lookup. | | List +| **saxonConfiguration** (producer) | To use a custom Saxon configuration | true | Object +| **saxonConfiguration Properties** (advanced) | To set custom Saxon configuration properties | | Map +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -105,51 +96,34 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* The name of the template to load from classpath
[01/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
Repository: camel Updated Branches: refs/heads/master e43230a01 -> db81a114e http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc -- diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc index 1e3bab5..aa617d1 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc @@ -229,15 +229,12 @@ The XML Security component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| signerConfiguration | | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. - -| verifierConfiguration | | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **signerConfiguration** (advanced) | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. | | XmlSignerConfiguration +| **verifierConfiguration** (advanced) | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. | | XmlVerifier Configuration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -258,88 +255,53 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| command | | XmlCommand | *Required* Whether to sign or verify. -| name | | String | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. +| Name | Description | Default | Type +| **command** | *Required* Whether to sign or verify. | | XmlCommand +| **name** | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. | | String |=== Query Parameters (35 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| baseUri | | String | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. - -| clearHeaders | true | Boolean | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. - -| cryptoContextProperties | | Map | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference - -| disallowDoctypeDecl | true | Boolean | Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is link BooleanTRUE. - -| omitXmlDeclaration | false | Boolean | Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION. - -| outputXmlEncoding | | String | The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used. - -| schemaResourceUri | | String | Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes might be set in the enveloped and enveloping case. If set then the XML document is validated with the specified
[25/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-apns/src/main/docs/apns-component.adoc -- diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc index 2b2fada..e2e08a8 100644 --- a/components/camel-apns/src/main/docs/apns-component.adoc +++ b/components/camel-apns/src/main/docs/apns-component.adoc @@ -55,13 +55,11 @@ The APNS component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| apnsService | | ApnsService | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **apnsService** (common) | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService | | ApnsService +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -77,57 +75,37 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| name | | String | Name of the endpoint +| Name | Description | Default | Type +| **name** | Name of the endpoint | | String |=== Query Parameters (20 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| tokens | | String | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also
[05/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sjms/src/main/docs/sjms-batch-component.adoc -- diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc index 2a2cf47..cf8f2b2 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc @@ -114,19 +114,14 @@ The Simple JMS Batch component supports 5 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent. - -| asyncStartListener | false | boolean | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. - -| recoveryInterval | 5000 | int | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. - 4+^s| filter -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsBatchComponent. | | ConnectionFactory +| **asyncStartListener** (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean +| **recoveryInterval** (advanced) | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. | 5000 | int +| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -147,61 +142,39 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| destinationName | | String | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. +| Name | Description | Default | Type +| **destinationName** | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. | | String |=== Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| aggregationStrategy | | AggregationStrategy | *Required* The aggregation strategy to use which merges all the batched messages into a single message - -| allowNullBody | true | boolean | Whether to allow sending messages with no
[14/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-jetty9/src/main/docs/jetty-component.adoc -- diff --git a/components/camel-jetty9/src/main/docs/jetty-component.adoc b/components/camel-jetty9/src/main/docs/jetty-component.adoc index b31d915..222ecf4 100644 --- a/components/camel-jetty9/src/main/docs/jetty-component.adoc +++ b/components/camel-jetty9/src/main/docs/jetty-component.adoc @@ -56,73 +56,41 @@ The Jetty 9 component supports 32 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| security -| sslKeyPassword | | String | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option). - -| sslPassword | | String | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option). - -| keystore | | String | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry. - 4+^s| advanced -| errorHandler | | ErrorHandler | This option is used to set the ErrorHandler that Jetty server uses. - 4+^s| security -| sslSocketConnectors | | Map | A map which contains per port number specific SSL connectors. - -| socketConnectors | | Map | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors. - 4+^s| producer -| httpClientMinThreads | | Integer | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. - -| httpClientMaxThreads | | Integer | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. - 4+^s| consumer -| minThreads | | Integer | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured. - -| maxThreads | | Integer | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured. - 4+^s| consumer (advanced) -| threadPool | | ThreadPool | To use a custom thread pool for the server. This option should only be used in special circumstances. - 4+^s| common -| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. - 4+^s| advanced -| jettyHttpBinding | | JettyHttpBinding | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer. - -| httpBinding | | HttpBinding | Not to be used - use JettyHttpBinding instead. - -| httpConfiguration | | HttpConfiguration | Jetty component does not use HttpConfiguration. - -| mbContainer | | MBeanContainer | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans. - 4+^s| security -| sslSocketConnectorProperties | | Map | A map which contains general SSL connector properties. - -| socketConnectorProperties | | Map | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties. - 4+^s| consumer -| continuationTimeout | 3 | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 3. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. - -| useContinuation | true | boolean | Whether or not to use Jetty continuations for the Jetty Server. - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| common -| responseBufferSize | | Integer | Allows to configure a custom value of the response buffer size on the Jetty connectors. - -| requestBufferSize | | Integer | Allows to configure a custom value of the request buffer size on the Jetty connectors. - -| requestHeaderSize | | Integer | Allows to configure a custom value of the request header size on the Jetty connectors. - -| responseHeaderSize | | Integer | Allows to configure a custom value of the response header size on the Jetty connectors. - 4+^s| proxy -| proxyHost | | String | To use a http proxy to configure the hostname. - -| proxyPort | | Integer | To use a http proxy to configure the port number. - 4+^s| common -| useXForwardedForHeader | false | boolean | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr. - 4+^s| consumer -|
[28/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/ref-component.adoc -- diff --git a/camel-core/src/main/docs/ref-component.adoc b/camel-core/src/main/docs/ref-component.adoc index f7e9318..67767cf 100644 --- a/camel-core/src/main/docs/ref-component.adoc +++ b/camel-core/src/main/docs/ref-component.adoc @@ -33,25 +33,21 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| name | | String | *Required* Name of endpoint to lookup in the registry. +| Name | Description | Default | Type +| **name** | *Required* Name of endpoint to lookup in the registry. | | String |=== Query Parameters (4 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| consumer -| bridgeErrorHandler | 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. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 | | ExchangePattern | Sets the default exchange pattern when creating an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **bridgeErrorHandler** (consumer) | 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. | false | boolean +| **exceptionHandler** (consumer) | 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. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the default exchange pattern when creating an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/camel-core/src/main/docs/rest-api-component.adoc -- diff --git a/camel-core/src/main/docs/rest-api-component.adoc b/camel-core/src/main/docs/rest-api-component.adoc index 43b19ef..c66121d 100644 --- a/camel-core/src/main/docs/rest-api-component.adoc +++ b/camel-core/src/main/docs/rest-api-component.adoc @@ -494,30 +494,24 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| path | | String | *Required* The base path -| contextIdPattern | | String | Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern. +| Name | Description | Default | Type +| **path** | *Required* The base path | | String +| **contextIdPattern** | Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern. | | String |=== Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"]
[16/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc -- diff --git a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc index 86a92a8..6a15115 100644 --- a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc +++ b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc @@ -57,13 +57,11 @@ The HDFS2 component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| jAASConfiguration | | Configuration | To use the given configuration for security with JAAS. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **jAASConfiguration** (common) | To use the given configuration for security with JAAS. | | Configuration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -81,95 +79,57 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| hostName | | String | *Required* HDFS host to use -| port | 8020 | int | HDFS port to use -| path | | String | *Required* The directory path to use +| Name | Description | Default | Type +| **hostName** | *Required* HDFS host to use | | String +| **port** | HDFS port to use | 8020 | int +| **path** | *Required* The directory path to use | | String |=== Query Parameters (38 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| connectOnStartup | true | boolean | Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup and not block for up till 15 minutes. - -| fileSystemType | HDFS | HdfsFileSystemType | Set to LOCAL to not use HDFS but local java.io.File instead. - -| fileType | NORMAL_FILE | HdfsFileType | The file type to use. For more details see Hadoop HDFS documentation about the various files types. - -| keyType | NULL | WritableType | The type for the key in case of sequence or map files. - -| owner | | String | The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped. - -| valueType | BYTES | WritableType | The type for the key in case of sequence or map files - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| delay | 1000 | long | The interval (milliseconds) between the directory scans. - -| initialDelay | 1 | long | For the consumer how much to wait (milliseconds) before to start scanning the directory. - -| pattern | * | String | The pattern used for scanning the directory - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A
[07/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc -- diff --git a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc index 623e40a..cbd0e2b 100644 --- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc @@ -53,133 +53,76 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| hostname | | String | *Required* The hostname of the running rabbitmq instance or cluster. -| portNumber | 5672 | int | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. -| exchangeName | | String | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. +| Name | Description | Default | Type +| **hostname** | *Required* The hostname of the running rabbitmq instance or cluster. | | String +| **portNumber** | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | 5672 | int +| **exchangeName** | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. | | String |=== Query Parameters (57 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| autoDelete | true | boolean | If it is true the exchange will be deleted when it is no longer in use - -| connectionTimeout | 6 | int | Connection timeout - -| deadLetterExchange | | String | The name of the dead letter exchange - -| deadLetterExchangeType | direct | String | The type of the dead letter exchange - -| deadLetterQueue | | String | The name of the dead letter queue - -| deadLetterRoutingKey | | String | The routing key for the dead letter exchange - -| declare | true | boolean | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server. - -| durable | true | boolean | If we are declaring a durable exchange (the exchange will survive a server restart) - -| exchangeType | direct | String | The exchange type such as direct or topic. - -| exclusive | false | boolean | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes. - -| queue | | String | The queue to receive messages from - -| routingKey | | String | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY. - -| skipExchangeDeclare | false | boolean | This can be used if we need to declare the queue but not the exchange - -| skipQueueBind | false | boolean | If true the queue will not be bound to the exchange after declaring it - -| skipQueueDeclare | false | boolean | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. - -| vhost | / | String | The vhost for the channel - 4+^s| consumer -| autoAck | true | boolean | If messages should be auto acknowledged - -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| concurrentConsumers | 1 | int | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). - -| prefetchCount | | int | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - -| prefetchEnabled | false | boolean | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - -| prefetchGlobal | false | boolean | If the settings should be applied to the entire
[03/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-sql/src/main/docs/sql-component.adoc -- diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc index 92dee04..e9baa47 100644 --- a/components/camel-sql/src/main/docs/sql-component.adoc +++ b/components/camel-sql/src/main/docs/sql-component.adoc @@ -111,15 +111,12 @@ The SQL component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - 4+^s| advanced -| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource +| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true | true | boolean +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -135,107 +132,62 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| query | | String | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. +| Name | Description | Default | Type +| **query** | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. | | String |=== Query Parameters (45 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries. - -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - -| dataSourceRef | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. - -| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne. - -| outputHeader | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. - -| outputType | SelectList | SqlOutputType | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way: a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column then it will return a Map of that result. c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows it throws an non-unique result exception. - -| separator | , | char | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders. Notice if you use named parameters then a Map type is used instead. The default value is comma. - 4+^s| consumer -| breakBatchOnConsumeFail | false | boolean | Sets whether to break batch if onConsume failed. - -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the
[21/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc -- diff --git a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc index bd0e135..dadb762 100644 --- a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc +++ b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc @@ -35,13 +35,11 @@ The Elasticsearch component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| client | | Client | To use an existing configured Elasticsearch client instead of creating a client per endpoint. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **client** (advanced) | To use an existing configured Elasticsearch client instead of creating a client per endpoint. | | Client +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -58,39 +56,28 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| clusterName | | String | *Required* Name of cluster or use local for local mode +| Name | Description | Default | Type +| **clusterName** | *Required* Name of cluster or use local for local mode | | String |=== Query Parameters (11 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| clientTransportSniff | true | Boolean | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. - -| consistencyLevel | DEFAULT | WriteConsistencyLevel | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) - -| data | | Boolean | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting. - -| indexName | | String | The name of the index to act against - -| indexType | | String | The type of the index to act against - -| ip | | String | The TransportClient remote host ip to use - -| operation | | String | What operation to perform - -| pathHome | ${user.home}/.elasticsearch | String | The path.home property of ElasticSearch configuration. You need to provide a valid path otherwise the default $user.home/.elasticsearch will be used. - -| port | 9300 | int | The TransportClient remote port to use (defaults to 9300) - -| transportAddresses | | String | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **clientTransportSniff** (producer) | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. | true | Boolean +| **consistencyLevel** (producer) | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) | DEFAULT | WriteConsistencyLevel +| **data** (producer) | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting. | | Boolean +| **indexName** (producer) | The name of the index to act against | | String +| **indexType** (producer) | The type of the index to act against | | String +| **ip** (producer) | The TransportClient remote host ip to use | | String +| **operation** (producer) | What operation to perform | | String +| **pathHome** (producer) | The path.home property of ElasticSearch configuration. You need to provide a valid
[17/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc -- diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc index 085ff27..c6616b8 100644 --- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc +++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc @@ -41,15 +41,12 @@ The Google Calendar component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| configuration | | GoogleCalendarConfiguration | To use the shared configuration - 4+^s| advanced -| clientFactory | | GoogleCalendarClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (common) | To use the shared configuration | | GoogleCalendar Configuration +| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory | | GoogleCalendarClient Factory +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -69,46 +66,32 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| apiName | | GoogleCalendarApiName | *Required* What kind of operation to perform -| methodName | | String | *Required* What sub operation to use for the selected operation +| Name | Description | Default | Type +| **apiName** | *Required* What kind of operation to perform | | GoogleCalendarApiName +| **methodName** | *Required* What sub operation to use for the selected operation | | String |=== Query Parameters (14 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| accessToken | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. - -| applicationName | | String | Google calendar application name. Example would be camel-google-calendar/1.0 - -| clientId | | String | Client ID of the calendar application - -| clientSecret | | String | Client secret of the calendar application - -| emailAddress | | String | The emailAddress of the Google Service Account. - -| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body - -| p12FileName | | String | The name of the p12 file which has the private key to use with the Google Service Account. - -| refreshToken | | String | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. - -| scopes | https://www.googleapis.com/auth/calendar | String | Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info. - -| user | | String | The email address of the user the application is trying to impersonate in the service account flow - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the
[26/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-amqp/src/main/docs/amqp-component.adoc -- diff --git a/components/camel-amqp/src/main/docs/amqp-component.adoc b/components/camel-amqp/src/main/docs/amqp-component.adoc index 391de32..44bc8ca 100644 --- a/components/camel-amqp/src/main/docs/amqp-component.adoc +++ b/components/camel-amqp/src/main/docs/amqp-component.adoc @@ -38,165 +38,88 @@ link:../../../../camel-jms/src/main/docs/readme.html[JMS] component after the de // component options: START -The AMQP component supports 76 options which are listed below. +The AMQP component supports 75 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | JmsConfiguration | To use a shared JMS configuration - 4+^s| consumer (advanced) -| acceptMessagesWhileStopping | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. - -| allowReplyManagerQuickStop | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. - 4+^s| consumer -| acknowledgementMode | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode.For the regular modes it is preferable to use the acknowledgementModeName instead. - 4+^s| consumer (advanced) -| eagerLoadingOfProperties | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties - 4+^s| consumer -| acknowledgementModeName | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE - -| autoStartup | true | boolean | Specifies whether the consumer container should auto-startup. - -| cacheLevel | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. - -| cacheLevelName | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. - 4+^s| producer (advanced) -| replyToCacheLevelName | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. - 4+^s| common -| clientId | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. - 4+^s| consumer -| concurrentConsumers | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. - 4+^s| producer -| replyToConcurrentConsumers | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the
[15/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-influxdb/src/main/docs/influxdb-component.adoc -- diff --git a/components/camel-influxdb/src/main/docs/influxdb-component.adoc b/components/camel-influxdb/src/main/docs/influxdb-component.adoc index e20c777..dff543d 100644 --- a/components/camel-influxdb/src/main/docs/influxdb-component.adoc +++ b/components/camel-influxdb/src/main/docs/influxdb-component.adoc @@ -56,29 +56,23 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| connectionBean | | String | *Required* Connection to the influx database of class InfluxDB.class +| Name | Description | Default | Type +| **connectionBean** | *Required* Connection to the influx database of class InfluxDB.class | | String |=== Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| batch | false | boolean | Define if this operation is a batch operation or not - -| databaseName | | String | The name of the database where the time series will be stored - -| operation | insert | String | Define if this operation is an insert or a query - -| query | | String | Define the query in case of operation query - -| retentionPolicy | default | String | The string that defines the retention policy to the data created by the endpoint - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **batch** (producer) | Define if this operation is a batch operation or not | false | boolean +| **databaseName** (producer) | The name of the database where the time series will be stored | | String +| **operation** (producer) | Define if this operation is an insert or a query | insert | String +| **query** (producer) | Define the query in case of operation query | | String +| **retentionPolicy** (producer) | The string that defines the retention policy to the data created by the endpoint | default | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-irc/src/main/docs/irc-component.adoc -- diff --git a/components/camel-irc/src/main/docs/irc-component.adoc b/components/camel-irc/src/main/docs/irc-component.adoc index 08dc8a8..36e8b1a 100644 --- a/components/camel-irc/src/main/docs/irc-component.adoc +++ b/components/camel-irc/src/main/docs/irc-component.adoc @@ -52,66 +52,42 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| hostname | | String | *Required* Hostname for the IRC chat server -| port | | int | Port number for the IRC chat server. If no port is configured then a default port of either 6667 6668 or 6669 is used. +| Name | Description | Default | Type +| **hostname** | *Required* Hostname for the IRC chat server | | String +| **port** | Port number for the IRC chat server. If no port is configured then a default port of either 6667 6668 or 6669 is used. | | int |=== Query Parameters (24 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| autoRejoin | true | boolean | Whether to auto re-join when being kicked - -| namesOnJoin | false | boolean | Sends NAMES command to channel after joining it. link onReply has to be true in order to process the result which will have the header value irc.num = '353'. - -| nickname | | String | The nickname used in chat. - -| persistent | true | boolean | Use persistent messages. - -| realname | | String | The IRC user's actual name. - 4+^s| consumer -| bridgeErrorHandler | false | boolean | Allows for
[22/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/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 143184f..c118b76 100644 --- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc +++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc @@ -56,44 +56,32 @@ with the following path and query parameters: Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use for communicating with the database. -| hostname | | String | *Required* Hostname of the running couchdb instance -| port | 5984 | int | Port number for the running couchdb instance -| database | | String | *Required* Name of the database to use +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use for communicating with the database. | | String +| **hostname** | *Required* Hostname of the running couchdb instance | | String +| **port** | Port number for the running couchdb instance | 5984 | int +| **database** | *Required* Name of the database to use | | String |=== Query Parameters (12 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| createDatabase | false | boolean | Creates the database if it does not already exist - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| deletes | true | boolean | Document deletes are published as events - -| heartbeat | 3 | long | How often to send an empty message to keep socket alive in millis - -| since | | String | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. - -| style | 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 | true | boolean | Document inserts/updates are published as events - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| password | | String | Password for authenticated databases - -| username | | String | Username in case of authenticated databases +| Name | Description | Default | Type +| **createDatabase** (common) | Creates the database if it does not already exist | false | boolean +| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean +| **deletes** (consumer) | Document deletes are published as events | true | boolean +| **heartbeat** (consumer) | How often to send an empty message to keep socket alive in millis | 3 | long +| **since** (consumer) | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. | | String +| **style** (consumer) | 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
[06/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc -- diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc index 46583bc..5fd49d5 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc +++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc @@ -431,59 +431,34 @@ The Salesforce component supports 25 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| security -| loginConfig | | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration - -| loginUrl | https://login.salesforce.com | String | Salesforce login URL defaults to https://login.salesforce.com - -| clientId | | String | Salesforce connected application Consumer Key - -| clientSecret | | String | Salesforce connected application Consumer Secret - -| keystore | | KeyStoreParameters | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. - -| refreshToken | | String | Salesforce connected application Consumer token - -| userName | | String | Salesforce account user name - -| password | | String | Salesforce account password - -| lazyLogin | false | boolean | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call - 4+^s| advanced -| config | | SalesforceEndpointConfig | To use the shared SalesforceEndpointConfig as endpoint configuration - -| httpClientProperties | | Map | Used for configuring HTTP client properties as key/value pairs - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| proxy -| httpProxyHost | | String | To configure HTTP proxy host - -| httpProxyPort | | Integer | To configure HTTP proxy port - 4+^s| security -| httpProxyUsername | | String | To configure HTTP proxy username - -| httpProxyPassword | | String | To configure HTTP proxy password - 4+^s| proxy -| isHttpProxySocks4 | false | boolean | Enable for Socks4 proxy false by default - 4+^s| security -| isHttpProxySecure | false | boolean | Enable for TLS connections true by default - 4+^s| proxy -| httpProxyIncludedAddresses | | Set | HTTP proxy included addresses - -| httpProxyExcludedAddresses | | Set | HTTP proxy excluded addresses - 4+^s| security -| httpProxyAuthUri | | String | HTTP proxy authentication URI - -| httpProxyRealm | | String | HTTP proxy authentication realm - -| httpProxyUseDigestAuth | false | boolean | Use HTTP proxy Digest authentication false by default - 4+^s| common -| packages | | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma). - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **loginConfig** (security) | To use the shared SalesforceLoginConfig as login configuration | | SalesforceLoginConfig +| **loginUrl** (security) | Salesforce login URL defaults to https://login.salesforce.com | https://login.salesforce.com | String +| **clientId** (security) | Salesforce connected application Consumer Key | | String +| **clientSecret** (security) | Salesforce connected application Consumer Secret | | String +| **keystore** (security) | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. | | KeyStoreParameters +| **refreshToken** (security) | Salesforce connected application Consumer token | | String +| **userName** (security) | Salesforce account user name | | String +| **password** (security) | Salesforce account password | | String +| **lazyLogin** (security) | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call | false | boolean +| **config** (advanced) | To use the shared SalesforceEndpointConfig as endpoint configuration | | SalesforceEndpoint Config +| **httpClientProperties** (advanced) | Used for configuring HTTP client properties as key/value pairs | | Map +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **httpProxyHost** (proxy) | To configure HTTP proxy host | | String +| **httpProxyPort** (proxy) | To configure HTTP proxy port | | Integer +| **httpProxyUsername**
[12/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc -- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc index 000b188..29fe8ae 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc @@ -51,71 +51,44 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| masterUrl | | String | *Required* Kubernetes Master url +| Name | Description | Default | Type +| **masterUrl** | *Required* Kubernetes Master url | | String |=== Query Parameters (27 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| apiVersion | | String | The Kubernetes API Version to use - -| category | | String | *Required* Kubernetes Producer and Consumer category - -| dnsDomain | | String | The dns domain used for ServiceCall EIP - -| kubernetesClient | | DefaultKubernetesClient | Default KubernetesClient to use if provided - -| portName | | String | The port name used for ServiceCall EIP - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| labelKey | | String | The Consumer Label key when watching at some resources - -| labelValue | | String | The Consumer Label value when watching at some resources - -| namespace | | String | The namespace - -| poolSize | 1 | int | The Consumer pool size - -| resourceName | | String | The Consumer Resource Name we would like to watch - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| operation | | String | Producer operation to do on Kubernetes - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| caCertData | | String | The CA Cert Data - -| caCertFile | | String | The CA Cert File - -| clientCertData | | String | The Client Cert Data - -| clientCertFile | | String | The Client Cert File - -| clientKeyAlgo | | String | The Key Algorithm used by the client - -| clientKeyData | | String | The Client Key data - -| clientKeyFile | | String | The Client Key file - -| clientKeyPassphrase | | String | The Client Key Passphrase - -| oauthToken | | String | The Auth Token - -| password | | String | Password to connect to Kubernetes - -| trustCerts | | Boolean | Define if the certs we used are trusted anyway or not - -| username | | String | Username to connect to Kubernetes +| Name | Description | Default | Type +| **apiVersion** (common) | The Kubernetes API Version to use | | String +| **category** (common) | *Required* Kubernetes Producer and Consumer category | | String +| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String +| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | DefaultKubernetesClient +| **portName** (common) | The port name used for ServiceCall EIP | | String +| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean +| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String +|
[18/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-ftp/src/main/docs/sftp-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc index aa3eb1f..733caf9 100644 --- a/components/camel-ftp/src/main/docs/sftp-component.adoc +++ b/components/camel-ftp/src/main/docs/sftp-component.adoc @@ -38,236 +38,127 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the FTP server -| port | | int | Port of the FTP server -| directoryName | | String | The starting directory +| Name | Description | Default | Type +| **host** | *Required* Hostname of the FTP server | | String +| **port** | Port of the FTP server | | int +| **directoryName** | The starting directory | | String |=== Query Parameters (109 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| charset | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. - -| disconnect | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. - -| doneFileName | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. - -| fileName | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary s tore CamelFileName and have to restore it afterwards. - -| jschLoggingLevel | WARN | LoggingLevel | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. - -| separator | UNIX | PathSeparator | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name - 4+^s| common (advanced) -| fastExistsCheck | false | boolean | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can
[11/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-mllp/src/main/docs/mllp-component.adoc -- diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc index 39493a2..7324dd1 100644 --- a/components/camel-mllp/src/main/docs/mllp-component.adoc +++ b/components/camel-mllp/src/main/docs/mllp-component.adoc @@ -59,62 +59,40 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| hostname | | String | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address -| port | | int | *Required* Port number for the TCP connection +| Name | Description | Default | Type +| **hostname** | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address | | String +| **port** | *Required* Port number for the TCP connection | | int |=== Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| autoAck | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only - -| bufferWrites | true | boolean | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). - -| hl7Headers | true | boolean | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only - -| keepAlive | true | boolean | Enable/disable the SO_KEEPALIVE socket option. - -| reuseAddress | false | boolean | Enable/disable the SO_REUSEADDR socket option. - -| tcpNoDelay | true | boolean | Enable/disable the TCP_NODELAY socket option. - -| validatePayload | false | boolean | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| backlog | 5 | int | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. - -| receiveBufferSize | | Integer | Sets the SO_RCVBUF option to the specified value (in bytes) - -| sendBufferSize | | Integer | Sets the SO_SNDBUF option to the specified value (in bytes) - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| codec -| charsetName | | String | Set the CamelCharsetName property on the exchange - 4+^s| timeout -| acceptTimeout | 6 | int | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only - -| bindRetryInterval | 5000 | int | TCP Server Only - The number of milliseconds to wait between bind attempts - -| bindTimeout | 3 | int | TCP Server Only - The number of milliseconds to retry binding to a server port - -|
[10/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-nagios/src/main/docs/nagios-component.adoc -- diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc index d36c76e..9bc6501 100644 --- a/components/camel-nagios/src/main/docs/nagios-component.adoc +++ b/components/camel-nagios/src/main/docs/nagios-component.adoc @@ -42,13 +42,11 @@ The Nagios component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | NagiosConfiguration | To use a shared NagiosConfiguration - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use a shared NagiosConfiguration | | NagiosConfiguration +| **resolveProperty Placeholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -67,30 +65,24 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* This is the address of the Nagios host where checks should be send. -| port | | int | *Required* The port number of the host. +| Name | Description | Default | Type +| **host** | *Required* This is the address of the Nagios host where checks should be send. | | String +| **port** | *Required* The port number of the host. | | int |=== Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| connectionTimeout | 5000 | int | Connection timeout in millis. - -| sendSync | true | boolean | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. - -| timeout | 5000 | int | Sending timeout in millis. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| encryptionMethod | | NagiosEncryptionMethod | To specify an encryption method. - -| password | | String | Password to be authenticated when sending checks to Nagios. +| Name | Description | Default | Type +| **connectionTimeout** (producer) | Connection timeout in millis. | 5000 | int +| **sendSync** (producer) | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. | true | boolean +| **timeout** (producer) | Sending timeout in millis. | 5000 | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **encryptionMethod** (security) | To specify an encryption method. | | NagiosEncryptionMethod +| **password** (security) | Password to be authenticated when sending checks to Nagios. | | String |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-nats/src/main/docs/nats-component.adoc -- diff --git a/components/camel-nats/src/main/docs/nats-component.adoc b/components/camel-nats/src/main/docs/nats-component.adoc index 9852eca..82e366e 100644 --- a/components/camel-nats/src/main/docs/nats-component.adoc +++ b/components/camel-nats/src/main/docs/nats-component.adoc @@ -46,61 +46,39 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java
[08/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc -- diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc index 8d206d5..c680006 100644 --- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc @@ -47,35 +47,26 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |=== Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| subsystem | | String | *Required* OpenStack Cinder subsystem - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **subsystem** (producer) | *Required* OpenStack Cinder subsystem | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-openstack/src/main/docs/openstack-glance-component.adoc -- diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc index 1607f18..96cf78b 100644 --- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc @@ -47,33 +47,25 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |=== Query Parameters (8 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default
[04/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/db81a114/components/camel-snmp/src/main/docs/snmp-component.adoc -- diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc index e37146d..100b522 100644 --- a/components/camel-snmp/src/main/docs/snmp-component.adoc +++ b/components/camel-snmp/src/main/docs/snmp-component.adoc @@ -57,86 +57,52 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the SNMP enabled device -| port | | Integer | *Required* Port number of the SNMP enabled device +| Name | Description | Default | Type +| **host** | *Required* Hostname of the SNMP enabled device | | String +| **port** | *Required* Port number of the SNMP enabled device | | Integer |=== Query Parameters (34 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Java Type | Description - -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| delay | 6 | long | Sets update rate in seconds - -| oids | | String | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1 - -| protocol | udp | String | Here you can select which protocol to use. You can use either udp or tcp. - -| retries | 2 | int | Defines how often a retry is made before canceling the request. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| snmpCommunity | public | String | Sets the community octet string for the snmp request. - -| snmpContextEngineId | | String | Sets the context engine ID field of the scoped PDU. - -| snmpContextName | | String | Sets the context name field of this scoped PDU. - -| snmpVersion | 0 | int | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3 - -| timeout | 1500 | int | Sets the timeout value for the request in millis. - -| type | | SnmpActionType | Which operation to perform such as poll trap etc. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long |
[30/30] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/db81a114 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/db81a114 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/db81a114 Branch: refs/heads/master Commit: db81a114ec9287b8f09dfecb60a5db443d4337ae Parents: e43230a Author: Claus IbsenAuthored: Fri Mar 17 17:23:52 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 17:23:52 2017 +0100 -- camel-core/src/main/docs/bean-component.adoc| 25 +- camel-core/src/main/docs/binding-component.adoc | 24 +- camel-core/src/main/docs/browse-component.adoc | 22 +- camel-core/src/main/docs/class-component.adoc | 25 +- .../src/main/docs/controlbus-component.adoc | 27 +- .../src/main/docs/dataformat-component.adoc | 15 +- camel-core/src/main/docs/dataset-component.adoc | 67 +-- camel-core/src/main/docs/direct-component.adoc | 44 +- .../src/main/docs/direct-vm-component.adoc | 56 +-- camel-core/src/main/docs/file-component.adoc| 250 -- .../src/main/docs/language-component.adoc | 30 +- camel-core/src/main/docs/log-component.adoc | 95 ++-- camel-core/src/main/docs/mock-component.adoc| 40 +- .../src/main/docs/properties-component.adoc | 83 ++- camel-core/src/main/docs/ref-component.adoc | 22 +- .../src/main/docs/rest-api-component.adoc | 30 +- camel-core/src/main/docs/rest-component.adoc| 72 +-- .../src/main/docs/scheduler-component.adoc | 80 ++- camel-core/src/main/docs/seda-component.adoc| 74 +-- camel-core/src/main/docs/stub-component.adoc| 74 +-- camel-core/src/main/docs/test-component.adoc| 52 +- camel-core/src/main/docs/timer-component.adoc | 46 +- .../src/main/docs/validator-component.adoc | 53 +- camel-core/src/main/docs/vm-component.adoc | 74 +-- camel-core/src/main/docs/xslt-component.adoc| 92 ++-- .../src/main/docs/ahc-ws-component.adoc | 89 ++-- .../camel-ahc/src/main/docs/ahc-component.adoc | 74 +-- .../src/main/docs/amqp-component.adoc | 500 +++ .../src/main/docs/apns-component.adoc | 80 ++- .../src/main/docs/asterisk-component.adoc | 34 +- .../src/main/docs/atmos-component.adoc | 48 +- .../docs/atmosphere-websocket-component.adoc| 149 ++ .../src/main/docs/atom-component.adoc | 91 ++-- .../src/main/docs/avro-component.adoc | 56 +-- .../src/main/docs/aws-cw-component.adoc | 43 +- .../src/main/docs/aws-ddb-component.adoc| 49 +- .../src/main/docs/aws-ddbstream-component.adoc | 79 ++- .../src/main/docs/aws-ec2-component.adoc| 34 +- .../src/main/docs/aws-kinesis-component.adoc| 82 ++- .../docs/aws-kinesis-firehose-component.adoc| 16 +- .../src/main/docs/aws-s3-component.adoc | 130 ++--- .../src/main/docs/aws-sdb-component.adoc| 40 +- .../src/main/docs/aws-ses-component.adoc| 43 +- .../src/main/docs/aws-sns-component.adoc| 43 +- .../src/main/docs/aws-sqs-component.adoc| 142 ++ .../src/main/docs/aws-swf-component.adoc| 97 ++-- .../src/main/docs/azure-blob-component.adoc | 67 +-- .../src/main/docs/azure-queue-component.adoc| 40 +- .../src/main/docs/bean-validator-component.adoc | 28 +- .../src/main/docs/beanstalk-component.adoc | 98 ++-- .../src/main/docs/bonita-component.adoc | 37 +- .../src/main/docs/box-component.adoc| 84 ++-- .../src/main/docs/braintree-component.adoc | 61 +-- .../src/main/docs/cache-component.adoc | 83 ++- .../src/main/docs/cql-component.adoc| 58 +-- .../main/docs/chronicle-engine-component.adoc | 48 +- .../src/main/docs/chunk-component.adoc | 31 +- .../src/main/docs/cm-sms-component.adoc | 25 +- .../src/main/docs/cmis-component.adoc | 59 +-- .../src/main/docs/coap-component.adoc | 25 +- .../src/main/docs/cometd-component.adoc | 87 ++-- .../src/main/docs/consul-component.adoc | 73 +-- .../src/main/docs/context-component.adoc| 24 +- .../src/main/docs/couchbase-component.adoc | 156 ++ .../src/main/docs/couchdb-component.adoc| 52 +- .../src/main/docs/crypto-component.adoc | 79 ++- .../camel-cxf/src/main/docs/cxf-component.adoc | 127 ++--- .../src/main/docs/cxfrs-component.adoc | 109 ++-- .../src/main/docs/disruptor-component.adoc | 74 +-- .../camel-dns/src/main/docs/dns-component.adoc | 13 +- .../src/main/docs/docker-component.adoc | 80 ++- .../src/main/docs/dozer-component.adoc | 31 +-
[3/3] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/e43230a0 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e43230a0 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e43230a0 Branch: refs/heads/master Commit: e43230a01ed991a675c8adf173bf3c7867f76eb2 Parents: 1976565 Author: Claus IbsenAuthored: Fri Mar 17 16:53:17 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 16:53:17 2017 +0100 -- .../camel-jms/src/main/docs/jms-component.adoc | 336 +-- .../src/main/resources/component-options.mvel | 6 +- .../src/main/resources/endpoint-options.mvel| 12 +- 3 files changed, 177 insertions(+), 177 deletions(-) --
[1/3] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
Repository: camel Updated Branches: refs/heads/master 1976565d8 -> e43230a01 http://git-wip-us.apache.org/repos/asf/camel/blob/e43230a0/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index bd0e92d..9c7a82d 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -5,9 +5,9 @@ The @{title} component supports @{componentOptions.size()} options which are lis @end{} @if{!componentOptions.isEmpty()} -[width="100%",cols="2,^1,5,2",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Description | Type -@foreach{row : componentOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} +| Name | Description | Default | Type +@foreach{row : componentOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/e43230a0/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index bb743a8..2223a79 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -6,16 +6,16 @@ with the following path and query parameters: Path Parameters (@{endpointPathOptions.size()} parameters): -[width="100%",cols="2,^1,5,2",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Description | Type -@foreach{row : endpointPathOptions}| **@{row.getShortName(25)}** | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} +| Name | Description | Default | Type +@foreach{row : endpointPathOptions}| **@{row.getShortName(30)}** | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== Query Parameters (@{endpointOptions.size()} parameters): -[width="100%",cols="2,^1,5,2",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Description | Type -@foreach{row : endpointOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} +| Name | Description | Default | Type +@foreach{row : endpointOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|===
[2/3] camel git commit: Component docs - Adjust tables yet again. Almost there in github to make it read all description and default value without scrolling.
http://git-wip-us.apache.org/repos/asf/camel/blob/e43230a0/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index 6d3c30e..52cb2f6 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -203,84 +203,84 @@ The JMS component supports 75 options which are listed below. -[width="100%",cols="2,^1,5,2",options="header"] +[width="100%",cols="2,5,^1,2",options="header"] |=== -| Name | Default | Description | Type -| **configuration** (advanced) | | To use a shared JMS configuration | JmsConfiguration -| **acceptMessagesWhile Stopping** (consumer) | false | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. | boolean -| **allowReplyManagerQuick Stop** (consumer) | false | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | boolean -| **acknowledgementMode** (consumer) | | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. | int -| **eagerLoadingOf Properties** (consumer) | false | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties | boolean -| **acknowledgementModeName** (consumer) | AUTO_ ACKNOWLEDGE | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | String -| **autoStartup** (consumer) | true | Specifies whether the consumer container should auto-startup. | boolean -| **cacheLevel** (consumer) | | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | int -| **cacheLevelName** (consumer) | CACHE_AUTO | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. | String -| **replyToCacheLevelName** (producer) | | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. | String -| **clientId** (common) | | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. | String -| **concurrentConsumers** (consumer) | 1 | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. | int -| **replyToConcurrent Consumers** (producer) | 1 | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. | int -| **connectionFactory** (common) | | The connection factory to be use. A connection factory must be configured either on the
[3/3] camel git commit: Component docs - Adjust tables, lets try with description sooner
Component docs - Adjust tables, lets try with description sooner Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/1976565d Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1976565d Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1976565d Branch: refs/heads/master Commit: 1976565d8af17e6c3ea320ae4bed74fac380f183 Parents: 2f427ac Author: Claus IbsenAuthored: Fri Mar 17 16:34:28 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 16:37:35 2017 +0100 -- .../camel-jms/src/main/docs/jms-component.adoc | 336 +-- .../src/main/resources/component-options.mvel | 6 +- .../src/main/resources/endpoint-options.mvel| 12 +- 3 files changed, 177 insertions(+), 177 deletions(-) --
[2/3] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/1976565d/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index 563d9de..6d3c30e 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -203,84 +203,84 @@ The JMS component supports 75 options which are listed below. -[width="100%",cols="2,6,1,1",options="header"] +[width="100%",cols="2,^1,5,2",options="header"] |=== -| Name | Description | Default | Type -| **configuration** (advanced) | To use a shared JMS configuration | | JmsConfiguration -| **acceptMessagesWhileStopping** (consumer) | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. | false | boolean -| **allowReplyManagerQuickStop** (consumer) | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | false | boolean -| **acknowledgementMode** (consumer) | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. | | int -| **eagerLoadingOfProperties** (consumer) | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties | false | boolean -| **acknowledgementModeName** (consumer) | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | AUTO_ ACKNOWLEDGE | String -| **autoStartup** (consumer) | Specifies whether the consumer container should auto-startup. | true | boolean -| **cacheLevel** (consumer) | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | | int -| **cacheLevelName** (consumer) | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. | CACHE_AUTO | String -| **replyToCacheLevelName** (producer) | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. | | String -| **clientId** (common) | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. | | String -| **concurrentConsumers** (consumer) | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. | 1 | int -| **replyToConcurrentConsumers** (producer) | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. | 1 | int -| **connectionFactory** (common) | The connection factory to be use. A connection factory must be configured either
[1/3] camel git commit: Component docs - Adjust tables, lets try with description sooner
Repository: camel Updated Branches: refs/heads/master 2f427acba -> 1976565d8 http://git-wip-us.apache.org/repos/asf/camel/blob/1976565d/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index 26e9e91..bd0e92d 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -5,9 +5,9 @@ The @{title} component supports @{componentOptions.size()} options which are lis @end{} @if{!componentOptions.isEmpty()} -[width="100%",cols="2,6,1,1",options="header"] +[width="100%",cols="2,^1,5,2",options="header"] |=== -| Name | Description | Default | Type -@foreach{row : componentOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +| Name | Default | Description | Type +@foreach{row : componentOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/1976565d/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index 84b24f7..bb743a8 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -6,16 +6,16 @@ with the following path and query parameters: Path Parameters (@{endpointPathOptions.size()} parameters): -[width="100%",cols="2,6,1,1",options="header"] +[width="100%",cols="2,^1,5,2",options="header"] |=== -| Name | Description | Default | Type -@foreach{row : endpointPathOptions}| **@{row.getShortName(30)}** | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +| Name | Default | Description | Type +@foreach{row : endpointPathOptions}| **@{row.getShortName(25)}** | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|=== Query Parameters (@{endpointOptions.size()} parameters): -[width="100%",cols="2,6,1,1",options="header"] +[width="100%",cols="2,^1,5,2",options="header"] |=== -| Name | Description | Default | Type -@foreach{row : endpointOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} +| Name | Default | Description | Type +@foreach{row : endpointOptions}| **@{row.getShortName(25)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(18)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|===
[02/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-twitter/src/main/docs/twitter-component.adoc -- diff --git a/components/camel-twitter/src/main/docs/twitter-component.adoc b/components/camel-twitter/src/main/docs/twitter-component.adoc index fb9be54..f5e4905 100644 --- a/components/camel-twitter/src/main/docs/twitter-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-component.adoc @@ -47,27 +47,18 @@ The Twitter component supports 9 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| security -| accessToken | | String | The access token - -| accessTokenSecret | | String | The access token secret - -| consumerKey | | String | The consumer key - -| consumerSecret | | String | The consumer secret - 4+^s| proxy -| httpProxyHost | | String | The http proxy host which can be used for the camel-twitter. - -| httpProxyUser | | String | The http proxy user which can be used for the camel-twitter. - -| httpProxyPassword | | String | The http proxy password which can be used for the camel-twitter. - -| httpProxyPort | | int | The http proxy port which can be used for the camel-twitter. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **accessToken** (security) | The access token | | String +| **accessTokenSecret** (security) | The access token secret | | String +| **consumerKey** (security) | The consumer key | | String +| **consumerSecret** (security) | The consumer secret | | String +| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. | | String +| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. | | String +| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. | | String +| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. | | int +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -147,101 +138,59 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| kind | | String | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. +| Name | Description | Default | Type +| **kind** | *Required* What polling mode to use direct polling or event based. The event mode is only supported when the endpoint kind is event based. | | String |=== Query Parameters (42 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| user | | String | Username used for user timeline consumption direct message production etc. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| type | polling | EndpointType | Endpoint type to use. Only streaming supports event type. - 4+^s| consumer (advanced) -| distanceMetric | km | String | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. - -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if
[23/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-box/camel-box-component/src/main/docs/box-component.adoc -- diff --git a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc index 0cfa410..5bf460a 100644 --- a/components/camel-box/camel-box-component/src/main/docs/box-component.adoc +++ b/components/camel-box/camel-box-component/src/main/docs/box-component.adoc @@ -51,13 +51,11 @@ The Box component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| configuration | | BoxConfiguration | To use the shared configuration - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (common) | To use the shared configuration | | BoxConfiguration +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -70,58 +68,38 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| apiName | | BoxApiName | *Required* What kind of operation to perform -| methodName | | String | *Required* What sub operation to use for the selected operation +| Name | Description | Default | Type +| **apiName** | *Required* What kind of operation to perform | | BoxApiName +| **methodName** | *Required* What sub operation to use for the selected operation | | String |=== Query Parameters (20 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] -|=== -| Name | Default | Java Type | Description - -| clientId | | String | Box application client ID - -| enterpriseId | | String | The enterprise ID to use for an App Enterprise. - -| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body - -| userId | | String | The user ID to use for an App User. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| httpParams | | Map | Custom HTTP params for settings like proxy host - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| accessTokenCache | | IAccessTokenCache | Custom Access Token Cache for storing and retrieving access tokens. - -| clientSecret | | String | Box application client secret - -| encryptionAlgorithm | RSA_SHA_256 | EncryptionAlgorithm | The type of encryption algorithm for JWT. Supported Algorithms: RSA_SHA_256 RSA_SHA_384 RSA_SHA_512 - -| maxCacheEntries | 100 | int | The maximum number of access tokens in cache. - 4+^s| authentication -| authenticationType | APP_USER_AUTHENTICATION | String | The type of authentication for connection. Types of Authentication: STANDARD_AUTHENTICATION - OAuth 2.0 (3-legged) SERVER_AUTHENTICATION - OAuth 2.0 with JSON Web Tokens - 4+^s| security -| privateKeyFile | | String | The private key for generating the JWT signature. - -| privateKeyPassword | | String | The password for the private key. - -| publicKeyId | | String | The ID for public key for validating the
[14/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-jetty9/src/main/docs/jetty-component.adoc -- diff --git a/components/camel-jetty9/src/main/docs/jetty-component.adoc b/components/camel-jetty9/src/main/docs/jetty-component.adoc index b31d915..df33f99 100644 --- a/components/camel-jetty9/src/main/docs/jetty-component.adoc +++ b/components/camel-jetty9/src/main/docs/jetty-component.adoc @@ -56,73 +56,41 @@ The Jetty 9 component supports 32 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| security -| sslKeyPassword | | String | The key password which is used to access the certificate's key entry in the keystore (this is the same password that is supplied to the keystore command's -keypass option). - -| sslPassword | | String | The ssl password which is required to access the keystore file (this is the same password that is supplied to the keystore command's -storepass option). - -| keystore | | String | Specifies the location of the Java keystore file which contains the Jetty server's own X.509 certificate in a key entry. - 4+^s| advanced -| errorHandler | | ErrorHandler | This option is used to set the ErrorHandler that Jetty server uses. - 4+^s| security -| sslSocketConnectors | | Map | A map which contains per port number specific SSL connectors. - -| socketConnectors | | Map | A map which contains per port number specific HTTP connectors. Uses the same principle as sslSocketConnectors. - 4+^s| producer -| httpClientMinThreads | | Integer | To set a value for minimum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. - -| httpClientMaxThreads | | Integer | To set a value for maximum number of threads in HttpClient thread pool. Notice that both a min and max size must be configured. - 4+^s| consumer -| minThreads | | Integer | To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured. - -| maxThreads | | Integer | To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured. - 4+^s| consumer (advanced) -| threadPool | | ThreadPool | To use a custom thread pool for the server. This option should only be used in special circumstances. - 4+^s| common -| enableJmx | false | boolean | If this option is true Jetty JMX support will be enabled for this endpoint. - 4+^s| advanced -| jettyHttpBinding | | JettyHttpBinding | To use a custom org.apache.camel.component.jetty.JettyHttpBinding which are used to customize how a response should be written for the producer. - -| httpBinding | | HttpBinding | Not to be used - use JettyHttpBinding instead. - -| httpConfiguration | | HttpConfiguration | Jetty component does not use HttpConfiguration. - -| mbContainer | | MBeanContainer | To use a existing configured org.eclipse.jetty.jmx.MBeanContainer if JMX is enabled that Jetty uses for registering mbeans. - 4+^s| security -| sslSocketConnectorProperties | | Map | A map which contains general SSL connector properties. - -| socketConnectorProperties | | Map | A map which contains general HTTP connector properties. Uses the same principle as sslSocketConnectorProperties. - 4+^s| consumer -| continuationTimeout | 3 | Long | Allows to set a timeout in millis when using Jetty as consumer (server). By default Jetty uses 3. You can use a value of = 0 to never expire. If a timeout occurs then the request will be expired and Jetty will return back a http error 503 to the client. This option is only in use when using Jetty with the Asynchronous Routing Engine. - -| useContinuation | true | boolean | Whether or not to use Jetty continuations for the Jetty Server. - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| common -| responseBufferSize | | Integer | Allows to configure a custom value of the response buffer size on the Jetty connectors. - -| requestBufferSize | | Integer | Allows to configure a custom value of the request buffer size on the Jetty connectors. - -| requestHeaderSize | | Integer | Allows to configure a custom value of the request header size on the Jetty connectors. - -| responseHeaderSize | | Integer | Allows to configure a custom value of the response header size on the Jetty connectors. - 4+^s| proxy -| proxyHost | | String | To use a http proxy to configure the hostname. - -| proxyPort | | Integer | To use a http proxy to configure the port number. - 4+^s| common -| useXForwardedForHeader | false | boolean | To use the X-Forwarded-For header in HttpServletRequest.getRemoteAddr. - 4+^s| consumer -|
[12/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc -- diff --git a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc index 000b188..994b9ab 100644 --- a/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc +++ b/components/camel-kubernetes/src/main/docs/kubernetes-component.adoc @@ -51,71 +51,44 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| masterUrl | | String | *Required* Kubernetes Master url +| Name | Description | Default | Type +| **masterUrl** | *Required* Kubernetes Master url | | String |=== Query Parameters (27 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| apiVersion | | String | The Kubernetes API Version to use - -| category | | String | *Required* Kubernetes Producer and Consumer category - -| dnsDomain | | String | The dns domain used for ServiceCall EIP - -| kubernetesClient | | DefaultKubernetesClient | Default KubernetesClient to use if provided - -| portName | | String | The port name used for ServiceCall EIP - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| labelKey | | String | The Consumer Label key when watching at some resources - -| labelValue | | String | The Consumer Label value when watching at some resources - -| namespace | | String | The namespace - -| poolSize | 1 | int | The Consumer pool size - -| resourceName | | String | The Consumer Resource Name we would like to watch - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| operation | | String | Producer operation to do on Kubernetes - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| caCertData | | String | The CA Cert Data - -| caCertFile | | String | The CA Cert File - -| clientCertData | | String | The Client Cert Data - -| clientCertFile | | String | The Client Cert File - -| clientKeyAlgo | | String | The Key Algorithm used by the client - -| clientKeyData | | String | The Client Key data - -| clientKeyFile | | String | The Client Key file - -| clientKeyPassphrase | | String | The Client Key Passphrase - -| oauthToken | | String | The Auth Token - -| password | | String | Password to connect to Kubernetes - -| trustCerts | | Boolean | Define if the certs we used are trusted anyway or not - -| username | | String | Username to connect to Kubernetes +| Name | Description | Default | Type +| **apiVersion** (common) | The Kubernetes API Version to use | | String +| **category** (common) | *Required* Kubernetes Producer and Consumer category | | String +| **dnsDomain** (common) | The dns domain used for ServiceCall EIP | | String +| **kubernetesClient** (common) | Default KubernetesClient to use if provided | | DefaultKubernetesClient +| **portName** (common) | The port name used for ServiceCall EIP | | String +| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean +| **labelKey** (consumer) | The Consumer Label key when watching at some resources | | String +|
[29/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/camel-core/src/main/docs/file-component.adoc -- diff --git a/camel-core/src/main/docs/file-component.adoc b/camel-core/src/main/docs/file-component.adoc index 4e870ad..b0f9862 100644 --- a/camel-core/src/main/docs/file-component.adoc +++ b/camel-core/src/main/docs/file-component.adoc @@ -68,177 +68,97 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| directoryName | | File | *Required* The starting directory +| Name | Description | Default | Type +| **directoryName** | *Required* The starting directory | | File |=== Query Parameters (80 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| charset | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. - -| doneFileName | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. - -| fileName | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary s tore CamelFileName and have to restore it afterwards. - 4+^s| consumer -| bridgeErrorHandler | 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. - -| delete | false | boolean | If true the file will be deleted after it is processed successfully. - -| moveFailed | | String | Sets the move failure expression based on Simple language. For example to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. - -| noop | false | boolean | If true the file is not moved or deleted in any way. This option is good for readonly data or for ETL type requirements. If noop=true Camel will set idempotent=true as well to avoid consuming the same files over and over again. - -| preMove | | String | Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. - -| recursive | false | boolean | If a directory will look for files in all
[07/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc -- diff --git a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc index 623e40a..362ffbd 100644 --- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc @@ -53,133 +53,76 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| hostname | | String | *Required* The hostname of the running rabbitmq instance or cluster. -| portNumber | 5672 | int | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. -| exchangeName | | String | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. +| Name | Description | Default | Type +| **hostname** | *Required* The hostname of the running rabbitmq instance or cluster. | | String +| **portNumber** | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. | 5672 | int +| **exchangeName** | *Required* The exchange name determines which exchange produced messages will sent to. In the case of consumers the exchange name determines which exchange the queue will bind to. | | String |=== Query Parameters (57 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| autoDelete | true | boolean | If it is true the exchange will be deleted when it is no longer in use - -| connectionTimeout | 6 | int | Connection timeout - -| deadLetterExchange | | String | The name of the dead letter exchange - -| deadLetterExchangeType | direct | String | The type of the dead letter exchange - -| deadLetterQueue | | String | The name of the dead letter queue - -| deadLetterRoutingKey | | String | The routing key for the dead letter exchange - -| declare | true | boolean | If the option is true camel declare the exchange and queue name and bind them together. If the option is false camel won't declare the exchange and queue name on the server. - -| durable | true | boolean | If we are declaring a durable exchange (the exchange will survive a server restart) - -| exchangeType | direct | String | The exchange type such as direct or topic. - -| exclusive | false | boolean | Exclusive queues may only be accessed by the current connection and are deleted when that connection closes. - -| queue | | String | The queue to receive messages from - -| routingKey | | String | The routing key to use when binding a consumer queue to the exchange. For producer routing keys you set the header rabbitmq.ROUTING_KEY. - -| skipExchangeDeclare | false | boolean | This can be used if we need to declare the queue but not the exchange - -| skipQueueBind | false | boolean | If true the queue will not be bound to the exchange after declaring it - -| skipQueueDeclare | false | boolean | If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. - -| vhost | / | String | The vhost for the channel - 4+^s| consumer -| autoAck | true | boolean | If messages should be auto acknowledged - -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| concurrentConsumers | 1 | int | Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). - -| prefetchCount | | int | The maximum number of messages that the server will deliver 0 if unlimited. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - -| prefetchEnabled | false | boolean | Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize prefetchCount prefetchGlobal at the same time - -| prefetchGlobal | false | boolean | If the settings should be applied to the entire
[04/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-snmp/src/main/docs/snmp-component.adoc -- diff --git a/components/camel-snmp/src/main/docs/snmp-component.adoc b/components/camel-snmp/src/main/docs/snmp-component.adoc index e37146d..9749380 100644 --- a/components/camel-snmp/src/main/docs/snmp-component.adoc +++ b/components/camel-snmp/src/main/docs/snmp-component.adoc @@ -57,86 +57,52 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the SNMP enabled device -| port | | Integer | *Required* Port number of the SNMP enabled device +| Name | Description | Default | Type +| **host** | *Required* Hostname of the SNMP enabled device | | String +| **port** | *Required* Port number of the SNMP enabled device | | Integer |=== Query Parameters (34 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| delay | 6 | long | Sets update rate in seconds - -| oids | | String | Defines which values you are interested in. Please have a look at the Wikipedia to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids=1.3.6.1.2.1.1.3.01.3.6.1.2.1.25.3.2.1.5.11.3.6.1.2.1.25.3.5.1.1.11.3.6.1.2.1.43.5.1.1.11.1 - -| protocol | udp | String | Here you can select which protocol to use. You can use either udp or tcp. - -| retries | 2 | int | Defines how often a retry is made before canceling the request. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| snmpCommunity | public | String | Sets the community octet string for the snmp request. - -| snmpContextEngineId | | String | Sets the context engine ID field of the scoped PDU. - -| snmpContextName | | String | Sets the context name field of this scoped PDU. - -| snmpVersion | 0 | int | Sets the snmp version for the request. The value 0 means SNMPv1 1 means SNMPv2c and the value 3 means SNMPv3 - -| timeout | 1500 | int | Sets the timeout value for the request in millis. - -| type | | SnmpActionType | Which operation to perform such as poll trap etc. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. - -| initialDelay | 1000 | long |
[30/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
Component docs - Adjust tables, lets try with description sooner Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/bb3764e3 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bb3764e3 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bb3764e3 Branch: refs/heads/doc-table Commit: bb3764e39f0d0ec21cd87ad93f111a87a4bb9678 Parents: 2f427ac Author: Claus IbsenAuthored: Fri Mar 17 16:07:07 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 16:07:07 2017 +0100 -- camel-core/src/main/docs/bean-component.adoc| 25 +- camel-core/src/main/docs/binding-component.adoc | 24 +- camel-core/src/main/docs/browse-component.adoc | 22 +- camel-core/src/main/docs/class-component.adoc | 25 +- .../src/main/docs/controlbus-component.adoc | 27 +- .../src/main/docs/dataformat-component.adoc | 15 +- camel-core/src/main/docs/dataset-component.adoc | 67 +-- camel-core/src/main/docs/direct-component.adoc | 44 +- .../src/main/docs/direct-vm-component.adoc | 56 +-- camel-core/src/main/docs/file-component.adoc| 250 -- .../src/main/docs/language-component.adoc | 30 +- camel-core/src/main/docs/log-component.adoc | 95 ++-- camel-core/src/main/docs/mock-component.adoc| 40 +- .../src/main/docs/properties-component.adoc | 83 ++- camel-core/src/main/docs/ref-component.adoc | 22 +- .../src/main/docs/rest-api-component.adoc | 30 +- camel-core/src/main/docs/rest-component.adoc| 72 +-- .../src/main/docs/scheduler-component.adoc | 80 ++- camel-core/src/main/docs/seda-component.adoc| 74 +-- camel-core/src/main/docs/stub-component.adoc| 74 +-- camel-core/src/main/docs/test-component.adoc| 52 +- camel-core/src/main/docs/timer-component.adoc | 46 +- .../src/main/docs/validator-component.adoc | 53 +- camel-core/src/main/docs/vm-component.adoc | 74 +-- camel-core/src/main/docs/xslt-component.adoc| 92 ++-- .../src/main/docs/ahc-ws-component.adoc | 89 ++-- .../camel-ahc/src/main/docs/ahc-component.adoc | 74 +-- .../src/main/docs/amqp-component.adoc | 500 +++ .../src/main/docs/apns-component.adoc | 80 ++- .../src/main/docs/asterisk-component.adoc | 34 +- .../src/main/docs/atmos-component.adoc | 48 +- .../docs/atmosphere-websocket-component.adoc| 149 ++ .../src/main/docs/atom-component.adoc | 91 ++-- .../src/main/docs/avro-component.adoc | 56 +-- .../src/main/docs/aws-cw-component.adoc | 43 +- .../src/main/docs/aws-ddb-component.adoc| 49 +- .../src/main/docs/aws-ddbstream-component.adoc | 79 ++- .../src/main/docs/aws-ec2-component.adoc| 34 +- .../src/main/docs/aws-kinesis-component.adoc| 82 ++- .../docs/aws-kinesis-firehose-component.adoc| 16 +- .../src/main/docs/aws-s3-component.adoc | 130 ++--- .../src/main/docs/aws-sdb-component.adoc| 40 +- .../src/main/docs/aws-ses-component.adoc| 43 +- .../src/main/docs/aws-sns-component.adoc| 43 +- .../src/main/docs/aws-sqs-component.adoc| 142 ++ .../src/main/docs/aws-swf-component.adoc| 97 ++-- .../src/main/docs/azure-blob-component.adoc | 67 +-- .../src/main/docs/azure-queue-component.adoc| 40 +- .../src/main/docs/bean-validator-component.adoc | 28 +- .../src/main/docs/beanstalk-component.adoc | 98 ++-- .../src/main/docs/bonita-component.adoc | 37 +- .../src/main/docs/box-component.adoc| 84 ++-- .../src/main/docs/braintree-component.adoc | 61 +-- .../src/main/docs/cache-component.adoc | 83 ++- .../src/main/docs/cql-component.adoc| 58 +-- .../main/docs/chronicle-engine-component.adoc | 48 +- .../src/main/docs/chunk-component.adoc | 31 +- .../src/main/docs/cm-sms-component.adoc | 25 +- .../src/main/docs/cmis-component.adoc | 59 +-- .../src/main/docs/coap-component.adoc | 25 +- .../src/main/docs/cometd-component.adoc | 87 ++-- .../src/main/docs/consul-component.adoc | 73 +-- .../src/main/docs/context-component.adoc| 24 +- .../src/main/docs/couchbase-component.adoc | 156 ++ .../src/main/docs/couchdb-component.adoc| 52 +- .../src/main/docs/crypto-component.adoc | 79 ++- .../camel-cxf/src/main/docs/cxf-component.adoc | 127 ++--- .../src/main/docs/cxfrs-component.adoc | 109 ++-- .../src/main/docs/disruptor-component.adoc | 74 +-- .../camel-dns/src/main/docs/dns-component.adoc | 13 +- .../src/main/docs/docker-component.adoc | 80 ++- .../src/main/docs/dozer-component.adoc | 31 +- .../src/main/docs/drill-component.adoc | 25 +-
[18/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-ftp/src/main/docs/sftp-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc index aa3eb1f..fb4e5d4 100644 --- a/components/camel-ftp/src/main/docs/sftp-component.adoc +++ b/components/camel-ftp/src/main/docs/sftp-component.adoc @@ -38,236 +38,127 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the FTP server -| port | | int | Port of the FTP server -| directoryName | | String | The starting directory +| Name | Description | Default | Type +| **host** | *Required* Hostname of the FTP server | | String +| **port** | Port of the FTP server | | int +| **directoryName** | The starting directory | | String |=== Query Parameters (109 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| charset | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. - -| disconnect | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. - -| doneFileName | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. - -| fileName | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary s tore CamelFileName and have to restore it afterwards. - -| jschLoggingLevel | WARN | LoggingLevel | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. - -| separator | UNIX | PathSeparator | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name - 4+^s| common (advanced) -| fastExistsCheck | false | boolean | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be
[13/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-jsch/src/main/docs/scp-component.adoc -- diff --git a/components/camel-jsch/src/main/docs/scp-component.adoc b/components/camel-jsch/src/main/docs/scp-component.adoc index 24fc3df..13bf5a9 100644 --- a/components/camel-jsch/src/main/docs/scp-component.adoc +++ b/components/camel-jsch/src/main/docs/scp-component.adoc @@ -45,13 +45,11 @@ The SCP component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| producer -| verboseLogging | false | boolean | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **verboseLogging** (producer) | JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again. | false | boolean +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -72,57 +70,38 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the FTP server -| port | | int | Port of the FTP server -| directoryName | | String | The starting directory +| Name | Description | Default | Type +| **host** | *Required* Hostname of the FTP server | | String +| **port** | Port of the FTP server | | int +| **directoryName** | The starting directory | | String |=== Query Parameters (19 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| disconnect | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. - 4+^s| producer -| chmod | 664 | String | Allows you to set chmod on the stored file. For example chmod=664. - -| fileName | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary s tore CamelFileName and have to restore it afterwards. - -| flatten | false | boolean | 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. - -| strictHostKeyChecking | no | String | Sets whether to use strict host key checking. Possible values are: no yes - 4+^s| producer (advanced) -| allowNullBody | false | boolean | Used to specify if a null body is allowed during file writing. If set to true then an
[05/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-sjms/src/main/docs/sjms-batch-component.adoc -- diff --git a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc index 2a2cf47..08022ac 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc @@ -114,19 +114,14 @@ The Simple JMS Batch component supports 5 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsBatchComponent. - -| asyncStartListener | false | boolean | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. - -| recoveryInterval | 5000 | int | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. - 4+^s| filter -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **connectionFactory** (advanced) | A ConnectionFactory is required to enable the SjmsBatchComponent. | | ConnectionFactory +| **asyncStartListener** (advanced) | Whether to startup the consumer message listener asynchronously when starting a route. For example if a JmsConsumer cannot get a connection to a remote JMS broker then it may block while retrying and/or failover. This will cause Camel to block while starting routes. By setting this option to true you will let routes startup while the JmsConsumer connects to the JMS broker using a dedicated thread in asynchronous mode. If this option is used then beware that if the connection could not be established then an exception is logged at WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. | false | boolean +| **recoveryInterval** (advanced) | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. | 5000 | int +| **headerFilterStrategy** (filter) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -147,61 +142,39 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| destinationName | | String | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. +| Name | Description | Default | Type +| **destinationName** | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. | | String |=== Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| aggregationStrategy | | AggregationStrategy | *Required* The aggregation strategy to use which merges all the batched messages into a single message - -| allowNullBody | true | boolean | Whether to allow sending messages with no
[24/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc -- diff --git a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc index 1882a07..08727fd 100644 --- a/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc +++ b/components/camel-aws/src/main/docs/aws-kinesis-firehose-component.adoc @@ -43,21 +43,19 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| streamName | | String | *Required* Name of the stream +| Name | Description | Default | Type +| **streamName** | *Required* Name of the stream | | String |=== Query Parameters (2 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| amazonKinesisFirehoseClient | | AmazonKinesisFirehose | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **amazonKinesisFirehoseClient** (producer) | *Required* Amazon Kinesis Firehose client to use for all requests for this endpoint | | AmazonKinesisFirehose +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-aws/src/main/docs/aws-s3-component.adoc -- diff --git a/components/camel-aws/src/main/docs/aws-s3-component.adoc b/components/camel-aws/src/main/docs/aws-s3-component.adoc index 7c68df7..527e788 100644 --- a/components/camel-aws/src/main/docs/aws-s3-component.adoc +++ b/components/camel-aws/src/main/docs/aws-s3-component.adoc @@ -57,97 +57,57 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| bucketNameOrArn | | String | *Required* Bucket name or ARN +| Name | Description | Default | Type +| **bucketNameOrArn** | *Required* Bucket name or ARN | | String |=== Query Parameters (40 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| accessKey | | String | Amazon AWS Access Key - -| amazonS3Client | | AmazonS3 | Reference to a com.amazonaws.services.sqs.AmazonS3 in the link:registry.htmlRegistry. - -| amazonS3Endpoint | | String | The region with which the AWS-S3 client wants to work with. - -| pathStyleAccess | false | boolean | Whether or not the S3 client should use path style access - -| policy | | String | Camel 2.8.4: The policy for this queue to set in the com.amazonaws.services.s3.AmazonS3setBucketPolicy() method. - -| proxyHost | | String | Camel 2.16: To define a proxy host when instantiating the SQS client - -| proxyPort | | Integer | Camel 2.16: Specify a proxy port to be used inside the client definition. - -| secretKey | | String | Amazon AWS Secret Key - 4+^s| consumer -| autocloseBody | true | boolean | If this option is true and includeBody is true then the S3Object.close() method will be called on exchange completion This option is strongly related to includeBody option. In case of setting includeBody to true and autocloseBody to false it will be up to the caller to close the S3Object stream. Setting autocloseBody to true will close the S3Object stream automatically. - -| bridgeErrorHandler | 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
[06/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc -- diff --git a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc index 46583bc..60a9f11 100644 --- a/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc +++ b/components/camel-salesforce/camel-salesforce-component/src/main/docs/salesforce-component.adoc @@ -431,59 +431,34 @@ The Salesforce component supports 25 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| security -| loginConfig | | SalesforceLoginConfig | To use the shared SalesforceLoginConfig as login configuration - -| loginUrl | https://login.salesforce.com | String | Salesforce login URL defaults to https://login.salesforce.com - -| clientId | | String | Salesforce connected application Consumer Key - -| clientSecret | | String | Salesforce connected application Consumer Secret - -| keystore | | KeyStoreParameters | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. - -| refreshToken | | String | Salesforce connected application Consumer token - -| userName | | String | Salesforce account user name - -| password | | String | Salesforce account password - -| lazyLogin | false | boolean | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call - 4+^s| advanced -| config | | SalesforceEndpointConfig | To use the shared SalesforceEndpointConfig as endpoint configuration - -| httpClientProperties | | Map | Used for configuring HTTP client properties as key/value pairs - 4+^s| security -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters - 4+^s| proxy -| httpProxyHost | | String | To configure HTTP proxy host - -| httpProxyPort | | Integer | To configure HTTP proxy port - 4+^s| security -| httpProxyUsername | | String | To configure HTTP proxy username - -| httpProxyPassword | | String | To configure HTTP proxy password - 4+^s| proxy -| isHttpProxySocks4 | false | boolean | Enable for Socks4 proxy false by default - 4+^s| security -| isHttpProxySecure | false | boolean | Enable for TLS connections true by default - 4+^s| proxy -| httpProxyIncludedAddresses | | Set | HTTP proxy included addresses - -| httpProxyExcludedAddresses | | Set | HTTP proxy excluded addresses - 4+^s| security -| httpProxyAuthUri | | String | HTTP proxy authentication URI - -| httpProxyRealm | | String | HTTP proxy authentication realm - -| httpProxyUseDigestAuth | false | boolean | Use HTTP proxy Digest authentication false by default - 4+^s| common -| packages | | String[] | Package names to scan for DTO classes (multiple packages can be separated by comma). - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **loginConfig** (security) | To use the shared SalesforceLoginConfig as login configuration | | SalesforceLoginConfig +| **loginUrl** (security) | Salesforce login URL defaults to https://login.salesforce.com | https://login.salesforce.com | String +| **clientId** (security) | Salesforce connected application Consumer Key | | String +| **clientSecret** (security) | Salesforce connected application Consumer Secret | | String +| **keystore** (security) | KeyStoreParameters to use in OAuth 2.0 JWT Bearer Token Flow. | | KeyStoreParameters +| **refreshToken** (security) | Salesforce connected application Consumer token | | String +| **userName** (security) | Salesforce account user name | | String +| **password** (security) | Salesforce account password | | String +| **lazyLogin** (security) | Flag to enable/disable lazy OAuth default is false. When enabled OAuth token retrieval or generation is not done until the first API call | false | boolean +| **config** (advanced) | To use the shared SalesforceEndpointConfig as endpoint configuration | | SalesforceEndpoint Config +| **httpClientProperties** (advanced) | Used for configuring HTTP client properties as key/value pairs | | Map +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters +| **httpProxyHost** (proxy) | To configure HTTP proxy host | | String +| **httpProxyPort** (proxy) | To configure HTTP proxy port | | Integer +|
[21/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc -- diff --git a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc index bd0e135..224470a 100644 --- a/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc +++ b/components/camel-elasticsearch/src/main/docs/elasticsearch-component.adoc @@ -35,13 +35,11 @@ The Elasticsearch component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| client | | Client | To use an existing configured Elasticsearch client instead of creating a client per endpoint. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **client** (advanced) | To use an existing configured Elasticsearch client instead of creating a client per endpoint. | | Client +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -58,39 +56,28 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| clusterName | | String | *Required* Name of cluster or use local for local mode +| Name | Description | Default | Type +| **clusterName** | *Required* Name of cluster or use local for local mode | | String |=== Query Parameters (11 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| clientTransportSniff | true | Boolean | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. - -| consistencyLevel | DEFAULT | WriteConsistencyLevel | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) - -| data | | Boolean | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting. - -| indexName | | String | The name of the index to act against - -| indexType | | String | The type of the index to act against - -| ip | | String | The TransportClient remote host ip to use - -| operation | | String | What operation to perform - -| pathHome | ${user.home}/.elasticsearch | String | The path.home property of ElasticSearch configuration. You need to provide a valid path otherwise the default $user.home/.elasticsearch will be used. - -| port | 9300 | int | The TransportClient remote port to use (defaults to 9300) - -| transportAddresses | | String | Comma separated list with ip:port formatted remote transport addresses to use. The ip and port options must be left blank for transportAddresses to be considered instead. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **clientTransportSniff** (producer) | Is the client allowed to sniff the rest of the cluster or not (default true). This setting map to the client.transport.sniff setting. | true | Boolean +| **consistencyLevel** (producer) | The write consistency level to use with INDEX and BULK operations (can be any of ONE QUORUM ALL or DEFAULT) | DEFAULT | WriteConsistencyLevel +| **data** (producer) | Is the node going to be allowed to allocate data (shards) to it or not. This setting map to the node.data setting. | | Boolean +| **indexName** (producer) | The name of the index to act against | | String +| **indexType** (producer) | The type of the index to act against | | String +| **ip** (producer) | The TransportClient remote host ip to use | | String +| **operation** (producer) | What operation to perform | | String +| **pathHome** (producer) | The path.home property of ElasticSearch configuration. You need to provide a valid
[17/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc -- diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc index 085ff27..7deded4 100644 --- a/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc +++ b/components/camel-google-calendar/src/main/docs/google-calendar-component.adoc @@ -41,15 +41,12 @@ The Google Calendar component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| configuration | | GoogleCalendarConfiguration | To use the shared configuration - 4+^s| advanced -| clientFactory | | GoogleCalendarClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (common) | To use the shared configuration | | GoogleCalendar Configuration +| **clientFactory** (advanced) | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory | | GoogleCalendarClient Factory +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -69,46 +66,32 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| apiName | | GoogleCalendarApiName | *Required* What kind of operation to perform -| methodName | | String | *Required* What sub operation to use for the selected operation +| Name | Description | Default | Type +| **apiName** | *Required* What kind of operation to perform | | GoogleCalendarApiName +| **methodName** | *Required* What sub operation to use for the selected operation | | String |=== Query Parameters (14 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| accessToken | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. - -| applicationName | | String | Google calendar application name. Example would be camel-google-calendar/1.0 - -| clientId | | String | Client ID of the calendar application - -| clientSecret | | String | Client secret of the calendar application - -| emailAddress | | String | The emailAddress of the Google Service Account. - -| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body - -| p12FileName | | String | The name of the p12 file which has the private key to use with the Google Service Account. - -| refreshToken | | String | OAuth 2 refresh token. Using this the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. - -| scopes | https://www.googleapis.com/auth/calendar | String | Specifies the level of permissions you want a calendar application to have to a user account. You can separate multiple scopes by comma. See https://developers.google.com/google-apps/calendar/auth for more info. - -| user | | String | The email address of the user the application is trying to impersonate in the service account flow - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer
[25/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-apns/src/main/docs/apns-component.adoc -- diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc index 2b2fada..dc124e1 100644 --- a/components/camel-apns/src/main/docs/apns-component.adoc +++ b/components/camel-apns/src/main/docs/apns-component.adoc @@ -55,13 +55,11 @@ The APNS component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| apnsService | | ApnsService | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **apnsService** (common) | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService | | ApnsService +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -77,57 +75,37 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| name | | String | Name of the endpoint +| Name | Description | Default | Type +| **name** | Name of the endpoint | | String |=== Query Parameters (20 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| tokens | | String | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| scheduler -| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. - -| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. - -| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. - -| delay | 500 | long | Milliseconds before the next poll. You can also
[20/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-freemarker/src/main/docs/freemarker-component.adoc -- diff --git a/components/camel-freemarker/src/main/docs/freemarker-component.adoc b/components/camel-freemarker/src/main/docs/freemarker-component.adoc index cc69077..71c1c54 100644 --- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc +++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc @@ -43,13 +43,11 @@ The Freemarker component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | Configuration | To use an existing freemarker.template.Configuration instance as the configuration. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use an existing freemarker.template.Configuration instance as the configuration. | | Configuration +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -66,27 +64,22 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +| Name | Description | Default | Type +| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String |=== Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| configuration | | Configuration | Sets the Freemarker configuration to use - -| contentCache | false | boolean | Sets whether to use resource content cache or not - -| encoding | | String | Sets the encoding to be used for loading the template file. - -| templateUpdateDelay | | int | Number of seconds the loaded template resource will remain in the cache. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **configuration** (producer) | Sets the Freemarker configuration to use | | Configuration +| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean +| **encoding** (producer) | Sets the encoding to be used for loading the template file. | | String +| **templateUpdateDelay** (producer) | Number of seconds the loaded template resource will remain in the cache. | | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-ftp/src/main/docs/ftp-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc index 498acfb..826369f 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -87,223 +87,121 @@ with the following path and query
[03/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-sql/src/main/docs/sql-component.adoc -- diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc index 92dee04..696d74f 100644 --- a/components/camel-sql/src/main/docs/sql-component.adoc +++ b/components/camel-sql/src/main/docs/sql-component.adoc @@ -111,15 +111,12 @@ The SQL component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - 4+^s| advanced -| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource +| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true | true | boolean +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -135,107 +132,62 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| query | | String | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. +| Name | Description | Default | Type +| **query** | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. | | String |=== Query Parameters (45 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries. - -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - -| dataSourceRef | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. - -| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne. - -| outputHeader | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. - -| outputType | SelectList | SqlOutputType | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way: a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column then it will return a Map of that result. c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows it throws an non-unique result exception. - -| separator | , | char | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders. Notice if you use named parameters then a Map type is used instead. The default value is comma. - 4+^s| consumer -| breakBatchOnConsumeFail | false | boolean | Sets whether to break batch if onConsume failed. - -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the
[08/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc -- diff --git a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc index 8d206d5..89d9d03 100644 --- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc @@ -47,35 +47,26 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |=== Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| subsystem | | String | *Required* OpenStack Cinder subsystem - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default | String +| **operation** (producer) | The operation to do | | String +| **password** (producer) | *Required* OpenStack password | | String +| **project** (producer) | *Required* The project ID | | String +| **subsystem** (producer) | *Required* OpenStack Cinder subsystem | | String +| **username** (producer) | *Required* OpenStack username | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-openstack/src/main/docs/openstack-glance-component.adoc -- diff --git a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc index 1607f18..1de7294 100644 --- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc @@ -47,33 +47,25 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* OpenStack host url +| Name | Description | Default | Type +| **host** | *Required* OpenStack host url | | String |=== Query Parameters (8 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| apiVersion | V3 | String | OpenStack API version - -| config | | Config | OpenStack configuration - -| domain | default | String | Authentication domain - -| operation | | String | The operation to do - -| password | | String | *Required* OpenStack password - -| project | | String | *Required* The project ID - -| username | | String | *Required* OpenStack username - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **apiVersion** (producer) | OpenStack API version | V3 | String +| **config** (producer) | OpenStack configuration | | Config +| **domain** (producer) | Authentication domain | default |
[11/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-mllp/src/main/docs/mllp-component.adoc -- diff --git a/components/camel-mllp/src/main/docs/mllp-component.adoc b/components/camel-mllp/src/main/docs/mllp-component.adoc index 39493a2..63c324d 100644 --- a/components/camel-mllp/src/main/docs/mllp-component.adoc +++ b/components/camel-mllp/src/main/docs/mllp-component.adoc @@ -59,62 +59,40 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| hostname | | String | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address -| port | | int | *Required* Port number for the TCP connection +| Name | Description | Default | Type +| **hostname** | *Required* Hostname or IP for connection for the TCP connection. The default value is null which means any local IP address | | String +| **port** | *Required* Port number for the TCP connection | | int |=== Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| autoAck | true | boolean | Enable/Disable the automatic generation of a MLLP Acknowledgement MLLP Consumers only - -| bufferWrites | true | boolean | Enable/Disable the validation of HL7 Payloads If enabled MLLP Payloads are buffered and written to the external system in a single write(byte) operation. If disabled the MLLP payload will not be buffered and three write operations will be used. The first operation will write the MLLP start-of-block character 0x0b (ASCII VT) the second operation will write the HL7 payload and the third operation will writh the MLLP end-of-block character and the MLLP end-of-data character 0x1c 0x0d (ASCII FS CR). - -| hl7Headers | true | boolean | Enable/Disable the automatic generation of message headers from the HL7 Message MLLP Consumers only - -| keepAlive | true | boolean | Enable/disable the SO_KEEPALIVE socket option. - -| reuseAddress | false | boolean | Enable/disable the SO_REUSEADDR socket option. - -| tcpNoDelay | true | boolean | Enable/disable the TCP_NODELAY socket option. - -| validatePayload | false | boolean | Enable/Disable the validation of HL7 Payloads If enabled HL7 Payloads received from external systems will be validated (see Hl7Util.generateInvalidPayloadExceptionMessage for details on the validation). If and invalid payload is detected a MllpInvalidMessageException (for consumers) or a MllpInvalidAcknowledgementException will be thrown. - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| backlog | 5 | int | The maximum queue length for incoming connection indications (a request to connect) is set to the backlog parameter. If a connection indication arrives when the queue is full the connection is refused. - -| receiveBufferSize | | Integer | Sets the SO_RCVBUF option to the specified value (in bytes) - -| sendBufferSize | | Integer | Sets the SO_SNDBUF option to the specified value (in bytes) - -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| codec -| charsetName | | String | Set the CamelCharsetName property on the exchange - 4+^s| timeout -| acceptTimeout | 6 | int | Timeout (in milliseconds) while waiting for a TCP connection TCP Server Only - -| bindRetryInterval | 5000 | int | TCP Server Only - The number of milliseconds to wait between bind attempts - -| bindTimeout | 3 | int | TCP Server Only - The number of milliseconds to retry binding to a server port - -|
[10/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-nagios/src/main/docs/nagios-component.adoc -- diff --git a/components/camel-nagios/src/main/docs/nagios-component.adoc b/components/camel-nagios/src/main/docs/nagios-component.adoc index d36c76e..cf58abc 100644 --- a/components/camel-nagios/src/main/docs/nagios-component.adoc +++ b/components/camel-nagios/src/main/docs/nagios-component.adoc @@ -42,13 +42,11 @@ The Nagios component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | NagiosConfiguration | To use a shared NagiosConfiguration - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use a shared NagiosConfiguration | | NagiosConfiguration +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -67,30 +65,24 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* This is the address of the Nagios host where checks should be send. -| port | | int | *Required* The port number of the host. +| Name | Description | Default | Type +| **host** | *Required* This is the address of the Nagios host where checks should be send. | | String +| **port** | *Required* The port number of the host. | | int |=== Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| connectionTimeout | 5000 | int | Connection timeout in millis. - -| sendSync | true | boolean | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. - -| timeout | 5000 | int | Sending timeout in millis. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| encryptionMethod | | NagiosEncryptionMethod | To specify an encryption method. - -| password | | String | Password to be authenticated when sending checks to Nagios. +| Name | Description | Default | Type +| **connectionTimeout** (producer) | Connection timeout in millis. | 5000 | int +| **sendSync** (producer) | Whether or not to use synchronous when sending a passive check. Setting it to false will allow Camel to continue routing the message and the passive check message will be send asynchronously. | true | boolean +| **timeout** (producer) | Sending timeout in millis. | 5000 | int +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **encryptionMethod** (security) | To specify an encryption method. | | NagiosEncryptionMethod +| **password** (security) | Password to be authenticated when sending checks to Nagios. | | String |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-nats/src/main/docs/nats-component.adoc -- diff --git a/components/camel-nats/src/main/docs/nats-component.adoc b/components/camel-nats/src/main/docs/nats-component.adoc index 9852eca..fd0e718 100644 --- a/components/camel-nats/src/main/docs/nats-component.adoc +++ b/components/camel-nats/src/main/docs/nats-component.adoc @@ -46,61 +46,39 @@ with the following path and query parameters: Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java
[16/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc -- diff --git a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc index 86a92a8..03e5af3 100644 --- a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc +++ b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc @@ -57,13 +57,11 @@ The HDFS2 component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| jAASConfiguration | | Configuration | To use the given configuration for security with JAAS. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **jAASConfiguration** (common) | To use the given configuration for security with JAAS. | | Configuration +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -81,95 +79,57 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| hostName | | String | *Required* HDFS host to use -| port | 8020 | int | HDFS port to use -| path | | String | *Required* The directory path to use +| Name | Description | Default | Type +| **hostName** | *Required* HDFS host to use | | String +| **port** | HDFS port to use | 8020 | int +| **path** | *Required* The directory path to use | | String |=== Query Parameters (38 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| connectOnStartup | true | boolean | Whether to connect to the HDFS file system on starting the producer/consumer. If false then the connection is created on-demand. Notice that HDFS may take up till 15 minutes to establish a connection as it has hardcoded 45 x 20 sec redelivery. By setting this option to false allows your application to startup and not block for up till 15 minutes. - -| fileSystemType | HDFS | HdfsFileSystemType | Set to LOCAL to not use HDFS but local java.io.File instead. - -| fileType | NORMAL_FILE | HdfsFileType | The file type to use. For more details see Hadoop HDFS documentation about the various files types. - -| keyType | NULL | WritableType | The type for the key in case of sequence or map files. - -| owner | | String | The file owner must match this owner for the consumer to pickup the file. Otherwise the file is skipped. - -| valueType | BYTES | WritableType | The type for the key in case of sequence or map files - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| delay | 1000 | long | The interval (milliseconds) between the directory scans. - -| initialDelay | 1 | long | For the consumer how much to wait (milliseconds) before to start scanning the directory. - -| pattern | * | String | The pattern used for scanning the directory - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - -| pollStrategy | | PollingConsumerPollStrategy | A pluggable
[22/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/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 143184f..53b7d42 100644 --- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc +++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc @@ -56,44 +56,32 @@ with the following path and query parameters: Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use for communicating with the database. -| hostname | | String | *Required* Hostname of the running couchdb instance -| port | 5984 | int | Port number for the running couchdb instance -| database | | String | *Required* Name of the database to use +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use for communicating with the database. | | String +| **hostname** | *Required* Hostname of the running couchdb instance | | String +| **port** | Port number for the running couchdb instance | 5984 | int +| **database** | *Required* Name of the database to use | | String |=== Query Parameters (12 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| createDatabase | false | boolean | Creates the database if it does not already exist - 4+^s| consumer -| bridgeErrorHandler | 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 or ERROR level and ignored. - -| deletes | true | boolean | Document deletes are published as events - -| heartbeat | 3 | long | How often to send an empty message to keep socket alive in millis - -| since | | String | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. - -| style | 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 | true | boolean | Document inserts/updates are published as events - 4+^s| consumer (advanced) -| exceptionHandler | | 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 or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). - 4+^s| security -| password | | String | Password for authenticated databases - -| username | | String | Username in case of authenticated databases +| Name | Description | Default | Type +| **createDatabase** (common) | Creates the database if it does not already exist | false | boolean +| **bridgeErrorHandler** (consumer) | 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 or ERROR level and ignored. | false | boolean +| **deletes** (consumer) | Document deletes are published as events | true | boolean +| **heartbeat** (consumer) | How often to send an empty message to keep socket alive in millis | 3 | long +| **since** (consumer) | Start tracking changes immediately after the given update sequence. The default null will start monitoring from the latest sequence. | | String +| **style** (consumer) | 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
[01/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
Repository: camel Updated Branches: refs/heads/doc-table [created] bb3764e39 http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc -- diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc index 1e3bab5..e1ebcd0 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc @@ -229,15 +229,12 @@ The XML Security component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| signerConfiguration | | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. - -| verifierConfiguration | | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **signerConfiguration** (advanced) | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. | | XmlSignerConfiguration +| **verifierConfiguration** (advanced) | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. | | XmlVerifier Configuration +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -258,88 +255,53 @@ with the following path and query parameters: Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| command | | XmlCommand | *Required* Whether to sign or verify. -| name | | String | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. +| Name | Description | Default | Type +| **command** | *Required* Whether to sign or verify. | | XmlCommand +| **name** | *Required* The name part in the URI can be chosen by the user to distinguish between different signer/verifier endpoints within the camel context. | | String |=== Query Parameters (35 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| common -| baseUri | | String | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. - -| clearHeaders | true | Boolean | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. - -| cryptoContextProperties | | Map | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference - -| disallowDoctypeDecl | true | Boolean | Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is link BooleanTRUE. - -| omitXmlDeclaration | false | Boolean | Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION. - -| outputXmlEncoding | | String | The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used. - -| schemaResourceUri | | String | Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes might be set in the enveloped and enveloping case. If set then the XML document is validated with the specified
[19/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-ftp/src/main/docs/ftps-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc index 8e4d75c..60a2629 100644 --- a/components/camel-ftp/src/main/docs/ftps-component.adoc +++ b/components/camel-ftp/src/main/docs/ftps-component.adoc @@ -38,238 +38,128 @@ with the following path and query parameters: Path Parameters (3 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| host | | String | *Required* Hostname of the FTP server -| port | | int | Port of the FTP server -| directoryName | | String | The starting directory +| Name | Description | Default | Type +| **host** | *Required* Hostname of the FTP server | | String +| **port** | Port of the FTP server | | int +| **directoryName** | The starting directory | | String |=== Query Parameters (110 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| binary | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false). - -| charset | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. - -| disconnect | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. - -| doneFileName | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. - -| fileName | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary s tore CamelFileName and have to restore it afterwards. - -| passiveMode | false | boolean | Sets passive mode connections. Default is active mode connections. - -| separator | UNIX | PathSeparator | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name - 4+^s| common (advanced) -| fastExistsCheck | false | boolean | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file
[09/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc -- 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 d687bdf..43b382f 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 @@ -79,23 +79,16 @@ The Netty4 HTTP component supports 7 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. - 4+^s| common -| configuration | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. - 4+^s| advanced -| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. - 4+^s| security -| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. - 4+^s| advanced -| maximumPoolSize | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. - -| executorService | | EventExecutorGroup | To use the given EventExecutorGroup - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **nettyHttpBinding** (advanced) | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. | | NettyHttpBinding +| **configuration** (common) | To use the NettyConfiguration as configuration when creating endpoints. | | NettyHttpConfiguration +| **headerFilterStrategy** (advanced) | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. | | HeaderFilterStrategy +| **securityConfiguration** (security) | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. | | NettyHttpSecurity Configuration +| **maximumPoolSize** (advanced) | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. | 16 | int +| **executorService** (advanced) | To use the given EventExecutorGroup | | EventExecutorGroup +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |=== // component options: END @@ -117,178 +110,99 @@ with the following path and query parameters: Path Parameters (4 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -| protocol | | String | *Required* The protocol to use which is either http or https -| host | | String | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. -| port | | int | The host port number -| path | | String | Resource path +| Name | Description | Default | Type +| **protocol** | *Required* The protocol to use which is either http or https | | String +| **host** | *Required* The local hostname such as localhost or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer. | | String +| **port** | The host port number | | int +| **path** | Resource path | | String |=== Query Parameters (79 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - -| bridgeEndpoint | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and
[26/30] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-amqp/src/main/docs/amqp-component.adoc -- diff --git a/components/camel-amqp/src/main/docs/amqp-component.adoc b/components/camel-amqp/src/main/docs/amqp-component.adoc index 391de32..c9c07d9 100644 --- a/components/camel-amqp/src/main/docs/amqp-component.adoc +++ b/components/camel-amqp/src/main/docs/amqp-component.adoc @@ -38,165 +38,88 @@ link:../../../../camel-jms/src/main/docs/readme.html[JMS] component after the de // component options: START -The AMQP component supports 76 options which are listed below. +The AMQP component supports 75 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | JmsConfiguration | To use a shared JMS configuration - 4+^s| consumer (advanced) -| acceptMessagesWhileStopping | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. - -| allowReplyManagerQuickStop | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. - 4+^s| consumer -| acknowledgementMode | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode.For the regular modes it is preferable to use the acknowledgementModeName instead. - 4+^s| consumer (advanced) -| eagerLoadingOfProperties | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties - 4+^s| consumer -| acknowledgementModeName | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE - -| autoStartup | true | boolean | Specifies whether the consumer container should auto-startup. - -| cacheLevel | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. - -| cacheLevelName | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. - 4+^s| producer (advanced) -| replyToCacheLevelName | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. - 4+^s| common -| clientId | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. - 4+^s| consumer -| concurrentConsumers | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. - 4+^s| producer -| replyToConcurrentConsumers | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the
[1/3] camel git commit: Component docs - Adjust tables, lets try with description sooner
Repository: camel Updated Branches: refs/heads/master 844f309a1 -> 2f427acba http://git-wip-us.apache.org/repos/asf/camel/blob/2f427acb/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index 8e22fdf..26e9e91 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -5,9 +5,9 @@ The @{title} component supports @{componentOptions.size()} options which are lis @end{} @if{!componentOptions.isEmpty()} -[width="100%",cols="2,1,6,1",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Description | Java Type -@foreach{row : componentOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(20)} | @{row.description} | @{row.getShortJavaType(25)} +| Name | Description | Default | Type +@foreach{row : componentOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/2f427acb/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index f7504ee..84b24f7 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -6,16 +6,16 @@ with the following path and query parameters: Path Parameters (@{endpointPathOptions.size()} parameters): -[width="100%",cols="2,1,6,1",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -@foreach{row : endpointPathOptions}| **@{row.getShortName(30)}** | @{row.getShortDefaultValue(20)} | @{row.description} | @{row.getShortJavaType(25)} +| Name | Description | Default | Type +@foreach{row : endpointPathOptions}| **@{row.getShortName(30)}** | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|=== Query Parameters (@{endpointOptions.size()} parameters): -[width="100%",cols="2,1,6,1",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Java Type | Description -@foreach{row : endpointOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(20)} | @{row.description} | @{row.getShortJavaType(25)} +| Name | Description | Default | Type +@foreach{row : endpointOptions}| **@{row.getShortName(30)}** (@{row.shortGroup}) | @{row.description} | @{row.getShortDefaultValue(20)} | @{row.getShortJavaType(25)} @end{}|===
[2/3] camel git commit: Component docs - Adjust tables, lets try with description sooner
http://git-wip-us.apache.org/repos/asf/camel/blob/2f427acb/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index a0d50b2..563d9de 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -203,84 +203,84 @@ The JMS component supports 75 options which are listed below. -[width="100%",cols="2,1,6,1",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |=== -| Name | Default | Description | Java Type -| **configuration** (advanced) | | To use a shared JMS configuration | JmsConfiguration -| **acceptMessagesWhileStopping** (consumer) | false | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. | boolean -| **allowReplyManagerQuickStop** (consumer) | false | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | boolean -| **acknowledgementMode** (consumer) | | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. | int -| **eagerLoadingOfProperties** (consumer) | false | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties | boolean -| **acknowledgementModeName** (consumer) | AUTO_ ACKNOWLEDGE | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | String -| **autoStartup** (consumer) | true | Specifies whether the consumer container should auto-startup. | boolean -| **cacheLevel** (consumer) | | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | int -| **cacheLevelName** (consumer) | CACHE_AUTO | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. | String -| **replyToCacheLevelName** (producer) | | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. | String -| **clientId** (common) | | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. | String -| **concurrentConsumers** (consumer) | 1 | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. | int -| **replyToConcurrentConsumers** (producer) | 1 | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. | int -| **connectionFactory** (common) | | The connection factory to be use. A connection factory must be configured either on the
camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
Repository: camel Updated Branches: refs/heads/master 70ec4ac4f -> 844f309a1 Component docs - Adjust tables as the previous attempt did not look so good. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/844f309a Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/844f309a Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/844f309a Branch: refs/heads/master Commit: 844f309a14fdc68cbbba743a7aaaf8845c6fdc18 Parents: 70ec4ac Author: Claus IbsenAuthored: Fri Mar 17 13:59:58 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 13:59:58 2017 +0100 -- .../camel-jms/src/main/docs/jms-component.adoc | 34 ++-- .../src/main/resources/component-options.mvel | 2 +- .../src/main/resources/endpoint-options.mvel| 4 +-- 3 files changed, 20 insertions(+), 20 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/844f309a/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index d15d6ff..a0d50b2 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -234,15 +234,15 @@ The JMS component supports 75 options which are listed below. | **idleTaskExecutionLimit** (advanced) | 1 | Specifies the limit for idle executions of a receive task not having received any message within its execution. If this limit is reached the task will shut down and leave receiving to other executing tasks (in the case of dynamic scheduling; see the maxConcurrentConsumers setting). There is additional doc available from Spring. | int | **idleConsumerLimit** (advanced) | 1 | Specify the limit for the number of consumers that are allowed to be idle at any given time. | int | **maxConcurrentConsumers** (consumer) | | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. | int -| **replyToMaxConcurrentConsumers** (producer) | | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. | int -| **replyOnTimeoutToMaxConcurrent Consumers** (producer) | 1 | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS. | int +| **replyToMaxConcurrent Consumers** (producer) | | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. | int +| **replyOnTimeoutToMax ConcurrentConsumers** (producer) | 1 | Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS. | int | **maxMessagesPerTask** (advanced) | -1 | The number of messages per task. -1 is unlimited. If you use a range for concurrent consumers (eg min max) then this option can be used to set a value to eg 100 to control how fast the consumers will shrink when less work is required. | int | **messageConverter** (advanced) | | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message. | MessageConverter | **mapJmsMessage** (advanced) | true | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. | boolean | **messageIdEnabled** (advanced) | true | When sending specifies whether message IDs should be added. This is just an hint to the JMS Broker. If the JMS provider accepts this hint these messages must have the message ID set to null; if the provider ignores the hint the message ID must be set to its normal unique value | boolean | **messageTimestampEnabled** (advanced) | true | Specifies whether timestamps should be enabled by default on sending messages. | boolean | **alwaysCopyMessage** (producer) | false | If true Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations such as when a replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a
[2/3] camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
http://git-wip-us.apache.org/repos/asf/camel/blob/70ec4ac4/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index 7fd64d8..d15d6ff 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -203,84 +203,84 @@ The JMS component supports 75 options which are listed below. -[width="100%",cols="2,1,1,6",options="header"] +[width="100%",cols="2,1,6,1",options="header"] |=== -| Name | Default | Java Type | Description -| **configuration** (advanced) | | JmsConfiguration | To use a shared JMS configuration -| **acceptMessagesWhileStopping** (consumer) | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. -| **allowReplyManagerQuickStop** (consumer) | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. -| **acknowledgementMode** (consumer) | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. -| **eagerLoadingOfProperties** (consumer) | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties -| **acknowledgementModeName** (consumer) | AUTO_ ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE -| **autoStartup** (consumer) | true | boolean | Specifies whether the consumer container should auto-startup. -| **cacheLevel** (consumer) | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. -| **cacheLevelName** (consumer) | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. -| **replyToCacheLevelName** (producer) | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. -| **clientId** (common) | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. -| **concurrentConsumers** (consumer) | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. -| **replyToConcurrentConsumers** (producer) | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. -| **connectionFactory** (common) | | ConnectionFactory | The connection factory to be use. A connection factory must be
[1/3] camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
Repository: camel Updated Branches: refs/heads/master 03d2a09c9 -> 70ec4ac4f http://git-wip-us.apache.org/repos/asf/camel/blob/70ec4ac4/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel index 8220e10..4efc7dd 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/component-options.mvel @@ -5,9 +5,9 @@ The @{title} component supports @{componentOptions.size()} options which are lis @end{} @if{!componentOptions.isEmpty()} -[width="100%",cols="2,1,1,6",options="header"] +[width="100%",cols="2,1,6,1",options="header"] |=== -| Name | Default | Java Type | Description -@foreach{row : componentOptions}| **@{row.getShortName(35)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(25)} | @{row.getShortJavaType(25)} | @{row.description} +| Name | Default | Description | Java Type +@foreach{row : componentOptions}| **@{row.getShortName(35)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(25)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|=== @end{} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/70ec4ac4/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel index 7617962..f49cbe4 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel +++ b/tooling/maven/camel-package-maven-plugin/src/main/resources/endpoint-options.mvel @@ -6,16 +6,16 @@ with the following path and query parameters: Path Parameters (@{endpointPathOptions.size()} parameters): -[width="100%",cols="2,1,1,6",options="header"] +[width="100%",cols="2,1,6,1",options="header"] |=== | Name | Default | Java Type | Description -@foreach{row : endpointPathOptions}| **@{row.getShortName(35)}** | @{row.getShortDefaultValue(25)} | @{row.getShortJavaType(25)} | @{row.description} +@foreach{row : endpointPathOptions}| **@{row.getShortName(35)}** | @{row.getShortDefaultValue(25)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|=== Query Parameters (@{endpointOptions.size()} parameters): -[width="100%",cols="2,1,1,6",options="header"] +[width="100%",cols="2,1,6,1",options="header"] |=== | Name | Default | Java Type | Description -@foreach{row : endpointOptions}| **@{row.getShortName(35)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(25)} | @{row.getShortJavaType(25)} | @{row.description} +@foreach{row : endpointOptions}| **@{row.getShortName(35)}** (@{row.shortGroup}) | @{row.getShortDefaultValue(25)} | @{row.description} | @{row.getShortJavaType(25)} @end{}|===
camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
Repository: camel Updated Branches: refs/heads/master fc4b5678c -> 03d2a09c9 Component docs - Adjust tables as the previous attempt did not look so good. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/03d2a09c Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/03d2a09c Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/03d2a09c Branch: refs/heads/master Commit: 03d2a09c99139430bcab980dddf2293e6eb3352c Parents: fc4b567 Author: Claus IbsenAuthored: Fri Mar 17 13:47:57 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 13:47:57 2017 +0100 -- components/camel-jms/src/main/docs/jms-component.adoc | 4 ++-- .../camel/maven/packaging/model/ComponentOptionModel.java | 6 ++ .../camel/maven/packaging/model/EndpointOptionModel.java | 6 ++ 3 files changed, 14 insertions(+), 2 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/03d2a09c/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index 0100588..7fd64d8 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -211,7 +211,7 @@ The JMS component supports 75 options which are listed below. | **allowReplyManagerQuickStop** (consumer) | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | **acknowledgementMode** (consumer) | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. | **eagerLoadingOfProperties** (consumer) | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties -| **acknowledgementModeName** (consumer) | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE +| **acknowledgementModeName** (consumer) | AUTO_ ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | **autoStartup** (consumer) | true | boolean | Specifies whether the consumer container should auto-startup. | **cacheLevel** (consumer) | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. | **cacheLevelName** (consumer) | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. @@ -328,7 +328,7 @@ with the following path and query parameters: | **durableSubscriptionName** (common) | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. | **jmsMessageType** (common) | | JmsMessageType | Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes Map Object Stream Text. By default Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. | **testConnectionOnStartup** (common) | false | boolean | Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. -| **acknowledgementModeName** (consumer) | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE +| **acknowledgementModeName** (consumer) | AUTO_ ACKNOWLEDGE | String | The JMS acknowledgement name which is one
camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
Repository: camel Updated Branches: refs/heads/master 572a09eb7 -> fc4b5678c Component docs - Adjust tables as the previous attempt did not look so good. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/fc4b5678 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/fc4b5678 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/fc4b5678 Branch: refs/heads/master Commit: fc4b5678c298d266b7fab8397361078009c0023e Parents: 572a09e Author: Claus IbsenAuthored: Fri Mar 17 13:41:53 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 13:42:18 2017 +0100 -- .../camel-jms/src/main/docs/jms-component.adoc | 166 +-- .../camel/maven/packaging/StringHelper.java | 15 +- .../packaging/model/ComponentOptionModel.java | 28 +++- .../packaging/model/EndpointOptionModel.java| 26 ++- .../src/main/resources/component-options.mvel | 2 +- .../src/main/resources/endpoint-options.mvel| 4 +- 6 files changed, 141 insertions(+), 100 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/fc4b5678/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index 901e76e..0100588 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -207,12 +207,12 @@ The JMS component supports 75 options which are listed below. |=== | Name | Default | Java Type | Description | **configuration** (advanced) | | JmsConfiguration | To use a shared JMS configuration -| **acceptMessagesWhileStopping** (consumer) | False | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. -| **allowReplyManagerQuickStop** (consumer) | False | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. +| **acceptMessagesWhileStopping** (consumer) | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. +| **allowReplyManagerQuickStop** (consumer) | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. | **acknowledgementMode** (consumer) | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. -| **eagerLoadingOfProperties** (consumer) | False | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties +| **eagerLoadingOfProperties** (consumer) | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any
[4/4] camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
Component docs - Adjust tables as the previous attempt did not look so good. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/1f50c729 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1f50c729 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1f50c729 Branch: refs/heads/master Commit: 1f50c7291f73a0738b8f5e13481cd550ed639f57 Parents: 0b074a7 Author: Claus IbsenAuthored: Fri Mar 17 12:10:22 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 13:16:54 2017 +0100 -- .../tools/apt/EndpointAnnotationProcessor.java | 3 +- .../maven/camel-package-maven-plugin/pom.xml| 7 ++ .../camel/maven/packaging/StringHelper.java | 74 .../packaging/model/ComponentOptionModel.java | 28 .../packaging/model/EndpointOptionModel.java| 26 +++ .../src/main/resources/component-options.mvel | 3 +- .../src/main/resources/endpoint-options.mvel| 5 +- 7 files changed, 140 insertions(+), 6 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/1f50c729/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java -- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java index 561dce8..3c7a381 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java @@ -452,7 +452,8 @@ public class EndpointAnnotationProcessor extends AbstractProcessor { } // skip unwanted methods as they are inherited from default component and are not intended for end users to configure -if ("setEndpointClass".equals(methodName) || "setCamelContext".equals(methodName) || "setEndpointHeaderFilterStrategy".equals(methodName)) { +if ("setEndpointClass".equals(methodName) || "setCamelContext".equals(methodName) +|| "setEndpointHeaderFilterStrategy".equals(methodName) || "setApplicationContext".equals(methodName)) { continue; } http://git-wip-us.apache.org/repos/asf/camel/blob/1f50c729/tooling/maven/camel-package-maven-plugin/pom.xml -- diff --git a/tooling/maven/camel-package-maven-plugin/pom.xml b/tooling/maven/camel-package-maven-plugin/pom.xml index c702518..24bbc02 100644 --- a/tooling/maven/camel-package-maven-plugin/pom.xml +++ b/tooling/maven/camel-package-maven-plugin/pom.xml @@ -105,6 +105,13 @@ ${asciidoctorj-version} + + + com.google.guava + guava + ${google-guava-version} + + org.jboss.forge.roaster http://git-wip-us.apache.org/repos/asf/camel/blob/1f50c729/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/StringHelper.java -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/StringHelper.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/StringHelper.java index d7829ae..2f0dfcd 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/StringHelper.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/StringHelper.java @@ -18,6 +18,8 @@ package org.apache.camel.maven.packaging; import java.util.Collection; +import com.google.common.base.CaseFormat; + public final class StringHelper { private StringHelper() { @@ -97,4 +99,76 @@ public final class StringHelper { return answer; } +/** + * To wrap long camel cased texts by words. + * + * @param option the option which is camel cased. + * @param watermark a watermark to denote the size to cut after + * @param newLine the new line to use when breaking into a new line + */ +public static String wrapCamelCaseWords(String option, int watermark, String newLine) { +String text = CaseFormat.UPPER_CAMEL.to(CaseFormat.LOWER_HYPHEN, option); +text = text.replace('-', ' '); +text = wrapWords(text, "\n", watermark, false); +text = text.replace(' ', '-'); +text = CaseFormat.LOWER_HYPHEN.to(CaseFormat.UPPER_CAMEL, text); +text = text.replaceAll("\\n", newLine); +return text; +} + +/** + * To wrap a big line by words. + * + * @param line the big
[3/4] camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
Component docs - Adjust tables as the previous attempt did not look so good. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/2f9773e2 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2f9773e2 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2f9773e2 Branch: refs/heads/master Commit: 2f9773e24e6ccb9f4127e44ac3bf742bbf8317ed Parents: 1f50c72 Author: Claus IbsenAuthored: Fri Mar 17 13:16:40 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 13:16:54 2017 +0100 -- .../camel-jms/src/main/docs/jms-component.adoc | 494 +++ .../springboot/JmsComponentConfiguration.java | 13 - .../src/main/resources/component-options.mvel | 2 +- .../src/main/resources/endpoint-options.mvel| 4 +- 4 files changed, 169 insertions(+), 344 deletions(-) --
[2/4] camel git commit: Component docs - Adjust tables as the previous attempt did not look so good.
http://git-wip-us.apache.org/repos/asf/camel/blob/2f9773e2/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index f7a9893..901e76e 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -199,165 +199,88 @@ about these properties by consulting the relevant Spring documentation. // component options: START -The JMS component supports 76 options which are listed below. +The JMS component supports 75 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,1,1,6",options="header"] |=== | Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | JmsConfiguration | To use a shared JMS configuration - 4+^s| consumer (advanced) -| acceptMessagesWhileStopping | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. - -| allowReplyManagerQuickStop | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. - 4+^s| consumer -| acknowledgementMode | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. - 4+^s| consumer (advanced) -| eagerLoadingOfProperties | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties - 4+^s| consumer -| acknowledgementModeName | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE - -| autoStartup | true | boolean | Specifies whether the consumer container should auto-startup. - -| cacheLevel | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. - -| cacheLevelName | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. - 4+^s| producer (advanced) -| replyToCacheLevelName | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. - 4+^s| common -| clientId | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. - 4+^s| consumer -| concurrentConsumers | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. - 4+^s| producer -| replyToConcurrentConsumers | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to
[23/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-cxf/src/main/docs/cxf-component.adoc -- diff --git a/components/camel-cxf/src/main/docs/cxf-component.adoc b/components/camel-cxf/src/main/docs/cxf-component.adoc index c3b8f69..95fbc89 100644 --- a/components/camel-cxf/src/main/docs/cxf-component.adoc +++ b/components/camel-cxf/src/main/docs/cxf-component.adoc @@ -116,12 +116,15 @@ The CXF component supports 3 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| allowStreaming | advanced | | Boolean | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| allowStreaming | | Boolean | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow streaming in some cases. + 4+^s| filter +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |=== // component options: END @@ -147,43 +150,77 @@ with the following path and query parameters: Query Parameters (34 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| dataFormat | common | POJO | DataFormat | The data type messages supported by the CXF endpoint. -| wrappedStyle | common | | Boolean | The WSDL style that describes how parameters are represented in the SOAP body. If the value is false CXF will chose the document-literal unwrapped style If the value is true CXF will chose the document-literal wrapped style -| 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 or 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| cookieHandler | producer | | CookieHandler | Configure a cookie handler to maintain a HTTP session -| defaultOperationName | producer | | String | This option will set the default operationName that will be used by the CxfProducer which invokes the remote service. -| defaultOperationNamespace | producer | | String | This option will set the default operationNamespace that will be used by the CxfProducer which invokes the remote service. -| hostnameVerifier | producer | | HostnameVerifier | The hostname verifier to be used. Use the notation to reference a HostnameVerifier from the registry. -| sslContextParameters | producer | | SSLContextParameters | The Camel SSL setting reference. Use the notation to reference the SSL Context. -| wrapped | producer | false | boolean | Which kind of operation that CXF endpoint producer will invoke -| allowStreaming | advanced | | Boolean | This option controls whether the CXF component when running in PAYLOAD mode will DOM parse the incoming messages into DOM Elements or keep the payload as a javax.xml.transform.Source object that would allow
[01/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
Repository: camel Updated Branches: refs/heads/master 86f5e0c50 -> 24d2f4aea Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/6ec46508 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/6ec46508 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/6ec46508 Branch: refs/heads/master Commit: 6ec46508205d21144c9109ae2ddcedbbfd41a976 Parents: 86f5e0c Author: Claus IbsenAuthored: Fri Mar 17 10:44:53 2017 +0100 Committer: Claus Ibsen Committed: Fri Mar 17 10:44:53 2017 +0100 -- .../camel/maven/packaging/UpdateReadmeMojo.java | 14 ++ .../maven/packaging/model/ComponentOptionModel.java | 11 +++ .../maven/packaging/model/EndpointOptionModel.java| 11 +++ .../src/main/resources/component-options.mvel | 7 --- .../src/main/resources/endpoint-options.mvel | 7 --- 5 files changed, 44 insertions(+), 6 deletions(-) -- http://git-wip-us.apache.org/repos/asf/camel/blob/6ec46508/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java index 837f5bf..45200b0 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/UpdateReadmeMojo.java @@ -774,6 +774,7 @@ public class UpdateReadmeMojo extends AbstractMojo { component.setArtifactId(getSafeValue("artifactId", rows)); component.setVersion(getSafeValue("version", rows)); +String oldGroup = null; rows = parseJsonSchema("componentProperties", json, true); for (Map row : rows) { ComponentOptionModel option = new ComponentOptionModel(); @@ -795,8 +796,15 @@ public class UpdateReadmeMojo extends AbstractMojo { option.setDescription(desc); } component.addComponentOption(option); + +// group separate between different options +if (oldGroup == null || !oldGroup.equals(option.getGroup())) { +option.setNewGroup(true); +} +oldGroup = option.getGroup(); } +oldGroup = null; rows = parseJsonSchema("properties", json, true); for (Map row : rows) { EndpointOptionModel option = new EndpointOptionModel(); @@ -825,6 +833,12 @@ public class UpdateReadmeMojo extends AbstractMojo { } else { component.addEndpointOption(option); } + +// group separate between different options +if (oldGroup == null || !oldGroup.equals(option.getGroup())) { +option.setNewGroup(true); +} +oldGroup = option.getGroup(); } return component; http://git-wip-us.apache.org/repos/asf/camel/blob/6ec46508/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java -- diff --git a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java index e1c0697..5b79f61 100644 --- a/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java +++ b/tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/model/ComponentOptionModel.java @@ -31,6 +31,9 @@ public class ComponentOptionModel { private String defaultValue; private String enums; +// special for documentation rendering +private boolean newGroup; + public String getName() { return name; } @@ -127,6 +130,14 @@ public class ComponentOptionModel { this.enums = enums; } +public boolean isNewGroup() { +return newGroup; +} + +public void setNewGroup(boolean newGroup) { +this.newGroup = newGroup; +} + public String getShortJavaType() { if (javaType.startsWith("java.util.Map")) { return "Map";
[19/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-ftp/src/main/docs/sftp-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/sftp-component.adoc b/components/camel-ftp/src/main/docs/sftp-component.adoc index cf1be87..aa3eb1f 100644 --- a/components/camel-ftp/src/main/docs/sftp-component.adoc +++ b/components/camel-ftp/src/main/docs/sftp-component.adoc @@ -48,117 +48,226 @@ with the following path and query parameters: Query Parameters (109 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| charset | common | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. -| disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. -| doneFileName | common | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. -| fileName | common | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to te mporary store CamelFileName and have to restore it afterwards. -| jschLoggingLevel | common | WARN | LoggingLevel | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. -| separator | common | UNIX | PathSeparator | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name -| fastExistsCheck | common (advanced) | false | boolean | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files. -| 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 or ERROR level and ignored. -| delete | consumer | false | boolean | If true the file will be deleted after it is processed successfully. -|
[05/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-sjms2/src/main/docs/sjms2-component.adoc -- diff --git a/components/camel-sjms2/src/main/docs/sjms2-component.adoc b/components/camel-sjms2/src/main/docs/sjms2-component.adoc index ad7fd86..57145d3 100644 --- a/components/camel-sjms2/src/main/docs/sjms2-component.adoc +++ b/components/camel-sjms2/src/main/docs/sjms2-component.adoc @@ -87,24 +87,39 @@ The Simple JMS2 component supports 15 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| connectionFactory | advanced | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. -| connectionResource | advanced | | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. -| connectionCount | common | 1 | Integer | The maximum number of connections available to endpoints started under this component -| jmsKeyFormatStrategy | advanced | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. -| transactionCommitStrategy | transaction | | TransactionCommitStrategy | To configure which kind of commit strategy to use. Camel provides two implementations out of the box default and batch. -| destinationCreationStrategy | advanced | | DestinationCreationStrategy | To use a custom DestinationCreationStrategy. -| timedTaskManager | advanced | | TimedTaskManager | To use a custom TimedTaskManager -| messageCreatedStrategy | advanced | | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. -| connectionTestOnBorrow | advanced | true | boolean | When using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource then should each javax.jms.Connection be tested (calling start) before returned from the pool. -| connectionUsername | security | | String | The username to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. -| connectionPassword | security | | String | The password to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. -| connectionClientId | advanced | | String | The client ID to use when creating javax.jms.Connection when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. -| connectionMaxWait | advanced | 5000 | long | The max wait time in millis to block and wait on free connection when the pool is exhausted when using the default org.apache.camel.component.sjms.jms.ConnectionFactoryResource. -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| connectionFactory | | ConnectionFactory | A ConnectionFactory is required to enable the SjmsComponent. It can be set directly or set set as part of a ConnectionResource. + +| connectionResource | | ConnectionResource | A ConnectionResource is an interface that allows for customization and container control of the ConnectionFactory. See Plugable Connection Resource Management for further details. + 4+^s| common +| connectionCount | 1 | Integer | The maximum number of connections available to endpoints started under this component + 4+^s| advanced +| jmsKeyFormatStrategy | | JmsKeyFormatStrategy | Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides one implementation out of the box: default. The default strategy will safely marshal dots and hyphens (. and -). Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own
[10/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-netty-http/src/main/docs/netty-http-component.adoc -- diff --git a/components/camel-netty-http/src/main/docs/netty-http-component.adoc b/components/camel-netty-http/src/main/docs/netty-http-component.adoc index e93a48f..9d1f650 100644 --- a/components/camel-netty-http/src/main/docs/netty-http-component.adoc +++ b/components/camel-netty-http/src/main/docs/netty-http-component.adoc @@ -80,15 +80,21 @@ The Netty HTTP component supports 6 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| nettyHttpBinding | advanced | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. -| configuration | common | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. -| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. -| securityConfiguration | security | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. -| maximumPoolSize | advanced | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API. + 4+^s| common +| configuration | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. + 4+^s| advanced +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. + 4+^s| security +| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources. + 4+^s| advanced +| maximumPoolSize | 16 | int | The core pool size for the ordered thread pool if its in use. The default value is 16. + +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |=== // component options: END @@ -119,87 +125,165 @@ with the following path and query parameters: Query Parameters (78 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| bridgeEndpoint | common | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). -| disconnect | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. -| keepAlive | common | true | boolean | Setting to ensure socket is not closed due to inactivity -| reuseAddress | common | true | boolean | Setting to facilitate socket multiplexing -| sync | common | true | boolean | Setting to set endpoint as one-way or request-response -| tcpNoDelay | common | true | boolean | Setting to improve TCP protocol performance -| 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 or ERROR level and ignored. -| matchOnUriPrefix | consumer | false | boolean | Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. -|
[02/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc -- diff --git a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc index 2ad96be..1e3bab5 100644 --- a/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc +++ b/components/camel-xmlsecurity/src/main/docs/xmlsecurity-component.adoc @@ -229,12 +229,15 @@ The XML Security component supports 3 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| signerConfiguration | advanced | | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. -| verifierConfiguration | advanced | | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| signerConfiguration | | XmlSignerConfiguration | To use a shared XmlSignerConfiguration configuration to use as base for configuring endpoints. + +| verifierConfiguration | | XmlVerifierConfiguration | To use a shared XmlVerifierConfiguration configuration to use as base for configuring endpoints. + +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |=== // component options: END @@ -264,44 +267,79 @@ with the following path and query parameters: Query Parameters (35 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| baseUri | common | | String | You can set a base URI which is used in the URI dereferencing. Relative URIs are then concatenated with the base URI. -| clearHeaders | common | true | Boolean | Determines if the XML signature specific headers be cleared after signing and verification. Defaults to true. -| cryptoContextProperties | common | | Map | Sets the crypto context properties. See link XMLCryptoContextsetProperty(String Object). Possible properties are defined in XMLSignContext an XMLValidateContext (see Supported Properties). The following properties are set by default to the value link BooleanTRUE for the XML validation. If you want to switch these features off you must set the property value to link BooleanFALSE. org.jcp.xml.dsig.validateManifests javax.xml.crypto.dsig.cacheReference -| disallowDoctypeDecl | common | true | Boolean | Disallows that the incoming XML document contains DTD DOCTYPE declaration. The default value is link BooleanTRUE. -| omitXmlDeclaration | common | false | Boolean | Indicator whether the XML declaration in the outgoing message body should be omitted. Default value is false. Can be overwritten by the header link XmlSignatureConstantsHEADER_OMIT_XML_DECLARATION. -| outputXmlEncoding | common | | String | The character encoding of the resulting signed XML document. If null then the encoding of the original XML document is used. -| schemaResourceUri | common | | String | Classpath to the XML Schema. Must be specified in the detached XML Signature case for determining the ID attributes might be set in the enveloped and enveloping case. If set then the XML document is validated with the specified XML schema. The schema resource URI can be overwritten by the header link XmlSignatureConstantsHEADER_SCHEMA_RESOURCE_URI. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| uriDereferencer | advanced | | URIDereferencer | If you want to restrict the remote access via reference URIs you can set an own dereferencer. Optional parameter. If not set the provider default dereferencer is used which can resolve URI fragments HTTP file and XPpointer URIs. Attention: The implementation is provider dependent! -| addKeyInfoReference | sign | true | Boolean | In order to protect the KeyInfo element from tampering you can add a reference to the signed info element so that it is protected via the signature value. The default value is true. Only relevant
[20/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-ftp/src/main/docs/ftps-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/ftps-component.adoc b/components/camel-ftp/src/main/docs/ftps-component.adoc index 5a11761..8e4d75c 100644 --- a/components/camel-ftp/src/main/docs/ftps-component.adoc +++ b/components/camel-ftp/src/main/docs/ftps-component.adoc @@ -48,118 +48,228 @@ with the following path and query parameters: Query Parameters (110 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| binary | common | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false). -| charset | common | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. -| disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. -| doneFileName | common | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. -| fileName | common | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to te mporary store CamelFileName and have to restore it afterwards. -| passiveMode | common | false | boolean | Sets passive mode connections. Default is active mode connections. -| separator | common | UNIX | PathSeparator | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name -| fastExistsCheck | common (advanced) | false | boolean | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files. -| 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 or ERROR level and ignored. -| delete | consumer | false | boolean | If true the file will be deleted
[09/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-netty4-http/src/main/docs/netty4-http-component.adoc -- 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 6c3ec43..d687bdf 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 @@ -79,16 +79,23 @@ The Netty4 HTTP component supports 7 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| nettyHttpBinding | advanced | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. -| configuration | common | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. -| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. -| securityConfiguration | security | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. -| maximumPoolSize | advanced | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. -| executorService | advanced | | EventExecutorGroup | To use the given EventExecutorGroup -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| nettyHttpBinding | | NettyHttpBinding | To use a custom org.apache.camel.component.netty4.http.NettyHttpBinding for binding to/from Netty and Camel Message API. + 4+^s| common +| configuration | | NettyHttpConfiguration | To use the NettyConfiguration as configuration when creating endpoints. + 4+^s| advanced +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. + 4+^s| security +| securityConfiguration | | NettyHttpSecurityConfiguration | Refers to a org.apache.camel.component.netty4.http.NettyHttpSecurityConfiguration for configuring secure web resources. + 4+^s| advanced +| maximumPoolSize | 16 | int | The thread pool size for the EventExecutorGroup if its in use. The default value is 16. + +| executorService | | EventExecutorGroup | To use the given EventExecutorGroup + +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |=== // component options: END @@ -121,88 +128,167 @@ with the following path and query parameters: Query Parameters (79 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| bridgeEndpoint | common | false | boolean | If the option is true the producer will ignore the Exchange.HTTP_URI header and use the endpoint's URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange). -| disconnect | common | false | boolean | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. -| keepAlive | common | true | boolean | Setting to ensure socket is not closed due to inactivity -| reuseAddress | common | true | boolean | Setting to facilitate socket multiplexing -| sync | common | true | boolean | Setting to set endpoint as one-way or request-response -| tcpNoDelay | common | true | boolean | Setting to improve TCP protocol performance -| 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 or
[21/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-ftp/src/main/docs/ftp-component.adoc -- diff --git a/components/camel-ftp/src/main/docs/ftp-component.adoc b/components/camel-ftp/src/main/docs/ftp-component.adoc index 064556f..498acfb 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -97,111 +97,213 @@ with the following path and query parameters: Query Parameters (102 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| binary | common | false | boolean | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false). -| charset | common | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. -| disconnect | common | false | boolean | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. -| doneFileName | common | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. -| fileName | common | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to te mporary store CamelFileName and have to restore it afterwards. -| passiveMode | common | false | boolean | Sets passive mode connections. Default is active mode connections. -| separator | common | UNIX | PathSeparator | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name -| fastExistsCheck | common (advanced) | false | boolean | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files. -| 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 or ERROR level and ignored. -| delete | consumer | false | boolean | If true the file will be deleted after
[12/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-mail/src/main/docs/mail-component.adoc -- diff --git a/components/camel-mail/src/main/docs/mail-component.adoc b/components/camel-mail/src/main/docs/mail-component.adoc index c3a3362..a26ef61 100644 --- a/components/camel-mail/src/main/docs/mail-component.adoc +++ b/components/camel-mail/src/main/docs/mail-component.adoc @@ -81,12 +81,15 @@ The Mail component supports 3 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| configuration | advanced | | MailConfiguration | Sets the Mail configuration -| contentTypeResolver | advanced | | ContentTypeResolver | Resolver to determine Content-Type for file attachments. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| configuration | | MailConfiguration | Sets the Mail configuration + +| contentTypeResolver | | ContentTypeResolver | Resolver to determine Content-Type for file attachments. + +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |=== // component options: END @@ -113,70 +116,131 @@ with the following path and query parameters: Query Parameters (61 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| 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 or ERROR level and ignored. -| closeFolder | consumer | true | boolean | Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well then the consumer keep the folder open between polls. -| copyTo | consumer | | String | After processing a mail message it can be copied to a mail folder with the given name. You can override this configuration value with a header with the key copyTo allowing you to copy messages to folder names configured at runtime. -| delete | consumer | false | boolean | Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false the SEEN flag is set instead. As of Camel 2.10 you can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not. -| disconnect | consumer | false | boolean | Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. -| handleFailedMessage | consumer | false | boolean | If the mail consumer cannot retrieve a given mail message then this option allows to handle the caused exception by the consumer's error handler. By enable the bridge error handler on the consumer then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel. -| maxMessagesPerPoll | consumer | | int | Specifies the maximum number of messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. -| peek | consumer | true | boolean | Will mark the javax.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek the mail will not be eager marked as SEEN on the mail server which allows us to rollback the mail message if there is an error processing in Camel. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| skipFailedMessage | consumer | false | boolean | If the mail consumer cannot retrieve a given mail message then this option allows to skip the message and move on to
[30/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/camel-core/src/main/docs/file-component.adoc -- diff --git a/camel-core/src/main/docs/file-component.adoc b/camel-core/src/main/docs/file-component.adoc index 1c4b9fe..4e870ad 100644 --- a/camel-core/src/main/docs/file-component.adoc +++ b/camel-core/src/main/docs/file-component.adoc @@ -76,89 +76,169 @@ with the following path and query parameters: Query Parameters (80 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| charset | common | | String | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. -| doneFileName | common | | String | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. -| fileName | common | | String | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:MMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to te mporary store CamelFileName and have to restore it afterwards. -| 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. -| delete | consumer | false | boolean | If true the file will be deleted after it is processed successfully. -| moveFailed | consumer | | String | Sets the move failure expression based on Simple language. For example to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. -| noop | consumer | false | boolean | If true the file is not moved or deleted in any way. This option is good for readonly data or for ETL type requirements. If noop=true Camel will set idempotent=true as well to avoid consuming the same files over and over again. -| preMove | consumer | | String | Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. -| recursive | consumer | false | boolean | If a directory will look for files in all the sub-directories as well. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| directoryMustExist | consumer (advanced) | false | boolean | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories. -| exceptionHandler | consumer (advanced) | |
[08/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc -- diff --git a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc index d7b4f3b..394075b 100644 --- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc @@ -57,17 +57,25 @@ with the following path and query parameters: Query Parameters (8 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| config | producer | | Config | OpenStack configuration -| domain | producer | default | String | Authentication domain -| operation | producer | | String | The operation to do -| password | producer | | String | *Required* OpenStack password -| project | producer | | String | *Required* The project ID -| subsystem | producer | | String | *Required* OpenStack Keystone subsystem -| username | producer | | String | *Required* OpenStack username -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| config | | Config | OpenStack configuration + +| domain | default | String | Authentication domain + +| operation | | String | The operation to do + +| password | | String | *Required* OpenStack password + +| project | | String | *Required* The project ID + +| subsystem | | String | *Required* OpenStack Keystone subsystem + +| username | | String | *Required* OpenStack username + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc -- diff --git a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc index 6b15f54..1e800fb 100644 --- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc @@ -55,18 +55,27 @@ with the following path and query parameters: Query Parameters (9 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| apiVersion | producer | V3 | String | OpenStack API version -| config | producer | | Config | OpenStack configuration -| domain | producer | default | String | Authentication domain -| operation | producer | | String | The operation to do -| password | producer | | String | *Required* OpenStack password -| project | producer | | String | *Required* The project ID -| subsystem | producer | | String | *Required* OpenStack Neutron subsystem -| username | producer | | String | *Required* OpenStack username -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| apiVersion | V3 | String | OpenStack API version + +| config | | Config | OpenStack configuration + +| domain | default | String | Authentication domain + +| operation | | String | The operation to do + +| password | | String | *Required* OpenStack password + +| project | | String | *Required* The project ID + +| subsystem | | String | *Required* OpenStack Neutron subsystem + +| username | | String | *Required* OpenStack username + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-openstack/src/main/docs/openstack-nova-component.adoc -- diff --git a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc index 37e5b87..d1f26de
[26/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-apns/src/main/docs/apns-component.adoc -- diff --git a/components/camel-apns/src/main/docs/apns-component.adoc b/components/camel-apns/src/main/docs/apns-component.adoc index 35f8dd8..2b2fada 100644 --- a/components/camel-apns/src/main/docs/apns-component.adoc +++ b/components/camel-apns/src/main/docs/apns-component.adoc @@ -55,11 +55,13 @@ The APNS component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| apnsService | common | | ApnsService | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| common +| apnsService | | ApnsService | *Required* The ApnsService to use. The org.apache.camel.component.apns.factory.ApnsServiceFactory can be used to build a ApnsService + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |=== // component options: END @@ -83,29 +85,49 @@ with the following path and query parameters: Query Parameters (20 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| tokens | common | | String | Configure this property in case you want to statically declare tokens related to devices you want to notify. Tokens are separated by comma. -| 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 or ERROR level and ignored. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. -| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also
[16/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jcache/src/main/docs/jcache-component.adoc -- diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc index 15c42a9..d9a2483 100644 --- a/components/camel-jcache/src/main/docs/jcache-component.adoc +++ b/components/camel-jcache/src/main/docs/jcache-component.adoc @@ -30,31 +30,53 @@ with the following path and query parameters: Query Parameters (22 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| cacheConfiguration | common | | Configuration | A Configuration for the Cache -| cacheConfigurationProperties | common | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager -| cachingProvider | common | | String | The fully qualified class name of the javax.cache.spi.CachingProvider -| configurationUri | common | | String | An implementation specific URI for the CacheManager -| managementEnabled | common | false | boolean | Whether management gathering is enabled -| readThrough | common | false | boolean | If read-through caching should be used -| statisticsEnabled | common | false | boolean | Whether statistics gathering is enabled -| storeByValue | common | true | boolean | If cache should use store-by-value or store-by-reference semantics -| writeThrough | common | false | boolean | If write-through caching should be used -| 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 or ERROR level and ignored. -| filteredEvents | consumer | | List | Events a consumer should filter. If using filteredEvents option then eventFilters one will be ignored -| oldValueRequired | consumer | false | boolean | if the old value is required for events -| synchronous | consumer | false | boolean | if the the event listener should block the thread causing the event -| eventFilters | consumer (advanced) | | List | The CacheEntryEventFilter. If using eventFilters option then filteredEvents one will be 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| action | producer | | String | To configure using a cache operation by default. If an operation in the message header then the operation from the header takes precedence. -| cacheLoaderFactory | advanced | | CacheLoader> | The CacheLoader factory -| cacheWriterFactory | advanced | | CacheWriter> | The CacheWriter factory -| createCacheIfNotExists | advanced | true | boolean | Configure if a cache need to be created if it does exist or can't be pre-configured. -| expiryPolicyFactory | advanced | | ExpiryPolicy> | The ExpiryPolicy factory -| lookupProviders | advanced | false | boolean | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. +| Name | Default | Java Type | Description + +| cacheConfiguration | | Configuration | A Configuration for the Cache + +| cacheConfigurationProperties | | Properties | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager + +| cachingProvider | | String | The fully qualified class name of the javax.cache.spi.CachingProvider + +| configurationUri | | String | An implementation specific URI for the CacheManager + +| managementEnabled | false | boolean | Whether management gathering is enabled + +| readThrough | false | boolean | If read-through caching should be used + +| statisticsEnabled | false | boolean | Whether statistics gathering is enabled + +| storeByValue | true | boolean | If cache should use store-by-value or store-by-reference semantics + +| writeThrough | false | boolean | If write-through caching should be used + 4+^s| consumer +| bridgeErrorHandler | 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
[15/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-jms/src/main/docs/jms-component.adoc -- diff --git a/components/camel-jms/src/main/docs/jms-component.adoc b/components/camel-jms/src/main/docs/jms-component.adoc index 36e6f2b..f7a9893 100644 --- a/components/camel-jms/src/main/docs/jms-component.adoc +++ b/components/camel-jms/src/main/docs/jms-component.adoc @@ -203,85 +203,161 @@ The JMS component supports 76 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| configuration | advanced | | JmsConfiguration | To use a shared JMS configuration -| acceptMessagesWhileStopping | consumer (advanced) | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqueued on the queue. If this option is false and you stop the JMS route then messages may be rejected and the JMS broker would have to attempt redeliveries which yet again may be rejected and eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. -| allowReplyManagerQuickStop | consumer (advanced) | false | boolean | Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfigurationisAcceptMessagesWhileStopping is enabled and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. -| acknowledgementMode | consumer | | int | The JMS acknowledgement mode defined as an Integer. Allows you to set vendor-specific extensions to the acknowledgment mode. For the regular modes it is preferable to use the acknowledgementModeName instead. -| eagerLoadingOfProperties | consumer (advanced) | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties -| acknowledgementModeName | consumer | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE -| autoStartup | consumer | true | boolean | Specifies whether the consumer container should auto-startup. -| cacheLevel | consumer | | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. -| cacheLevelName | consumer | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. -| replyToCacheLevelName | producer (advanced) | | String | Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. -| clientId | common | | String | Sets the JMS client ID to use. Note that this value if specified must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. -| concurrentConsumers | consumer | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. -| replyToConcurrentConsumers | producer | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. -| connectionFactory | common | | ConnectionFactory | The connection factory to be use. A connection factory must be
[07/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc -- diff --git a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc index acdde17..9be24f4 100644 --- a/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc +++ b/components/camel-rest-swagger/src/main/docs/rest-swagger-component.adoc @@ -80,16 +80,23 @@ The REST Swagger component supports 7 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| basePath | producer | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification. -| componentName | producer | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration. -| consumes | producer | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration -| host | producer | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration. -| produces | producer | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification. Can be overriden in endpoint configuration. -| specificationUri | producer | swagger.json | URI | Path to the Swagger specification file. The scheme host base path are taken from this specification but these can be overriden with properties on the component or endpoint level. If not given the component tries to load swagger.json resource. Note that the host defined on the component and endpoint of this Component should contain the scheme hostname and optionally the port in the URI syntax (i.e. https://api.example.com:8080). Can be overriden in endpoint configuration. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| producer +| basePath | | String | API basePath for example /v2. Default is unset if set overrides the value present in Swagger specification. + +| componentName | | String | Name of the Camel component that will perform the requests. The compnent must be present in Camel registry and it must implement RestProducerFactory service provider interface. If not set CLASSPATH is searched for single component that implements RestProducerFactory SPI. Can be overriden in endpoint configuration. + +| consumes | | String | What payload type this component capable of consuming. Could be one type like application/json or multiple types as application/json application/xml; q=0.5 according to the RFC7231. This equates to the value of Accept HTTP header. If set overrides any value found in the Swagger specification. Can be overriden in endpoint configuration + +| host | | String | Scheme hostname and port to direct the HTTP requests to in the form of https://hostname:port. Can be configured at the endpoint component or in the correspoding REST configuration in the Camel Context. If you give this component a name (e.g. petstore) that REST configuration is consulted first rest-swagger next and global configuration last. If set overrides any value found in the Swagger specification RestConfiguration. Can be overriden in endpoint configuration. + +| produces | | String | What payload type this component is producing. For example application/json according to the RFC7231. This equates to the value of Content-Type HTTP header. If set overrides any value present in the Swagger specification.
[17/31] camel git commit: Component docs - Adjust tables to have group label span column which makes more room to show the description as there is one row less.
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-http/src/main/docs/http-component.adoc -- diff --git a/components/camel-http/src/main/docs/http-component.adoc b/components/camel-http/src/main/docs/http-component.adoc index 2c26143..8707723 100644 --- a/components/camel-http/src/main/docs/http-component.adoc +++ b/components/camel-http/src/main/docs/http-component.adoc @@ -118,16 +118,23 @@ The HTTP component supports 7 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| httpClientConfigurer | advanced | | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. -| httpConnectionManager | advanced | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections -| httpBinding | producer | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. -| httpConfiguration | producer | | HttpConfiguration | To use the shared HttpConfiguration as base configuration. -| allowJavaSerializedObject | producer | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. -| headerFilterStrategy | filter | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| httpClientConfigurer | | HttpClientConfigurer | To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. + +| httpConnectionManager | | HttpConnectionManager | To use a custom HttpConnectionManager to manage connections + 4+^s| producer +| httpBinding | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. + +| httpConfiguration | | HttpConfiguration | To use the shared HttpConfiguration as base configuration. + +| allowJavaSerializedObject | false | boolean | Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. + 4+^s| filter +| headerFilterStrategy | | HeaderFilterStrategy | To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |=== // component options: END @@ -156,47 +163,85 @@ with the following path and query parameters: Query Parameters (38 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |=== -| Name | Group | Default | Java Type | Description -| disableStreamCache | common | false | boolean | Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file Stream caching) cache. By default Camel will cache the Servlet input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance in case you do not need to read the message payload multiple times. The http/http4 producer will by default cache the response body stream. If setting this option to true then the producers will not ca che the response body stream but use the response stream as-is as the message body. -| headerFilterStrategy | common | | HeaderFilterStrategy | To use a custom