THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-twitter</artifactId>
<version>${camel-version}</version>
</dependency>
|
URI format
| Code Block | ||
|---|---|---|
| ||
twitter://endpoint[?options] |
...
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:
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).
| Wiki Markup |
|---|
{div:class=confluenceTableSmall}
|| Endpoint || Context || Body Type || Notice ||
| directmessage | direct, polling | twitter4j.DirectMessage | |
| search | direct, polling | twitter4j.Tweet | |
| streaming/filter | event, polling | twitter4j.Status | |
| streaming/sample | event, polling | twitter4j.Status | |
| 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. |
{div} |
Producer Endpoints:
| Wiki Markup |
|---|
{div:class=confluenceTableSmall}
|| Endpoint || Body Type ||
| directmessage | String |
| search | List<twitter4j.Tweet> |
| timeline/user | String |
{div} |
URI Options
...
Endpoint | Context | Body Type | Notice |
|---|---|---|---|
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 twitter4j.DirectMessagetwitter4j.UserList | Camel 2.16: To receive tweets from protected users and accounts. Camel 2.17: DirectMessages, Favorites, Lists, Following events are now supported |
timeline/home | direct, polling | twitter4j.Status |
|
timeline/mentions | direct, polling | twitter4j.Status |
|
|
|
|
|
timeline/retweetsofme | direct, polling | twitter4j.Status |
|
timeline/user | direct, polling | twitter4j.Status |
|
|
|
|
|
|
|
|
|
Producer Endpoints:
Endpoint | Body Type |
|---|---|
directmessage | String |
search | List<twitter4j.Status> |
timeline/user | String |
URI Options
Name | Default Value | Description |
|---|---|---|
type |
| direct, event, or polling |
delay |
| Delay between polls. The value is 60 seconds by default. The value is in seconds for Camel 2.16 or older. And in millis seconds from Camel 2.17 onwards. |
consumerKey |
| Consumer Key. Can also be configured on the |
consumerSecret |
| Consumer Secret. Can also be configured on the |
accessToken |
| Access Token. Can also be configured on the |
accessTokenSecret |
| Access Token Secret. Can also be configured on the |
user |
| Username, used for user timeline consumption, direct message production, etc. |
locations |
| 'lat,lon;lat,lon;...' |
...
Bounding |
...
boxes, |
...
created |
...
by |
...
pairs |
...
of |
...
lat/lons. |
...
Can |
...
be |
...
used |
...
for |
...
streaming/filter |
...
keywords |
| 'foo1,foo2,foo3...' |
...
Can |
...
be |
...
used |
...
for |
...
search |
...
and |
...
streaming/filter. |
...
See |
...
...
...
for |
...
keywords |
...
syntax |
...
for |
...
searching |
...
with |
...
for |
...
example |
...
OR. |
...
userIds |
| 'username,username...' |
...
Can |
...
be |
...
used |
...
for |
...
streaming/filter |
...
filterOld |
| Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id. Since Camel 2.11.0 |
...
The |
...
search |
...
producer |
...
supports |
...
this |
...
option |
...
sinceId |
| Camel 2.11.0: |
...
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. |
...
lang |
| Camel 2.11.0: |
...
The |
...
lang |
...
string |
...
...
which |
...
will |
...
be |
...
used |
...
for |
...
searching |
...
count |
| Camel 2.11.0: |
...
Limiting |
...
number |
...
of |
...
results |
...
per |
...
page. |
...
numberOfPages |
| Camel 2.11.0: |
...
The |
...
number |
...
of |
...
pages |
...
result |
...
which |
...
you |
...
want |
...
camel-twitter |
...
to |
...
consume. |
...
httpProxyHost |
| Camel 2.12.3: |
...
The |
...
http |
...
proxy |
...
host |
...
which |
...
can |
...
be |
...
used |
...
for |
...
the |
...
camel-twitter. |
...
httpProxyPort |
| Camel 2.12.3: |
...
The |
...
http |
...
proxy |
...
port |
...
which |
...
can |
...
be |
...
used |
...
for |
...
the |
...
camel-twitter. |
...
httpProxyUser |
| Camel 2.12.3: |
...
The |
...
http |
...
proxy |
...
user |
...
which |
...
can |
...
be |
...
used |
...
for |
...
the |
...
camel-twitter. |
...
httpProxyPassword |
| Camel 2.12.3: |
...
The |
...
http |
...
proxy |
...
password |
...
which |
...
can |
...
be |
...
used |
...
for |
...
the |
...
camel-twitter. |
...
Message header
...
| latitude | Camel 2.16: Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric. | |
| longitude | Camel 2.16: Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric. | |
| radius | Camel 2.16: Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric. | |
| distanceMetric | km | Camel 2.16: 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. |
Message header
Name | Description |
|---|---|
| This header is used by the search producer to change the search key words dynamically. |
| Camel |
...
2.11.0: |
...
This |
...
header |
...
can |
...
override |
...
the |
...
option |
...
of |
...
|
...
which |
...
set |
...
the |
...
search |
...
language |
...
for |
...
the |
...
search |
...
endpoint |
...
dynamically |
...
| Camel 2.11.0 |
...
This |
...
header |
...
can |
...
override |
...
the |
...
option |
...
of |
...
|
...
which |
...
sets |
...
the |
...
max |
...
twitters |
...
that |
...
will |
...
be |
...
returned. |
...
| Camel 2.11.0 |
...
This |
...
header |
...
can |
...
converrid |
...
the |
...
option |
...
of |
...
|
...
which |
...
sets |
...
how |
...
many |
...
pages |
...
we |
...
want |
...
to |
...
...
returns. | |
| CamelTwitterEvent | Camel 2.17.0 The type of event received (see org.apache.camel.component.twitter.consumer.TwitterEventType) |
| CamelTwitterUser1..N | Camel 2.17.0 Identify a party |
| CamelTwitterUserRole1..N | Camel 2.17.0 Identify a party role |
Message body
All message bodies utilize objects provided by the Twitter4J API.
Use cases
| Tip | ||||
|---|---|---|---|---|
| ||||
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. |
To create a status update within your Twitter profile, send this producer a String body.
| Code Block |
|---|
from("direct:foo")
.to("twitter://timeline/user?consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]);
|
To poll, every
...
60 sec., all statuses on your home timeline:
| Code Block |
|---|
from("twitter://timeline/home?type=polling&delay=560&consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]")
.to("bean:blah");
|
...