This component integrates with Twitter to send tweets or search for tweets and more.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| kind | path | common | true | java.lang.String | directmessage search streaming/filter streaming/sample streaming/user timeline/home timeline/mentions timeline/retweetsofme timeline/user |
What polling mode to use, direct, polling or event based. The event mode is only supported when the endpoint kind is event based. | |
| accessToken | parameter | common | java.lang.String | The access token. Can also be configured on the TwitterComponent level instead. | |||
| accessTokenSecret | parameter | common | java.lang.String | The access secret. Can also be configured on the TwitterComponent level instead. | |||
| consumerKey | parameter | common | java.lang.String | The consumer key. Can also be configured on the TwitterComponent level instead. | |||
| consumerSecret | parameter | common | java.lang.String | The consumer secret. Can also be configured on the TwitterComponent level instead. | |||
| user | parameter | common | java.lang.String | Username, used for user timeline consumption, direct message production, etc. | |||
| bridgeErrorHandler | parameter | consumer | boolean | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| sendEmptyMessageWhenIdle | parameter | consumer | boolean | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
| type | parameter | consumer | direct | org.apache.camel.component.twitter.data.EndpointType | polling direct event |
Endpoint type to use. Only streaming supports event type. | |
| distanceMetric | parameter | consumer (advanced) | km | java.lang.String | km mi |
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. | |
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| latitude | parameter | consumer (advanced) | java.lang.Double | Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric. | |||
| locations | parameter | consumer (advanced) | java.lang.String | Bounding boxes, created by pairs of lat/lons. Can be used for streaming/filter. A pair is defined as lat,lon. And multiple paris can be separated by semi colon. | |||
| longitude | parameter | consumer (advanced) | java.lang.Double | Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric. | |||
| pollStrategy | parameter | consumer (advanced) | org.apache.camel.spi.PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | |||
| radius | parameter | consumer (advanced) | java.lang.Double | Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric. | |||
| twitterStream | parameter | consumer (advanced) | twitter4j.TwitterStream | To use a custom instance of TwitterStream | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| count | parameter | filter | java.lang.Integer | Limiting number of results per page. | |||
| filterOld | parameter | filter | true | boolean | Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id. | ||
| keywords | parameter | filter | java.lang.String | Can be used for search and streaming/filter. Multiple values can be separated with comma. | |||
| lang | parameter | filter | java.lang.String | The lang string ISO_639-1 which will be used for searching | |||
| numberOfPages | parameter | filter | 1 | java.lang.Integer | The number of pages result which you want camel-twitter to consume. | ||
| sinceId | parameter | filter | 1 | long | 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. | ||
| userIds | parameter | filter | java.lang.String | To filter by user ids for streaming/filter. Multiple values can be separated by comma. | |||
| backoffErrorThreshold | parameter | scheduler | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
| backoffIdleThreshold | parameter | scheduler | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
| backoffMultiplier | parameter | scheduler | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | |||
| delay | parameter | scheduler | 60000 | long | Milliseconds before the next poll. | ||
| greedy | parameter | scheduler | boolean | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
| initialDelay | parameter | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). | ||
| runLoggingLevel | parameter | scheduler | TRACE | org.apache.camel.LoggingLevel | TRACE DEBUG INFO WARN ERROR OFF |
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | |
| scheduledExecutorService | parameter | scheduler | java.util.concurrent.ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | |||
| scheduler | parameter | scheduler | none | org.apache.camel.spi.ScheduledPollConsumerScheduler | none spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | |
| schedulerProperties | parameter | scheduler | java.util.Map |
To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
| startScheduler | parameter | scheduler | true | boolean | Whether the scheduler should be auto started. | ||
| timeUnit | parameter | scheduler | MILLISECONDS | java.util.concurrent.TimeUnit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
| useFixedDelay | parameter | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | ||
| httpProxyHost | parameter | proxy | java.lang.String | The http proxy host which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | |||
| httpProxyPassword | parameter | proxy | java.lang.String | The http proxy password which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | |||
| httpProxyPort | parameter | proxy | java.lang.Integer | The http proxy port which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. | |||
| httpProxyUser | parameter | proxy | java.lang.String | The http proxy user which can be used for the camel-twitter. Can also be configured on the TwitterComponent level instead. |