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 2013/07/11 21:19:00 UTC
svn commit: r869146 - in /websites/production/camel/content:
cache/main.pageCache camel-2120-release.html yammer.html
Author: buildbot
Date: Thu Jul 11 19:19:00 2013
New Revision: 869146
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/camel-2120-release.html
websites/production/camel/content/yammer.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/camel-2120-release.html
==============================================================================
--- websites/production/camel/content/camel-2120-release.html (original)
+++ websites/production/camel/content/camel-2120-release.html Thu Jul 11 19:19:00 2013
@@ -106,7 +106,7 @@
<h3><a shape="rect" name="Camel2.12.0Release-NewComponents"></a>New <a shape="rect" href="components.html" title="Components">Components</a></h3>
-<ul><li><a shape="rect" href="geocoder.html" title="Geocoder"><tt>camel-geocoder</tt></a> - For looking up geocodes (latitude, longitude) for a given address, or reverse lookup with <a shape="rect" class="external-link" href="https://code.google.com/p/geocoder-java/" rel="nofollow">Java API for Google Geocoder</a></li><li><a shape="rect" href="mustache.html" title="Mustache"><tt>camel-mustache</tt></a> - For templating using <a shape="rect" class="external-link" href="http://mustache.github.io/" rel="nofollow">Mustache</a></li><li><a shape="rect" href="mvel-component.html" title="MVEL Component"><tt>camel-mvel</tt></a> - For templating using <a shape="rect" class="external-link" href="http://mvel.codehaus.org/" rel="nofollow">MVEL</a></li><li><a shape="rect" href="netty-http.html" title="Netty HTTP"><tt>camel-netty-http</tt></a> - HTTP component using <a shape="rect" href="netty.html" title="Netty">Netty</a> as transport</li><li><a shape="rect" href="sap-netweaver.html" title="SAP N
etWeaver"><tt>camel-sap-netwever</tt></a> - For integration with <a shape="rect" class="external-link" href="http://scn.sap.com/community/developer-center/netweaver-gateway" rel="nofollow">SAP NetWeaver Gateway</a></li><li><a shape="rect" href="weather.html" title="Weather"><tt>camel-weather</tt></a> - For polling weather information from <a shape="rect" class="external-link" href="http://openweathermap.org" rel="nofollow">Open Weather Map</a></li></ul>
+<ul><li><a shape="rect" href="geocoder.html" title="Geocoder"><tt>camel-geocoder</tt></a> - For looking up geocodes (latitude, longitude) for a given address, or reverse lookup with <a shape="rect" class="external-link" href="https://code.google.com/p/geocoder-java/" rel="nofollow">Java API for Google Geocoder</a></li><li><a shape="rect" href="mustache.html" title="Mustache"><tt>camel-mustache</tt></a> - For templating using <a shape="rect" class="external-link" href="http://mustache.github.io/" rel="nofollow">Mustache</a></li><li><a shape="rect" href="mvel-component.html" title="MVEL Component"><tt>camel-mvel</tt></a> - For templating using <a shape="rect" class="external-link" href="http://mvel.codehaus.org/" rel="nofollow">MVEL</a></li><li><a shape="rect" href="netty-http.html" title="Netty HTTP"><tt>camel-netty-http</tt></a> - HTTP component using <a shape="rect" href="netty.html" title="Netty">Netty</a> as transport</li><li><a shape="rect" href="sap-netweaver.html" title="SAP N
etWeaver"><tt>camel-sap-netwever</tt></a> - For integration with <a shape="rect" class="external-link" href="http://scn.sap.com/community/developer-center/netweaver-gateway" rel="nofollow">SAP NetWeaver Gateway</a></li><li><a shape="rect" href="weather.html" title="Weather"><tt>camel-weather</tt></a> - For polling weather information from <a shape="rect" class="external-link" href="http://openweathermap.org" rel="nofollow">Open Weather Map</a></li><li><a shape="rect" href="yammer.html" title="Yammer"><tt>camel-yammer</tt></a> - Allows you to interact with the <a shape="rect" class="external-link" href="http://yammer.com" rel="nofollow">Yammer</a> enterprise social network</li></ul>
<h3><a shape="rect" name="Camel2.12.0Release-NewDSL"></a>New DSL</h3>
Modified: websites/production/camel/content/yammer.html
==============================================================================
--- websites/production/camel/content/yammer.html (original)
+++ websites/production/camel/content/yammer.html Thu Jul 11 19:19:00 2013
@@ -103,13 +103,11 @@
]]></script>
</div></div>
-<p><b>TODO: other message consumers, message producer, user/relationship stuff</b></p>
-
<h3><a shape="rect" name="Yammer-URIformat"></a>URI format</h3>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-yammer://[function]?[options]
+yammer:[function]?[options]
]]></script>
</div></div>
@@ -119,23 +117,230 @@ yammer://[function]?[options]
<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></tbody></table>
</div>
+</div>
+
+<h3><a shape="rect" name="Yammer-Consumingmessages"></a>Consuming messages</h3>
+
+<p>The camel-yammer component provides several endpoints for consuming messages:</p>
+
+<div class="confluenceTableSmall"><div class="table-wrap">
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> URI </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:messages?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> All public messages in the user's (whose access token is being used to make the API call) Yammer network. Corresponds to "All" conversations in the Yammer web interface. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:my_feed?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> The user's feed, based on the selection they have made between "Following" and "Top" conversations. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:algo?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> The algorithmic feed for the user that corresponds to "Top" conversations, which is what the vast majority of users will see in the Yammer web interface. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:following?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> The "Following" feed which is conversations involving people, groups and topics that the user is following. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:sent?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> All messages sent by the user. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:private?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> Private messages received by the user. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:received?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> All messages received by the user </td></tr></tbody></table>
+</div>
+</div>
+<h4><a shape="rect" name="Yammer-URIOptionsforconsumingmessages"></a>URI Options for consuming messages</h4>
+<div class="confluenceTableSmall"><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"> useJson </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to true if you want to use raw JSON rather than converting to POJOs. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> delay </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>5000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> in milliseconds </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>YammerComponent</tt> level instead.
</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. Can also be configured on the <tt>YammerComponent</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>YammerComponent</tt> level instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> limit </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Return only the specified number of messages. Works for threaded=true and threaded=extended. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> threaded </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</
tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> threaded=true will only return the first message in each thread. This parameter is intended for apps which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on the Yammer web interface. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> olderThan </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you're currently viewing 20 messages and the oldest is number 2912, you could append "?olderThan=2912″ to your request to get the 20 messages prior to those you're seeing. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> newerThan</td><td colspan="1
" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you're looking at messages, and the most recent message returned is 3516, you can make a request with the parameter "?newerThan=3516″ to ensure that you do not get duplicate copies of messages already on your page. </td></tr></tbody></table>
+</div>
</div>
-<h3><a shape="rect" name="Yammer-MessageConsumer"></a>Message Consumer</h3>
+<h4><a shape="rect" name="Yammer-Messageformat"></a>Message format</h4>
+
+<p>All messages by default are converted to a POJO model provided in the org.apache.camel.component.yammer.model package. The original message coming from yammer is in JSON. For all message consuming & producing endpoints, a Messages object is returned. Take for example a route like:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+from("yammer:messages?consumerKey=aConsumerKey&consumerSecret=aConsumerSecretKey&accessToken=aAccessToken").to("mock:result");
+]]></script>
+</div></div>
+
+<p>and lets say the yammer server returns:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+{
+ "messages":[
+ {
+ "replied_to_id":null,
+ "network_id":7654,
+ "url":"https://www.yammer.com/api/v1/messages/305298242",
+ "thread_id":305298242,
+ "id":305298242,
+ "message_type":"update",
+ "chat_client_sequence":null,
+ "body":{
+ "parsed":"Testing yammer API...",
+ "plain":"Testing yammer API...",
+ "rich":"Testing yammer API..."
+ },
+ "client_url":"https://www.yammer.com/",
+ "content_excerpt":"Testing yammer API...",
+ "created_at":"2013/06/25 18:14:45 +0000",
+ "client_type":"Web",
+ "privacy":"public",
+ "sender_type":"user",
+ "liked_by":{
+ "count":1,
+ "names":[
+ {
+ "permalink":"janstey",
+ "full_name":"Jonathan Anstey",
+ "user_id":1499642294
+ }
+
+ ]
+
+ },
+ "sender_id":1499642294,
+ "language":null,
+ "system_message":false,
+ "attachments":[
+
+ ],
+ "direct_message":false,
+ "web_url":"https://www.yammer.com/redhat.com/messages/305298242"
+ },
+ {
+ "replied_to_id":null,
+ "network_id":7654,
+ "url":"https://www.yammer.com/api/v1/messages/294326302",
+ "thread_id":294326302,
+ "id":294326302,
+ "message_type":"system",
+ "chat_client_sequence":null,
+ "body":{
+ "parsed":"(Principal Software Engineer) has [[tag:14658]] the redhat.com network. Take a moment to welcome Jonathan.",
+ "plain":"(Principal Software Engineer) has #joined the redhat.com network. Take a moment to welcome Jonathan.",
+ "rich":"(Principal Software Engineer) has #joined the redhat.com network. Take a moment to welcome Jonathan."
+ },
+ "client_url":"https://www.yammer.com/",
+ "content_excerpt":"(Principal Software Engineer) has #joined the redhat.com network. Take a moment to welcome Jonathan.",
+ "created_at":"2013/05/10 19:08:29 +0000",
+ "client_type":"Web",
+ "sender_type":"user",
+ "privacy":"public",
+ "liked_by":{
+ "count":0,
+ "names":[
+
+ ]
+
+ }
+ }
+ ]
+
+ }
+]]></script>
+</div></div>
+
+<p>Camel will marshal that into a Messages object containing 2 Message objects. As shown below there is a rich object model that makes it easy to get any information you need:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ Exchange exchange = mock.getExchanges().get(0);
+ Messages messages = exchange.getIn().getBody(Messages.class);
+
+ assertEquals(2, messages.getMessages().size());
+ assertEquals("Testing yammer API...", messages.getMessages().get(0).getBody().getPlain());
+ assertEquals("(Principal Software Engineer) has #joined the redhat.com network. Take a moment to welcome Jonathan.", messages.getMessages().get(1).getBody().getPlain());
+]]></script>
+</div></div>
+
+<p>That said, marshaling this data into POJOs is not free so if you need you can switch back to using pure JSON by adding the useJson=false option to your URI.</p>
+
+<h3><a shape="rect" name="Yammer-Creatingmessages"></a>Creating messages</h3>
+
+<p>To create a new message in the account of the current user, you can use the following URI:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+yammer:messages?[options]
+]]></script>
+</div></div>
+
+<p>The current Camel message body is what will be used to set the text of the Yammer message. The response body will include the new message formatted the same way as when you consume messages (i.e. as a Messages object by default). </p>
+
+<p>Take this route for instance:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+from("direct:start").to("yammer:messages?consumerKey=aConsumerKey&consumerSecret=aConsumerSecretKey&accessToken=aAccessToken").to("mock:result");
+]]></script>
+</div></div>
+
+<p>By sending to the direct:start endpoint a "Hi from Camel!" message body:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ template.sendBody("direct:start", "Hi from Camel!");
+]]></script>
+</div></div>
+
+<p>a new message will be created in the current user's account on the server and also this new message will be returned to Camel and converted into a Messages object. Like when consuming messages you can interrogate the Messages object: </p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ Exchange exchange = mock.getExchanges().get(0);
+ Messages messages = exchange.getIn().getBody(Messages.class);
+
+ assertEquals(1, messages.getMessages().size());
+ assertEquals("Hi from Camel!", messages.getMessages().get(0).getBody().getPlain());
+]]></script>
+</div></div>
+
+<h3><a shape="rect" name="Yammer-Retrievinguserrelationships"></a>Retrieving user relationships</h3>
+
+<p>The camel-yammer component can retrieve user relationships:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-yammer://messages?[options]
+yammer:relationships?[options]
]]></script>
</div></div>
-<h4><a shape="rect" name="Yammer-URIOptions"></a>URI Options</h4>
+<h4><a shape="rect" name="Yammer-URIOptionsforretrievingrelationships"></a>URI Options for retrieving relationships</h4>
<div class="confluenceTableSmall"><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"> delay </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>5000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> in milliseconds </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>YammerComponent</tt> level instead. </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. Can also be configured on the <tt>YammerComponent<
/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>YammerComponent</tt> level instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> limit </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Return only the specified number of messages. Works for threaded=true and threaded=extended. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> threaded </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> threaded=true will only return the first message in each thread. This parameter is intended for apps which display message threads collapsed. threaded=extended will return the thread starter messages in order of
most recently active as well as the two most recent messages, as they are viewed in the default view on the Yammer web interface. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> olderThan </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Returns messages older than the message ID specified as a numeric string. This is useful for paginating messages. For example, if you’re currently viewing 20 messages and the oldest is number 2912, you could append “?olderThan=2912″ to your request to get the 20 messages prior to those you’re seeing. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> newerThan</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>-1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Returns messages newer than the message ID specified as a numeric string. This should be used when polling for new messages. If you’re looking
at messages, and the most recent message returned is 3516, you can make a request with the parameter “?newerThan=3516″ to ensure that you do not get duplicate copies of messages already on your page. </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"> useJson </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to true if you want to use raw JSON rather than converting to POJOs. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> delay </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>5000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> in milliseconds </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>YammerComponent</tt> level instead.
</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. Can also be configured on the <tt>YammerComponent</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>YammerComponent</tt> level instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> userId </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>current user</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> To view the relationships for a user other than the current user. </td></tr></tbody></table>
</div>
</div>
+<h3><a shape="rect" name="Yammer-Retrievingusers"></a>Retrieving users</h3>
+
+<p>The camel-yammer component provides several endpoints for retrieving users:</p>
+
+<div class="confluenceTableSmall"><div class="table-wrap">
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> URI </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:users?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> Retrieve users in the current user's Yammer network. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[yammer:current?[options]]]></script>
+</div></div> </td><td colspan="1" rowspan="1" class="confluenceTd"> View data about the current user. </td></tr></tbody></table>
+</div>
+</div>
+
+<h4><a shape="rect" name="Yammer-URIOptionsforretrievingusers"></a>URI Options for retrieving users</h4>
+<div class="confluenceTableSmall"><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"> useJson </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Set to true if you want to use raw JSON rather than converting to POJOs. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> delay </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>5000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> in milliseconds </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>YammerComponent</tt> level instead.
</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. Can also be configured on the <tt>YammerComponent</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>YammerComponent</tt> level instead. </td></tr></tbody></table>
+</div>
+</div>
+
+<h3><a shape="rect" name="Yammer-Usinganenricher"></a>Using an enricher</h3>
+
+<p>It is helpful sometimes (or maybe always in the case of users or relationship consumers) to use an enricher pattern rather than a route initiated with one of the polling consumers in camel-yammer. This is because the consumers will fire repeatedly, however often you set the delay for. If you just want to look up a user's data, or grab a message at a point in time, it is better to call that consumer once and then get one with your route. </p>
+
+<p>Lets say you have a route that at some point needs to go out and fetch user data for the current user. Rather than polling for this user over and over again, use the pollEnrich DSL method:</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+from("direct:start").pollEnrich("yammer:current?consumerKey=aConsumerKey&consumerSecret=aConsumerSecretKey&accessToken=aAccessToken").to("mock:result");
+]]></script>
+</div></div>
+
+<p>This will go out and fetch the current user's User object and set it as the Camel message body. </p>
+
<h3><a shape="rect" name="Yammer-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>
</div>