http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-sql/src/main/docs/sql-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sql/src/main/docs/sql-component.adoc b/components/camel-sql/src/main/docs/sql-component.adoc index 92dee04..696d74f 100644 --- a/components/camel-sql/src/main/docs/sql-component.adoc +++ b/components/camel-sql/src/main/docs/sql-component.adoc @@ -111,15 +111,12 @@ The SQL component supports 3 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| common -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - 4+^s| advanced -| usePlaceholder | true | boolean | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true - -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource +| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true | true | boolean +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -135,107 +132,62 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| query | | String | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. +| Name | Description | Default | Type +| **query** | *Required* Sets the SQL query to perform. You can externalize the query by using file: or classpath: as prefix and specify the location of the file. | | String |======================================================================= #### Query Parameters (45 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| allowNamedParameters | true | boolean | Whether to allow using named parameters in the queries. - -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - -| dataSourceRef | | String | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. - -| outputClass | | String | Specify the full package and class name to use as conversion when outputType=SelectOne. - -| outputHeader | | String | Store the query result in a header instead of the message body. By default outputHeader == null and the query result is stored in the message body any existing content in the message body is discarded. If outputHeader is set the value is used as the name of the header to store the query result and the original message body is preserved. - -| outputType | SelectList | SqlOutputType | Make the output of consumer or producer to SelectList as List of Map or SelectOne as single Java object in the following way: a) If the query has only single column then that JDBC Column object is returned. (such as SELECT COUNT( ) FROM PROJECT will return a Long object. b) If the query has more than one column then it will return a Map of that result. c) If the outputClass is set then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with. d) If the query resulted in more than one rows it throws an non-unique result exception. - -| separator | , | char | The separator to use when parameter values is taken from message body (if the body is a String type) to be inserted at placeholders. Notice if you use named parameters then a Map type is used instead. The default value is comma. - 4+^s| consumer -| breakBatchOnConsumeFail | false | boolean | Sets whether to break batch if onConsume failed. - -| bridgeErrorHandler | false | boolean | Allows for bridging the consumer to the 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 consumer break 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 -| 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. This option is default true - 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. +| Name | Description | Default | Type +| **allowNamedParameters** (common) | Whether to allow using named parameters in the queries. | true | boolean +| **dataSource** (common) | Sets the DataSource to use to communicate with the database. | | DataSource +| **dataSourceRef** (common) | Sets the reference to a DataSource to lookup from the registry to use for communicating with the database. | | String +| **outputClass** (common) | Specify the full package and class name to use as conversion when outputType=SelectOne. | | String +| **outputHeader** (common) | 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. | | String +| **outputType** (common) | 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. | SelectList | SqlOutputType +| **separator** (common) | 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. | , | char +| **breakBatchOnConsumeFail** (consumer) | Sets whether to break batch if onConsume failed. | false | boolean +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **expectedUpdateCount** (consumer) | Sets an expected update count to validate when using onConsume. | -1 | int +| **maxMessagesPerPoll** (consumer) | Sets the maximum number of messages to poll | | int +| **onConsume** (consumer) | 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. | | String +| **onConsumeBatchComplete** (consumer) | After processing the entire batch this query can be executed to bulk update rows etc. The query cannot have parameters. | | String +| **onConsumeFailed** (consumer) | 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. | | String +| **routeEmptyResultSet** (consumer) | 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. | false | boolean +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **transacted** (consumer) | 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 | false | boolean +| **useIterator** (consumer) | Sets how resultset should be delivered to route. Indicates delivery as either a list or individual object. defaults to true. | true | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | 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. | | PollingConsumerPoll Strategy +| **processingStrategy** (consumer) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlProcessingStrategy to execute queries when the consumer has processed the rows/batch. | | SqlProcessingStrategy +| **batch** (producer) | Enables or disables batch mode | false | boolean +| **noop** (producer) | 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 | false | boolean +| **useMessageBodyForSql** (producer) | 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. | false | boolean +| **alwaysPopulateStatement** (producer) | 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. | false | boolean +| **parametersCount** (producer) | 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. | | int +| **placeholder** (advanced) | 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). | # | String +| **prepareStatementStrategy** (advanced) | Allows to plugin to use a custom org.apache.camel.component.sql.SqlPrepareStatementStrategy to control preparation of the query and prepared statement. | | SqlPrepareStatement Strategy +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **templateOptions** (advanced) | Configures the Spring JdbcTemplate with the key/values from the Map | | Map +| **usePlaceholder** (advanced) | Sets whether to use placeholder and replace all placeholder characters with sign in the SQL queries. This option is default true | true | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | 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. | | int +| **delay** (scheduler) | 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). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | 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). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean |======================================================================= // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-sql/src/main/docs/sql-stored-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc index a02d139..3ed9aa6 100644 --- a/components/camel-sql/src/main/docs/sql-stored-component.adoc +++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc @@ -67,13 +67,11 @@ The SQL StoredProcedure component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| producer -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **dataSource** (producer) | Sets the DataSource to use to communicate with the database. | | DataSource +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -89,29 +87,23 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| template | | String | *Required* Sets the StoredProcedure template to perform +| Name | Description | Default | Type +| **template** | *Required* Sets the StoredProcedure template to perform | | String |======================================================================= #### Query Parameters (6 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| batch | false | boolean | Enables or disables batch mode - -| dataSource | | DataSource | Sets the DataSource to use to communicate with the database. - -| noop | false | boolean | If set will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing - -| outputHeader | | String | Store the template result in a header instead of the message body. By default outputHeader == null and the template 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 template result and the original message body is preserved. - -| useMessageBodyForTemplate | false | boolean | Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not 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). +| Name | Description | Default | Type +| **batch** (producer) | Enables or disables batch mode | false | boolean +| **dataSource** (producer) | Sets the DataSource to use to communicate with the database. | | DataSource +| **noop** (producer) | If set will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing | false | boolean +| **outputHeader** (producer) | Store the template result in a header instead of the message body. By default outputHeader == null and the template 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 template result and the original message body is preserved. | | String +| **useMessageBodyForTemplate** (producer) | Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not used. | false | boolean +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-ssh/src/main/docs/ssh-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-ssh/src/main/docs/ssh-component.adoc b/components/camel-ssh/src/main/docs/ssh-component.adoc index 69403e8..751608b 100644 --- a/components/camel-ssh/src/main/docs/ssh-component.adoc +++ b/components/camel-ssh/src/main/docs/ssh-component.adoc @@ -34,33 +34,21 @@ The SSH component supports 12 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | SshConfiguration | To use the shared SSH configuration - 4+^s| common -| host | | String | Sets the hostname of the remote SSH server. - -| port | | int | Sets the port number for the remote SSH server. - 4+^s| security -| username | | String | Sets the username to use in logging into the remote SSH server. - -| password | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. - 4+^s| common -| pollCommand | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A - 4+^s| security -| keyPairProvider | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. - -| keyType | | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. - 4+^s| common -| timeout | | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. - 4+^s| security -| certFilename | | String | Sets the resource path of the certificate to use for Authentication. - -| certResource | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use the shared SSH configuration | | SshConfiguration +| **host** (common) | Sets the hostname of the remote SSH server. | | String +| **port** (common) | Sets the port number for the remote SSH server. | | int +| **username** (security) | Sets the username to use in logging into the remote SSH server. | | String +| **password** (security) | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. | | String +| **pollCommand** (common) | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...). You may need to end your command with a newline and that must be URL encoded 0A | | String +| **keyPairProvider** (security) | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. | | KeyPairProvider +| **keyType** (security) | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. | | String +| **timeout** (common) | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | | long +| **certFilename** (security) | Sets the resource path of the certificate to use for Authentication. | | String +| **certResource** (security) | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. | | String +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -76,70 +64,44 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| host | | String | *Required* Sets the hostname of the remote SSH server. -| port | 22 | int | Sets the port number for the remote SSH server. +| Name | Description | Default | Type +| **host** | *Required* Sets the hostname of the remote SSH server. | | String +| **port** | Sets the port number for the remote SSH server. | 22 | int |======================================================================= #### Query Parameters (26 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| timeout | 30000 | long | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. - 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. - -| pollCommand | | String | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A - -| 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. - 4+^s| security -| certResource | | String | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. - -| keyPairProvider | | KeyPairProvider | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. - -| keyType | ssh-rsa | String | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. - -| password | | String | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. - -| username | | String | Sets the username to use in logging into the remote SSH server. +| Name | Description | Default | Type +| **timeout** (common) | Sets the timeout in milliseconds to wait in establishing the remote SSH server connection. Defaults to 30000 milliseconds. | 30000 | long +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **pollCommand** (consumer) | Sets the command string to send to the remote SSH server during every poll cycle. Only works with camel-ssh component being used as a consumer i.e. from(ssh://...) You may need to end your command with a newline and that must be URL encoded 0A | | String +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | 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. | | PollingConsumerPoll Strategy +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | 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. | | int +| **delay** (scheduler) | 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). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | 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). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean +| **certResource** (security) | Sets the resource path of the certificate to use for Authentication. Will use ResourceHelperKeyPairProvider to resolve file based certificate and depends on keyType setting. | | String +| **keyPairProvider** (security) | Sets the KeyPairProvider reference to use when connecting using Certificates to the remote SSH Server. | | KeyPairProvider +| **keyType** (security) | Sets the key type to pass to the KeyPairProvider as part of authentication. KeyPairProvider.loadKey(...) will be passed this value. Defaults to ssh-rsa. | ssh-rsa | String +| **password** (security) | Sets the password to use in connecting to remote SSH server. Requires keyPairProvider to be set to null. | | String +| **username** (security) | Sets the username to use in logging into the remote SSH server. | | String |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-stax/src/main/docs/stax-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stax/src/main/docs/stax-component.adoc b/components/camel-stax/src/main/docs/stax-component.adoc index c2befeb..4d717d9 100644 --- a/components/camel-stax/src/main/docs/stax-component.adoc +++ b/components/camel-stax/src/main/docs/stax-component.adoc @@ -62,19 +62,18 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| contentHandlerClass | | String | *Required* The FQN class name for the ContentHandler implementation to use. +| Name | Description | Default | Type +| **contentHandlerClass** | *Required* The FQN class name for the ContentHandler implementation to use. | | String |======================================================================= #### Query Parameters (1 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-stomp/src/main/docs/stomp-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stomp/src/main/docs/stomp-component.adoc b/components/camel-stomp/src/main/docs/stomp-component.adoc index 0296941..a8e3249d 100644 --- a/components/camel-stomp/src/main/docs/stomp-component.adoc +++ b/components/camel-stomp/src/main/docs/stomp-component.adoc @@ -38,21 +38,15 @@ The Stomp component supports 6 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| advanced -| configuration | | StompConfiguration | To use the shared stomp configuration - 4+^s| common -| brokerURL | | String | The URI of the Stomp broker to connect to - 4+^s| security -| login | | String | The username - -| passcode | | String | The password - 4+^s| common -| host | | String | The virtual host - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **configuration** (advanced) | To use the shared stomp configuration | | StompConfiguration +| **brokerURL** (common) | The URI of the Stomp broker to connect to | | String +| **login** (security) | The username | | String +| **passcode** (security) | The password | | String +| **host** (common) | The virtual host | | String +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -69,35 +63,26 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| destination | | String | *Required* Name of the queue +| Name | Description | Default | Type +| **destination** | *Required* Name of the queue | | String |======================================================================= #### Query Parameters (9 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| brokerURL | tcp://localhost:61613 | String | *Required* The URI of the Stomp broker to connect to - -| host | | String | The virtual host name - 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| security -| login | | String | The username - -| passcode | | String | The password - -| sslContextParameters | | SSLContextParameters | To configure security using SSLContextParameters +| Name | Description | Default | Type +| **brokerURL** (common) | *Required* The URI of the Stomp broker to connect to | tcp://localhost:61613 | String +| **host** (common) | The virtual host name | | String +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **login** (security) | The username | | String +| **passcode** (security) | The password | | String +| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-stream/src/main/docs/stream-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stream/src/main/docs/stream-component.adoc b/components/camel-stream/src/main/docs/stream-component.adoc index 492a1f4..622d351 100644 --- a/components/camel-stream/src/main/docs/stream-component.adoc +++ b/components/camel-stream/src/main/docs/stream-component.adoc @@ -61,53 +61,35 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| kind | | String | *Required* Kind of stream to use such as System.in or System.out. +| Name | Description | Default | Type +| **kind** | *Required* Kind of stream to use such as System.in or System.out. | | String |======================================================================= #### Query Parameters (18 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| encoding | | String | You can configure the encoding (is a charset name) to use text-based streams (for example message body is a String object). If not provided Camel uses the JVM default Charset. - -| fileName | | String | When using the stream:file URI format this option specifies the filename to stream to/from. - -| url | | String | When using the stream:url URI format this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility. - 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. - -| groupLines | | int | To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines instead of 1 Exchange per line. - -| groupStrategy | | GroupStrategy | Allows to use a custom GroupStrategy to control how to group lines. - -| initialPromptDelay | 2000 | long | Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. - -| promptDelay | | long | Optional delay in milliseconds before showing the message prompt. - -| promptMessage | | String | Message prompt to use when reading from stream:in; for example you could set this to Enter a command: - -| retry | false | boolean | Will retry opening the file if it's overwritten somewhat like tail --retry - -| scanStream | false | boolean | To be used for continuously reading a stream such as the unix tail command. - -| scanStreamDelay | | long | Delay in milliseconds between read attempts when using scanStream. - 4+^s| consumer (advanced) -| exceptionHandler | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. - -| exchangePattern | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. - 4+^s| producer -| autoCloseCount | | int | Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent the stream is reopened for another autoCloseCount batch. - -| closeOnDone | false | boolean | This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done to improve performance. Mind this requires that you only stream to the same file and not 2 or more files. - -| delay | | long | Initial delay in milliseconds before producing the stream. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **encoding** (common) | You can configure the encoding (is a charset name) to use text-based streams (for example message body is a String object). If not provided Camel uses the JVM default Charset. | | String +| **fileName** (common) | When using the stream:file URI format this option specifies the filename to stream to/from. | | String +| **url** (common) | When using the stream:url URI format this option specifies the URL to stream to/from. The input/output stream will be opened using the JDK URLConnection facility. | | String +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **groupLines** (consumer) | To group X number of lines in the consumer. For example to group 10 lines and therefore only spit out an Exchange with 10 lines instead of 1 Exchange per line. | | int +| **groupStrategy** (consumer) | Allows to use a custom GroupStrategy to control how to group lines. | | GroupStrategy +| **initialPromptDelay** (consumer) | Initial delay in milliseconds before showing the message prompt. This delay occurs only once. Can be used during system startup to avoid message prompts being written while other logging is done to the system out. | 2000 | long +| **promptDelay** (consumer) | Optional delay in milliseconds before showing the message prompt. | | long +| **promptMessage** (consumer) | Message prompt to use when reading from stream:in; for example you could set this to Enter a command: | | String +| **retry** (consumer) | Will retry opening the file if it's overwritten somewhat like tail --retry | false | boolean +| **scanStream** (consumer) | To be used for continuously reading a stream such as the unix tail command. | false | boolean +| **scanStreamDelay** (consumer) | Delay in milliseconds between read attempts when using scanStream. | | long +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **autoCloseCount** (producer) | Number of messages to process before closing stream on Producer side. Never close stream by default (only when Producer is stopped). If more messages are sent the stream is reopened for another autoCloseCount batch. | | int +| **closeOnDone** (producer) | This option is used in combination with Splitter and streaming to the same file. The idea is to keep the stream open and only close when the Splitter is done to improve performance. Mind this requires that you only stream to the same file and not 2 or more files. | false | boolean +| **delay** (producer) | Initial delay in milliseconds before producing the stream. | | long +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-stringtemplate/src/main/docs/string-template-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc index f60fc57..ab2a2bf 100644 --- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc +++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc @@ -51,25 +51,21 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| resourceUri | | String | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. +| Name | Description | Default | Type +| **resourceUri** | *Required* Path to the resource. You can prefix with: classpath file http ref or bean. classpath file and http loads the resource using these protocols (classpath is default). ref will lookup the resource in the registry. bean will call a method on a bean to be used as the resource. For bean you can specify the method name after dot eg bean:myBean.myMethod. | | String |======================================================================= #### Query Parameters (4 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| contentCache | false | boolean | Sets whether to use resource content cache or not - -| delimiterStart | < | char | The variable start delimiter - -| delimiterStop | > | char | The variable end delimiter - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean +| **delimiterStart** (producer) | The variable start delimiter | < | char +| **delimiterStop** (producer) | The variable end delimiter | > | char +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-telegram/src/main/docs/telegram-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-telegram/src/main/docs/telegram-component.adoc b/components/camel-telegram/src/main/docs/telegram-component.adoc index 0e3ee61..c40e17b 100644 --- a/components/camel-telegram/src/main/docs/telegram-component.adoc +++ b/components/camel-telegram/src/main/docs/telegram-component.adoc @@ -47,13 +47,11 @@ The Telegram component supports 2 options which are listed below. -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 4+^s| security -| authorizationToken | | String | The default Telegram authorization token to be used when the information is not provided in the endpoints. - 4+^s| advanced -| resolvePropertyPlaceholders | true | boolean | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. +| Name | Description | Default | Type +| **authorizationToken** (security) | The default Telegram authorization token to be used when the information is not provided in the endpoints. | | String +| **resolvePropertyPlaceholders** (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |======================================================================= // component options: END @@ -68,62 +66,40 @@ with the following path and query parameters: #### Path Parameters (2 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| type | | String | *Required* The endpoint type. Currently only the 'bots' type is supported. -| authorizationToken | | String | *Required* The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H. +| Name | Description | Default | Type +| **type** | *Required* The endpoint type. Currently only the 'bots' type is supported. | | String +| **authorizationToken** | *Required* The authorization token for using the bot (ask the BotFather) eg. 654321531:HGF_dTra456323dHuOedsE343211fqr3t-H. | | String |======================================================================= #### Query Parameters (22 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - 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. - -| limit | 100 | Integer | Limit on the number of updates that can be received in a single polling request. - -| sendEmptyMessageWhenIdle | false | boolean | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. - -| timeout | 30 | Integer | Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time. - 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| producer -| chatId | | String | The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot its client sends automatically a '/start' message containing the chat id). It is an optional parameter as the chat id can be set dynamically for each outgoing message (using body or headers). - 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. +| Name | Description | Default | Type +| **bridgeErrorHandler** (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean +| **limit** (consumer) | Limit on the number of updates that can be received in a single polling request. | 100 | Integer +| **sendEmptyMessageWhenIdle** (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean +| **timeout** (consumer) | Timeout in seconds for long polling. Put 0 for short polling or a bigger number for long polling. Long polling produces shorter response time. | 30 | Integer +| **exceptionHandler** (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler +| **exchangePattern** (consumer) | Sets the exchange pattern when the consumer creates an exchange. | | ExchangePattern +| **pollStrategy** (consumer) | 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. | | PollingConsumerPoll Strategy +| **chatId** (producer) | The identifier of the chat that will receive the produced messages. Chat ids can be first obtained from incoming messages (eg. when a telegram user starts a conversation with a bot its client sends automatically a '/start' message containing the chat id). It is an optional parameter as the chat id can be set dynamically for each outgoing message (using body or headers). | | String +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| **backoffErrorThreshold** (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | | int +| **backoffIdleThreshold** (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | | int +| **backoffMultiplier** (scheduler) | 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. | | int +| **delay** (scheduler) | 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). | 500 | long +| **greedy** (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean +| **initialDelay** (scheduler) | 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). | 1000 | long +| **runLoggingLevel** (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel +| **scheduledExecutorService** (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | | ScheduledExecutor Service +| **scheduler** (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler +| **schedulerProperties** (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. | | Map +| **startScheduler** (scheduler) | Whether the scheduler should be auto started. | true | boolean +| **timeUnit** (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit +| **useFixedDelay** (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean |======================================================================= // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/bb3764e3/components/camel-tika/src/main/docs/tika-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-tika/src/main/docs/tika-component.adoc b/components/camel-tika/src/main/docs/tika-component.adoc index 4d14c5a..b7d8649 100644 --- a/components/camel-tika/src/main/docs/tika-component.adoc +++ b/components/camel-tika/src/main/docs/tika-component.adoc @@ -48,27 +48,22 @@ with the following path and query parameters: #### Path Parameters (1 parameters): -[width="100%",cols="2,1,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description -| operation | | TikaOperation | *Required* Tika Operation. parse or detect +| Name | Description | Default | Type +| **operation** | *Required* Tika Operation. parse or detect | | TikaOperation |======================================================================= #### Query Parameters (5 parameters): -[width="100%",cols="2,1m,1m,6",options="header"] +[width="100%",cols="2,6,1,1",options="header"] |======================================================================= -| Name | Default | Java Type | Description - -| tikaConfig | | TikaConfig | Tika Config - -| tikaConfigUri | | String | Tika Config Uri: The URI of tika-config.xml - -| tikaParseOutputEncoding | | String | Tika Parse Output Encoding - Used to specify the character encoding of the parsed output. Defaults to Charset.defaultCharset() . - -| tikaParseOutputFormat | xml | TikaParseOutputFormat | Tika Output Format. Supported output formats. xml: Returns Parsed Content as XML. html: Returns Parsed Content as HTML. text: Returns Parsed Content as Text. textMain: Uses the boilerpipe library to automatically extract the main content from a web page. - 4+^s| advanced -| synchronous | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| Name | Description | Default | Type +| **tikaConfig** (producer) | Tika Config | | TikaConfig +| **tikaConfigUri** (producer) | Tika Config Uri: The URI of tika-config.xml | | String +| **tikaParseOutputEncoding** (producer) | Tika Parse Output Encoding - Used to specify the character encoding of the parsed output. Defaults to Charset.defaultCharset() . | | String +| **tikaParseOutputFormat** (producer) | Tika Output Format. Supported output formats. xml: Returns Parsed Content as XML. html: Returns Parsed Content as HTML. text: Returns Parsed Content as Text. textMain: Uses the boilerpipe library to automatically extract the main content from a web page. | xml | TikaParseOutputFormat +| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean |======================================================================= // endpoint options: END
