Twitter

Available as of Camel 2.10

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>

URI format

twitter://[endpoint]?[options]

TwitterComponent:

The twitter component can be configured with the Twitter account settings which is mandatory to configure before using.
You can also configure these options directly in the endpoint.

Option Description
consumerKey The consumer key
consumerSecret The consumer secret
accessToken The access token
accessTokenSecret The access token secret

Consumer Endpoints:

Endpoint Context Body Type
directmessage direct, polling List<twitter4j.DirectMessage>
search direct, polling List<twitter4j.Tweet>
streaming/filter event, polling List<twitter4j.Status>
streaming/sample event, polling event: twitter4j.Status, polling: List<twitter4j.Status>
timeline/home direct, polling List<twitter4j.Status>
timeline/mentions direct, polling List<twitter4j.Status>
timeline/public direct, polling List<twitter4j.Status>
timeline/retweetsofme direct, polling List<twitter4j.Status>
timeline/user direct, polling List<twitter4j.Status>

Producer Endpoints:

Endpoint Body Type
directmessage String
timeline/user String

URI Options

Name Default Value Description
type direct direct, event, or polling
delay 60 in seconds
consumerKey null Consumer Key. Can also be configured on the TwitterComponent level instead.
consumerSecret null Consumer Secret. Can also be configured on the TwitterComponent level instead.
accessToken null Access Token. Can also be configured on the TwitterComponent level instead.
accessTokenSecret null Access Token Secret. Can also be configured on the TwitterComponent level instead.
user null Username, used for user timeline consumption, direct message production, etc.
keywords null 'lat,lon;lat,lon;...' Can be used for streaming/filter
userIds null 'username,username...' Can be used for streaming/filter

Message body

All message bodies utilize objects provided by the Twitter4J API.

Use cases

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

twitter://timeline/user?consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]

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

twitter://timeline/home?type=polling&delay=5&consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]

To search for all statuses with the keyword 'camel':

twitter://search?type=direct&keywords=camel&consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]

Example

See also the Twitter Websocket Example.

See Also

© 2004-2011 The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Graphic Design By Hiram