Modified: websites/production/camel/content/twitter.html ============================================================================== --- websites/production/camel/content/twitter.html (original) +++ websites/production/camel/content/twitter.html Mon Feb 1 15:18:43 2016 @@ -96,7 +96,7 @@ </div></div><h3 id="Twitter-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="brush: text; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[twitter://endpoint[?options] ]]></script> -</div></div><h3 id="Twitter-TwitterComponent:">TwitterComponent:</h3><p>The twitter component can be configured with the Twitter account settings which is mandatory to configure before using.<br clear="none"> You can also configure these options directly in the endpoint.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerKey</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The consumer key</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerSecret</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The consumer secret</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessToken</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The access token</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessTokenSecret</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The access token secret</p></td></tr></tbody></table></div><h3 id="Twitter-ConsumerEndpoints:">Consumer Endpoints:</h3><p>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).</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Notice</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>directmessage</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspa n="1" rowspan="1" class="confluenceTd"><p>twitter4j.DirectMessage</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>search</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streaming/filter</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>event, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streaming/sample</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>event, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" r owspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">streaming/user</td><td colspan="1" rowspan="1" class="confluenceTd">event, polling</td><td colspan="1" rowspan="1" class="confluenceTd"><span>twitter4j.Status</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16</strong>: To receive tweets from protected users and accounts.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/home</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/mentions</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="conflu enceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><s>timeline/public</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>direct, polling</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>twitter4j.Status</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>@deprecated. Use timeline/home or direct/home instead. Removed from <strong>Camel 2.11</strong> onwards.</s></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/retweetsofme</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/user</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</ p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><s>trends/daily</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s><strong>Camel 2.10.1:</strong> direct, polling</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>twitter4j.Status</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>@deprecated. Removed from Camel 2.11 onwards.</s></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><s>trends/weekly</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s><strong>Camel 2.10.1:</strong> direct, polling</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>twitter4j.Status</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>@deprecated. Removed from Camel 2.11 onwards.</s></p></td></tr></tbody></table></div><h3 id="Twitter-ProducerEndpoints:">Producer Endpoints:</h3><div class="table-wrap"><table clas s="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>directmessage</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>String</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>search</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>List<twitter4j.Status></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/user</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>String</p></td></tr></tbody></table></div><h3 id="Twitter-URIOptions">URI Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td c olspan="1" rowspan="1" class="confluenceTd"><p>type</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>direct</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, event, or polling</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>delay</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>60</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>in seconds</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerKey</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer Key. Can also be configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerSecret</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer Secret. Can also b e configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessToken</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Access Token. Can also be configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessTokenSecret</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Access Token Secret. Can also be configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>user</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username, used for user timeline consumption, direct message production, etc.</p></td></tr> <tr><td colspan="1" rowspan="1" class="confluenceTd"><p>locations</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>'lat,lon;lat,lon;...' Bounding boxes, created by pairs of lat/lons. Can be used for streaming/filter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>keywords</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>'foo1,foo2,foo3...' Can be used for search and streaming/filter. See <a shape="rect" class="external-link" href="https://support.twitter.com/articles/71577-using-advanced-search"; rel="nofollow">Advanced search</a> for keywords syntax for searching with for example OR.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>userIds</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenc eTd"><p>'username,username...' Can be used for streaming/filter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>filterOld</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id. <strong>Since Camel 2.11.0</strong> The search producer supports this option</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>sinceId</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>lang</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null< /code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> The lang string <a shape="rect" class="external-link" href="http://en.wikipedia.org/wiki/ISO_639-1"; rel="nofollow">ISO_639-1</a> which will be used for searching</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>count</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> Limiting number of results per page.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>numberOfPages</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> The number of pages result which you want camel-twitter to consume.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>httpProxyHost</p></td><td colspan="1" rowspan="1" class="confluenceTd" ><p><code>null</code></p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p><strong>Camel 2.12.3:</strong> The http proxy host >which can be used for the camel-twitter.</p></td></tr><tr><td colspan="1" >rowspan="1" class="confluenceTd"><p>httpProxyPort</p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.3:</strong> The http >proxy port which can be used for the camel-twitter.</p></td></tr><tr><td >colspan="1" rowspan="1" class="confluenceTd"><p>httpProxyUser</p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel >2.12.3:</strong> The http proxy user which can be used for the >camel-twitter.</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p>httpProxyPassword</p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan= "1" class="confluenceTd"><p><strong>Camel 2.12.3:</strong> The http proxy password which can be used for the camel-twitter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">latitude</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> </span>Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">longitude</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> </span>Used by the non-stream geography search to search by longitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">radius</td><td colspa n="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> </span>Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">distanceMetric</td><td colspan="1" rowspan="1" class="confluenceTd">km</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> 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.</td></tr></tbody></table></div><h3 id="Twitter-Messageheader">Message header</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" r owspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelTwitterKeywords</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>This header is used by the search producer to change the search key words dynamically.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelTwitterSearchLanguage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> This header can override the option of <code>lang</code> which set the search language for the search endpoint dynamically</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelTwitterCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0</strong> This header can override the option of <code>count</code> which sets the max twitters that will be returned.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Cam elTwitterNumberOfPages</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0</strong> This header can converrid the option of <code>numberOfPages</code> which sets how many pages we want to twitter returns.</p></td></tr></tbody></table></div><h3 id="Twitter-Messagebody">Message body</h3><p>All message bodies utilize objects provided by the Twitter4J API.</p><h3 id="Twitter-Usecases">Use cases</h3><div class="confluence-information-macro has-no-icon confluence-information-macro-tip"><p class="title">API Rate Limits</p><div class="confluence-information-macro-body"><p>Twitter REST APIs encapsulated by <a shape="rect" class="external-link" href="http://twitter4j.org/"; rel="nofollow">Twitter4J</a> are subjected to <a shape="rect" class="external-link" href="https://dev.twitter.com/rest/public/rate-limiting"; rel="nofollow">API Rate Limiting</a>. You can find the per method limits in the <a shape="rect" class="external-link" href="https://dev.twitter.com/ rest/public/rate-limits" rel="nofollow">API Rate Limits</a> documentation. Note <span style="color: rgb(41,47,51);">that endpoints/resources not listed in that page are default to 15 requests per allotted user per window.</span></p></div></div><h4 id="Twitter-TocreateastatusupdatewithinyourTwitterprofile,sendthisproduceraStringbody.">To create a status update within your Twitter profile, send this producer a String body.</h4><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +</div></div><h3 id="Twitter-TwitterComponent:">TwitterComponent:</h3><p>The twitter component can be configured with the Twitter account settings which is mandatory to configure before using.<br clear="none"> You can also configure these options directly in the endpoint.</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerKey</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The consumer key</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerSecret</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The consumer secret</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessToken</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The access token</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessTokenSecret</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The access token secret</p></td></tr></tbody></table></div><h3 id="Twitter-ConsumerEndpoints:">Consumer Endpoints:</h3><p>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).</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Context</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Notice</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>directmessage</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspa n="1" rowspan="1" class="confluenceTd"><p>twitter4j.DirectMessage</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>search</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streaming/filter</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>event, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streaming/sample</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>event, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" r owspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">streaming/user</td><td colspan="1" rowspan="1" class="confluenceTd">event, polling</td><td colspan="1" rowspan="1" class="confluenceTd"><span>twitter4j.Status</span></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16</strong>: To receive tweets from protected users and accounts.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/home</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/mentions</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="conflu enceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><s>timeline/public</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>direct, polling</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>twitter4j.Status</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>@deprecated. Use timeline/home or direct/home instead. Removed from <strong>Camel 2.11</strong> onwards.</s></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/retweetsofme</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/user</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, polling</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>twitter4j.Status</ p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><s>trends/daily</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s><strong>Camel 2.10.1:</strong> direct, polling</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>twitter4j.Status</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>@deprecated. Removed from Camel 2.11 onwards.</s></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><s>trends/weekly</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s><strong>Camel 2.10.1:</strong> direct, polling</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>twitter4j.Status</s></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><s>@deprecated. Removed from Camel 2.11 onwards.</s></p></td></tr></tbody></table></div><h3 id="Twitter-ProducerEndpoints:">Producer Endpoints:</h3><div class="table-wrap"><table clas s="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Endpoint</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Body Type</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>directmessage</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>String</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>search</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>List<twitter4j.Status></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>timeline/user</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>String</p></td></tr></tbody></table></div><h3 id="Twitter-URIOptions">URI Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td c olspan="1" rowspan="1" class="confluenceTd"><p>type</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>direct</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>direct, event, or polling</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>delay</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Delay between polls. The value is 60 seconds by default. The value is in seconds for <strong>Camel 2.16</strong> or older. And in millis seconds from <strong>Camel 2.17</strong> onwards.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerKey</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer Key. Can also be configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>consumerSecre t</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Consumer Secret. Can also be configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessToken</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Access Token. Can also be configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>accessTokenSecret</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Access Token Secret. Can also be configured on the <code>TwitterComponent</code> level instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>user</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><c ode>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username, used for user timeline consumption, direct message production, etc.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>locations</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>'lat,lon;lat,lon;...' Bounding boxes, created by pairs of lat/lons. Can be used for streaming/filter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>keywords</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>'foo1,foo2,foo3...' Can be used for search and streaming/filter. See <a shape="rect" class="external-link" href="https://support.twitter.com/articles/71577-using-advanced-search"; rel="nofollow">Advanced search</a> for keywords syntax for searching with for example OR.</p></td></tr><tr><td colspan="1" rowspan ="1" class="confluenceTd"><p>userIds</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>'username,username...' Can be used for streaming/filter</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>filterOld</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Filter out old tweets, that has previously been polled. This state is stored in memory only, and based on last tweet id. <strong>Since Camel 2.11.0</strong> The search producer supports this option</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>sinceId</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>lang</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> The lang string <a shape="rect" class="external-link" href="http://en.wikipedia.org/wiki/ISO_639-1"; rel="nofollow">ISO_639-1</a> which will be used for searching</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>count</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> Limiting number of results per page.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>numberOfPages</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> The number of pages result which you wan t camel-twitter to consume.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>httpProxyHost</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.3:</strong> The http proxy host which can be used for the camel-twitter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>httpProxyPort</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.3:</strong> The http proxy port which can be used for the camel-twitter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>httpProxyUser</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.3:</strong> The http proxy user which can be used for the camel-twitter.</p></td></tr><tr><td colspan=" 1" rowspan="1" class="confluenceTd"><p>httpProxyPassword</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.3:</strong> The http proxy password which can be used for the camel-twitter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">latitude</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> </span>Used by the non-stream geography search to search by latitude. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">longitude</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> </span>Used by the non-stream geography search to search by longitude. You need to co nfigure all the following options: longitude, latitude, radius, and distanceMetric.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">radius</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> </span>Used by the non-stream geography search to search by radius. You need to configure all the following options: longitude, latitude, radius, and distanceMetric.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">distanceMetric</td><td colspan="1" rowspan="1" class="confluenceTd">km</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> 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.</td></tr></tbody></table></div><h3 id="Twitter-Messageheader"> Message header</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelTwitterKeywords</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>This header is used by the search producer to change the search key words dynamically.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelTwitterSearchLanguage</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> This header can override the option of <code>lang</code> which set the search language for the search endpoint dynamically</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelTwitterCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0</strong> This header can over ride the option of <code>count</code> which sets the max twitters that will be returned.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelTwitterNumberOfPages</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0</strong> This header can converrid the option of <code>numberOfPages</code> which sets how many pages we want to twitter returns.</p></td></tr></tbody></table></div><h3 id="Twitter-Messagebody">Message body</h3><p>All message bodies utilize objects provided by the Twitter4J API.</p><h3 id="Twitter-Usecases">Use cases</h3><div class="confluence-information-macro has-no-icon confluence-information-macro-tip"><p class="title">API Rate Limits</p><div class="confluence-information-macro-body"><p>Twitter REST APIs encapsulated by <a shape="rect" class="external-link" href="http://twitter4j.org/"; rel="nofollow">Twitter4J</a> are subjected to <a shape="rect" class="external-link" href="https://dev.twitter.com/rest/pub lic/rate-limiting" rel="nofollow">API Rate Limiting</a>. You can find the per method limits in the <a shape="rect" class="external-link" href="https://dev.twitter.com/rest/public/rate-limits"; rel="nofollow">API Rate Limits</a> documentation. Note <span style="color: rgb(41,47,51);">that endpoints/resources not listed in that page are default to 15 requests per allotted user per window.</span></p></div></div><h4 id="Twitter-TocreateastatusupdatewithinyourTwitterprofile,sendthisproduceraStringbody.">To create a status update within your Twitter profile, send this producer a String body.</h4><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:foo") .to("twitter://timeline/user?consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]); ]]></script>
