http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 3c24125..735029a 100644 --- a/components/camel-stringtemplate/src/main/docs/string-template-component.adoc +++ b/components/camel-stringtemplate/src/main/docs/string-template-component.adoc @@ -1,4 +1,4 @@ -## String Template Component +== String Template Component *Available as of Camel version 1.2* @@ -45,28 +45,30 @@ The String Template component has no options. // endpoint options: START The String Template endpoint is configured using URI syntax: - string-template:resourceUri +---- +string-template: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 (4 parameters): +==== Query Parameters (4 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 -| **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 -|======================================================================= +| *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/4f4f2e45/components/camel-syslog/src/main/docs/syslog-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc index be155bd..bb2560c 100644 --- a/components/camel-syslog/src/main/docs/syslog-dataformat.adoc +++ b/components/camel-syslog/src/main/docs/syslog-dataformat.adoc @@ -1,4 +1,4 @@ -## Syslog DataFormat +== Syslog DataFormat *Available as of Camel version 2.6* @@ -52,10 +52,10 @@ The Syslog dataformat supports 1 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | 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 ### RFC5424 Syslog protocol http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc b/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc index f394941..55e9333 100644 --- a/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc +++ b/components/camel-tagsoup/src/main/docs/tidyMarkup-dataformat.adoc @@ -1,4 +1,4 @@ -## TidyMarkup DataFormat +== TidyMarkup DataFormat *Available as of Camel version 2.0* @@ -27,12 +27,12 @@ The TidyMarkup dataformat supports 3 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | dataObjectType | org.w3c.dom.Node | String | What data type to unmarshal as can either be org.w3c.dom.Node or java.lang.String. Is by default org.w3c.dom.Node | omitXmlDeclaration | false | Boolean | When returning a String do we omit the XML declaration in the top. | 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-tarfile/src/main/docs/tarfile-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc index e0dda4a..9f0c972 100644 --- a/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc +++ b/components/camel-tarfile/src/main/docs/tarfile-dataformat.adoc @@ -1,4 +1,4 @@ -## Tar File DataFormat +== Tar File DataFormat *Available as of Camel version 2.16* @@ -19,12 +19,12 @@ The Tar File dataformat supports 3 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | usingIterator | false | Boolean | If the tar file has more then one entry the setting this option to true allows to work with the splitter EIP to split the data using an iterator in a streaming mode. | allowEmptyDirectory | false | Boolean | If the tar file has more then one entry setting this option to true allows to get the iterator even if the directory is empty | 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-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 9b1dd53..8497e95 100644 --- a/components/camel-telegram/src/main/docs/telegram-component.adoc +++ b/components/camel-telegram/src/main/docs/telegram-component.adoc @@ -1,4 +1,4 @@ -## Telegram Component +== Telegram Component *Available as of Camel version 2.18* @@ -48,11 +48,11 @@ The Telegram component supports 2 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **authorizationToken** (security) | The default Telegram authorization token to be used when the information is not provided in the endpoints. | | String -| **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 -|======================================================================= +| *authorizationToken* (security) | The default Telegram authorization token to be used when the information is not provided in the endpoints. | | String +| *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 @@ -60,47 +60,49 @@ The Telegram component supports 2 options which are listed below. // endpoint options: START The Telegram endpoint is configured using URI syntax: - telegram:type/authorizationToken +---- +telegram:type/authorizationToken +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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): +==== Query Parameters (22 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 -| **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 -|======================================================================= +| *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/4f4f2e45/components/camel-thrift/src/main/docs/thrift-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-thrift/src/main/docs/thrift-component.adoc b/components/camel-thrift/src/main/docs/thrift-component.adoc index cad6a59..c5954fb 100644 --- a/components/camel-thrift/src/main/docs/thrift-component.adoc +++ b/components/camel-thrift/src/main/docs/thrift-component.adoc @@ -1,4 +1,4 @@ -## Thrift Component +== Thrift Component *Available as of Camel version 2.20* @@ -34,33 +34,35 @@ The Thrift component has no options. // endpoint options: START The Thrift endpoint is configured using URI syntax: - thrift:host:port/service +---- +thrift:host:port/service +---- with the following path and query parameters: -#### Path Parameters (3 parameters): +==== Path Parameters (3 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **host** | The Thrift server host name. This is localhost or 0.0.0.0 (if not defined) when being a consumer or remote server hostname when using producer. | | String -| **port** | *Required* The Thrift server port | | int -| **service** | *Required* Fully qualified service name from the protocol buffer descriptor file (package dot service definition name) | | String -|======================================================================= +| *host* | The Thrift server host name. This is localhost or 0.0.0.0 (if not defined) when being a consumer or remote server hostname when using producer. | | String +| *port* | *Required* The Thrift server port | | int +| *service* | *Required* Fully qualified service name from the protocol buffer descriptor file (package dot service definition name) | | String +|=== -#### Query Parameters (7 parameters): +==== Query Parameters (7 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 -| **maxPoolSize** (consumer) | The Thrift server consumer max thread pool size | 10 | int -| **poolSize** (consumer) | The Thrift server consumer initial thread pool size | 1 | int -| **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 -| **method** (producer) | The Thrift invoked method name | | String -| **synchronous** (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | 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 +| *maxPoolSize* (consumer) | The Thrift server consumer max thread pool size | 10 | int +| *poolSize* (consumer) | The Thrift server consumer initial thread pool size | 1 | int +| *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 +| *method* (producer) | The Thrift invoked method name | | 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 ### Thrift method parameters mapping @@ -142,4 +144,3 @@ https://thrift.apache.org/tutorial/java [Apache Thrift Java tutorial] * link:configuring-camel.html[Configuring Camel] * link:component.html[Component] * link:endpoint.html[Endpoint] - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-thrift/src/main/docs/thrift-dataformat.adoc ---------------------------------------------------------------------- diff --git a/components/camel-thrift/src/main/docs/thrift-dataformat.adoc b/components/camel-thrift/src/main/docs/thrift-dataformat.adoc index 54a6267..a828932 100644 --- a/components/camel-thrift/src/main/docs/thrift-dataformat.adoc +++ b/components/camel-thrift/src/main/docs/thrift-dataformat.adoc @@ -1,4 +1,4 @@ -## Thrift DataFormat +== Thrift DataFormat *Available as of Camel version 2.20* @@ -21,12 +21,12 @@ The Thrift dataformat supports 3 options which are listed below. [width="100%",cols="2s,1m,1m,6",options="header"] -|======================================================================= +|=== | Name | Default | Java Type | Description | instanceClass | | String | Name of class to use when unarmshalling | contentTypeFormat | binary | String | Defines a content type format in which thrift message will be serialized/deserialized from(to) the Java been. The format can either be native or json for either native binary thrift json or simple json fields representation. The default value is binary. | 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 ### Content type format http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/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 1639336..803464c 100644 --- a/components/camel-tika/src/main/docs/tika-component.adoc +++ b/components/camel-tika/src/main/docs/tika-component.adoc @@ -1,4 +1,4 @@ -## Tika Component +== Tika Component *Available as of Camel version 2.19* @@ -42,29 +42,31 @@ The Tika component has no options. // endpoint options: START The Tika endpoint is configured using URI syntax: - tika:operation +---- +tika:operation +---- 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 -| **operation** | *Required* Tika Operation. parse or detect | | TikaOperation -|======================================================================= +| *operation* | *Required* Tika Operation. parse or detect | | TikaOperation +|=== -#### Query Parameters (5 parameters): +==== Query Parameters (5 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | 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 -|======================================================================= +| *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 http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-twilio/src/main/docs/twilio-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twilio/src/main/docs/twilio-component.adoc b/components/camel-twilio/src/main/docs/twilio-component.adoc index 4fd68e8..366a94b 100644 --- a/components/camel-twilio/src/main/docs/twilio-component.adoc +++ b/components/camel-twilio/src/main/docs/twilio-component.adoc @@ -1,4 +1,4 @@ -## Twilio Component +== Twilio Component *Available as of Camel version 2.20* @@ -26,44 +26,46 @@ The Twilio component supports 3 options which are listed below. [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **configuration** (advanced) | To use the shared configuration | | TwilioConfiguration -| **restClient** (advanced) | To use the shared REST client | | TwilioRestClient -| **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 -|======================================================================= +| *configuration* (advanced) | To use the shared configuration | | TwilioConfiguration +| *restClient* (advanced) | To use the shared REST client | | TwilioRestClient +| *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 // endpoint options: START The Twilio endpoint is configured using URI syntax: - twilio:apiName/methodName +---- +twilio:apiName/methodName +---- with the following path and query parameters: -#### Path Parameters (2 parameters): +==== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **apiName** | *Required* What kind of operation to perform | | TwilioApiName -| **methodName** | *Required* What sub operation to use for the selected operation | | String -|======================================================================= +| *apiName* | *Required* What kind of operation to perform | | TwilioApiName +| *methodName* | *Required* What sub operation to use for the selected operation | | String +|=== -#### Query Parameters (8 parameters): +==== Query Parameters (8 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **inBody** (common) | Sets the name of a parameter to be passed in the exchange In Body | | 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 -| **accountSid** (security) | The account SID to use. | | String -| **password** (security) | Auth token for the account. | | String -| **username** (security) | The account to use. | | String -|======================================================================= +| *inBody* (common) | Sets the name of a parameter to be passed in the exchange In Body | | 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 +| *accountSid* (security) | The account SID to use. | | String +| *password* (security) | Auth token for the account. | | String +| *username* (security) | The account to use. | | String +|=== // endpoint options: END @@ -191,4 +193,3 @@ endpoints with *CamelTwilio.* prefix. All result message bodies utilize objects provided by the Twilio Java SDK. Producer endpoints can specify the option name for incoming message body in the *inBody* endpoint parameter. - http://git-wip-us.apache.org/repos/asf/camel/blob/4f4f2e45/components/camel-twitter/src/main/docs/twitter-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter-component.adoc b/components/camel-twitter/src/main/docs/twitter-component.adoc index 93501d9..4056b2c 100644 --- a/components/camel-twitter/src/main/docs/twitter-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-component.adoc @@ -1,4 +1,4 @@ -## Twitter Component (deprecated) +== Twitter Component (deprecated) *Available as of Camel version 2.10* @@ -59,18 +59,18 @@ The Twitter 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 @@ -143,67 +143,69 @@ Removed from Camel 2.11 onwards.* // endpoint options: START The Twitter endpoint is configured using URI syntax: - twitter:kind +---- +twitter:kind +---- 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 -| **kind** | *Required* The kind of endpoint | | String -|======================================================================= +| *kind* | *Required* The kind of endpoint | | String +|=== -#### Query Parameters (43 parameters): +==== Query Parameters (43 parameters): [width="100%",cols="2,5,^1,2",options="header"] -|======================================================================= +|=== | Name | Description | Default | Type -| **user** (common) | Username used for user timeline consumption direct message production etc. | | 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 search and 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 -|======================================================================= +| *user* (common) | Username used for user timeline consumption direct message production etc. | | 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 search and 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-directmessage-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc b/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc index 86a352d..13385e8 100644 --- a/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc +++ b/components/camel-twitter/src/main/docs/twitter-directmessage-component.adoc @@ -1,4 +1,4 @@ -## Twitter Direct Message Component +== Twitter Direct Message Component *Available as of Camel version 2.10* @@ -13,18 +13,18 @@ The Twitter Direct Message 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 @@ -33,63 +33,65 @@ The Twitter Direct Message component supports 9 options which are listed below. // endpoint options: START The Twitter Direct Message endpoint is configured using URI syntax: - twitter-directmessage:user +---- +twitter-directmessage:user +---- 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 -| **user** | *Required* The user name to send a direct message. This will be ignored for consumer. | | String -|======================================================================= +| *user* | *Required* The user name to send a direct message. This will be ignored for consumer. | | 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
