Repository: camel Updated Branches: refs/heads/master 0be929fe8 -> 9a5778bb6
Components/dataformats/languages docs update Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/9a5778bb Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/9a5778bb Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/9a5778bb Branch: refs/heads/master Commit: 9a5778bb6751b46ccf197840bde19e0d98a73153 Parents: 0be929f Author: Andrea Cosentino <anco...@gmail.com> Authored: Tue Sep 6 15:56:01 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Tue Sep 6 16:06:05 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/dropbox-component.adoc | 37 +++-- .../src/main/docs/elsql-component.adoc | 152 +++++++++---------- .../src/main/docs/eventadmin-component.adoc | 31 +++- .../src/main/docs/exec-component.adoc | 53 +++---- .../src/main/docs/flatpack-component.adoc | 55 ++++--- .../src/main/docs/flatpack-dataformat.adoc | 38 ++--- .../src/main/docs/hessian-dataformat.adoc | 7 + .../src/main/docs/ical-dataformat.adoc | 18 +++ .../src/main/docs/jibx-dataformat.adoc | 20 +++ .../camel-jmx/src/main/docs/jmx-component.adoc | 50 ++++++ .../camel-lzf/src/main/docs/lzf-dataformat.adoc | 18 ++- .../src/main/docs/quickfix-component.adoc | 40 +++++ .../src/main/docs/syslog-dataformat.adoc | 12 +- .../src/main/docs/zookeeper-component.adoc | 22 +++ 14 files changed, 377 insertions(+), 176 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-dropbox/src/main/docs/dropbox-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-dropbox/src/main/docs/dropbox-component.adoc b/components/camel-dropbox/src/main/docs/dropbox-component.adoc index 84c4a50..6fc5d04 100644 --- a/components/camel-dropbox/src/main/docs/dropbox-component.adoc +++ b/components/camel-dropbox/src/main/docs/dropbox-component.adoc @@ -72,16 +72,33 @@ You can refer to the https://www.dropbox.com/developers/core/start/java[Dropbox documentation] that expalins how to get them.  -Below are listed the mandatory options for all operations: - -[width="100%",cols="20%,20%,60%",options="header",] -|======================================================================= -|Property |Mandatory |Description - -|`accessToken` |`true` |The access token to make API requests for a specific Dropbox user - -|`clientIdentifier` |`true` |Name of the app registered to make API requests -|======================================================================= +// component options: START +The Dropbox component has no options. +// component options: END + +// endpoint options: START +The Dropbox component supports 13 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| operation | common | | DropboxOperation | *Required* The specific action (typically is a CRUD action) to perform on Dropbox remote folder. +| accessToken | common | | String | *Required* The access token to make API requests for a specific Dropbox user +| client | common | | DbxClient | To use an existing DbxClient instance as DropBox client. +| clientIdentifier | common | | String | *Required* Name of the app registered to make API requests +| localPath | common | | String | Folder or file to upload on Dropbox from the local filesystem. +| newRemotePath | common | | String | Destination file or folder +| query | common | | String | A space-separated list of substrings to search for. A file matches only if it contains all the substrings. If this option is not set all files will be matched. +| remotePath | common | | String | Original file or folder to move +| uploadMode | common | | DropboxUploadMode | Which mode to upload. in case of add the new file will be renamed if a file with the same name already exists on dropbox. in case of force if a file with the same name already exists on dropbox this will be overwritten. +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END [[Dropbox-Deloperation]] Del operation http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/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 32031d4..7c05cbb 100644 --- a/components/camel-elsql/src/main/docs/elsql-component.adoc +++ b/components/camel-elsql/src/main/docs/elsql-component.adoc @@ -55,94 +55,82 @@ If a named parameter cannot be resolved, then an exception is thrown. Options ^^^^^^^ -[width="100%",cols="10%,10%,10%,70%",options="header",] -|======================================================================= -|Option |Type |Default |Description - -|`resourceUri` |String |null |*Required* 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. - -|`elSqlConfig` | | null |To use a specific configured ElSqlConfig. It may be better to use the -databaseVendor option instead. - -|`databaseVendor` | | Default |To use a vendor specific ElSqlConfig. The possible values are: Default, -Postgres, HSql, MySql, Oracle, SqlServer2008, Veritca - -|`batch` |`boolean` |`false` |Execute SQL batch update statements. See notes below on how the -treatment of the inbound message body changes if this is set to `true`. - -|`dataSource` |`String` |`null` |Reference to a `DataSource` to look up in the registry. - -|`template.<xxx>` | | `null` |Sets additional options on the Spring NamedParameterJdbcTemplate that is -used behind the scenes to execute the queries. For instance, -`template.maxRows=10`. For detailed documentation, see the -NamedParameterJdbcTemplate javadoc documentation. - -|`consumer.delay` |`long` |`500` |Delay in milliseconds between each poll. - -|`consumer.initialDelay` |`long` |`1000` |Milliseconds before polling starts. - -|`consumer.useFixedDelay` |`boolean` |`false` |Set to `true` to use fixed delay between polls, otherwise fixed rate is -used. See -http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html[ScheduledExecutorService] -in JDK for details. +// component options: START +The ElSQL component supports 4 options which are listed below. -|`maxMessagesPerPoll` |`int` |`0` |An integer value to define the maximum number of messages to gather per -poll. By default, no maximum is set. -|`consumer.useIterator` |`boolean` |`true` |If `true` each row returned when polling will be processed individually. -If `false` the entire `java.util.List` of data is set as the IN body. -|`consumer.routeEmptyResultSet` |`boolean` |`false` |Whether to route a single empty link:exchange.html[Exchange] if there -was no data to poll. - -|`consumer.onConsume` |`String` |`null` |After processing each row then this query can be executed, if the -link:exchange.html[Exchange] was processed successfully, for example to -mark the row as processed. The query can have parameter. - -|`consumer.onConsumeFailed` |`String` |`null` |After processing each row then this query can be executed, if the -link:exchange.html[Exchange] failed, for example to mark the row as -failed. The query can have parameter. - -|`consumer.onConsumeBatchComplete` |`String` |`null` |After processing the entire batch, this query can be executed to bulk -update rows etc. The query cannot have parameters. - -|`consumer.breakBatchOnConsumeFail` |`boolean` |`false` |If using `consumer.onConsume` and it fails, then this option controls -whether to break out of the batch or continue processing the next row -from the batch. - -|`outputType` |`String` |`SelectList` |Make the output of consumer or producer to `SelectList` as List of Map, -or `SelectOne` as single Java object in the following way: + - a) If the query has only single column, then that JDBC Column object is -returned. (such as `SELECT COUNT( * ) FROM PROJECT` will return a Long -object. + - b) If the query has more than one column, then it will return a Map of -that result. + - c) If the `outputClass` is set, then it will convert the query result -into an Java bean object by calling all the setters that match the -column names. It will assume your class has a default constructor to -create instance with. + - d) If the query resulted in more than one rows, it throws an non-unique -result exception. -The SelectList also supports mapping each row to a Java object as the -SelectOne does (only step c). - -|`outputClass` |`String` |`null` |Specify the full package and class name to use as conversion when -`outputType=SelectOne`. - -|`outputHeader` |`String` |`null` |To store the result as a header instead of the message body. This allows -to preserve the existing message body as-is. +{% raw %} +[width="100%",cols="2,1m,7",options="header"] +|======================================================================= +| Name | Java Type | Description +| databaseVendor | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig +| dataSource | DataSource | Sets the DataSource to use to communicate with the database. +| elSqlConfig | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. +| 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 %} +// component options: END -|`noop` |`boolean` |`false` |If set, will ignore the results of the SQL query and use the existing IN -message as the OUT message for the continuation of processing +// endpoint options: START +The ElSQL component supports 49 endpoint options which are listed below: -|`transacted` |`boolean` |`false` |*Camel 2.16.2:* *SQL consumer only:*Enables or disables transaction. If -enabled then if processing an exchange failed then the consumer break -out processing any further exchanges to cause a rollback eager +{% 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. +| dataSourceRef | common | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. +| elSqlConfig | common | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. +| outputClass | common | | String | Specify the full package and class name to use as conversion when outputType=SelectOne. +| outputHeader | common | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. +| outputType | common | SelectList | SqlOutputType | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way:a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object.b) If the query has more than one column then it will return a Map of that result.c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names.It will assume your class has a default constructor to create instance with.d) If the query resulted in more than one rows it throws an non-unique result exception.StreamList streams the result of the query using an Iterator. This can be used with the Splitter EIP in streaming mode to process the ResultSet in streaming fashion. +| separator | common | , | char | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders.Notice if you use named parameters then a Map type is used instead. The default value is comma +| breakBatchOnConsumeFail | consumer | false | boolean | Sets whether to break batch if onConsume failed. +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| expectedUpdateCount | consumer | -1 | int | Sets an expected update count to validate when using onConsume. +| maxMessagesPerPoll | consumer | | int | Sets the maximum number of messages to poll +| onConsume | consumer | | String | After processing each row then this query can be executed if the Exchange was processed successfully for example to mark the row as processed. The query can have parameter. +| onConsumeBatchComplete | consumer | | String | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. +| onConsumeFailed | consumer | | String | After processing each row then this query can be executed if the Exchange failed for example to mark the row as failed. The query can have parameter. +| routeEmptyResultSet | consumer | false | boolean | Sets whether empty resultset should be allowed to be sent to the next hop. Defaults to false. So the empty resultset will be filtered out. +| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. +| transacted | consumer | false | boolean | Enables or disables transaction. If enabled then if processing an exchange failed then the consumerbreak out processing any further exchanges to cause a rollback eager. +| useIterator | consumer | true | boolean | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. +| processingStrategy | consumer (advanced) | | SqlProcessingStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. +| batch | producer | false | boolean | Enables or disables batch mode +| noop | producer | false | boolean | If set will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing +| useMessageBodyForSql | producer | false | boolean | Whether to use the message body as the SQL and then headers for parameters. If this option is enabled then the SQL in the uri is not used. +| alwaysPopulateStatement | producer (advanced) | false | boolean | If enabled then the populateStatement method from org.apache.camel.component.sql.SqlPrepareStatementStrategy is always invoked also if there is no expected parameters to be prepared. When this is false then the populateStatement is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters. +| parametersCount | producer (advanced) | | int | If set greater than zero then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count then user may override instead. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| placeholder | advanced | # | String | Specifies a character that will be replaced to in SQL query. Notice that it is simple String.replaceAll() operation and no SQL parsing is involved (quoted strings will also change). +| prepareStatementStrategy | advanced | | SqlPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| templateOptions | advanced | | Map | Configures the Spring JdbcTemplate with the key/values from the Map +| usePlaceholder | advanced | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. +| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. +| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. +| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. +| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). +| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. +| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). +| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. +| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. +| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component +| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. +| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. +| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. +| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= +{% endraw %} +// endpoint options: END [[ElSql-Resultofthequery]] Result of the query http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/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 4e621f3..41ab545 100644 --- a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc +++ b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc @@ -40,13 +40,36 @@ where `topic` is the name of the topic to listen too. URI options ^^^^^^^^^^^ -[width="100%",cols="10%,10%,80%",options="header",] +// component options: START +The OSGi EventAdmin component supports 1 options which are listed below. + + + +{% raw %} +[width="100%",cols="2,1m,7",options="header"] |======================================================================= -|Name |Default value |Description +| Name | Java Type | Description +| bundleContext | BundleContext | The OSGi BundleContext is automatic injected by Camel +|======================================================================= +{% endraw %} +// component options: END + +// endpoint options: START +The OSGi EventAdmin component supports 6 endpoint options which are listed below: -|`send` |`false` |Whether to use 'send' or 'synchronous' deliver. Default false (async -delivery) +{% 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/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} +// endpoint options: END [[EventAdmin-Messageheaders]] Message headers http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/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 a81a33b..7af653c 100644 --- a/components/camel-exec/src/main/docs/exec-component.adoc +++ b/components/camel-exec/src/main/docs/exec-component.adoc @@ -41,39 +41,30 @@ executable must in the system path. URI options ^^^^^^^^^^^ -[width="100%",cols="10%,10%,80%",options="header",] +// component options: START +The Exec component has no options. +// component options: END + +// endpoint options: START +The Exec component supports 10 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= -|Name |Default value |Description -|`args` |`null` |The arguments of the executable. The arguments may be one or many + - whitespace-separated tokens, that can be quoted with `"` - e.g. -`args="arg 1" arg2` will use two arguments `arg 1` and `arg2`. To -include the quotes use `""` - e.g. `args=""arg 1"" arg2` will use the -arguments `"arg 1"` and `arg2`. - -|`workingDir` |`null` |The directory in which the command should be executed. If `null`, the -working directory of the current process will be used. - -|`timeout` |`Long.MAX_VALUE` |The timeout, in milliseconds, after which the executable should be -terminated. If execution has not completed within the timeout, the -component will send a termination request. - -|`outFile` |`null` |The name of a file, created by the executable, that should be considered -as its output. If no `outFile` is set, the standard output (stdout) of -the executable will be used instead. - -|`binding` |a `DefaultExecBinding` instance |A reference to a `org.apache.commons.exec.ExecBinding` in the -http://camel.apache.org/registry.html[Registry]. - -|`commandExecutor` |a `DefaultCommandExecutor` instance |A reference to a `org.apache.commons.exec.ExecCommandExecutor` in the -http://camel.apache.org/registry.html[Registry] that customizes the -command execution. The default command executor utilizes the -http://commons.apache.org/exec/[commons-exec library], which adds a -shutdown hook for every executed command. - -|`useStderrOnEmptyStdout` |`false` |A boolean indicating that when `stdout` is empty, this component will -populate the Camel Message Body with `stderr`. This behavior is disabled -(`false`) by default. +| 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. +| outFile | producer | | String | The name of a file created by the executable that should be considered as its output. If no outFile is set the standard output (stdout) of the executable will be used instead. +| timeout | producer | | long | The timeout in milliseconds after which the executable should be terminated. If execution has not completed within the timeout the component will send a termination request. +| useStderrOnEmptyStdout | producer | false | boolean | A boolean indicating that when stdout is empty this component will populate the Camel Message Body with stderr. This behavior is disabled (false) by default. +| workingDir | producer | | String | The directory in which the command should be executed. If null the working directory of the current process will be used. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} +// endpoint options: END [[Exec-Messageheaders]] Message headers http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/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 cd25aa7..8e730e6 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-component.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-component.adoc @@ -44,26 +44,47 @@ You can append query options to the URI in the following format, URI Options ^^^^^^^^^^^ -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Name |Default Value |Description - -|`delimiter` |`,` |The default character delimiter for delimited files. +// component options: START +The Flatpack component has no options. +// component options: END -|`textQualifier` |`"` |The text qualifier for delimited files. - -|`ignoreFirstRecord` |`true` |Whether the first line is ignored for delimited files (for the column -headers). +// endpoint options: START +The Flatpack component supports 27 endpoint options which are listed below: -|`splitRows` |`true` |The component can either process each row one by one or the entire -content at once. - -|`allowShortLines` |`false` |*Camel 2.9.7 and 2.10.5 onwards:* Allows for lines to be shorter than -expected and ignores the extra characters. - -|`ignoreExtraColumns` |`false` |*Camel 2.9.7 and 2.10.5 onwards:* Allows for lines to be longer than -expected and ignores the extra characters. +{% raw %} +[width="100%",cols="2,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| type | common | | 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 +| ignoreFirstRecord | common | true | boolean | Whether the first line is ignored for delimited files (for the column headers). +| splitRows | common | true | boolean | Sets the Component to send each row as a separate exchange once parsed +| textQualifier | common | | char | The text qualifier for delimited files. +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. +| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. +| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. +| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). +| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. +| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). +| runLoggingLevel | scheduler | TRACE | LoggingLevel | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. +| scheduledExecutorService | scheduler | | ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. +| scheduler | scheduler | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component +| schedulerProperties | scheduler | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. +| startScheduler | scheduler | true | boolean | Whether the scheduler should be auto started. +| timeUnit | scheduler | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. +| useFixedDelay | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= +{% endraw %} +// endpoint options: END [[Flatpack-Examples]] Examples http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc index d4d526b..1892521 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-dataformat.adoc @@ -22,32 +22,26 @@ trailers for the marshal operation. Options ^^^^^^^ -The data format has the following options: +// dataformat options: START +The Flatpack dataformat supports 8 options which are listed below. -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Option |Default |Description - -|`definition` |`null` |The flatpack pzmap configuration file. Can be omitted in simpler -situations, but its preferred to use the pzmap. - -|`fixed` |`false` |Delimited or fixed. - -|`ignoreFirstRecord` |`true` |Whether the first line is ignored for delimited files (for the column -headers). -|`textQualifier` |`"` |If the text is qualified with a char such as `"`. -|`delimiter` |`,` |The delimiter char (could be `;` `,` or similar) - -|`parserFactory` |`null` |Uses the default Flatpack parser factory. - -|`allowShortLines` |`false` |*Camel 2.9.7 and 2.10.5 onwards*: Allows for lines to be shorter than -expected and ignores the extra characters. - -|`ignoreExtraColumns` |`false` |*Camel 2.9.7 and 2.10.5 onwards*: Allows for lines to be longer than -expected and ignores the extra characters. +{% raw %} +[width="100%",cols="2s,1m,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| parserFactoryRef | | String | References to a custom parser factory to lookup in the registry +| definition | | String | The flatpack pzmap configuration file. Can be omitted in simpler situations but its preferred to use the pzmap. +| fixed | false | Boolean | Delimited or fixed. Is by default false = delimited +| ignoreFirstRecord | true | Boolean | Whether the first line is ignored for delimited files (for the column headers). Is by default true. +| textQualifier | " | String | If the text is qualified with a char such as " +| delimiter | , | String | The delimiter char (could be ; or similar) +| allowShortLines | false | Boolean | Allows for lines to be shorter than expected and ignores the extra characters +| ignoreExtraColumns | false | Boolean | Allows for lines to be longer than expected and ignores the extra characters. |======================================================================= +{% endraw %} +// dataformat options: END [[FlatpackDataFormat-Usage]] Usage http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-hessian/src/main/docs/hessian-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-hessian/src/main/docs/hessian-dataformat.adoc b/components/camel-hessian/src/main/docs/hessian-dataformat.adoc index 72997b7..77ac570 100644 --- a/components/camel-hessian/src/main/docs/hessian-dataformat.adoc +++ b/components/camel-hessian/src/main/docs/hessian-dataformat.adoc @@ -16,6 +16,13 @@ If you want to use Hessian Data Format from Maven, add the following dependency </dependency> ------------------------------------------------------------ +[[HessianDataFormat-Options]] +Options +^^^^^^^ + +// dataformat options: START +The Hessian dataformat has no options. +// dataformat options: END [[hessian-UsingHessianDataFormat]] Using the Hessian data format in Java DSL http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-ical/src/main/docs/ical-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ical/src/main/docs/ical-dataformat.adoc b/components/camel-ical/src/main/docs/ical-dataformat.adoc index 121a18c..1bca47d 100644 --- a/components/camel-ical/src/main/docs/ical-dataformat.adoc +++ b/components/camel-ical/src/main/docs/ical-dataformat.adoc @@ -28,6 +28,24 @@ END:VEVENT END:VCALENDAR ---------------------------------------------------------------------- +[[ICal-Options]] +Options +^^^^^^^ + +// dataformat options: START +The iCal dataformat supports 1 options which are listed below. + + + +{% raw %} +[width="100%",cols="2s,1m,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| validating | false | Boolean | Whether to validate. +|======================================================================= +{% endraw %} +// dataformat options: END + [[ICal-BasicUsage]] Basic Usage ^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-jibx/src/main/docs/jibx-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jibx/src/main/docs/jibx-dataformat.adoc b/components/camel-jibx/src/main/docs/jibx-dataformat.adoc index a49bf89..fac8f9e 100644 --- a/components/camel-jibx/src/main/docs/jibx-dataformat.adoc +++ b/components/camel-jibx/src/main/docs/jibx-dataformat.adoc @@ -28,6 +28,26 @@ from("mqseries:Another.Queue"). to("activemq:My.Queue"); ------------------------------------------- +[[JiBX-Options]] +Options +^^^^^^^ + +// dataformat options: START +The JiBX dataformat supports 2 options which are listed below. + + + +{% raw %} +[width="100%",cols="2s,1m,1m,6",options="header"] +|======================================================================= +| Name | Default | Java Type | Description +| unmarshallClass | | String | Class name to use when unmarshalling from XML to Java. +| bindingName | | String | To use a custom binding factory +|======================================================================= +{% endraw %} +// dataformat options: END + + [[JiBX-JiBXSpringDSL]] JiBX Spring DSL ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-jmx/src/main/docs/jmx-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jmx/src/main/docs/jmx-component.adoc b/components/camel-jmx/src/main/docs/jmx-component.adoc index 0248d3d..6b52b72 100644 --- a/components/camel-jmx/src/main/docs/jmx-component.adoc +++ b/components/camel-jmx/src/main/docs/jmx-component.adoc @@ -17,6 +17,56 @@ Camel also provides a link:jmx.html[JMX] component that allows you to subscribe to MBean notifications. This page is about how to manage and monitor Camel using JMX. + +[[CamelJMX-Options]] +Options +^^^^^^^ + +// component options: START +The JMX component has no options. +// component options: END + +// endpoint options: START +The JMX component supports 30 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| serverURL | consumer | | String | server url comes from the remaining 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/ERROR level and ignored. +| format | consumer | xml | String | URI Property: Format for the message body. Either xml or raw. If xml the notification is serialized to xml. If raw then the raw java object is set as the body. +| granularityPeriod | consumer | 10000 | long | URI Property: monitor types only The frequency to poll the bean to check the monitor. +| monitorType | consumer | | String | URI Property: monitor types only The type of monitor to create. One of string gauge counter. +| objectDomain | consumer | | String | *Required* URI Property: The domain for the mbean you're connecting to +| objectName | consumer | | String | URI Property: The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed. +| observedAttribute | consumer | | String | URI Property: monitor types only The attribute to observe for the monitor bean. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| handback | advanced | | Object | URI Property: Value to handback to the listener when a notification is received. This value will be put in the message header with the key jmx.handback +| notificationFilter | advanced | | NotificationFilter | URI Property: Reference to a bean that implements the NotificationFilter. +| objectProperties | advanced | | Map | URI Property: properties for the object name. These values will be used if the objectName param is not set +| reconnectDelay | advanced | 10 | int | URI Property: The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection +| reconnectOnConnectionFailure | advanced | false | boolean | URI Property: If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs. The consumer will attempt to re-establish the JMX connection every 'x' seconds until the connection is made-- where 'x' is the configured reconnectionDelay +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| testConnectionOnStartup | advanced | true | boolean | URI Property: If true the consumer will throw an exception if unable to establish the JMX connection upon startup. If false the consumer will attempt to establish the JMX connection every 'x' seconds until the connection is made -- where 'x' is the configured reconnectionDelay +| initThreshold | counter | | int | URI Property: counter monitor only Initial threshold for the monitor. The value must exceed this before notifications are fired. +| modulus | counter | | int | URI Property: counter monitor only The value at which the counter is reset to zero +| offset | counter | | int | URI Property: counter monitor only The amount to increment the threshold after it's been exceeded. +| differenceMode | gauge | false | boolean | URI Property: counter gauge monitor only If true then the value reported in the notification is the difference from the threshold as opposed to the value itself. +| notifyHigh | gauge | false | boolean | URI Property: gauge monitor only If true the gauge will fire a notification when the high threshold is exceeded +| notifyLow | gauge | false | boolean | URI Property: gauge monitor only If true the gauge will fire a notification when the low threshold is exceeded +| thresholdHigh | gauge | | Double | URI Property: gauge monitor only Value for the gauge's high threshold +| thresholdLow | gauge | | Double | URI Property: gauge monitor only Value for the gauge's low threshold +| password | security | | String | URI Property: credentials for making a remote connection +| user | security | | String | URI Property: credentials for making a remote connection +| notifyDiffer | string | false | boolean | URI Property: string monitor only If true the string monitor will fire a notification when the string attribute differs from the string to compare. +| notifyMatch | string | false | boolean | URI Property: string monitor only If true the string monitor will fire a notification when the string attribute matches the string to compare. +| stringToCompare | string | | String | URI Property: string monitor only Value for the string monitor's string to compare. +|======================================================================= +{% endraw %} +// endpoint options: END + [[CamelJMX-ActivatingJMXinCamel]] Activating JMX in Camel ^^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-lzf/src/main/docs/lzf-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc index 34697f4..db09d69 100644 --- a/components/camel-lzf/src/main/docs/lzf-dataformat.adoc +++ b/components/camel-lzf/src/main/docs/lzf-dataformat.adoc @@ -15,17 +15,19 @@ comressed using LZF algotithm. Options ^^^^^^^ -There are no options provided for this data format. +// dataformat options: START +The LZF Deflate Compression dataformat supports 1 options which are listed below. -[width="100%",cols="<25%,<25%,<25%,<25%",options="header",] + + +{% raw %} +[width="100%",cols="2s,1m,1m,6",options="header"] |======================================================================= -|Name |Type |Default |Description -|usingParallelCompression |`boolean` |`false` -|`Enable parallel compressor` implementation which can encode (compress) -content using multiple processing cores: concurrent compression works on -chunk-by-chunk basis (64k max chunk size) so megabyte-sized content can -be processed very efficiently. +| Name | Default | Java Type | Description +| usingParallelCompression | false | Boolean | Enable encoding (compress) using multiple processing cores. |======================================================================= +{% endraw %} +// dataformat options: END [[LZFDataFormat-Marshal]] Marshal http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/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 45bb2f5..135698b 100644 --- a/components/camel-quickfix/src/main/docs/quickfix-component.adoc +++ b/components/camel-quickfix/src/main/docs/quickfix-component.adoc @@ -86,6 +86,46 @@ include the session-related fields in the FIX message being sent. If a session is specified in the URI then the component will automatically inject the session-related fields into the FIX message. +[[Quickfix-Options]] +Options +~~~~~~~ + +// component options: START +The QuickFix component supports 5 options which are listed below. + + + +{% raw %} +[width="100%",cols="2,1m,7",options="header"] +|======================================================================= +| Name | Java Type | Description +| messageFactory | MessageFactory | To use the given MessageFactory +| logFactory | LogFactory | To use the given LogFactory +| messageStoreFactory | MessageStoreFactory | To use the given MessageStoreFactory +| configurations | Map | To use the given map of pre configured QuickFix configurations mapped to the key +| lazyCreateEngines | boolean | If set to true the engines will be created and started when needed (when first message is send) +|======================================================================= +{% endraw %} +// component options: END + +// endpoint options: START +The QuickFix component supports 7 endpoint options which are listed below: + +{% 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/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + [[Quickfix-ExchangeFormat]] Exchange Format ^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-syslog/src/main/docs/syslog-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc index 3cead3e..51c30c7 100644 --- a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc +++ b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc @@ -39,8 +39,8 @@ RFC3164 Syslog protocol Syslog uses the user datagram protocol (UDP) https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=CAMEL&title=1&linkCreation=true&fromPageId=24185759[1] -as its underlying transport layer mechanism. + - The UDP port that has been assigned to syslog is 514. +as its underlying transport layer mechanism. +The UDP port that has been assigned to syslog is 514. To expose a Syslog listener service we reuse the existing link:mina.html[camel-mina] component or link:netty.html[camel-netty] @@ -48,6 +48,14 @@ where we just use the `Rfc3164SyslogDataFormat` to marshal and unmarshal messages. Notice that from *Camel 2.14* onwards the syslog dataformat is renamed to `SyslogDataFormat`. +[[Syslog-Dataformat-Options]] +Options +^^^^^^^ + +// dataformat options: START +The Syslog dataformat has no options. +// dataformat options: END + [[Syslog-RFC5424Syslogprotocol]] RFC5424 Syslog protocol ^^^^^^^^^^^^^^^^^^^^^^^ http://git-wip-us.apache.org/repos/asf/camel/blob/9a5778bb/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc index cc05c63..9a4669d 100644 --- a/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc +++ b/components/camel-zookeeper/src/main/docs/zookeeper-component.adoc @@ -54,6 +54,28 @@ _znode_) that will be the target of the endpoint: Options ^^^^^^^ +// component options: START +The ZooKeeper component supports 10 options which are listed below. + + + +{% raw %} +[width="100%",cols="2,1m,7",options="header"] +|======================================================================= +| Name | Java Type | Description +| configuration | ZooKeeperConfiguration | To use a shared ZooKeeperConfiguration. Properties of the shared configuration can also be set individually. +| servers | List | The zookeeper server hosts +| timeout | int | The time interval to wait on connection before timing out. +| listChildren | boolean | Whether the children of the node should be listed +| path | String | The node in the ZooKeeper server (aka znode) +| repeat | boolean | Should changes to the znode be 'watched' and repeatedly processed. +| backoff | long | The time interval to backoff for after an error before retrying. +| create | boolean | Should the endpoint create the node if it does not currently exist. +| createMode | String | The create mode that should be used for the newly created node +| sendEmptyMessageOnDelete | boolean | Upon the delete of a znode should an empty message be send to the consumer +|======================================================================= +{% endraw %} +// component options: END // endpoint options: START The ZooKeeper component supports 14 endpoint options which are listed below:
