http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-twitter/src/main/docs/twitter-search-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter-search-component.adoc b/components/camel-twitter/src/main/docs/twitter-search-component.adoc index 4661e9c..cdbc7dc 100644 --- a/components/camel-twitter/src/main/docs/twitter-search-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-search-component.adoc @@ -1,4 +1,4 @@ -## Twitter Search Component +== Twitter Search Component *Available as of Camel version 2.10* @@ -12,18 +12,18 @@ The Twitter Search component supports 9 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessToken** (security) | The access token | | String -| **accessTokenSecret** (security) | The access token secret | | String -| **consumerKey** (security) | The consumer key | | String -| **consumerSecret** (security) | The consumer secret | | String -| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. | | String -| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. | | String -| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. | | String -| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. | | int -| **resolveProperty Placeholders** (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 -|======================================================================= +| *accessToken* (security) | The access token | | String +| *accessTokenSecret* (security) | The access token secret | | String +| *consumerKey* (security) | The consumer key | | String +| *consumerSecret* (security) | The consumer secret | | String +| *httpProxyHost* (proxy) | The http proxy host which can be used for the camel-twitter. | | String +| *httpProxyUser* (proxy) | The http proxy user which can be used for the camel-twitter. | | String +| *httpProxyPassword* (proxy) | The http proxy password which can be used for the camel-twitter. | | String +| *httpProxyPort* (proxy) | The http proxy port which can be used for the camel-twitter. | | int +| *resolveProperty Placeholders* (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 @@ -32,63 +32,65 @@ The Twitter Search component supports 9 options which are listed below. // endpoint options: START The Twitter Search endpoint is configured using URI syntax: - twitter-search:keywords +---- +twitter-search:keywords +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **keywords** | *Required* The search keywords. Multiple values can be separated with comma. | | String -|======================================================================= +| *keywords* | *Required* The search keywords. Multiple values can be separated with comma. | | String +|=== -#### Query Parameters (41 parameters): +==== Query Parameters (41 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **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 -| **type** (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType -| **distanceMetric** (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | String -| **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 -| **latitude** (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **locations** (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String -| **longitude** (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **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 -| **radius** (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **twitterStream** (consumer) | To use a custom instance of TwitterStream | | TwitterStream -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **count** (filter) | Limiting number of results per page. | | Integer -| **filterOld** (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean -| **lang** (filter) | The lang string ISO_639-1 which will be used for searching | | String -| **numberOfPages** (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer -| **sinceId** (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long -| **userIds** (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String -| **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. | 30000 | 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 -| **sortById** (sort) | Sorts by id so the oldest are first and newest last. | true | boolean -| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer -| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **accessToken** (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String -| **accessTokenSecret** (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String -| **consumerKey** (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String -| **consumerSecret** (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | 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 +| *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 +| *type* (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType +| *distanceMetric* (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | String +| *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 +| *latitude* (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *locations* (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String +| *longitude* (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *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 +| *radius* (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *twitterStream* (consumer) | To use a custom instance of TwitterStream | | TwitterStream +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *count* (filter) | Limiting number of results per page. | | Integer +| *filterOld* (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean +| *lang* (filter) | The lang string ISO_639-1 which will be used for searching | | String +| *numberOfPages* (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer +| *sinceId* (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long +| *userIds* (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String +| *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. | 30000 | 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 +| *sortById* (sort) | Sorts by id so the oldest are first and newest last. | true | boolean +| *httpProxyHost* (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *httpProxyPassword* (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *httpProxyPort* (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer +| *httpProxyUser* (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *accessToken* (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String +| *accessTokenSecret* (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String +| *consumerKey* (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String +| *consumerSecret* (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | String +|=== // endpoint options: END
http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-twitter/src/main/docs/twitter-streaming-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter-streaming-component.adoc b/components/camel-twitter/src/main/docs/twitter-streaming-component.adoc index 81446bc..9feeaf8 100644 --- a/components/camel-twitter/src/main/docs/twitter-streaming-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-streaming-component.adoc @@ -1,4 +1,4 @@ -## Twitter Streaming Component +== Twitter Streaming Component *Available as of Camel version 2.10* @@ -12,18 +12,18 @@ The Twitter Streaming component supports 9 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessToken** (security) | The access token | | String -| **accessTokenSecret** (security) | The access token secret | | String -| **consumerKey** (security) | The consumer key | | String -| **consumerSecret** (security) | The consumer secret | | String -| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. | | String -| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. | | String -| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. | | String -| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. | | int -| **resolveProperty Placeholders** (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 -|======================================================================= +| *accessToken* (security) | The access token | | String +| *accessTokenSecret* (security) | The access token secret | | String +| *consumerKey* (security) | The consumer key | | String +| *consumerSecret* (security) | The consumer secret | | String +| *httpProxyHost* (proxy) | The http proxy host which can be used for the camel-twitter. | | String +| *httpProxyUser* (proxy) | The http proxy user which can be used for the camel-twitter. | | String +| *httpProxyPassword* (proxy) | The http proxy password which can be used for the camel-twitter. | | String +| *httpProxyPort* (proxy) | The http proxy port which can be used for the camel-twitter. | | int +| *resolveProperty Placeholders* (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 @@ -32,64 +32,66 @@ The Twitter Streaming component supports 9 options which are listed below. // endpoint options: START The Twitter Streaming endpoint is configured using URI syntax: - twitter-streaming:streamingType +---- +twitter-streaming:streamingType +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **streamingType** | *Required* The streaming type to consume. | | StreamingType -|======================================================================= +| *streamingType* | *Required* The streaming type to consume. | | StreamingType +|=== -#### Query Parameters (42 parameters): +==== Query Parameters (42 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **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 -| **type** (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType -| **distanceMetric** (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | String -| **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 -| **latitude** (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **locations** (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String -| **longitude** (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **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 -| **radius** (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **twitterStream** (consumer) | To use a custom instance of TwitterStream | | TwitterStream -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **count** (filter) | Limiting number of results per page. | | Integer -| **filterOld** (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean -| **keywords** (filter) | Can be used for a streaming filter. Multiple values can be separated with comma. | | String -| **lang** (filter) | The lang string ISO_639-1 which will be used for searching | | String -| **numberOfPages** (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer -| **sinceId** (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long -| **userIds** (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String -| **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. | 30000 | 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 -| **sortById** (sort) | Sorts by id so the oldest are first and newest last. | true | boolean -| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer -| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **accessToken** (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String -| **accessTokenSecret** (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String -| **consumerKey** (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String -| **consumerSecret** (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | 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 +| *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 +| *type* (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType +| *distanceMetric* (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | String +| *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 +| *latitude* (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *locations* (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String +| *longitude* (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *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 +| *radius* (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *twitterStream* (consumer) | To use a custom instance of TwitterStream | | TwitterStream +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *count* (filter) | Limiting number of results per page. | | Integer +| *filterOld* (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean +| *keywords* (filter) | Can be used for a streaming filter. Multiple values can be separated with comma. | | String +| *lang* (filter) | The lang string ISO_639-1 which will be used for searching | | String +| *numberOfPages* (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer +| *sinceId* (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long +| *userIds* (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String +| *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. | 30000 | 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 +| *sortById* (sort) | Sorts by id so the oldest are first and newest last. | true | boolean +| *httpProxyHost* (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *httpProxyPassword* (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *httpProxyPort* (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer +| *httpProxyUser* (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *accessToken* (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String +| *accessTokenSecret* (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String +| *consumerKey* (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String +| *consumerSecret* (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | String +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc b/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc index 9dde987..dbcb7d5 100644 --- a/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-timeline-component.adoc @@ -1,4 +1,4 @@ -## Twitter Timeline Component +== Twitter Timeline Component *Available as of Camel version 2.10* @@ -12,18 +12,18 @@ The Twitter Timeline component supports 9 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **accessToken** (security) | The access token | | String -| **accessTokenSecret** (security) | The access token secret | | String -| **consumerKey** (security) | The consumer key | | String -| **consumerSecret** (security) | The consumer secret | | String -| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. | | String -| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. | | String -| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. | | String -| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. | | int -| **resolveProperty Placeholders** (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 -|======================================================================= +| *accessToken* (security) | The access token | | String +| *accessTokenSecret* (security) | The access token secret | | String +| *consumerKey* (security) | The consumer key | | String +| *consumerSecret* (security) | The consumer secret | | String +| *httpProxyHost* (proxy) | The http proxy host which can be used for the camel-twitter. | | String +| *httpProxyUser* (proxy) | The http proxy user which can be used for the camel-twitter. | | String +| *httpProxyPassword* (proxy) | The http proxy password which can be used for the camel-twitter. | | String +| *httpProxyPort* (proxy) | The http proxy port which can be used for the camel-twitter. | | int +| *resolveProperty Placeholders* (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 @@ -32,65 +32,66 @@ The Twitter Timeline component supports 9 options which are listed below. // endpoint options: START The Twitter Timeline endpoint is configured using URI syntax: - twitter-timeline:timelineType +---- +twitter-timeline:timelineType +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **timelineType** | *Required* The timeline type to produce/consume. | | TimelineType -|======================================================================= +| *timelineType* | *Required* The timeline type to produce/consume. | | TimelineType +|=== -#### Query Parameters (42 parameters): +==== Query Parameters (42 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **user** (common) | The username when using timelineType=user | | 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 -| **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 -| **type** (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType -| **distanceMetric** (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | String -| **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 -| **latitude** (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **locations** (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String -| **longitude** (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **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 -| **radius** (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double -| **twitterStream** (consumer) | To use a custom instance of TwitterStream | | TwitterStream -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **count** (filter) | Limiting number of results per page. | | Integer -| **filterOld** (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean -| **lang** (filter) | The lang string ISO_639-1 which will be used for searching | | String -| **numberOfPages** (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer -| **sinceId** (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long -| **userIds** (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String -| **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. | 30000 | 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 -| **sortById** (sort) | Sorts by id so the oldest are first and newest last. | true | boolean -| **httpProxyHost** (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **httpProxyPassword** (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **httpProxyPort** (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer -| **httpProxyUser** (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String -| **accessToken** (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String -| **accessTokenSecret** (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String -| **consumerKey** (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String -| **consumerSecret** (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | String -|======================================================================= +| *user* (common) | The username when using timelineType=user | | 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 +| *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 +| *type* (consumer) | Endpoint type to use. Only streaming supports event type. | polling | EndpointType +| *distanceMetric* (consumer) | Used by the non-stream geography search to search by radius using the configured metrics. The unit can either be mi for miles or km for kilometers. You need to configure all the following options: longitude latitude radius and distanceMetric. | km | String +| *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 +| *latitude* (consumer) | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *locations* (consumer) | Bounding boxes created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as latlon. And multiple paris can be separated by semi colon. | | String +| *longitude* (consumer) | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *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 +| *radius* (consumer) | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude latitude radius and distanceMetric. | | Double +| *twitterStream* (consumer) | To use a custom instance of TwitterStream | | TwitterStream +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *count* (filter) | Limiting number of results per page. | | Integer +| *filterOld* (filter) | Filter out old tweets that has previously been polled. This state is stored in memory only and based on last tweet id. | true | boolean +| *lang* (filter) | The lang string ISO_639-1 which will be used for searching | | String +| *numberOfPages* (filter) | The number of pages result which you want camel-twitter to consume. | 1 | Integer +| *sinceId* (filter) | The last tweet id which will be used for pulling the tweets. It is useful when the camel route is restarted after a long running. | 1 | long +| *userIds* (filter) | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | | String +| *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. | 30000 | 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 +| *sortById* (sort) | Sorts by id so the oldest are first and newest last. | true | boolean +| *httpProxyHost* (proxy) | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *httpProxyPassword* (proxy) | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *httpProxyPort* (proxy) | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | Integer +| *httpProxyUser* (proxy) | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | | String +| *accessToken* (security) | The access token. Can also be configured on the TwitterComponent level instead. | | String +| *accessTokenSecret* (security) | The access secret. Can also be configured on the TwitterComponent level instead. | | String +| *consumerKey* (security) | The consumer key. Can also be configured on the TwitterComponent level instead. | | String +| *consumerSecret* (security) | The consumer secret. Can also be configured on the TwitterComponent level instead. | | String +|=== // endpoint options: END - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-undertow/src/main/docs/undertow-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-undertow/src/main/docs/undertow-component.adoc b/components/camel-undertow/src/main/docs/undertow-component.adoc index 11c07b8..b81aeab 100644 --- a/components/camel-undertow/src/main/docs/undertow-component.adoc +++ b/components/camel-undertow/src/main/docs/undertow-component.adoc @@ -1,4 +1,4 @@ -## Undertow Component +== Undertow Component *Available as of Camel version 2.16* @@ -43,14 +43,14 @@ The Undertow component supports 5 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **undertowHttpBinding** (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | UndertowHttpBinding -| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters -| **useGlobalSslContext Parameters** (security) | Enable usage of global SSL context parameters. | false | boolean -| **hostOptions** (advanced) | To configure common options such as thread pools | | UndertowHostOptions -| **resolveProperty Placeholders** (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 -|======================================================================= +| *undertowHttpBinding* (advanced) | To use a custom HttpBinding to control the mapping between Camel message and HttpClient. | | UndertowHttpBinding +| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters +| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters. | false | boolean +| *hostOptions* (advanced) | To configure common options such as thread pools | | UndertowHostOptions +| *resolveProperty Placeholders* (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 @@ -62,41 +62,43 @@ The Undertow component supports 5 options which are listed below. // endpoint options: START The Undertow endpoint is configured using URI syntax: - undertow:httpURI +---- +undertow:httpURI +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **httpURI** | *Required* The url of the HTTP endpoint to use. | | URI -|======================================================================= +| *httpURI* | *Required* The url of the HTTP endpoint to use. | | URI +|=== -#### Query Parameters (17 parameters): +==== Query Parameters (17 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -| **httpMethodRestrict** (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String -| **matchOnUriPrefix** (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | Boolean -| **optionsEnabled** (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | 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 -| **cookieHandler** (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler -| **keepAlive** (producer) | Setting to ensure socket is not closed due to inactivity | true | Boolean -| **options** (producer) | Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri then prefix each option with option. such as option.close-abort=true&option.send-buffer=8192 | | Map -| **reuseAddresses** (producer) | Setting to facilitate socket multiplexing | true | Boolean -| **tcpNoDelay** (producer) | Setting to improve TCP protocol performance | true | Boolean -| **throwExceptionOnFailure** (producer) | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. | true | Boolean -| **transferException** (producer) | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | Boolean -| **headerFilterStrategy** (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| **undertowHttpBinding** (advanced) | To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow. | | UndertowHttpBinding -| **sslContextParameters** (security) | To configure security using SSLContextParameters | | SSLContextParameters -|======================================================================= +| *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 +| *httpMethodRestrict* (consumer) | Used to only allow consuming if the HttpMethod matches such as GET/POST/PUT etc. Multiple methods can be specified separated by comma. | | String +| *matchOnUriPrefix* (consumer) | Whether or not the consumer should try to find a target consumer by matching the URI prefix if no exact match is found. | false | Boolean +| *optionsEnabled* (consumer) | Specifies whether to enable HTTP OPTIONS for this Servlet consumer. By default OPTIONS is turned off. | 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 +| *cookieHandler* (producer) | Configure a cookie handler to maintain a HTTP session | | CookieHandler +| *keepAlive* (producer) | Setting to ensure socket is not closed due to inactivity | true | Boolean +| *options* (producer) | Sets additional channel options. The options that can be used are defined in org.xnio.Options. To configure from endpoint uri then prefix each option with option. such as option.close-abort=true&option.send-buffer=8192 | | Map +| *reuseAddresses* (producer) | Setting to facilitate socket multiplexing | true | Boolean +| *tcpNoDelay* (producer) | Setting to improve TCP protocol performance | true | Boolean +| *throwExceptionOnFailure* (producer) | Option to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code. | true | Boolean +| *transferException* (producer) | If enabled and an Exchange failed processing on the consumer side and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is instead of the HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. | false | Boolean +| *headerFilterStrategy* (advanced) | To use a custom HeaderFilterStrategy to filter header to and from Camel message. | | HeaderFilterStrategy +| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean +| *undertowHttpBinding* (advanced) | To use a custom UndertowHttpBinding to control the mapping between Camel message and undertow. | | UndertowHttpBinding +| *sslContextParameters* (security) | To configure security using SSLContextParameters | | SSLContextParameters +|=== // endpoint options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc b/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc index c38576c..e030656 100644 --- a/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc +++ b/components/camel-univocity-parsers/src/main/docs/univocity-csv-dataformat.adoc @@ -1,4 +1,4 @@ -## uniVocity CSV DataFormat +== uniVocity CSV DataFormat *Available as of Camel version 2.15* @@ -48,7 +48,7 @@ The uniVocity CSV dataformat supports 18 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | quoteAllFields | false | Boolean | Whether or not all values must be quoted when writing them. | quote | " | String | The quote symbol. @@ -68,7 +68,7 @@ The uniVocity CSV dataformat supports 18 options which are listed below. | lazyLoad | false | Boolean | Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false | asMap | false | Boolean | Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc b/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc index 98315e4..3777483 100644 --- a/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc +++ b/components/camel-univocity-parsers/src/main/docs/univocity-fixed-dataformat.adoc @@ -1,4 +1,4 @@ -## uniVocity Fixed Length DataFormat +== uniVocity Fixed Length DataFormat *Available as of Camel version 2.15* @@ -48,7 +48,7 @@ The uniVocity Fixed Length dataformat supports 17 options which are listed below [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | skipTrailingCharsUntilNewline | false | Boolean | Whether or not the trailing characters until new line must be ignored. The default value is false | recordEndsOnNewline | false | Boolean | Whether or not the record ends on new line. The default value is false @@ -67,7 +67,7 @@ The uniVocity Fixed Length dataformat supports 17 options which are listed below | lazyLoad | false | Boolean | Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false | asMap | false | Boolean | Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc b/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc index 2f58d5b..24ee98a 100644 --- a/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc +++ b/components/camel-univocity-parsers/src/main/docs/univocity-tsv-dataformat.adoc @@ -1,4 +1,4 @@ -## uniVocity TSV DataFormat +== uniVocity TSV DataFormat *Available as of Camel version 2.15* @@ -48,7 +48,7 @@ The uniVocity TSV dataformat supports 15 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | escapeChar | \ | String | The escape character. | nullValue | | String | The string representation of a null value. The default value is null @@ -65,7 +65,7 @@ The uniVocity TSV dataformat supports 15 options which are listed below. | lazyLoad | false | Boolean | Whether the unmarshalling should produce an iterator that reads the lines on the fly or if all the lines must be read at one. The default value is false | asMap | false | Boolean | Whether the unmarshalling should produce maps for the lines values instead of lists. It requires to have header (either defined or collected). The default value is false | contentTypeHeader | false | Boolean | Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML or application/json for data formats marshalling to JSon etc. -|======================================================================= +|=== // dataformat options: END http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-velocity/src/main/docs/velocity-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-velocity/src/main/docs/velocity-component.adoc b/components/camel-velocity/src/main/docs/velocity-component.adoc index 31a4a72..220c4a2 100644 --- a/components/camel-velocity/src/main/docs/velocity-component.adoc +++ b/components/camel-velocity/src/main/docs/velocity-component.adoc @@ -1,4 +1,4 @@ -## Velocity Component +== Velocity Component *Available as of Camel version 1.2* @@ -44,11 +44,11 @@ The Velocity component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **velocityEngine** (advanced) | To use the VelocityEngine otherwise a new engine is created | | VelocityEngine -| **resolveProperty Placeholders** (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 -|======================================================================= +| *velocityEngine* (advanced) | To use the VelocityEngine otherwise a new engine is created | | VelocityEngine +| *resolveProperty Placeholders* (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 @@ -57,29 +57,31 @@ The Velocity component supports 2 options which are listed below. // endpoint options: START The Velocity endpoint is configured using URI syntax: - velocity:resourceUri +---- +velocity:resourceUri +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **contentCache** (producer) | Sets whether to use resource content cache or not | false | boolean -| **encoding** (producer) | Character encoding of the resource content. | | String -| **loaderCache** (producer) | Enables / disables the velocity resource loader cache which is enabled by default | true | boolean -| **propertiesFile** (producer) | The URI of the properties file which is used for VelocityEngine initialization. | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean -|======================================================================= +| *contentCache* (producer) | Sets whether to use resource content cache or not | false | boolean +| *encoding* (producer) | Character encoding of the resource content. | | String +| *loaderCache* (producer) | Enables / disables the velocity resource loader cache which is enabled by default | true | boolean +| *propertiesFile* (producer) | The URI of the properties file which is used for VelocityEngine initialization. | | String +| *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/4f4f2e45/components/camel-vertx/src/main/docs/vertx-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-vertx/src/main/docs/vertx-component.adoc b/components/camel-vertx/src/main/docs/vertx-component.adoc index 3034c5b..d650187 100644 --- a/components/camel-vertx/src/main/docs/vertx-component.adoc +++ b/components/camel-vertx/src/main/docs/vertx-component.adoc @@ -1,4 +1,4 @@ -## Vert.x Component +== Vert.x Component *Available as of Camel version 2.12* @@ -41,16 +41,16 @@ The Vert.x component supports 7 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **vertxFactory** (advanced) | To use a custom VertxFactory implementation | | VertxFactory -| **host** (common) | Hostname for creating an embedded clustered EventBus | | String -| **port** (common) | Port for creating an embedded clustered EventBus | | int -| **vertxOptions** (common) | Options to use for creating vertx | | VertxOptions -| **vertx** (common) | To use the given vertx EventBus instead of creating a new embedded EventBus | | Vertx -| **timeout** (common) | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. | 60 | int -| **resolveProperty Placeholders** (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 -|======================================================================= +| *vertxFactory* (advanced) | To use a custom VertxFactory implementation | | VertxFactory +| *host* (common) | Hostname for creating an embedded clustered EventBus | | String +| *port* (common) | Port for creating an embedded clustered EventBus | | int +| *vertxOptions* (common) | Options to use for creating vertx | | VertxOptions +| *vertx* (common) | To use the given vertx EventBus instead of creating a new embedded EventBus | | Vertx +| *timeout* (common) | Timeout in seconds to wait for clustered Vertx EventBus to be ready. The default value is 60. | 60 | int +| *resolveProperty Placeholders* (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 @@ -59,29 +59,31 @@ The Vert.x component supports 7 options which are listed below. // endpoint options: START The Vert.x endpoint is configured using URI syntax: - vertx:address +---- +vertx:address +---- with the following path and query parameters: -#### Path Parameters (1 parameters): +==== Path Parameters (1 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **address** | *Required* Sets the event bus address used to communicate | | String -|======================================================================= +| *address* | *Required* Sets the event bus address used to communicate | | String +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **pubSub** (common) | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. | | 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 -| **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 -|======================================================================= +| *pubSub* (common) | Whether to use publish/subscribe instead of point to point when sending to a vertx endpoint. | | 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 +| *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 +|=== // endpoint options: END
