http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc b/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc index 57eea45..efa814e 100644 --- a/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc +++ b/components/camel-elasticsearch5/src/main/docs/elasticsearch5-component.adoc @@ -39,13 +39,26 @@ The Elasticsearch5 component has no options. // endpoint options: START -The Elasticsearch5 component supports 10 endpoint options which are listed below: +The Elasticsearch5 component is configured using the URI syntax with the following path and query parameters: + + elasticsearch5:clusterName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| clusterName | | String | *Required* Name of the cluster +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| clusterName | producer | | String | *Required* Name of the cluster | clientTransportSniff | producer | 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. | indexName | producer | | String | The name of the index to act against | indexType | producer | | String | The type of the index to act against
http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-elsql/src/main/docs/elsql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-elsql/src/main/docs/elsql-component.adoc b/components/camel-elsql/src/main/docs/elsql-component.adoc index e8a024b..9f5efed 100644 --- a/components/camel-elsql/src/main/docs/elsql-component.adoc +++ b/components/camel-elsql/src/main/docs/elsql-component.adoc @@ -67,14 +67,27 @@ The ElSQL component supports 5 options which are listed below. // component options: END // endpoint options: START -The ElSQL component supports 49 endpoint options which are listed below: +The ElSQL component is configured using the URI syntax with the following path and query parameters: + + elsql:elsqlName:resourceUri + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| elsqlName | | String | *Required* The name of the elsql to use (is NAMED in the elsql file) +| resourceUri | | String | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint. +|======================================================================= +{% endraw %} + +#### 47 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| elsqlName | common | | String | *Required* The name of the elsql to use (is NAMED in the elsql file) -| resourceUri | common | | String | The resource file which contains the elsql SQL statements to use. You can specify multiple resources separated by comma. The resources are loaded on the classpath by default you can prefix with file: to load from file system. Notice you can set this option on the component and then you do not have to configure this on the endpoint. | allowNamedParameters | common | true | boolean | Whether to allow using named parameters in the queries. | databaseVendor | common | | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig | dataSource | common | | DataSource | Sets the DataSource to use to communicate with the database. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-etcd/src/main/docs/etcd-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-etcd/src/main/docs/etcd-component.adoc b/components/camel-etcd/src/main/docs/etcd-component.adoc index 1ed9252..41c7e25 100644 --- a/components/camel-etcd/src/main/docs/etcd-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-component.adoc @@ -16,14 +16,27 @@ // endpoint options: START -The etcd component supports 31 endpoint options which are listed below: +The etcd component is configured using the URI syntax with the following path and query parameters: + + etcd:namespace/path + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| namespace | | EtcdNamespace | *Required* The API namespace to use +| path | | String | The path the endpoint refers to +|======================================================================= +{% endraw %} + +#### 29 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| namespace | common | | EtcdNamespace | *Required* The API namespace to use -| path | common | | String | The path the endpoint refers to | recursive | common | false | boolean | To apply an action recursively. | servicePath | common | /services/ | String | The path to look for for service discovery | timeout | common | | Long | To set the maximum time an action could take to complete. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc index bea2f97..d167a41 100644 --- a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc +++ b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc @@ -48,13 +48,26 @@ The OSGi EventAdmin component supports 2 options which are listed below. // component options: END // endpoint options: START -The OSGi EventAdmin component supports 6 endpoint options which are listed below: +The OSGi EventAdmin component is configured using the URI syntax with the following path and query parameters: + + eventadmin:topic + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| topic | | String | Name of topic to listen or send to +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| topic | common | | String | Name of topic to listen or send to | send | common | false | boolean | Whether to use 'send' or 'synchronous' deliver. Default false (async delivery) | 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-exec/src/main/docs/exec-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-exec/src/main/docs/exec-component.adoc b/components/camel-exec/src/main/docs/exec-component.adoc index 47bad79..1a5cfc9 100644 --- a/components/camel-exec/src/main/docs/exec-component.adoc +++ b/components/camel-exec/src/main/docs/exec-component.adoc @@ -38,13 +38,26 @@ The Exec component has no options. // component options: END // endpoint options: START -The Exec component supports 9 endpoint options which are listed below: +The Exec component is configured using the URI syntax with the following path and query parameters: + + exec:executable + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| executable | | String | *Required* Sets the executable to be executed. The executable must not be empty or null. +|======================================================================= +{% endraw %} + +#### 8 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| executable | producer | | String | *Required* Sets the executable to be executed. The executable must not be empty or null. | args | producer | | String | The arguments may be one or many whitespace-separated tokens. | binding | producer | | ExecBinding | A reference to a org.apache.commons.exec.ExecBinding in the Registry. | commandExecutor | producer | | ExecCommandExecutor | A reference to a org.apache.commons.exec.ExecCommandExecutor in the Registry that customizes the command execution. The default command executor utilizes the commons-exec library which adds a shutdown hook for every executed command. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-facebook/src/main/docs/facebook-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-facebook/src/main/docs/facebook-component.adoc b/components/camel-facebook/src/main/docs/facebook-component.adoc index 3d33a71..cf3ad3f 100644 --- a/components/camel-facebook/src/main/docs/facebook-component.adoc +++ b/components/camel-facebook/src/main/docs/facebook-component.adoc @@ -71,13 +71,26 @@ The Facebook component supports 2 options which are listed below. // endpoint options: START -The Facebook component supports 103 endpoint options which are listed below: +The Facebook component is configured using the URI syntax with the following path and query parameters: + + facebook:methodName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| methodName | | String | *Required* What operation to perform +|======================================================================= +{% endraw %} + +#### 102 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| methodName | common | | String | *Required* What operation to perform | achievementURL | common | | URL | The unique URL of the achievement | albumId | common | | String | The album ID | albumUpdate | common | | AlbumUpdate | The facebook Album to be created or updated http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-flatpack/src/main/docs/flatpack-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flatpack/src/main/docs/flatpack-component.adoc b/components/camel-flatpack/src/main/docs/flatpack-component.adoc index 6b5c875..f02fcda 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-component.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-component.adoc @@ -45,14 +45,27 @@ The Flatpack component has no options. // component options: END // endpoint options: START -The Flatpack component supports 27 endpoint options which are listed below: +The Flatpack component is configured using the URI syntax with the following path and query parameters: + + flatpack:type:resourceUri + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| type | delim | FlatpackType | Whether to use fixed or delimiter +| resourceUri | | String | *Required* URL for loading the flatpack mapping file from classpath or file system +|======================================================================= +{% endraw %} + +#### 25 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| type | common | delim | FlatpackType | Whether to use fixed or delimiter -| resourceUri | common | | String | *Required* URL for loading the flatpack mapping file from classpath or file system | allowShortLines | common | false | boolean | Allows for lines to be shorter than expected and ignores the extra characters | delimiter | common | , | char | The default character delimiter for delimited files. | ignoreExtraColumns | common | false | boolean | Allows for lines to be longer than expected and ignores the extra characters http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-flink/src/main/docs/flink-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flink/src/main/docs/flink-component.adoc b/components/camel-flink/src/main/docs/flink-component.adoc index f4c9397..5ce3d8d 100644 --- a/components/camel-flink/src/main/docs/flink-component.adoc +++ b/components/camel-flink/src/main/docs/flink-component.adoc @@ -39,13 +39,26 @@ FlinkEndpoint Options // endpoint options: START -The Apache Flink component supports 7 endpoint options which are listed below: +The Apache Flink component is configured using the URI syntax with the following path and query parameters: + + flink: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 (dataset datastream). +|======================================================================= +{% 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 (dataset datastream). | collect | producer | true | boolean | Indicates if results should be collected or counted. | dataSet | producer | | DataSet | DataSet to compute against. | dataSetCallback | producer | | DataSetCallback | Function performing action against a DataSet. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-fop/src/main/docs/fop-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-fop/src/main/docs/fop-component.adoc b/components/camel-fop/src/main/docs/fop-component.adoc index 0b509b1..5c03430 100644 --- a/components/camel-fop/src/main/docs/fop-component.adoc +++ b/components/camel-fop/src/main/docs/fop-component.adoc @@ -68,13 +68,26 @@ The FOP component has no options. // endpoint options: START -The FOP component supports 4 endpoint options which are listed below: +The FOP component is configured using the URI syntax with the following path and query parameters: + + fop:outputType + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| outputType | | FopOutputType | *Required* The primary output format is PDF but other output formats are also supported. +|======================================================================= +{% endraw %} + +#### 3 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| outputType | producer | | FopOutputType | *Required* The primary output format is PDF but other output formats are also supported. | fopFactory | producer | | FopFactory | Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory. | userConfigURL | producer | | String | The location of a configuration file which can be loaded from classpath or file system. | 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-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 07a2409..215b469 100644 --- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc +++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc @@ -58,13 +58,26 @@ The Freemarker component supports 2 options which are listed below. // endpoint options: START -The Freemarker component supports 6 endpoint options which are listed below: +The Freemarker component is configured using the URI syntax with the following path and query parameters: + + freemarker:resourceUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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. +|======================================================================= +{% endraw %} + +#### 5 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| resourceUri | producer | | 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. | configuration | producer | | Configuration | Sets the Freemarker configuration to use | contentCache | producer | false | boolean | Sets whether to use resource content cache or not | encoding | producer | | String | Sets the encoding to be used for loading the template file. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 a46285b..2954a88 100644 --- a/components/camel-ftp/src/main/docs/ftp-component.adoc +++ b/components/camel-ftp/src/main/docs/ftp-component.adoc @@ -79,15 +79,28 @@ The FTP component has no options. // endpoint options: START -The FTP component supports 105 endpoint options which are listed below: +The FTP component is configured using the URI syntax with the following path and query parameters: + + ftp:host:port/directoryName + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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 +|======================================================================= +{% endraw %} + +#### 102 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Hostname of the FTP server -| port | common | | int | Port of the FTP server -| directoryName | common | | String | The starting directory | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 b6fd5cd..ad324ad 100644 --- a/components/camel-ftp/src/main/docs/ftps-component.adoc +++ b/components/camel-ftp/src/main/docs/ftps-component.adoc @@ -30,15 +30,28 @@ The FTPS component has no options. // endpoint options: START -The FTPS component supports 113 endpoint options which are listed below: +The FTPS component is configured using the URI syntax with the following path and query parameters: + + ftps:host:port/directoryName + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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 +|======================================================================= +{% endraw %} + +#### 110 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Hostname of the FTP server -| port | common | | int | Port of the FTP server -| directoryName | common | | String | The starting directory | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 757ac18..3a4f86f 100644 --- a/components/camel-ftp/src/main/docs/sftp-component.adoc +++ b/components/camel-ftp/src/main/docs/sftp-component.adoc @@ -30,15 +30,28 @@ The SFTP component has no options. // endpoint options: START -The SFTP component supports 112 endpoint options which are listed below: +The SFTP component is configured using the URI syntax with the following path and query parameters: + + sftp:host:port/directoryName + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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 +|======================================================================= +{% endraw %} + +#### 109 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Hostname of the FTP server -| port | common | | int | Port of the FTP server -| directoryName | common | | String | The starting directory | 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-ganglia/src/main/docs/ganglia-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ganglia/src/main/docs/ganglia-component.adoc b/components/camel-ganglia/src/main/docs/ganglia-component.adoc index 18ae6d5..ab54eaf 100644 --- a/components/camel-ganglia/src/main/docs/ganglia-component.adoc +++ b/components/camel-ganglia/src/main/docs/ganglia-component.adoc @@ -70,14 +70,27 @@ The Ganglia component supports 2 options which are listed below. // endpoint options: START -The Ganglia component supports 15 endpoint options which are listed below: +The Ganglia component is configured using the URI syntax with the following path and query parameters: + + ganglia:host:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | 239.2.11.71 | String | Host name for Ganglia server +| port | 8649 | int | Port for Ganglia server +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | producer | 239.2.11.71 | String | Host name for Ganglia server -| port | producer | 8649 | int | Port for Ganglia server | dmax | producer | 0 | int | Minumum time in seconds before Ganglia will purge the metric value if it expires. Set to 0 and the value will remain in Ganglia indefinitely until a gmond agent restart. | groupName | producer | java | String | The group that the metric belongs to. | metricName | producer | metric | String | The name to use for the metric. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-geocoder/src/main/docs/geocoder-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-geocoder/src/main/docs/geocoder-component.adoc b/components/camel-geocoder/src/main/docs/geocoder-component.adoc index acbe6c3..e9404af 100644 --- a/components/camel-geocoder/src/main/docs/geocoder-component.adoc +++ b/components/camel-geocoder/src/main/docs/geocoder-component.adoc @@ -39,14 +39,27 @@ The Geocoder component has no options. // endpoint options: START -The Geocoder component supports 16 endpoint options which are listed below: +The Geocoder component is configured using the URI syntax with the following path and query parameters: + + geocoder:address:latlng + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| address | | String | The geo address which should be prefixed with address: +| latlng | | String | The geo latitude and longitude which should be prefixed with latlng: +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| address | producer | | String | The geo address which should be prefixed with address: -| latlng | producer | | String | The geo latitude and longitude which should be prefixed with latlng: | clientId | producer | | String | To use google premium with this client id | clientKey | producer | | String | To use google premium with this client key | headersOnly | producer | false | boolean | Whether to only enrich the Exchange with headers and leave the body as-is. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-git/src/main/docs/git-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-git/src/main/docs/git-component.adoc b/components/camel-git/src/main/docs/git-component.adoc index 2c602fb9..186c58f 100644 --- a/components/camel-git/src/main/docs/git-component.adoc +++ b/components/camel-git/src/main/docs/git-component.adoc @@ -36,13 +36,26 @@ The Git component has no options. // endpoint options: START -The Git component supports 14 endpoint options which are listed below: +The Git component is configured using the URI syntax with the following path and query parameters: + + git:localPath + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| localPath | | String | *Required* Local repository path +|======================================================================= +{% endraw %} + +#### 13 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| localPath | common | | String | *Required* Local repository path | branchName | common | | String | The branch name to work on | password | common | | String | Remote repository password | remoteName | common | | String | The remote repository name to use in particular operation like pull http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-github/src/main/docs/github-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-github/src/main/docs/github-component.adoc b/components/camel-github/src/main/docs/github-component.adoc index 18c8fd6..4a1f1e3 100644 --- a/components/camel-github/src/main/docs/github-component.adoc +++ b/components/camel-github/src/main/docs/github-component.adoc @@ -51,14 +51,27 @@ The GitHub component has no options. // endpoint options: START -The GitHub component supports 14 endpoint options which are listed below: +The GitHub component is configured using the URI syntax with the following path and query parameters: + + github:type/branchName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| type | | GitHubType | *Required* What git operation to execute +| branchName | | String | Name of branch +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| type | common | | GitHubType | *Required* What git operation to execute -| branchName | consumer | | String | Name of branch | oauthToken | common | | String | GitHub OAuth token required unless username & password are provided | password | common | | String | GitHub password required unless oauthToken is provided | repoName | common | | String | *Required* GitHub repository name http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 8294bb4..e9e507d 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 @@ -60,14 +60,27 @@ The Google Calendar component supports 3 options which are listed below. // endpoint options: START -The Google Calendar component supports 16 endpoint options which are listed below: +The Google Calendar component is configured using the URI syntax with the following path and query parameters: + + google-calendar:apiName/methodName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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 +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiName | common | | GoogleCalendarApiName | *Required* What kind of operation to perform -| methodName | common | | String | *Required* What sub operation to use for the selected operation | accessToken | common | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | applicationName | common | | String | Google calendar application name. Example would be camel-google-calendar/1.0 | clientId | common | | String | Client ID of the calendar application http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-google-drive/src/main/docs/google-drive-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-drive/src/main/docs/google-drive-component.adoc b/components/camel-google-drive/src/main/docs/google-drive-component.adoc index d5cb173..10f7830 100644 --- a/components/camel-google-drive/src/main/docs/google-drive-component.adoc +++ b/components/camel-google-drive/src/main/docs/google-drive-component.adoc @@ -85,14 +85,27 @@ The Google Drive component supports 3 options which are listed below. // endpoint options: START -The Google Drive component supports 14 endpoint options which are listed below: +The Google Drive component is configured using the URI syntax with the following path and query parameters: + + google-drive:apiName/methodName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| apiName | | GoogleDriveApiName | *Required* What kind of operation to perform +| methodName | | String | *Required* What sub operation to use for the selected operation +|======================================================================= +{% endraw %} + +#### 12 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiName | common | | GoogleDriveApiName | *Required* What kind of operation to perform -| methodName | common | | String | *Required* What sub operation to use for the selected operation | accessToken | common | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | applicationName | common | | String | Google drive application name. Example would be camel-google-drive/1.0 | clientFactory | common | | GoogleDriveClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleDriveClientFactory http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-google-mail/src/main/docs/google-mail-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-mail/src/main/docs/google-mail-component.adoc b/components/camel-google-mail/src/main/docs/google-mail-component.adoc index 425a683..c275a18 100644 --- a/components/camel-google-mail/src/main/docs/google-mail-component.adoc +++ b/components/camel-google-mail/src/main/docs/google-mail-component.adoc @@ -79,14 +79,27 @@ The Google Mail component supports 3 options which are listed below. // endpoint options: START -The Google Mail component supports 13 endpoint options which are listed below: +The Google Mail component is configured using the URI syntax with the following path and query parameters: + + google-mail:apiName/methodName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| apiName | | GoogleMailApiName | *Required* What kind of operation to perform +| methodName | | String | *Required* What sub operation to use for the selected operation +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| apiName | common | | GoogleMailApiName | *Required* What kind of operation to perform -| methodName | common | | String | *Required* What sub operation to use for the selected operation | accessToken | common | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. | applicationName | common | | String | Google mail application name. Example would be camel-google-mail/1.0 | clientId | common | | String | Client ID of the mail application http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc index 7280aaa..5cf80e6 100644 --- a/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc +++ b/components/camel-google-pubsub/src/main/docs/google-pubsub-component.adoc @@ -70,14 +70,27 @@ The Google Pubsub component supports 2 options which are listed below. // component options: END // endpoint options: START -The Google Pubsub component supports 11 endpoint options which are listed below: +The Google Pubsub component is configured using the URI syntax with the following path and query parameters: + + google-pubsub:projectId:destinationName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| projectId | | String | *Required* Project Id +| destinationName | | String | *Required* Destination Name +|======================================================================= +{% endraw %} + +#### 9 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| projectId | common | | String | *Required* Project Id -| destinationName | common | | String | *Required* Destination Name | ackMode | common | AUTO | AckMode | AUTO = exchange gets ack'ed/nack'ed on completion. NONE = downstream process has to ack/nack explicitly | concurrentConsumers | common | 1 | Integer | The number of parallel streams consuming from the subscription | connectionFactory | common | | GooglePubsubConnectionFactory | ConnectionFactory to obtain connection to PubSub Service. If non provided the default will be used. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-gora/src/main/docs/gora-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-gora/src/main/docs/gora-component.adoc b/components/camel-gora/src/main/docs/gora-component.adoc index 1648d65..b07b99a 100644 --- a/components/camel-gora/src/main/docs/gora-component.adoc +++ b/components/camel-gora/src/main/docs/gora-component.adoc @@ -83,13 +83,26 @@ The Gora component has no options. // endpoint options: START -The Gora component supports 22 endpoint options which are listed below: +The Gora component is configured using the URI syntax with the following path and query parameters: + + gora:name + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| name | | String | *Required* Instance name +|======================================================================= +{% endraw %} + +#### 21 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| name | common | | String | *Required* Instance name | dataStoreClass | common | | String | The type of the dataStore | keyClass | common | | String | The type class of the key | valueClass | common | | String | The type of the value http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-grape/src/main/docs/grape-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-grape/src/main/docs/grape-component.adoc b/components/camel-grape/src/main/docs/grape-component.adoc index a4084ee..0af4276 100644 --- a/components/camel-grape/src/main/docs/grape-component.adoc +++ b/components/camel-grape/src/main/docs/grape-component.adoc @@ -17,13 +17,26 @@ The Grape component has no options. // endpoint options: START -The Grape component supports 3 endpoint options which are listed below: +The Grape component is configured using the URI syntax with the following path and query parameters: + + grape:defaultCoordinates + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| defaultCoordinates | | String | *Required* Maven coordinates to use as default to grab if the message body is empty. +|======================================================================= +{% endraw %} + +#### 2 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| defaultCoordinates | | | String | *Required* Maven coordinates to use as default to grab if the message body is empty. | exchangePattern | | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange. | synchronous | | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= @@ -222,4 +235,4 @@ command: * 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-guava-eventbus/src/main/docs/guava-eventbus-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc index bf45e26..9875a8f 100644 --- a/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc +++ b/components/camel-guava-eventbus/src/main/docs/guava-eventbus-component.adoc @@ -67,13 +67,26 @@ The Guava EventBus component supports 3 options which are listed below. // endpoint options: START -The Guava EventBus component supports 7 endpoint options which are listed below: +The Guava EventBus component is configured using the URI syntax with the following path and query parameters: + + guava-eventbus:eventBusRef + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| eventBusRef | | String | To lookup the Guava EventBus from the registry with the given name +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| eventBusRef | common | | String | To lookup the Guava EventBus from the registry with the given name | eventClass | common | | Class<?> | If used on the consumer side of the route will filter events received from the EventBus to the instances of the class and superclasses of eventClass. Null value of this option is equal to setting it to the java.lang.Object i.e. the consumer will capture all messages incoming to the event bus. This option cannot be used together with listenerInterface option. | listenerInterface | common | | Class<?> | The interface with method(s) marked with the Subscribe annotation. Dynamic proxy will be created over the interface so it could be registered as the EventBus listener. Particularly useful when creating multi-event listeners and for handling DeadEvent properly. This option cannot be used together with eventClass option. | 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-hazelcast/src/main/docs/hazelcast-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc b/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc index 8ffa9e7..42f95ea 100644 --- a/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc +++ b/components/camel-hazelcast/src/main/docs/hazelcast-component.adoc @@ -66,14 +66,27 @@ The Hazelcast component supports 2 options which are listed below. // endpoint options: START -The Hazelcast component supports 13 endpoint options which are listed below: +The Hazelcast component is configured using the URI syntax with the following path and query parameters: + + hazelcast:command:cacheName + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| command | | HazelcastCommand | *Required* What operation to perform. +| cacheName | | String | *Required* The name of the cache +|======================================================================= +{% endraw %} + +#### 11 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| command | common | | HazelcastCommand | *Required* What operation to perform. -| cacheName | common | | String | *Required* The name of the cache | defaultOperation | common | | String | To specify a default operation to use if no operation header has been provided. | hazelcastInstance | common | | HazelcastInstance | The hazelcast instance reference which can be used for hazelcast endpoint. | hazelcastInstanceName | common | | String | The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference camel use the default hazelcast instance from the camel-hazelcast instance. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-hbase/src/main/docs/hbase-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hbase/src/main/docs/hbase-component.adoc b/components/camel-hbase/src/main/docs/hbase-component.adoc index 4608a1d..ef6e228 100644 --- a/components/camel-hbase/src/main/docs/hbase-component.adoc +++ b/components/camel-hbase/src/main/docs/hbase-component.adoc @@ -122,13 +122,26 @@ The HBase component supports 3 options which are listed below. // endpoint options: START -The HBase component supports 17 endpoint options which are listed below: +The HBase component is configured using the URI syntax with the following path and query parameters: + + hbase:tableName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| tableName | | String | *Required* The name of the table +|======================================================================= +{% endraw %} + +#### 16 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| tableName | common | | String | *Required* The name of the table | cellMappingStrategyFactory | common | | CellMappingStrategyFactory | To use a custom CellMappingStrategyFactory that is responsible for mapping cells. | filters | common | | List | A list of filters to use. | mappingStrategyClassName | common | | String | The class name of a custom mapping strategy implementation. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-hdfs/src/main/docs/hdfs-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hdfs/src/main/docs/hdfs-component.adoc b/components/camel-hdfs/src/main/docs/hdfs-component.adoc index eb8edad..5edc675 100644 --- a/components/camel-hdfs/src/main/docs/hdfs-component.adoc +++ b/components/camel-hdfs/src/main/docs/hdfs-component.adoc @@ -76,15 +76,28 @@ The HDFS component supports 2 options which are listed below. // endpoint options: START -The HDFS component supports 41 endpoint options which are listed below: +The HDFS component is configured using the URI syntax with the following path and query parameters: + + hdfs:hostName:port/path + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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 +|======================================================================= +{% endraw %} + +#### 38 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| hostName | common | | String | *Required* HDFS host to use -| port | common | 8020 | int | HDFS port to use -| path | common | | String | *Required* The directory path to use | connectOnStartup | common | 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 | common | HDFS | HdfsFileSystemType | Set to LOCAL to not use HDFS but local java.io.File instead. | fileType | common | NORMAL_FILE | HdfsFileType | The file type to use. For more details see Hadoop HDFS documentation about the various files types. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 8cb9453..d61a713 100644 --- a/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc +++ b/components/camel-hdfs2/src/main/docs/hdfs2-component.adoc @@ -73,15 +73,28 @@ The HDFS2 component supports 2 options which are listed below. // endpoint options: START -The HDFS2 component supports 41 endpoint options which are listed below: +The HDFS2 component is configured using the URI syntax with the following path and query parameters: + + hdfs2:hostName:port/path + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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 +|======================================================================= +{% endraw %} + +#### 38 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| hostName | common | | String | *Required* HDFS host to use -| port | common | 8020 | int | HDFS port to use -| path | common | | String | *Required* The directory path to use | connectOnStartup | common | 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 | common | HDFS | HdfsFileSystemType | Set to LOCAL to not use HDFS but local java.io.File instead. | fileType | common | NORMAL_FILE | HdfsFileType | The file type to use. For more details see Hadoop HDFS documentation about the various files types. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-hipchat/src/main/docs/hipchat-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hipchat/src/main/docs/hipchat-component.adoc b/components/camel-hipchat/src/main/docs/hipchat-component.adoc index 0bc8b51..a33c498 100644 --- a/components/camel-hipchat/src/main/docs/hipchat-component.adoc +++ b/components/camel-hipchat/src/main/docs/hipchat-component.adoc @@ -35,15 +35,28 @@ The Hipchat component has no options. // endpoint options: START -The Hipchat component supports 24 endpoint options which are listed below: +The Hipchat component is configured using the URI syntax with the following path and query parameters: + + hipchat:protocol:host:port + +#### 3 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| protocol | | String | *Required* The protocol for the hipchat server such as http. +| host | | String | *Required* The host for the hipchat server such as api.hipchat.com +| port | 80 | Integer | The port for the hipchat server. Is by default 80. +|======================================================================= +{% endraw %} + +#### 21 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 for the hipchat server such as http. -| host | common | | String | *Required* The host for the hipchat server such as api.hipchat.com -| port | common | 80 | Integer | The port for the hipchat server. Is by default 80. | authToken | common | | String | OAuth 2 auth token | consumeUsers | common | | String | Username(s) when consuming messages from the hiptchat server. Multiple user names can be 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. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 2f19e72..c17cef3 100644 --- a/components/camel-http/src/main/docs/http-component.adoc +++ b/components/camel-http/src/main/docs/http-component.adoc @@ -142,13 +142,26 @@ The HTTP component supports 7 options which are listed below. // endpoint options: START -The HTTP component supports 39 endpoint options which are listed below: +The HTTP component is configured using the URI syntax with the following path and query parameters: + + http:httpUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| httpUri | | URI | *Required* The url of the HTTP endpoint to call. +|======================================================================= +{% endraw %} + +#### 38 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| httpUri | producer | | URI | *Required* The url of the HTTP endpoint to call. | 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-http4/src/main/docs/http4-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-http4/src/main/docs/http4-component.adoc b/components/camel-http4/src/main/docs/http4-component.adoc index 93e6812..fd07940 100644 --- a/components/camel-http4/src/main/docs/http4-component.adoc +++ b/components/camel-http4/src/main/docs/http4-component.adoc @@ -87,13 +87,26 @@ The HTTP4 component supports 14 options which are listed below. // endpoint options: START -The HTTP4 component supports 48 endpoint options which are listed below: +The HTTP4 component is configured using the URI syntax with the following path and query parameters: + + http4:httpUri + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| httpUri | | URI | *Required* The url of the HTTP endpoint to call. +|======================================================================= +{% endraw %} + +#### 47 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| httpUri | producer | | URI | *Required* The url of the HTTP endpoint to call. | 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-ibatis/src/main/docs/ibatis-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ibatis/src/main/docs/ibatis-component.adoc b/components/camel-ibatis/src/main/docs/ibatis-component.adoc index bf8ccc8..a829c16 100644 --- a/components/camel-ibatis/src/main/docs/ibatis-component.adoc +++ b/components/camel-ibatis/src/main/docs/ibatis-component.adoc @@ -80,13 +80,26 @@ The iBatis component supports 4 options which are listed below. // endpoint options: START -The iBatis component supports 28 endpoint options which are listed below: +The iBatis component is configured using the URI syntax with the following path and query parameters: + + ibatis:statement + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| statement | | String | *Required* The statement name in the iBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. +|======================================================================= +{% endraw %} + +#### 27 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| statement | common | | String | *Required* The statement name in the iBatis XML mapping file which maps to the query insert update or delete operation you wish to evaluate. | isolation | common | TRANSACTION_REPEATABLE_READ | String | Transaction isolation level | useTransactions | common | true | boolean | Whether to use transactions. This option is by default true. | 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-infinispan/src/main/docs/infinispan-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-infinispan/src/main/docs/infinispan-component.adoc b/components/camel-infinispan/src/main/docs/infinispan-component.adoc index cbddadd..e8d1d84 100644 --- a/components/camel-infinispan/src/main/docs/infinispan-component.adoc +++ b/components/camel-infinispan/src/main/docs/infinispan-component.adoc @@ -45,13 +45,26 @@ The Infinispan component has no options. // endpoint options: START -The Infinispan component supports 15 endpoint options which are listed below: +The Infinispan component is configured using the URI syntax with the following path and query parameters: + + infinispan:host + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* Specifies the host of the cache on Infinispan instance +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Specifies the host of the cache on Infinispan instance | cacheContainer | common | | BasicCacheContainer | Specifies the cache Container to connect | cacheName | common | | String | Specifies the cache name | queryBuilder | common | | InfinispanQueryBuilder | Specifies the query builder. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 12ec1b4..71f0390 100644 --- a/components/camel-influxdb/src/main/docs/influxdb-component.adoc +++ b/components/camel-influxdb/src/main/docs/influxdb-component.adoc @@ -48,13 +48,26 @@ The InfluxDB component has no options. // endpoint options: START -The InfluxDB component supports 7 endpoint options which are listed below: +The InfluxDB component is configured using the URI syntax with the following path and query parameters: + + influxdb:connectionBean + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| connectionBean | | String | *Required* Connection to the influx database of class InfluxDB.class +|======================================================================= +{% endraw %} + +#### 6 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| connectionBean | producer | | String | *Required* Connection to the influx database of class InfluxDB.class | batch | producer | false | boolean | Define if this operation is a batch operation or not | databaseName | producer | | String | The name of the database where the time series will be stored | operation | producer | insert | String | Define if this operation is an insert or a query http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 b496788..5fb9921 100644 --- a/components/camel-irc/src/main/docs/irc-component.adoc +++ b/components/camel-irc/src/main/docs/irc-component.adoc @@ -44,14 +44,27 @@ The IRC component has no options. // endpoint options: START -The IRC component supports 26 endpoint options which are listed below: +The IRC component is configured using the URI syntax with the following path and query parameters: + + irc:hostname:port + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",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. +|======================================================================= +{% endraw %} + +#### 24 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| hostname | common | | String | *Required* Hostname for the IRC chat server -| port | common | | 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. | autoRejoin | common | true | boolean | Whether to auto re-join when being kicked | namesOnJoin | common | 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 | common | | String | The nickname used in chat. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-ironmq/src/main/docs/ironmq-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ironmq/src/main/docs/ironmq-component.adoc b/components/camel-ironmq/src/main/docs/ironmq-component.adoc index 3f3712b..77c8bca 100644 --- a/components/camel-ironmq/src/main/docs/ironmq-component.adoc +++ b/components/camel-ironmq/src/main/docs/ironmq-component.adoc @@ -40,13 +40,26 @@ Where **queueName** identifies the IronMQ queue you want to publish or consume m // endpoint options: START -The IronMQ component supports 31 endpoint options which are listed below: +The IronMQ component is configured using the URI syntax with the following path and query parameters: + + ironmq:queueName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| queueName | | String | *Required* The name of the IronMQ queue +|======================================================================= +{% endraw %} + +#### 30 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| queueName | common | | String | *Required* The name of the IronMQ queue | client | common | | Client | Reference to a io.iron.ironmq.Client in the Registry. | ironMQCloud | common | https://mq-aws-us-east-1-1.iron.io | String | IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU) | preserveHeaders | common | false | boolean | Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list and a message body. Useful when Camel is both consumer and producer. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-javaspace/src/main/docs/javaspace-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-javaspace/src/main/docs/javaspace-component.adoc b/components/camel-javaspace/src/main/docs/javaspace-component.adoc index 4c40b73..121d0e0 100644 --- a/components/camel-javaspace/src/main/docs/javaspace-component.adoc +++ b/components/camel-javaspace/src/main/docs/javaspace-component.adoc @@ -55,13 +55,26 @@ The JavaSpace component has no options. // endpoint options: START -The JavaSpace component supports 11 endpoint options which are listed below: +The JavaSpace component is configured using the URI syntax with the following path and query parameters: + + javaspace:url + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| url | | String | *Required* The URL to the JavaSpace server +|======================================================================= +{% endraw %} + +#### 10 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| url | common | | String | *Required* The URL to the JavaSpace server | spaceName | common | | String | *Required* Specifies the JavaSpace name. | transactional | common | false | boolean | If true sending and receiving entries is performed within a transaction. | transactionTimeout | common | | long | Specifies the transaction timeout in millis. By default there is no timeout. http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jbpm/src/main/docs/jbpm-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jbpm/src/main/docs/jbpm-component.adoc b/components/camel-jbpm/src/main/docs/jbpm-component.adoc index 22c7e15..a14945f 100644 --- a/components/camel-jbpm/src/main/docs/jbpm-component.adoc +++ b/components/camel-jbpm/src/main/docs/jbpm-component.adoc @@ -38,13 +38,26 @@ The JBPM component has no options. // endpoint options: START -The JBPM component supports 26 endpoint options which are listed below: +The JBPM component is configured using the URI syntax with the following path and query parameters: + + jbpm:connectionURL + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| connectionURL | | URL | *Required* The URL to the jBPM server. +|======================================================================= +{% endraw %} + +#### 25 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| connectionURL | producer | | URL | *Required* The URL to the jBPM server. | attachmentId | producer | | Long | attachId to use when retrieving attachments | contentId | producer | | Long | contentId to use when retrieving attachments | deploymentId | producer | | String | *Required* The id of the deployment http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/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 66047dd..03de152 100644 --- a/components/camel-jcache/src/main/docs/jcache-component.adoc +++ b/components/camel-jcache/src/main/docs/jcache-component.adoc @@ -8,13 +8,26 @@ // endpoint options: START -The JCache component supports 23 endpoint options which are listed below: +The JCache component is configured using the URI syntax with the following path and query parameters: + + jcache:cacheName + +#### 1 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| cacheName | | String | *Required* The name of the cache +|======================================================================= +{% endraw %} + +#### 22 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| cacheName | common | | String | *Required* The name of the cache | 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 http://git-wip-us.apache.org/repos/asf/camel/blob/c776464d/components/camel-jclouds/src/main/docs/jclouds-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jclouds/src/main/docs/jclouds-component.adoc b/components/camel-jclouds/src/main/docs/jclouds-component.adoc index 9d56c70..b9d86aa 100644 --- a/components/camel-jclouds/src/main/docs/jclouds-component.adoc +++ b/components/camel-jclouds/src/main/docs/jclouds-component.adoc @@ -123,14 +123,27 @@ The JClouds component supports 3 options which are listed below. // endpoint options: START -The JClouds component supports 17 endpoint options which are listed below: +The JClouds component is configured using the URI syntax with the following path and query parameters: + + jclouds:command:providerId + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| command | | JcloudsCommand | *Required* What command to execute such as blobstore or compute. +| providerId | | String | *Required* The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2). +|======================================================================= +{% endraw %} + +#### 15 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| command | common | | JcloudsCommand | *Required* What command to execute such as blobstore or compute. -| providerId | common | | String | *Required* The name of the cloud provider that provides the target service (e.g. aws-s3 or aws_ec2). | 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-jcr/src/main/docs/jcr-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jcr/src/main/docs/jcr-component.adoc b/components/camel-jcr/src/main/docs/jcr-component.adoc index ac7283e..192f9d0 100644 --- a/components/camel-jcr/src/main/docs/jcr-component.adoc +++ b/components/camel-jcr/src/main/docs/jcr-component.adoc @@ -48,14 +48,27 @@ The JCR component has no options. // endpoint options: START -The JCR component supports 16 endpoint options which are listed below: +The JCR component is configured using the URI syntax with the following path and query parameters: + + jcr:host/base + +#### 2 path parameters: + +{% raw %} +[width="100%",cols="2,1,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| host | | String | *Required* Name of the javax.jcr.Repository to lookup from the Camel registry to be used. +| base | | String | Get the base node when accessing the repository +|======================================================================= +{% endraw %} + +#### 14 query parameters: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description -| host | common | | String | *Required* Name of the javax.jcr.Repository to lookup from the Camel registry to be used. -| base | common | | String | Get the base node when accessing the repository | deep | common | false | boolean | When isDeep is true events whose associated parent node is at absPath or within its subgraph are received. | eventTypes | common | | int | eventTypes (a combination of one or more event types encoded as a bit mask value such as javax.jcr.observation.Event.NODE_ADDED javax.jcr.observation.Event.NODE_REMOVED etc.). | nodeTypeNames | common | | String | When a comma separated nodeTypeName list string is set only events whose associated parent node has one of the node types (or a subtype of one of the node types) in this list will be received.
