Chapter 330. Twitter Component (deprecated)

Available as of Camel version 2.10

Important

The composite twitter component has been deprecated. Use individual component for directmessage, search, streaming and timeline.

The Twitter component enables the most useful features of the Twitter API by encapsulating Twitter4J. It allows direct, polling, or event-driven consumption of timelines, users, trends, and direct messages. Also, it supports producing messages as status updates or direct messages.

Twitter now requires the use of OAuth for all client application authentication. In order to use camel-twitter with your account, you’ll need to create a new application within Twitter at https://dev.twitter.com/apps/new and grant the application access to your account. Finally, generate your access token and secret.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-twitter</artifactId>
    <version>${camel-version}</version>
</dependency>

330.1. URI format

twitter://endpoint[?options]

330.2. Twitter component

The twitter component can be configured with the Twitter account settings which is mandatory to configure before using.

The Twitter component supports 9 options which are listed below.

NameDescriptionDefaultType

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

You can also configure these options directly in the endpoint.

330.3. Consumer endpoints

Rather than the endpoints returning a List through one single route exchange, camel-twitter creates one route exchange per returned object. As an example, if "timeline/home" results in five statuses, the route will be executed five times (one for each Status).

EndpointContextBody TypeNotice

directmessage

direct, polling

twitter4j.DirectMessage

 

search

direct, polling

twitter4j.Status

 

streaming/filter

event, polling

twitter4j.Status

 

streaming/sample

event, polling

twitter4j.Status

 

streaming/user

event, polling

twitter4j.Status

Camel 2.16: To receive tweets from protected users and accounts.

timeline/home

direct, polling

twitter4j.Status

 

timeline/mentions

direct, polling

twitter4j.Status

 

timeline/public

direct, polling

twitter4j.Status

@deprecated. Use timeline/home or direct/home instead. Removed from *Camel 2.11 onwards.*

timeline/retweetsofme

direct, polling

twitter4j.Status

 

timeline/user

direct, polling

twitter4j.Status

 

trends/daily

*Camel 2.10.1: direct, polling*

twitter4j.Status

@deprecated. Removed from Camel 2.11 onwards.

trends/weekly

*Camel 2.10.1: direct, polling*

twitter4j.Status

@deprecated. Removed from Camel 2.11 onwards.

330.4. Producer endpoints

EndpointBody Type

directmessage

String

search

List<twitter4j.Status>

timeline/user

String

330.5. URI options

The Twitter endpoint is configured using URI syntax:

twitter:kind

with the following path and query parameters:

330.5.1. Path Parameters (1 parameters):

NameDescriptionDefaultType

kind

Required The kind of endpoint

 

String

330.5.2. Query Parameters (44 parameters):

NameDescriptionDefaultType

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

extendedMode (consumer)

Used for enabling full text from twitter (eg receive tweets that contains more than 140 characters).

true

boolean

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 lat,lon. 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

330.6. Message headers

NameDescription

CamelTwitterKeywords

This header is used by the search producer to change the search key words dynamically.

CamelTwitterSearchLanguage

Camel 2.11.0: This header can override the option of lang which set the search language for the search endpoint dynamically

CamelTwitterCount

Camel 2.11.0 This header can override the option of count which sets the max twitters that will be returned.

CamelTwitterNumberOfPages

Camel 2.11.0 This header can override the option of numberOfPages which sets how many pages we want to twitter returns.

330.7. Message body

All message bodies utilize objects provided by the Twitter4J API.

330.8. Use cases

Note

API Rate Limits: Twitter REST APIs encapsulated by Twitter4J are subjected to API Rate Limiting. You can find the per method limits in the API Rate Limits documentation. Note that endpoints/resources not listed in that page are default to 15 requests per allotted user per window.

330.8.1. To create a status update within your Twitter profile, send this producer a String body:

from("direct:foo")
  .to("twitter://timeline/user?consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]);

330.8.2. To poll, every 60 sec., all statuses on your home timeline:

from("twitter://timeline/home?type=polling&delay=60&consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]")
  .to("bean:blah");

330.8.3. To search for all statuses with the keyword 'camel' only once:

from("twitter://search?type=polling&keywords=camel&consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]")
  .to("bean:blah");

330.8.4. Searching using a producer with static keywords:

from("direct:foo")
  .to("twitter://search?keywords=camel&consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]");

330.8.5. Searching using a producer with dynamic keywords from header:

In the bar header we have the keywords we want to search, so we can assign this value to the CamelTwitterKeywords header:

from("direct:foo")
  .setHeader("CamelTwitterKeywords", header("bar"))
  .to("twitter://search?consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]");

330.9. Example

See also the Twitter Websocket Example.

330.10. See Also

  • Configuring Camel
  • Component
  • Endpoint
  • Getting Started
  • Twitter Websocket Example