Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 240E6200C2D for ; Sat, 4 Mar 2017 16:57:13 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 22C8D160B66; Sat, 4 Mar 2017 15:57:13 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id B769D160B71 for ; Sat, 4 Mar 2017 16:57:10 +0100 (CET) Received: (qmail 73319 invoked by uid 500); 4 Mar 2017 15:57:09 -0000 Mailing-List: contact commits-help@camel.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@camel.apache.org Delivered-To: mailing list commits@camel.apache.org Received: (qmail 73240 invoked by uid 99); 4 Mar 2017 15:57:09 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 04 Mar 2017 15:57:09 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id AAF28DFC15; Sat, 4 Mar 2017 15:57:09 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: davsclaus@apache.org To: commits@camel.apache.org Date: Sat, 04 Mar 2017 15:57:10 -0000 Message-Id: <0cb47bab393c49d28f2b0c5d3de09827@git.apache.org> In-Reply-To: <7e8157efeba745bdb9af671775830398@git.apache.org> References: <7e8157efeba745bdb9af671775830398@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [2/6] camel git commit: CAMEL-10940: Component docs - Separate path and query parameters archived-at: Sat, 04 Mar 2017 15:57:13 -0000 http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-openshift/src/main/docs/openshift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openshift/src/main/docs/openshift-component.adoc b/components/camel-openshift/src/main/docs/openshift-component.adoc index 3305b19..74c83fa 100644 --- a/components/camel-openshift/src/main/docs/openshift-component.adoc +++ b/components/camel-openshift/src/main/docs/openshift-component.adoc @@ -54,13 +54,26 @@ The OpenShift component supports 5 options which are listed below. // endpoint options: START -The OpenShift component supports 27 endpoint options which are listed below: +The OpenShift component is configured using the URI syntax with the following path and query parameters: + + openshift:clientId + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| clientId | | String | *Required* The client id +|======================================================================= +{% endraw %} + +#### 26 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| clientId | common | | String | *Required* The client id | domain | common | | String | Domain name. If not specified then the default domain is used. | password | common | | String | *Required* The password for login to openshift server. | server | common | | String | Url to the openshift server. If not specified then the default value from the local openshift configuration file /.openshift/express.conf is used. And if that fails as well then openshift.redhat.com is used. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 2834382..9357cac 100644 --- a/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-cinder-component.adoc @@ -39,13 +39,26 @@ The OpenStack Cinder component has no options. // component options: END // endpoint options: START -The OpenStack Cinder component supports 10 endpoint options which are listed below: +The OpenStack Cinder component is configured using the URI syntax with the following path and query parameters: + + openstack-cinder:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* OpenStack host url +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* OpenStack host url | apiVersion | producer | V3 | String | OpenStack API version | config | producer | | Config | OpenStack configuration | domain | producer | default | String | Authentication domain http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 9dcbcab..df15350 100644 --- a/components/camel-openstack/src/main/docs/openstack-glance-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-glance-component.adoc @@ -39,13 +39,26 @@ The OpenStack Glance component has no options. // component options: END // endpoint options: START -The OpenStack Glance component supports 9 endpoint options which are listed below: +The OpenStack Glance component is configured using the URI syntax with the following path and query parameters: + + openstack-glance:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* OpenStack host url +|======================================================================= +{% endraw %} + +#### 8 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* OpenStack host url | apiVersion | producer | V3 | String | OpenStack API version | config | producer | | Config | OpenStack configuration | domain | producer | default | String | Authentication domain http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 f6f255e..09b869f 100644 --- a/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-keystone-component.adoc @@ -41,13 +41,26 @@ The OpenStack Keystone component has no options. // component options: END // endpoint options: START -The OpenStack Keystone component supports 9 endpoint options which are listed below: +The OpenStack Keystone component is configured using the URI syntax with the following path and query parameters: + + openstack-keystone:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* OpenStack host url +|======================================================================= +{% endraw %} + +#### 8 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* OpenStack host url | config | producer | | Config | OpenStack configuration | domain | producer | default | String | Authentication domain | operation | producer | | String | The operation to do http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 dbb2e58..df0facd 100644 --- a/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-neutron-component.adoc @@ -39,13 +39,26 @@ The OpenStack Neutron component has no options. // component options: END // endpoint options: START -The OpenStack Neutron component supports 10 endpoint options which are listed below: +The OpenStack Neutron component is configured using the URI syntax with the following path and query parameters: + + openstack-neutron:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* OpenStack host url +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* OpenStack host url | apiVersion | producer | V3 | String | OpenStack API version | config | producer | | Config | OpenStack configuration | domain | producer | default | String | Authentication domain http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 308b567..5ede951 100644 --- a/components/camel-openstack/src/main/docs/openstack-nova-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-nova-component.adoc @@ -39,13 +39,26 @@ The OpenStack Nova component has no options. // component options: END // endpoint options: START -The OpenStack Nova component supports 10 endpoint options which are listed below: +The OpenStack Nova component is configured using the URI syntax with the following path and query parameters: + + openstack-nova:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* OpenStack host url +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* OpenStack host url | apiVersion | producer | V3 | String | OpenStack API version | config | producer | | Config | OpenStack configuration | domain | producer | default | String | Authentication domain http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-openstack/src/main/docs/openstack-swift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc index 2d07bcd..a75ccaa 100644 --- a/components/camel-openstack/src/main/docs/openstack-swift-component.adoc +++ b/components/camel-openstack/src/main/docs/openstack-swift-component.adoc @@ -39,13 +39,26 @@ The OpenStack Swift component has no options. // component options: END // endpoint options: START -The OpenStack Swift component supports 10 endpoint options which are listed below: +The OpenStack Swift component is configured using the URI syntax with the following path and query parameters: + + openstack-swift:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* OpenStack host url +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | | String | *Required* OpenStack host url | apiVersion | producer | V3 | String | OpenStack API version | config | producer | | Config | OpenStack configuration | domain | producer | default | String | Authentication domain http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc index 2a60ff1..9b722a3 100644 --- a/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc +++ b/components/camel-optaplanner/src/main/docs/optaplanner-component.adoc @@ -45,13 +45,26 @@ The OptaPlanner component has no options. // endpoint options: START -The OptaPlanner component supports 8 endpoint options which are listed below: +The OptaPlanner component is configured using the URI syntax with the following path and query parameters: + + optaplanner:configFile + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| configFile | | String | *Required* Specifies the location to the solver file +|======================================================================= +{% endraw %} + +#### 7 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configFile | common | | String | *Required* Specifies the location to the solver file | solverId | common | DEFAULT_SOLVER | String | Specifies the solverId to user for the solver instance key | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-paho/src/main/docs/paho-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-paho/src/main/docs/paho-component.adoc b/components/camel-paho/src/main/docs/paho-component.adoc index 9dac391..e39de33 100644 --- a/components/camel-paho/src/main/docs/paho-component.adoc +++ b/components/camel-paho/src/main/docs/paho-component.adoc @@ -137,13 +137,26 @@ The Paho component supports 4 options which are listed below. // endpoint options: START -The Paho component supports 12 endpoint options which are listed below: +The Paho component is configured using the URI syntax with the following path and query parameters: + + paho:topic + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| topic | | String | *Required* Name of the topic +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| topic | common | | String | *Required* Name of the topic | brokerUrl | common | tcp://localhost:1883 | String | The URL of the MQTT broker. | clientId | common | | String | MQTT client identifier. | connectOptions | common | | MqttConnectOptions | Client connection options http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc index 714e525..da3aa67 100644 --- a/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc +++ b/components/camel-paxlogging/src/main/docs/paxlogging-component.adoc @@ -55,13 +55,26 @@ The OSGi PAX Logging component supports 2 options which are listed below. // endpoint options: START -The OSGi PAX Logging component supports 5 endpoint options which are listed below: +The OSGi PAX Logging component is configured using the URI syntax with the following path and query parameters: + + paxlogging:appender + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| appender | | String | *Required* Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration. +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| appender | consumer | | String | *Required* Appender is the name of the pax appender that need to be configured in the PaxLogging service configuration. | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-pdf/src/main/docs/pdf-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pdf/src/main/docs/pdf-component.adoc b/components/camel-pdf/src/main/docs/pdf-component.adoc index 4160d25..f8da0a6 100644 --- a/components/camel-pdf/src/main/docs/pdf-component.adoc +++ b/components/camel-pdf/src/main/docs/pdf-component.adoc @@ -40,13 +40,26 @@ The PDF component has no options. // endpoint options: START -The PDF component supports 10 endpoint options which are listed below: +The PDF component is configured using the URI syntax with the following path and query parameters: + + pdf:operation + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| operation | | PdfOperation | *Required* Operation type +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| operation | producer | | PdfOperation | *Required* Operation type | font | producer | Helvetica | PDFont | Font | fontSize | producer | 14 | float | Font size in pixels | marginBottom | producer | 20 | int | Margin bottom in pixels http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-pgevent/src/main/docs/pgevent-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-pgevent/src/main/docs/pgevent-component.adoc b/components/camel-pgevent/src/main/docs/pgevent-component.adoc index 6b0b7c0..2463dc1 100644 --- a/components/camel-pgevent/src/main/docs/pgevent-component.adoc +++ b/components/camel-pgevent/src/main/docs/pgevent-component.adoc @@ -43,16 +43,29 @@ The PostgresSQL Event component has no options. // endpoint options: START -The PostgresSQL Event component supports 11 endpoint options which are listed below: +The PostgresSQL Event component is configured using the URI syntax with the following path and query parameters: + + pgevent:host:port/database/channel + +#### 4 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | localhost | String | To connect using hostname and port to the database. +| port | 5432 | Integer | To connect using hostname and port to the database. +| database | | String | *Required* The database name +| channel | | String | *Required* The channel name +|======================================================================= +{% endraw %} + +#### 7 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | localhost | String | To connect using hostname and port to the database. -| port | common | 5432 | Integer | To connect using hostname and port to the database. -| database | common | | String | *Required* The database name -| channel | common | | String | *Required* The channel name | datasource | common | | DataSource | To connect using the given javax.sql.DataSource instead of using hostname and port. | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-printer/src/main/docs/lpr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-printer/src/main/docs/lpr-component.adoc b/components/camel-printer/src/main/docs/lpr-component.adoc index 0670e20..ac98574 100644 --- a/components/camel-printer/src/main/docs/lpr-component.adoc +++ b/components/camel-printer/src/main/docs/lpr-component.adoc @@ -52,15 +52,28 @@ The Printer component has no options. // endpoint options: START -The Printer component supports 14 endpoint options which are listed below: +The Printer component is configured using the URI syntax with the following path and query parameters: + + lpr:hostname:port/printername + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| hostname | | String | *Required* Hostname of the printer +| port | | int | Port number of the printer +| printername | | String | Name of the printer +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| hostname | producer | | String | *Required* Hostname of the printer -| port | producer | | int | Port number of the printer -| printername | producer | | String | Name of the printer | copies | producer | 1 | int | Number of copies to print | docFlavor | producer | | DocFlavor | Sets DocFlavor to use. | flavor | producer | | String | Sets DocFlavor to use. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-quartz/src/main/docs/quartz-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quartz/src/main/docs/quartz-component.adoc b/components/camel-quartz/src/main/docs/quartz-component.adoc index a7c2d6c..93a89ec 100644 --- a/components/camel-quartz/src/main/docs/quartz-component.adoc +++ b/components/camel-quartz/src/main/docs/quartz-component.adoc @@ -70,14 +70,27 @@ The Quartz component supports 8 options which are listed below. // endpoint options: START -The Quartz component supports 15 endpoint options which are listed below: +The Quartz component is configured using the URI syntax with the following path and query parameters: + + quartz:groupName/timerName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| groupName | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique. +| timerName | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| groupName | consumer | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique. -| timerName | consumer | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. | 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. | cron | consumer | | String | Specifies a cron expression to define when to trigger. | deleteJob | consumer | true | boolean | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-quartz2/src/main/docs/quartz2-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quartz2/src/main/docs/quartz2-component.adoc b/components/camel-quartz2/src/main/docs/quartz2-component.adoc index 6ec0114..1f823f5 100644 --- a/components/camel-quartz2/src/main/docs/quartz2-component.adoc +++ b/components/camel-quartz2/src/main/docs/quartz2-component.adoc @@ -74,14 +74,27 @@ The Quartz2 component supports 11 options which are listed below. // endpoint options: START -The Quartz2 component supports 21 endpoint options which are listed below: +The Quartz2 component is configured using the URI syntax with the following path and query parameters: + + quartz2:groupName/triggerName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| groupName | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique. +| triggerName | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. +|======================================================================= +{% endraw %} + +#### 19 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| groupName | consumer | Camel | String | The quartz group name to use. The combination of group name and timer name should be unique. -| triggerName | consumer | | String | *Required* The quartz timer name to use. The combination of group name and timer name should be unique. | 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. | cron | consumer | | String | Specifies a cron expression to define when to trigger. | deleteJob | consumer | true | boolean | If set to true then the trigger automatically delete when route stop. Else if set to false it will remain in scheduler. When set to false it will also mean user may reuse pre-configured trigger with camel Uri. Just ensure the names match. Notice you cannot have both deleteJob and pauseJob set to true. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-quickfix/src/main/docs/quickfix-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-quickfix/src/main/docs/quickfix-component.adoc b/components/camel-quickfix/src/main/docs/quickfix-component.adoc index 4fd3c94..1c583e7 100644 --- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc +++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc @@ -96,13 +96,26 @@ The QuickFix component supports 6 options which are listed below. // component options: END // endpoint options: START -The QuickFix component supports 7 endpoint options which are listed below: +The QuickFix component is configured using the URI syntax with the following path and query parameters: + + quickfix:configurationName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| configurationName | | String | *Required* The configFile is the name of the QuickFIX/J configuration to use for the FIX engine (located as a resource found in your classpath). +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| configurationName | common | | String | *Required* The configFile is the name of the QuickFIX/J configuration to use for the FIX engine (located as a resource found in your classpath). | lazyCreateEngine | common | false | boolean | This option allows to create QuickFIX/J engine on demand. Value true means the engine is started when first message is send or there's consumer configured in route definition. When false value is used the engine is started at the endpoint creation. When this parameter is missing the value of component's property lazyCreateEngines is being used. | sessionID | common | | SessionID | The optional sessionID identifies a specific FIX session. The format of the sessionID is: (BeginString):(SenderCompID)/(SenderSubID)/(SenderLocationID)-(TargetCompID)/(TargetSubID)/(TargetLocationID) | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 0c98d78..b860203 100644 --- a/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc +++ b/components/camel-rabbitmq/src/main/docs/rabbitmq-component.adoc @@ -45,15 +45,28 @@ The RabbitMQ component has no options. // endpoint options: START -The RabbitMQ component supports 60 endpoint options which are listed below: +The RabbitMQ component is configured using the URI syntax with the following path and query parameters: + + rabbitmq:hostname:portNumber/exchangeName + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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. +|======================================================================= +{% endraw %} + +#### 57 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| hostname | common | | String | *Required* The hostname of the running rabbitmq instance or cluster. -| portNumber | common | 5672 | int | *Required* Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. -| exchangeName | common | | 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. | autoDelete | common | true | boolean | If it is true the exchange will be deleted when it is no longer in use | connectionTimeout | common | 60000 | int | Connection timeout | deadLetterExchange | common | | String | The name of the dead letter exchange http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc index 8f2156a..2e2cb66 100644 --- a/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc +++ b/components/camel-reactive-streams/src/main/docs/reactive-streams-component.adoc @@ -64,13 +64,26 @@ The Reactive Streams component supports 3 options which are listed below. // endpoint options: START -The Reactive Streams component supports 11 endpoint options which are listed below: +The Reactive Streams component is configured using the URI syntax with the following path and query parameters: + + reactive-streams:stream + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| stream | | String | Name of the stream channel used by the endpoint to exchange messages. +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| stream | common | | String | Name of the stream channel used by the endpoint to exchange messages. | serviceName | common | | String | Allows using an alternative CamelReactiveStreamService implementation. The implementation is looked up from the registry. | 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. | concurrentConsumers | consumer | 1 | int | Number of threads used to process exchanges in the Camel route. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-restlet/src/main/docs/restlet-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-restlet/src/main/docs/restlet-component.adoc b/components/camel-restlet/src/main/docs/restlet-component.adoc index 6c9bff7..6231856 100644 --- a/components/camel-restlet/src/main/docs/restlet-component.adoc +++ b/components/camel-restlet/src/main/docs/restlet-component.adoc @@ -99,16 +99,29 @@ The Restlet component supports 21 options which are listed below. // endpoint options: START -The Restlet component supports 22 endpoint options which are listed below: +The Restlet component is configured using the URI syntax with the following path and query parameters: + + restlet:protocol:host:port/uriPattern + +#### 4 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol to use which is http or https +| host | | String | *Required* The hostname of the restlet service +| port | 80 | int | *Required* The port number of the restlet service +| uriPattern | | String | The resource pattern such as /customer/id +|======================================================================= +{% endraw %} + +#### 18 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| protocol | common | | String | *Required* The protocol to use which is http or https -| host | common | | String | *Required* The hostname of the restlet service -| port | common | 80 | int | *Required* The port number of the restlet service -| uriPattern | common | | String | The resource pattern such as /customer/id | restletMethod | common | GET | Method | On a producer endpoint specifies the request method to use. On a consumer endpoint specifies that the endpoint consumes only restletMethod requests. | 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. | restletMethods | consumer | | String | Specify one or more methods separated by commas (e.g. restletMethods=postput) to be serviced by a restlet consumer endpoint. If both restletMethod and restletMethods options are specified the restletMethod setting is ignored. The possible methods are: ALLCONNECTDELETEGETHEADOPTIONSPATCHPOSTPUTTRACE http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-rmi/src/main/docs/rmi-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rmi/src/main/docs/rmi-component.adoc b/components/camel-rmi/src/main/docs/rmi-component.adoc index cd79eeb..679e911 100644 --- a/components/camel-rmi/src/main/docs/rmi-component.adoc +++ b/components/camel-rmi/src/main/docs/rmi-component.adoc @@ -53,15 +53,28 @@ The RMI component has no options. // endpoint options: START -The RMI component supports 9 endpoint options which are listed below: +The RMI component is configured using the URI syntax with the following path and query parameters: + + rmi:hostname:port/name + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| hostname | localhost | String | Hostname of RMI server +| name | | String | *Required* Name to use when binding to RMI server +| port | 1099 | int | Port number of RMI server +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| hostname | common | localhost | String | Hostname of RMI server -| name | common | | String | *Required* Name to use when binding to RMI server -| port | common | 1099 | int | Port number of RMI server | method | common | | String | You can set the name of the method to invoke. | remoteInterfaces | common | | List | To specific the remote interfaces. | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-routebox/src/main/docs/routebox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-routebox/src/main/docs/routebox-component.adoc b/components/camel-routebox/src/main/docs/routebox-component.adoc index 412b926..d083d98 100644 --- a/components/camel-routebox/src/main/docs/routebox-component.adoc +++ b/components/camel-routebox/src/main/docs/routebox-component.adoc @@ -105,13 +105,26 @@ The RouteBox component has no options. // endpoint options: START -The RouteBox component supports 18 endpoint options which are listed below: +The RouteBox component is configured using the URI syntax with the following path and query parameters: + + routebox:routeboxName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| routeboxName | | String | *Required* Logical name for the routebox (eg like a queue name) +|======================================================================= +{% endraw %} + +#### 17 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| routeboxName | common | | String | *Required* Logical name for the routebox (eg like a queue name) | dispatchMap | common | | Map | A string representing a key in the Camel Registry matching an object value of the type HashMap. The HashMap key should contain strings that can be matched against the value set for the exchange header ROUTE_DISPATCH_KEY. The HashMap value should contain inner route consumer URI's to which requests should be directed. | dispatchStrategy | common | | RouteboxDispatchStrategy | To use a custom RouteboxDispatchStrategy which allows to use custom dispatching instead of the default. | forkContext | common | true | boolean | Whether to fork and create a new inner CamelContext instead of reusing the same CamelContext. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-rss/src/main/docs/rss-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-rss/src/main/docs/rss-component.adoc b/components/camel-rss/src/main/docs/rss-component.adoc index 46bab51..6e9d0ce 100644 --- a/components/camel-rss/src/main/docs/rss-component.adoc +++ b/components/camel-rss/src/main/docs/rss-component.adoc @@ -48,13 +48,26 @@ The RSS component has no options. // endpoint options: START -The RSS component supports 28 endpoint options which are listed below: +The RSS component is configured using the URI syntax with the following path and query parameters: + + rss:feedUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| feedUri | | String | *Required* The URI to the feed to poll. +|======================================================================= +{% endraw %} + +#### 27 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| feedUri | consumer | | String | *Required* The URI to the feed to poll. | 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. | feedHeader | consumer | true | boolean | Sets whether to add the feed object as a header | filter | consumer | true | boolean | Sets whether to use filtering or not of the entries. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 e8b3f74..57ce5d6 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 @@ -469,14 +469,27 @@ The Salesforce component supports 24 options which are listed below. // endpoint options: START -The Salesforce component supports 43 endpoint options which are listed below: +The Salesforce component is configured using the URI syntax with the following path and query parameters: + + salesforce:operationName:topicName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| operationName | | OperationName | The operation to use +| topicName | | String | The name of the topic to use +|======================================================================= +{% endraw %} + +#### 41 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| operationName | producer | | OperationName | The operation to use -| topicName | consumer | | String | The name of the topic to use | apexMethod | common | | String | APEX method name | apexQueryParams | common | | Map | Query params for APEX method | apexUrl | common | | String | APEX method URL http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc index b26d33f..426f29e 100644 --- a/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc +++ b/components/camel-sap-netweaver/src/main/docs/sap-netweaver-component.adoc @@ -53,13 +53,26 @@ The SAP NetWeaver component has no options. // endpoint options: START -The SAP NetWeaver component supports 7 endpoint options which are listed below: +The SAP NetWeaver component is configured using the URI syntax with the following path and query parameters: + + sap-netweaver:url + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| url | | String | *Required* Url to the SAP net-weaver gateway server. +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| url | producer | | String | *Required* Url to the SAP net-weaver gateway server. | flatternMap | producer | true | boolean | If the JSON Map contains only a single entry then flattern by storing that single entry value as the message body. | json | producer | true | boolean | Whether to return data in JSON format. If this option is false then XML is returned in Atom format. | jsonAsMap | producer | true | boolean | To transform the JSON from a String to a Map in the message body. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-saxon/src/main/docs/xquery-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-saxon/src/main/docs/xquery-component.adoc b/components/camel-saxon/src/main/docs/xquery-component.adoc index 7ab559d..b936cff 100644 --- a/components/camel-saxon/src/main/docs/xquery-component.adoc +++ b/components/camel-saxon/src/main/docs/xquery-component.adoc @@ -35,13 +35,26 @@ The XQuery component supports 4 options which are listed below. // endpoint options: START -The XQuery component supports 32 endpoint options which are listed below: +The XQuery component is configured using the URI syntax with the following path and query parameters: + + xquery:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| resourceUri | | String | *Required* The name of the template to load from classpath or file system +|======================================================================= +{% endraw %} + +#### 31 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | common | | String | *Required* The name of the template to load from classpath or file system | allowStAX | common | false | boolean | Whether to allow using StAX mode | headerName | common | | String | To use a Camel Message header as the input source instead of Message body. | namespacePrefixes | common | | Map | Allows to control which namespace prefixes to use for a set of namespace mappings http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-schematron/src/main/docs/schematron-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-schematron/src/main/docs/schematron-component.adoc b/components/camel-schematron/src/main/docs/schematron-component.adoc index 6143788..d0a1334 100644 --- a/components/camel-schematron/src/main/docs/schematron-component.adoc +++ b/components/camel-schematron/src/main/docs/schematron-component.adoc @@ -36,13 +36,26 @@ The Schematron component has no options. // endpoint options: START -The Schematron component supports 5 endpoint options which are listed below: +The Schematron component is configured using the URI syntax with the following path and query parameters: + + schematron:path + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| path | | String | *Required* The path to the schematron rules file. Can either be in class path or location in the file system. +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| path | producer | | String | *Required* The path to the schematron rules file. Can either be in class path or location in the file system. | abort | producer | false | boolean | Flag to abort the route and throw a schematron validation exception. | rules | producer | | Templates | To use the given schematron rules instead of loading from the path | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-servicenow/src/main/docs/servicenow-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-servicenow/src/main/docs/servicenow-component.adoc b/components/camel-servicenow/src/main/docs/servicenow-component.adoc index 662d82f..45e4948 100644 --- a/components/camel-servicenow/src/main/docs/servicenow-component.adoc +++ b/components/camel-servicenow/src/main/docs/servicenow-component.adoc @@ -52,13 +52,26 @@ The ServiceNow component supports 8 options which are listed below. // endpoint options: START -The ServiceNow component supports 41 endpoint options which are listed below: +The ServiceNow component is configured using the URI syntax with the following path and query parameters: + + servicenow:instanceName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| instanceName | | String | *Required* The ServiceNow instance name +|======================================================================= +{% endraw %} + +#### 40 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| instanceName | producer | | String | *Required* The ServiceNow instance name | display | producer | true | String | Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default. | displayValue | producer | false | String | Return the display value (true) actual value (false) or both (all) for reference fields (default: false) | excludeReferenceLink | producer | | Boolean | True to exclude Table API links for reference fields (default: false) http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-servlet/src/main/docs/servlet-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-servlet/src/main/docs/servlet-component.adoc b/components/camel-servlet/src/main/docs/servlet-component.adoc index bc325e7..3daafdd 100644 --- a/components/camel-servlet/src/main/docs/servlet-component.adoc +++ b/components/camel-servlet/src/main/docs/servlet-component.adoc @@ -63,13 +63,26 @@ The Servlet component supports 8 options which are listed below. // component options: END // endpoint options: START -The Servlet component supports 22 endpoint options which are listed below: +The Servlet component is configured using the URI syntax with the following path and query parameters: + + servlet:contextPath + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| contextPath | | String | *Required* The context-path to use +|======================================================================= +{% endraw %} + +#### 21 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| contextPath | consumer | | String | *Required* The context-path to use | 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 HeaderFilterStrategy to filter header to and from Camel message. | httpBinding | common (advanced) | | HttpBinding | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-sip/src/main/docs/sip-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sip/src/main/docs/sip-component.adoc b/components/camel-sip/src/main/docs/sip-component.adoc index f516874..0d3b7d8 100644 --- a/components/camel-sip/src/main/docs/sip-component.adoc +++ b/components/camel-sip/src/main/docs/sip-component.adoc @@ -75,13 +75,26 @@ The SIP component has no options. // endpoint options: START -The SIP component supports 45 endpoint options which are listed below: +The SIP component is configured using the URI syntax with the following path and query parameters: + + sip:uri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| uri | | URI | *Required* URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999) +|======================================================================= +{% endraw %} + +#### 44 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| uri | common | | URI | *Required* URI of the SIP server to connect to (the username and password can be included such as: john:secretmyserver:9999) | cacheConnections | common | false | boolean | Should connections be cached by the SipStack to reduce cost of connection creation. This is useful if the connection is used for long running conversations. | contentSubType | common | plain | String | Setting for contentSubType can be set to any valid MimeSubType. | contentType | common | text | String | Setting for contentType can be set to any valid MimeType. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 88ac966..e8816c3 100644 --- a/components/camel-sjms/src/main/docs/sjms-batch-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-batch-component.adoc @@ -136,13 +136,26 @@ The Simple JMS Batch component supports 5 options which are listed below. // endpoint options: START -The Simple JMS Batch component supports 23 endpoint options which are listed below: +The Simple JMS Batch component is configured using the URI syntax with the following path and query parameters: + + sjms-batch:destinationName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| destinationName | | String | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. +|======================================================================= +{% endraw %} + +#### 22 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| destinationName | consumer | | String | *Required* The destination name. Only queues are supported names may be prefixed by 'queue:'. | aggregationStrategy | consumer | | AggregationStrategy | *Required* The aggregation strategy to use which merges all the batched messages into a single message | allowNullBody | consumer | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-sjms/src/main/docs/sjms-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sjms/src/main/docs/sjms-component.adoc b/components/camel-sjms/src/main/docs/sjms-component.adoc index 9352911..f2509a4 100644 --- a/components/camel-sjms/src/main/docs/sjms-component.adoc +++ b/components/camel-sjms/src/main/docs/sjms-component.adoc @@ -113,14 +113,27 @@ The Simple JMS component supports 10 options which are listed below. // endpoint options: START -The Simple JMS component supports 36 endpoint options which are listed below: +The Simple JMS component is configured using the URI syntax with the following path and query parameters: + + sjms:destinationType:destinationName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| destinationType | queue | String | The kind of destination to use +| destinationName | | String | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. +|======================================================================= +{% endraw %} + +#### 34 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| destinationType | common | queue | String | The kind of destination to use -| destinationName | common | | String | *Required* DestinationName is a JMS queue or topic name. By default the destinationName is interpreted as a queue name. | acknowledgementMode | common | AUTO_ACKNOWLEDGE | SessionAcknowledgementType | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE | 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. | consumerCount | consumer | 1 | int | Sets the number of consumer listeners used for this endpoint. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-slack/src/main/docs/slack-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc index dbd017b..b95b1b7 100644 --- a/components/camel-slack/src/main/docs/slack-component.adoc +++ b/components/camel-slack/src/main/docs/slack-component.adoc @@ -60,13 +60,26 @@ The Slack component supports 2 options which are listed below. // endpoint options: START -The Slack component supports 6 endpoint options which are listed below: +The Slack component is configured using the URI syntax with the following path and query parameters: + + slack:channel + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| channel | | String | *Required* The channel name (syntax name) or slackuser (syntax userName) to send a message directly to an user. +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| channel | producer | | String | *Required* The channel name (syntax name) or slackuser (syntax userName) to send a message directly to an user. | iconEmoji | producer | | String | Use a Slack emoji as an avatar | iconUrl | producer | | String | The avatar that the component will use when sending message to a channel or user. | username | producer | | String | This is the username that the bot will have when sending messages to a channel or user. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-smpp/src/main/docs/smpp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-smpp/src/main/docs/smpp-component.adoc b/components/camel-smpp/src/main/docs/smpp-component.adoc index 2039073..ac8d91c 100644 --- a/components/camel-smpp/src/main/docs/smpp-component.adoc +++ b/components/camel-smpp/src/main/docs/smpp-component.adoc @@ -187,14 +187,27 @@ The SMPP component supports 2 options which are listed below. // endpoint options: START -The SMPP component supports 40 endpoint options which are listed below: +The SMPP component is configured using the URI syntax with the following path and query parameters: + + smpp:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | localhost | String | Hostname for the SMSC server to use. +| port | 2775 | Integer | Port number for the SMSC server to use. +|======================================================================= +{% endraw %} + +#### 38 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | localhost | String | Hostname for the SMSC server to use. -| port | common | 2775 | Integer | Port number for the SMSC server to use. | initialReconnectDelay | common | 5000 | long | Defines the initial delay in milliseconds after the consumer/producer tries to reconnect to the SMSC after the connection was lost. | maxReconnect | common | 2147483647 | int | Defines the maximum number of attempts to reconnect to the SMSC if SMSC returns a negative bind response | reconnectDelay | common | 5000 | long | Defines the interval in milliseconds between the reconnect attempts if the connection to the SMSC was lost and the previous was not succeed. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 884ec2d..9f0ec65 100644 --- a/components/camel-snmp/src/main/docs/snmp-component.adoc +++ b/components/camel-snmp/src/main/docs/snmp-component.adoc @@ -49,14 +49,27 @@ The SNMP component has no options. // endpoint options: START -The SNMP component supports 36 endpoint options which are listed below: +The SNMP component is configured using the URI syntax with the following path and query parameters: + + snmp:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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 +|======================================================================= +{% endraw %} + +#### 34 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | consumer | | String | *Required* Hostname of the SNMP enabled device -| port | consumer | | Integer | *Required* Port number of the SNMP enabled device | 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. | delay | consumer | 60000 | long | Sets update rate in seconds | oids | consumer | | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-solr/src/main/docs/solr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-solr/src/main/docs/solr-component.adoc b/components/camel-solr/src/main/docs/solr-component.adoc index 28298db..12c3ab9 100644 --- a/components/camel-solr/src/main/docs/solr-component.adoc +++ b/components/camel-solr/src/main/docs/solr-component.adoc @@ -40,13 +40,26 @@ The Solr component has no options. // endpoint options: START -The Solr component supports 14 endpoint options which are listed below: +The Solr component is configured using the URI syntax with the following path and query parameters: + + solr:url + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| url | | String | *Required* Hostname and port for the solr server +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| url | producer | | String | *Required* Hostname and port for the solr server | allowCompression | producer | | Boolean | Server side must support gzip or deflate for this to have any effect | connectionTimeout | producer | | Integer | connectionTimeout on the underlying HttpConnectionManager | defaultMaxConnectionsPerHost | producer | | Integer | maxConnectionsPerHost on the underlying HttpConnectionManager @@ -198,4 +211,4 @@ http://wiki.apache.org/solr/SolrQuerySyntax[Solr Query Syntax] * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] -* link:getting-started.html[Getting Started] \ No newline at end of file +* link:getting-started.html[Getting Started] http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc index bdbd46e..e3e7245 100644 --- a/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc +++ b/components/camel-spark-rest/src/main/docs/spark-rest-component.adoc @@ -60,14 +60,27 @@ The Spark Rest component supports 12 options which are listed below. // endpoint options: START -The Spark Rest component supports 13 endpoint options which are listed below: +The Spark Rest component is configured using the URI syntax with the following path and query parameters: + + spark-rest:verb:path + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| verb | | String | *Required* get post put patch delete head trace connect or options. +| path | | String | *Required* The content path which support Spark syntax. +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| verb | consumer | | String | *Required* get post put patch delete head trace connect or options. -| path | consumer | | String | *Required* The content path which support Spark syntax. | accept | consumer | | String | Accept type such as: 'text/xml' or 'application/json'. By default we accept all kinds of types. | 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. | disableStreamCache | consumer | false | boolean | Determines whether or not the raw input stream from Spark HttpRequestgetContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure 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. Mind that if you enable this option then you cannot read the Netty stream multiple times out of the box and you would need manually to reset the reader index on the Spark raw stream. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spark/src/main/docs/spark-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spark/src/main/docs/spark-component.adoc b/components/camel-spark/src/main/docs/spark-component.adoc index 1b472d9..7934dc9 100644 --- a/components/camel-spark/src/main/docs/spark-component.adoc +++ b/components/camel-spark/src/main/docs/spark-component.adoc @@ -70,13 +70,26 @@ The Apache Spark component supports 3 options which are listed below. // endpoint options: START -The Apache Spark component supports 7 endpoint options which are listed below: +The Apache Spark component is configured using the URI syntax with the following path and query parameters: + + spark:endpointType + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| endpointType | | EndpointType | *Required* Type of the endpoint (rdd dataframe hive). +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| endpointType | producer | | EndpointType | *Required* Type of the endpoint (rdd dataframe hive). | collect | producer | true | boolean | Indicates if results should be collected or counted. | dataFrame | producer | | DataFrame | DataFrame to compute against. | dataFrameCallback | producer | | DataFrameCallback | Function performing action against an DataFrame. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-splunk/src/main/docs/splunk-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-splunk/src/main/docs/splunk-component.adoc b/components/camel-splunk/src/main/docs/splunk-component.adoc index 637bf65..18ecb75 100644 --- a/components/camel-splunk/src/main/docs/splunk-component.adoc +++ b/components/camel-splunk/src/main/docs/splunk-component.adoc @@ -104,13 +104,26 @@ The Splunk component supports 2 options which are listed below. // endpoint options: START -The Splunk component supports 43 endpoint options which are listed below: +The Splunk component is configured using the URI syntax with the following path and query parameters: + + splunk:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Name has no purpose +|======================================================================= +{% endraw %} + +#### 42 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Name has no purpose | app | common | | String | Splunk app | connectionTimeout | common | 5000 | int | Timeout in MS when connecting to Splunk server | host | common | localhost | String | Splunk host. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc index 990cccd..85c9890 100644 --- a/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc +++ b/components/camel-spring-batch/src/main/docs/spring-batch-component.adoc @@ -63,13 +63,26 @@ The Spring Batch component supports 3 options which are listed below. // endpoint options: START -The Spring Batch component supports 5 endpoint options which are listed below: +The Spring Batch component is configured using the URI syntax with the following path and query parameters: + + spring-batch:jobName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| jobName | | String | *Required* The name of the Spring Batch job located in the registry. +|======================================================================= +{% endraw %} + +#### 4 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| jobName | producer | | String | *Required* The name of the Spring Batch job located in the registry. | jobFromHeader | producer | false | boolean | Explicitly defines if the jobName should be taken from the headers instead of the URI. | jobLauncher | producer | | JobLauncher | Explicitly specifies a JobLauncher to be used. | jobRegistry | producer | | JobRegistry | Explicitly specifies a JobRegistry to be used. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc index b9763bb..8e23e48 100644 --- a/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc +++ b/components/camel-spring-integration/src/main/docs/spring-integration-component.adoc @@ -45,13 +45,26 @@ The Spring Integration component has no options. // endpoint options: START -The Spring Integration component supports 8 endpoint options which are listed below: +The Spring Integration component is configured using the URI syntax with the following path and query parameters: + + spring-integration:defaultChannel + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| defaultChannel | | String | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider. +|======================================================================= +{% endraw %} + +#### 7 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| defaultChannel | common | | String | *Required* The default channel name which is used by the Spring Integration Spring context. It will equal to the inputChannel name for the Spring Integration consumer and the outputChannel name for the Spring Integration provider. | inOut | common | false | boolean | The exchange pattern that the Spring integration endpoint should use. If inOut=true then a reply channel is expected either from the Spring Integration Message header or configured on the endpoint. | 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. | inputChannel | consumer | | String | The Spring integration input channel name that this endpoint wants to consume from Spring integration. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc index 4313562..ac58140 100644 --- a/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc +++ b/components/camel-spring-ldap/src/main/docs/spring-ldap-component.adoc @@ -40,13 +40,26 @@ The Spring LDAP component has no options. // endpoint options: START -The Spring LDAP component supports 4 endpoint options which are listed below: +The Spring LDAP component is configured using the URI syntax with the following path and query parameters: + + spring-ldap:templateName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| templateName | | String | *Required* Name of the Spring LDAP Template bean +|======================================================================= +{% endraw %} + +#### 3 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| templateName | producer | | String | *Required* Name of the Spring LDAP Template bean | operation | producer | | LdapOperation | *Required* The LDAP operation to be performed. | scope | producer | subtree | String | The scope of the search operation. | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).