You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2012/03/25 14:18:25 UTC
svn commit: r809945 - in /websites/production/camel/content:
cache/main.pageCache twitter-websocket-example.html twitter.html
Author: buildbot
Date: Sun Mar 25 12:18:24 2012
New Revision: 809945
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/twitter-websocket-example.html
websites/production/camel/content/twitter.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/twitter-websocket-example.html
==============================================================================
--- websites/production/camel/content/twitter-websocket-example.html (original)
+++ websites/production/camel/content/twitter-websocket-example.html Sun Mar 25 12:18:24 2012
@@ -91,9 +91,13 @@ As usual the code in Camel is very simpl
</pre>
</div></div>
-<p>To use twitter, you need a twitter account which have setup an application to be used.<br clear="none">
+<p>This example is already configured using a testing purpose twitter account named 'cameltweet'. And therefore the example is ready to run out of the box.</p>
+
+<p>This account is only for testing purpose, and should <b>not</b> be used in your custom applications. For that you need to setup and use your own twitter account.</p>
+
+<div class="panelMacro"><table class="infoMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/information.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1"><b>How to use my own twitter account</b><br clear="none">To use twitter, you need a twitter account which have setup an application to be used.<br clear="none">
For twitter users, you may be familiar that twitter requires you to grant applications access to your twitter account, such as twitter for iphone etc.<br clear="none">
-The same applies for this example. You can read details about how to setup a new twitter application at the Camel <a shape="rect" href="twitter.html" title="Twitter">Twitter</a> documentation.</p>
+The same applies for this example. You can read details about how to setup a new twitter application at the Camel <a shape="rect" href="twitter.html" title="Twitter">Twitter</a> documentation.
<p>In your Twitter settings under the Apps menu, it will list your approved applications. For example I created an application named "Camel-Example"<br clear="none">
which is now listed as approved with read-only access.<br clear="none">
@@ -101,8 +105,7 @@ which is now listed as approved with rea
<p>When you have created an application, you get a number of details back from twitter<br clear="none">
which you need to use the twitter component. Enter these details in the source code at:<br clear="none">
- <tt>src/main/java/org/apache/camel/example/websocket/CamelTwitterWebSocketMain.java</tt><br clear="none">
-in the constant fileds, by replacing the values "INSERT HERE".</p>
+ <tt>src/main/java/org/apache/camel/example/websocket/CamelTwitterWebSocketMain.java</tt></p></td></tr></table></div>
<p>You will need to compile this example first:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
Modified: websites/production/camel/content/twitter.html
==============================================================================
--- websites/production/camel/content/twitter.html (original)
+++ websites/production/camel/content/twitter.html Sun Mar 25 12:18:24 2012
@@ -82,6 +82,17 @@
<p>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 <a shape="rect" class="external-link" href="https://dev.twitter.com/apps/new" rel="nofollow">https://dev.twitter.com/apps/new</a> and grant the application access to your account. Finally, generate your access token and secret.</p>
+<p>Maven users will need to add the following dependency to their pom.xml for this component:</p>
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<pre class="code-xml">
+<span class="code-tag"><dependency></span>
+ <span class="code-tag"><groupId></span>org.apache.camel<span class="code-tag"></groupId></span>
+ <span class="code-tag"><artifactId></span>camel-twitter<span class="code-tag"></artifactId></span>
+ <span class="code-tag"><version></span>${camel-version}<span class="code-tag"></version></span>
+<span class="code-tag"></dependency></span>
+</pre>
+</div></div>
+
<h3><a shape="rect" name="Twitter-URIformat"></a>URI format</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
@@ -90,6 +101,15 @@ twitter:<span class="code-comment">//[en
</pre>
</div></div>
+<h3><a shape="rect" name="Twitter-TwitterComponent%3A"></a>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="confluenceTableSmall"><div class="table-wrap">
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Option </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> consumerKey </td><td colspan="1" rowspan="1" class="confluenceTd"> The consumer key </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> consumerSecret </td><td colspan="1" rowspan="1" class="confluenceTd"> The consumer secret </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> accessToken </td><td colspan="1" rowspan="1" class="confluenceTd"> The access token </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> accessTokenSecret </td><td colspan="1" rowspan="1" class="confluenceTd"> The access token secret </td></tr></tbody></table>
+</div>
+</div>
+
<h3><a shape="rect" name="Twitter-ConsumerEndpoints%3A"></a>Consumer Endpoints:</h3>
<div class="confluenceTableSmall"><div class="table-wrap">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Endpoint </th><th colspan="1" rowspan="1" class="confluenceTh"> Context </th><th colspan="1" rowspan="1" class="confluenceTh"> Body Type </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> directmessage </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.DirectMessage> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> search </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.Tweet> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> streaming/filter </td><td colspan="1" rowspan="1" class="confluenceTd"> event, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.Status> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceT
d"> streaming/sample </td><td colspan="1" rowspan="1" class="confluenceTd"> event, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> event: twitter4j.Status, polling: List<twitter4j.Status> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> timeline/home </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.Status> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> timeline/mentions </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.Status> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> timeline/public </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.Status> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> timeline/re
tweetsofme </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.Status> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> timeline/user </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, polling </td><td colspan="1" rowspan="1" class="confluenceTd"> List<twitter4j.Status> </td></tr></tbody></table>
@@ -104,30 +124,13 @@ twitter:<span class="code-comment">//[en
<h3><a shape="rect" name="Twitter-URIOptions"></a>URI Options</h3>
<div class="table-wrap">
-<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> type </td><td colspan="1" rowspan="1" class="confluenceTd"> direct </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, event, or polling </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> delay </td><td colspan="1" rowspan="1" class="confluenceTd"> 60 </td><td colspan="1" rowspan="1" class="confluenceTd"> in seconds </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> *consumerKey </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer Key </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> *consumerSecret </td><td colspan="1" rowspan="1" class="confluenceTd"> <
tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer Secret </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> *accessToken </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Access Token </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> *accessTokenSecret </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Access Token Secret </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> user </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Username, used for user timeline consumption, direct message production, etc. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> keywords</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd
"> 'lat,lon;lat,lon;...' Can be used for streaming/filter </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> userIds</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 'username,username...' Can be used for streaming/filter </td></tr></tbody></table>
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> type </td><td colspan="1" rowspan="1" class="confluenceTd"> direct </td><td colspan="1" rowspan="1" class="confluenceTd"> direct, event, or polling </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> delay </td><td colspan="1" rowspan="1" class="confluenceTd"> 60 </td><td colspan="1" rowspan="1" class="confluenceTd"> in seconds </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> consumerKey </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer Key. Can also be configured on the <tt>TwitterComponent</tt> level instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> c
onsumerSecret </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Consumer Secret. Can also be configured on the <tt>TwitterComponent</tt> level instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> accessToken </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Access Token. Can also be configured on the <tt>TwitterComponent</tt> level instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> accessTokenSecret </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Access Token Secret. Can also be configured on the <tt>TwitterComponent</tt> level instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> user </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="co
nfluenceTd"> Username, used for user timeline consumption, direct message production, etc. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> keywords</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 'lat,lon;lat,lon;...' Can be used for streaming/filter </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> userIds</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 'username,username...' Can be used for streaming/filter </td></tr></tbody></table>
</div>
-<div class="panelMacro"><table class="infoMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/information.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1"><b>Note</b><br clear="none">Options: (* = required).</td></tr></table></div>
-
<h3><a shape="rect" name="Twitter-Messagebody"></a>Message body</h3>
+<p>All message bodies utilize objects provided by the Twitter4J API.</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-All message bodies utilize objects provided by the Twitter4J API.
-</pre>
-</div></div>
-
-<h3><a shape="rect" name="Twitter-MavenDependency%3A"></a>Maven Dependency:</h3>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.camel<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>camel-twitter<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>${camel-version}<span class="code-tag"></version></span>
-<span class="code-tag"></dependency></span>
-</pre>
-</div></div>
<h3><a shape="rect" name="Twitter-Usecases"></a>Use cases</h3>
@@ -149,8 +152,14 @@ twitter:<span class="code-comment">//tim
twitter:<span class="code-comment">//search?type=direct&keywords=camel&consumerKey=[s]&consumerSecret=[s]&accessToken=[s]&accessTokenSecret=[s]</span>
</pre>
</div></div>
+
+<h3><a shape="rect" name="Twitter-Example"></a>Example</h3>
+<p>See also the <a shape="rect" href="twitter-websocket-example.html" title="Twitter Websocket Example">Twitter Websocket Example</a>.</p>
+
<h3><a shape="rect" name="Twitter-SeeAlso"></a>See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html" title="Configuring Camel">Configuring Camel</a></li><li><a shape="rect" href="component.html" title="Component">Component</a></li><li><a shape="rect" href="endpoint.html" title="Endpoint">Endpoint</a></li><li><a shape="rect" href="getting-started.html" title="Getting Started">Getting Started</a></li></ul>
+
+<ul class="alternate" type="square"><li><a shape="rect" href="twitter-websocket-example.html" title="Twitter Websocket Example">Twitter Websocket Example</a></li></ul>
</div>
</td>
<td valign="top">