http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 3c78f42..17ce69e 100644 --- a/components/camel-elsql/src/main/docs/elsql-component.adoc +++ b/components/camel-elsql/src/main/docs/elsql-component.adoc @@ -53,14 +53,19 @@ The ElSQL component supports 5 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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. -| elSqlConfig | advanced | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. -| 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. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| common +| databaseVendor | | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig + +| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. + 4+^s| advanced +| elSqlConfig | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. + 4+^s| common +| 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. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -82,56 +87,103 @@ with the following path and query parameters: #### Query Parameters (47 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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. -| 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 or 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 or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. -| 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. -| elSqlConfig | advanced | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. -| 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. +| Name | Default | Java Type | Description + +| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries. + +| databaseVendor | | ElSqlDatabaseVendor | To use a vendor specific com.opengamma.elsql.ElSqlConfig + +| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. + +| dataSourceRef | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. + +| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne. + +| outputHeader | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. + +| outputType | SelectList | SqlOutputType | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way:a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object.b) If the query has more than one column then it will return a Map of that result.c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names.It will assume your class has a default constructor to create instance with.d) If the query resulted in more than one rows it throws an non-unique result exception.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 | , | char | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders.Notice if you use named parameters then a Map type is used instead. The default value is comma + 4+^s| consumer +| breakBatchOnConsumeFail | false | boolean | Sets whether to break batch if onConsume failed. + +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the 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. + +| expectedUpdateCount | -1 | int | Sets an expected update count to validate when using onConsume. + +| maxMessagesPerPoll | | int | Sets the maximum number of messages to poll + +| onConsume | | 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 | | String | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. + +| onConsumeFailed | | 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 | 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 | 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 | 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 | true | boolean | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + +| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. + +| processingStrategy | | 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. + 4+^s| producer +| batch | false | boolean | Enables or disables batch mode + +| noop | 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 | 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. + 4+^s| producer (advanced) +| alwaysPopulateStatement | 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 | | 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. + 4+^s| advanced +| elSqlConfig | | ElSqlConfig | To use a specific configured ElSqlConfig. It may be better to use the databaseVendor option instead. + +| placeholder | # | 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 | | SqlPrepareStatementStrategy | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. + +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + +| templateOptions | | Map | Configures the Spring JdbcTemplate with the key/values from the Map + +| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. + 4+^s| scheduler +| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. + +| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. + +| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. + +| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). + +| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. + +| initialDelay | 1000 | long | 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 | 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 | | 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 | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component + +| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. + +| startScheduler | true | boolean | Whether the scheduler should be auto started. + +| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. + +| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 3a121ad..925b8ea 100644 --- a/components/camel-etcd/src/main/docs/etcd-component.adoc +++ b/components/camel-etcd/src/main/docs/etcd-component.adoc @@ -35,37 +35,66 @@ with the following path and query parameters: #### Query Parameters (29 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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. -| uris | common | http://localhost:2379,http://localhost:4001 | String | To set the URIs the client connects. -| 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. -| sendEmptyExchangeOnTimeout | consumer | false | boolean | To send an empty message in case of timeout watching for a key. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| fromIndex | consumer (advanced) | 0 | Long | The index to watch from -| 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. -| timeToLive | producer | | Integer | To set the lifespan of a key in milliseconds. -| 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. -| password | security | | String | The password to use for basic authentication. -| sslContextParameters | security | | SSLContextParameters | To configure security using SSLContextParameters. -| userName | security | | String | The user name to use for basic authentication. +| Name | Default | Java Type | Description + +| recursive | false | boolean | To apply an action recursively. + +| servicePath | /services/ | String | The path to look for for service discovery + +| timeout | | Long | To set the maximum time an action could take to complete. + +| uris | http://localhost:2379,http://localhost:4001 | String | To set the URIs the client connects. + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| sendEmptyExchangeOnTimeout | false | boolean | To send an empty message in case of timeout watching for a key. + +| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + +| fromIndex | 0 | Long | The index to watch from + +| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. + 4+^s| producer +| timeToLive | | Integer | To set the lifespan of a key in milliseconds. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| scheduler +| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. + +| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. + +| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. + +| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). + +| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. + +| initialDelay | 1000 | long | 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 | 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 | | 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 | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component + +| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. + +| startScheduler | true | boolean | Whether the scheduler should be auto started. + +| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. + +| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. + 4+^s| security +| password | | String | The password to use for basic authentication. + +| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters. + +| userName | | String | The user name to use for basic authentication. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 d0cec52..de78d74 100644 --- a/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc +++ b/components/camel-eventadmin/src/main/docs/eventadmin-component.adoc @@ -37,11 +37,13 @@ The OSGi EventAdmin component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| bundleContext | common | | BundleContext | The OSGi BundleContext is automatic injected by Camel -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| common +| bundleContext | | BundleContext | The OSGi BundleContext is automatic injected by Camel + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -62,14 +64,19 @@ with the following path and query parameters: #### Query Parameters (5 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| send | false | boolean | Whether to use 'send' or 'synchronous' deliver. Default false (async delivery) + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-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 054d0b2..73d0f46 100644 --- a/components/camel-exec/src/main/docs/exec-component.adoc +++ b/components/camel-exec/src/main/docs/exec-component.adoc @@ -54,17 +54,25 @@ with the following path and query parameters: #### Query Parameters (8 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| args | | String | The arguments may be one or many whitespace-separated tokens. + +| binding | | ExecBinding | A reference to a org.apache.commons.exec.ExecBinding in the Registry. + +| commandExecutor | | 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 | | 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 | | 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 | 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 | | String | The directory in which the command should be executed. If null the working directory of the current process will be used. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-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 b26acde..a482af1 100644 --- a/components/camel-facebook/src/main/docs/facebook-component.adoc +++ b/components/camel-facebook/src/main/docs/facebook-component.adoc @@ -56,11 +56,13 @@ The Facebook component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | FacebookConfiguration | To use the shared configuration -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| configuration | | FacebookConfiguration | To use the shared configuration + +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -85,111 +87,213 @@ with the following path and query parameters: #### Query Parameters (102 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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 -| appId | common | | String | The ID of the Facebook Application -| center | common | | GeoLocation | Location latitude and longitude -| checkinId | common | | String | The checkin ID -| checkinUpdate | common | | CheckinUpdate | The checkin to be created. Deprecated instead create a Post with an attached location -| clientURL | common | | String | Facebook4J API client URL -| clientVersion | common | | String | Facebook4J client API version -| commentId | common | | String | The comment ID -| commentUpdate | common | | CommentUpdate | The facebook Comment to be created or updated -| debugEnabled | common | false | Boolean | Enables deubg output. Effective only with the embedded logger -| description | common | | String | The description text -| distance | common | | Integer | Distance in meters -| domainId | common | | String | The domain ID -| domainName | common | | String | The domain name -| domainNames | common | | List | The domain names -| eventId | common | | String | The event ID -| eventUpdate | common | | EventUpdate | The event to be created or updated -| friendId | common | | String | The friend ID -| friendlistId | common | | String | The friend list ID -| friendlistName | common | | String | The friend list Name -| friendUserId | common | | String | The friend user ID -| groupId | common | | String | The group ID -| gzipEnabled | common | true | Boolean | Use Facebook GZIP encoding -| httpConnectionTimeout | common | 20000 | Integer | Http connection timeout in milliseconds -| httpDefaultMaxPerRoute | common | 2 | Integer | HTTP maximum connections per route -| httpMaxTotalConnections | common | 20 | Integer | HTTP maximum total connections -| httpReadTimeout | common | 120000 | Integer | Http read timeout in milliseconds -| httpRetryCount | common | 0 | Integer | Number of HTTP retries -| httpRetryIntervalSeconds | common | 5 | Integer | HTTP retry interval in seconds -| httpStreamingReadTimeout | common | 40000 | Integer | HTTP streaming read timeout in milliseconds -| ids | common | | List | The ids of users -| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body -| includeRead | common | | Boolean | Enables notifications that the user has already read in addition to unread ones -| isHidden | common | | Boolean | Whether hidden -| jsonStoreEnabled | common | false | Boolean | If set to true raw JSON forms will be stored in DataObjectFactory -| link | common | | URL | Link URL -| linkId | common | | String | Link ID -| locale | common | | Locale | Desired FQL locale -| mbeanEnabled | common | false | Boolean | If set to true Facebook4J mbean will be registerd -| message | common | | String | The message text -| messageId | common | | String | The message ID -| metric | common | | String | The metric name -| milestoneId | common | | String | The milestone id -| name | common | | String | Test user name must be of the form 'first last' -| noteId | common | | String | The note ID -| notificationId | common | | String | The notification ID -| objectId | common | | String | The insight object ID -| offerId | common | | String | The offer id -| optionDescription | common | | String | The question's answer option description -| pageId | common | | String | The page id -| permissionName | common | | String | The permission name -| permissions | common | | String | Test user permissions in the format perm1perm2... -| photoId | common | | String | The photo ID -| pictureId | common | | Integer | The picture id -| pictureId2 | common | | Integer | The picture2 id -| pictureSize | common | | PictureSize | The picture size -| placeId | common | | String | The place ID -| postId | common | | String | The post ID -| postUpdate | common | | PostUpdate | The post to create or update -| prettyDebugEnabled | common | false | Boolean | Prettify JSON debug output if set to true -| queries | common | | Map | FQL queries -| query | common | | String | FQL query or search terms for search endpoints -| questionId | common | | String | The question id -| reading | common | | Reading | Optional reading parameters. See Reading Options(reading) -| readingOptions | common | | Map | To configure Reading using key/value pairs from the Map. -| restBaseURL | common | https://graph.facebook.com/ | String | API base URL -| scoreValue | common | | Integer | The numeric score with value -| size | common | | PictureSize | The picture size one of large normal small or square -| source | common | | Media | The media content from either a java.io.File or java.io.Inputstream -| subject | common | | String | The note of the subject -| tabId | common | | String | The tab id -| tagUpdate | common | | TagUpdate | Photo tag information -| testUser1 | common | | TestUser | Test user 1 -| testUser2 | common | | TestUser | Test user 2 -| testUserId | common | | String | The ID of the test user -| title | common | | String | The title text -| toUserId | common | | String | The ID of the user to tag -| toUserIds | common | | List | The IDs of the users to tag -| userId | common | | String | The Facebook user ID -| userId1 | common | | String | The ID of a user 1 -| userId2 | common | | String | The ID of a user 2 -| userIds | common | | List | The IDs of users to invite to event -| userLocale | common | | String | The test user locale -| useSSL | common | true | Boolean | Use SSL -| videoBaseURL | common | https://graph-video.facebook.com/ | String | Video API base URL -| videoId | common | | String | The video ID -| 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. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| httpProxyHost | proxy | | String | HTTP proxy server host name -| httpProxyPassword | proxy | | String | HTTP proxy server password -| httpProxyPort | proxy | | Integer | HTTP proxy server port -| httpProxyUser | proxy | | String | HTTP proxy server user name -| oAuthAccessToken | security | | String | The user access token -| oAuthAccessTokenURL | security | https://graph.facebook.com/oauth/access_token | String | OAuth access token URL -| oAuthAppId | security | | String | The application Id -| oAuthAppSecret | security | | String | The application Secret -| oAuthAuthorizationURL | security | https://www.facebook.com/dialog/oauth | String | OAuth authorization URL -| oAuthPermissions | security | | String | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail +| Name | Default | Java Type | Description + +| achievementURL | | URL | The unique URL of the achievement + +| albumId | | String | The album ID + +| albumUpdate | | AlbumUpdate | The facebook Album to be created or updated + +| appId | | String | The ID of the Facebook Application + +| center | | GeoLocation | Location latitude and longitude + +| checkinId | | String | The checkin ID + +| checkinUpdate | | CheckinUpdate | The checkin to be created. Deprecated instead create a Post with an attached location + +| clientURL | | String | Facebook4J API client URL + +| clientVersion | | String | Facebook4J client API version + +| commentId | | String | The comment ID + +| commentUpdate | | CommentUpdate | The facebook Comment to be created or updated + +| debugEnabled | false | Boolean | Enables deubg output. Effective only with the embedded logger + +| description | | String | The description text + +| distance | | Integer | Distance in meters + +| domainId | | String | The domain ID + +| domainName | | String | The domain name + +| domainNames | | List | The domain names + +| eventId | | String | The event ID + +| eventUpdate | | EventUpdate | The event to be created or updated + +| friendId | | String | The friend ID + +| friendlistId | | String | The friend list ID + +| friendlistName | | String | The friend list Name + +| friendUserId | | String | The friend user ID + +| groupId | | String | The group ID + +| gzipEnabled | true | Boolean | Use Facebook GZIP encoding + +| httpConnectionTimeout | 20000 | Integer | Http connection timeout in milliseconds + +| httpDefaultMaxPerRoute | 2 | Integer | HTTP maximum connections per route + +| httpMaxTotalConnections | 20 | Integer | HTTP maximum total connections + +| httpReadTimeout | 120000 | Integer | Http read timeout in milliseconds + +| httpRetryCount | 0 | Integer | Number of HTTP retries + +| httpRetryIntervalSeconds | 5 | Integer | HTTP retry interval in seconds + +| httpStreamingReadTimeout | 40000 | Integer | HTTP streaming read timeout in milliseconds + +| ids | | List | The ids of users + +| inBody | | String | Sets the name of a parameter to be passed in the exchange In Body + +| includeRead | | Boolean | Enables notifications that the user has already read in addition to unread ones + +| isHidden | | Boolean | Whether hidden + +| jsonStoreEnabled | false | Boolean | If set to true raw JSON forms will be stored in DataObjectFactory + +| link | | URL | Link URL + +| linkId | | String | Link ID + +| locale | | Locale | Desired FQL locale + +| mbeanEnabled | false | Boolean | If set to true Facebook4J mbean will be registerd + +| message | | String | The message text + +| messageId | | String | The message ID + +| metric | | String | The metric name + +| milestoneId | | String | The milestone id + +| name | | String | Test user name must be of the form 'first last' + +| noteId | | String | The note ID + +| notificationId | | String | The notification ID + +| objectId | | String | The insight object ID + +| offerId | | String | The offer id + +| optionDescription | | String | The question's answer option description + +| pageId | | String | The page id + +| permissionName | | String | The permission name + +| permissions | | String | Test user permissions in the format perm1perm2... + +| photoId | | String | The photo ID + +| pictureId | | Integer | The picture id + +| pictureId2 | | Integer | The picture2 id + +| pictureSize | | PictureSize | The picture size + +| placeId | | String | The place ID + +| postId | | String | The post ID + +| postUpdate | | PostUpdate | The post to create or update + +| prettyDebugEnabled | false | Boolean | Prettify JSON debug output if set to true + +| queries | | Map | FQL queries + +| query | | String | FQL query or search terms for search endpoints + +| questionId | | String | The question id + +| reading | | Reading | Optional reading parameters. See Reading Options(reading) + +| readingOptions | | Map | To configure Reading using key/value pairs from the Map. + +| restBaseURL | https://graph.facebook.com/ | String | API base URL + +| scoreValue | | Integer | The numeric score with value + +| size | | PictureSize | The picture size one of large normal small or square + +| source | | Media | The media content from either a java.io.File or java.io.Inputstream + +| subject | | String | The note of the subject + +| tabId | | String | The tab id + +| tagUpdate | | TagUpdate | Photo tag information + +| testUser1 | | TestUser | Test user 1 + +| testUser2 | | TestUser | Test user 2 + +| testUserId | | String | The ID of the test user + +| title | | String | The title text + +| toUserId | | String | The ID of the user to tag + +| toUserIds | | List | The IDs of the users to tag + +| userId | | String | The Facebook user ID + +| userId1 | | String | The ID of a user 1 + +| userId2 | | String | The ID of a user 2 + +| userIds | | List | The IDs of users to invite to event + +| userLocale | | String | The test user locale + +| useSSL | true | Boolean | Use SSL + +| videoBaseURL | https://graph-video.facebook.com/ | String | Video API base URL + +| videoId | | String | The video ID + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| proxy +| httpProxyHost | | String | HTTP proxy server host name + +| httpProxyPassword | | String | HTTP proxy server password + +| httpProxyPort | | Integer | HTTP proxy server port + +| httpProxyUser | | String | HTTP proxy server user name + 4+^s| security +| oAuthAccessToken | | String | The user access token + +| oAuthAccessTokenURL | https://graph.facebook.com/oauth/access_token | String | OAuth access token URL + +| oAuthAppId | | String | The application Id + +| oAuthAppSecret | | String | The application Secret + +| oAuthAuthorizationURL | https://www.facebook.com/dialog/oauth | String | OAuth authorization URL + +| oAuthPermissions | | String | Default OAuth permissions. Comma separated permission names. See https://developers.facebook.com/docs/reference/login/permissions for the detail |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 83b74dc..2ec6b1b 100644 --- a/components/camel-flatpack/src/main/docs/flatpack-component.adoc +++ b/components/camel-flatpack/src/main/docs/flatpack-component.adoc @@ -62,34 +62,59 @@ with the following path and query parameters: #### Query Parameters (25 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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 or ERROR level and ignored. -| sendEmptyMessageWhenIdle | consumer | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. -| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. -| exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. -| pollStrategy | consumer (advanced) | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). -| backoffErrorThreshold | scheduler | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. -| backoffIdleThreshold | scheduler | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. -| backoffMultiplier | scheduler | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. -| delay | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). -| greedy | scheduler | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. -| initialDelay | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also 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. +| Name | Default | Java Type | Description + +| allowShortLines | false | boolean | Allows for lines to be shorter than expected and ignores the extra characters + +| delimiter | , | char | The default character delimiter for delimited files. + +| ignoreExtraColumns | false | boolean | Allows for lines to be longer than expected and ignores the extra characters + +| ignoreFirstRecord | true | boolean | Whether the first line is ignored for delimited files (for the column headers). + +| splitRows | true | boolean | Sets the Component to send each row as a separate exchange once parsed + +| textQualifier | | char | The text qualifier for delimited files. + 4+^s| consumer +| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. + 4+^s| consumer (advanced) +| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. + +| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. + +| pollStrategy | | PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). + 4+^s| scheduler +| backoffErrorThreshold | | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. + +| backoffIdleThreshold | | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. + +| backoffMultiplier | | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. + +| delay | 500 | long | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). + +| greedy | false | boolean | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. + +| initialDelay | 1000 | long | 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 | 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 | | 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 | none | ScheduledPollConsumerScheduler | To use a cron scheduler from either camel-spring or camel-quartz2 component + +| schedulerProperties | | Map | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. + +| startScheduler | true | boolean | Whether the scheduler should be auto started. + +| timeUnit | MILLISECONDS | TimeUnit | Time unit for initialDelay and delay options. + +| useFixedDelay | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 336ce33..976349c 100644 --- a/components/camel-flink/src/main/docs/flink-component.adoc +++ b/components/camel-flink/src/main/docs/flink-component.adoc @@ -55,15 +55,21 @@ with the following path and query parameters: #### Query Parameters (6 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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. -| dataStream | producer | | DataStream | DataStream to compute against. -| dataStreamCallback | producer | | DataStreamCallback | Function performing action against a DataStream. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| collect | true | boolean | Indicates if results should be collected or counted. + +| dataSet | | DataSet | DataSet to compute against. + +| dataSetCallback | | DataSetCallback | Function performing action against a DataSet. + +| dataStream | | DataStream | DataStream to compute against. + +| dataStreamCallback | | DataStreamCallback | Function performing action against a DataStream. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END @@ -79,14 +85,19 @@ The Apache Flink component supports 5 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| dataSet | producer | | DataSet | DataSet to compute against. -| dataStream | producer | | DataStream | DataStream to compute against. -| dataSetCallback | producer | | DataSetCallback | Function performing action against a DataSet. -| dataStreamCallback | producer | | DataStreamCallback | Function performing action against a DataStream. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| producer +| dataSet | | DataSet | DataSet to compute against. + +| dataStream | | DataStream | DataStream to compute against. + +| dataSetCallback | | DataSetCallback | Function performing action against a DataSet. + +| dataStreamCallback | | DataStreamCallback | Function performing action against a DataStream. + 4+^s| advanced +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/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 7fe4547..f2c784f 100644 --- a/components/camel-fop/src/main/docs/fop-component.adoc +++ b/components/camel-fop/src/main/docs/fop-component.adoc @@ -84,12 +84,15 @@ with the following path and query parameters: #### Query Parameters (3 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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). +| Name | Default | Java Type | Description + +| fopFactory | | FopFactory | Allows to use a custom configured or implementation of org.apache.fop.apps.FopFactory. + +| userConfigURL | | String | The location of a configuration file which can be loaded from classpath or file system. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/24d2f4ae/components/camel-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 ba47f61..cc69077 100644 --- a/components/camel-freemarker/src/main/docs/freemarker-component.adoc +++ b/components/camel-freemarker/src/main/docs/freemarker-component.adoc @@ -43,11 +43,13 @@ The Freemarker component supports 2 options which are listed below. -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| configuration | advanced | | Configuration | To use an existing freemarker.template.Configuration instance as the configuration. -| resolvePropertyPlaceholders | advanced | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Default | Java Type | Description + 4+^s| advanced +| configuration | | Configuration | To use an existing freemarker.template.Configuration instance as the configuration. + +| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. |======================================================================= // component options: END @@ -72,14 +74,19 @@ with the following path and query parameters: #### Query Parameters (5 parameters): -[width="100%",cols="2,1,1m,1m,5",options="header"] +[width="100%",cols="2,1m,1m,6",options="header"] |======================================================================= -| Name | Group | Default | Java Type | Description -| 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. -| templateUpdateDelay | producer | | int | Number of seconds the loaded template resource will remain in the cache. -| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Default | Java Type | Description + +| configuration | | Configuration | Sets the Freemarker configuration to use + +| contentCache | false | boolean | Sets whether to use resource content cache or not + +| encoding | | String | Sets the encoding to be used for loading the template file. + +| templateUpdateDelay | | int | Number of seconds the loaded template resource will remain in the cache. + 4+^s| advanced +| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= // endpoint options: END
