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 2015/05/21 17:19:54 UTC
svn commit: r952200 - in /websites/production/camel/content:
cache/main.pageCache googlecalendar.html
Author: buildbot
Date: Thu May 21 15:19:53 2015
New Revision: 952200
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/googlecalendar.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/googlecalendar.html
==============================================================================
--- websites/production/camel/content/googlecalendar.html (original)
+++ websites/production/camel/content/googlecalendar.html Thu May 21 15:19:53 2015
@@ -78,10 +78,10 @@
<div class="wiki-content maincontent"><h2 id="GoogleCalendar-GoogleCalendarComponent">GoogleCalendar Component</h2><hr><p><strong>Available as of Camel 2.15</strong></p><h3 id="GoogleCalendar-ComponentDescription">Component Description</h3><p>The Google Calendar component provides access to <a shape="rect" class="external-link" href="http://google.com/calendar" rel="nofollow">Google Calendar</a> via the <a shape="rect" class="external-link" href="https://developers.google.com/google-apps/calendar/v3/reference/" rel="nofollow">Google Calendar Web APIs</a>.</p><p><span style="color: rgb(34,34,34);">Google Calendar uses the </span><a shape="rect" class="external-link" href="https://developers.google.com/accounts/docs/OAuth2" rel="nofollow">OAuth 2.0 protocol</a><span style="color: rgb(34,34,34);"> for authenticating a Google account and authorizing access to user data. Before you can use this component, you will need to <a shape="rect" class="external-link
" href="https://developers.google.com/google-apps/calendar/auth" rel="nofollow">create an account and generate OAuth credentials</a>. Credentials comprise of a clientId, clientSecret, and a refreshToken. A handy resource for generating a long-lived refreshToken is the <a shape="rect" class="external-link" href="https://developers.google.com/oauthplayground" rel="nofollow">OAuth playground</a>.</span></p><p>Maven users will need to add the following dependency to their pom.xml for this component:</p><pre> <dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-calendar</artifactId>
- <version>2.15-SNAPSHOT</version>
+ <version>2.15.0</version>
</dependency>
</pre><h3 id="GoogleCalendar-URIFormat">URI Format</h3><hr><p>The GoogleCalendar Component uses the following URI format:</p><pre> google-calendar://endpoint-prefix/endpoint?[options]
- </pre><p>Endpoint prefix can be one of:</p><ul><li>acl</li><li>calendars</li><li>channels</li><li>colors</li><li>events</li><li>freebusy</li><li>list</li><li>settings</li></ul><h3 id="GoogleCalendar-GoogleCalendarComponent.1">GoogleCalendarComponent</h3><hr><p>The GoogleCalendar Component can be configured with the options below. These options can be provided using the component's bean property <code>configuration</code> of type <code>org.apache.camel.component.google.calendar.GoogleCalendarConfiguration</code>.</p><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">Type</th><th colspan="1" rowspan="1" class="confluenceTh"> </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">accessToken</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">OAuth 2 access token. This typically expires
after an hour so refreshToken is recommended for long term usage.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">applicationName</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Google calendar application name. Example would be "camel-google-calendar/1.0"</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Client ID of the calendar application</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientSecret</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Client secret of the calendar application</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">refreshToken</td><td colspan="1" rowspan="1" class="confluenceTd"><p>String</p></td><td colspan="1" rowspan="1" class="confluenceTd">OAuth 2 refres
h token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">scopes</td><td colspan="1" rowspan="1" class="confluenceTd">List<String></td><td colspan="1" rowspan="1" class="confluenceTd">Specifies the level of permissions you want a calendar application to have to a user account. See <a shape="rect" class="external-link" href="https://developers.google.com/google-apps/calendar/auth" rel="nofollow">https://developers.google.com/google-apps/calendar/auth</a> for more info.</td></tr></tbody></table></div><h3 id="GoogleCalendar-ProducerEndpoints">Producer Endpoints</h3><hr><p>Producer endpoints can use endpoint prefixes followed by endpoint names and associated options described next. A shorthand alias can be used for some endpoints. The endpoint URI MUST contain a prefix.</p><p>Endpoint options that are not man
datory are denoted by []. When there are no mandatory options for an endpoint, one of the set of [] options MUST be provided. Producer endpoints can also use a special option <strong><code>inBody</code></strong> that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message.</p><p>Any of the endpoint options can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format <code>CamelGoogleCalendar.<option></code>. Note that the <code>inBody</code> option overrides message header, i.e. the endpoint option <code>inBody=option</code> would override a <code>CamelGoogleCalendar.option</code> header.</p><h3 id="GoogleCalendar-1.EndpointPrefixacl">1. Endpoint Prefix <em>acl</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>acl</code> as follows:</p><pre> google-calendar://acl/endpoint?[options]
+ </pre><p>Endpoint prefix can be one of:</p><ul><li>acl</li><li>calendars</li><li>channels</li><li>colors</li><li>events</li><li>freebusy</li><li>list</li><li>settings</li></ul><h3 id="GoogleCalendar-GoogleCalendarComponent.1">GoogleCalendarComponent</h3><hr><p>The GoogleCalendar Component can be configured with the options below. These options can be provided using the component's bean property <code>configuration</code> of type <code>org.apache.camel.component.google.calendar.GoogleCalendarConfiguration</code>.</p><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">Type</th><th colspan="1" rowspan="1" class="confluenceTh"> </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">accessToken</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">OAuth 2 access token. This typically expires
after an hour so refreshToken is recommended for long term usage.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">applicationName</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Google calendar application name. Example would be "camel-google-calendar/1.0"</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Client ID of the calendar application</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clientSecret</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Client secret of the calendar application</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">refreshToken</td><td colspan="1" rowspan="1" class="confluenceTd"><p>String</p></td><td colspan="1" rowspan="1" class="confluenceTd">OAuth 2 refres
h token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">scopes</td><td colspan="1" rowspan="1" class="confluenceTd">List<String></td><td colspan="1" rowspan="1" class="confluenceTd">Specifies the level of permissions you want a calendar application to have to a user account. See <a shape="rect" class="external-link" href="https://developers.google.com/google-apps/calendar/auth" rel="nofollow">https://developers.google.com/google-apps/calendar/auth</a> for more info.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">emailAddress</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Since <strong>Camel 2.16.0</strong>, the emailAddress of the Google Service Account.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">p12FileN
ame</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Since <strong>Camel 2.16.0</strong>, the name of the p12 file which has the private key to use with the Google Service Account.</td></tr></tbody></table></div><h3 id="GoogleCalendar-ProducerEndpoints">Producer Endpoints</h3><hr><p>Producer endpoints can use endpoint prefixes followed by endpoint names and associated options described next. A shorthand alias can be used for some endpoints. The endpoint URI MUST contain a prefix.</p><p>Endpoint options that are not mandatory are denoted by []. When there are no mandatory options for an endpoint, one of the set of [] options MUST be provided. Producer endpoints can also use a special option <strong><code>inBody</code></strong> that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message.</p><p>Any of the endpoint options can be provided in either the endpoint
URI, or dynamically in a message header. The message header name must be of the format <code>CamelGoogleCalendar.<option></code>. Note that the <code>inBody</code> option overrides message header, i.e. the endpoint option <code>inBody=option</code> would override a <code>CamelGoogleCalendar.option</code> header.</p><h3 id="GoogleCalendar-1.EndpointPrefixacl">1. Endpoint Prefix <em>acl</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>acl</code> as follows:</p><pre> google-calendar://acl/endpoint?[options]
</pre><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">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, ruleId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">get</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, ruleId</td><td colspan="1" rowspan="1" class="confluenceTd"><span>com.google.api.services.calendar.model.AclRule</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">insert</td><td colspan="1" ro
wspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, content</td><td colspan="1" rowspan="1" class="confluenceTd"><span>com.google.api.services.calendar.model.AclRule</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">list</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,
0,0);">calendar</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">model</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Acl</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">patch</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, content, ruleId</td><td colspan="1" rowspan="1" class="confluenceTd"><span>com.google.api.services.calendar.model.AclRule</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, content, ruleId</td><td colspan="1" rowspan="1" class="confluenceTd"><span>com.google.api.services.calendar.model.AclRule</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">watch</td><td colspan="1" rowsp
an="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, contentChannel</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.calendar.model.Channel</td></tr></tbody></table></div><h4 id="GoogleCalendar-URIOptionsforacl">URI Options for <em>acl</em></h4><hr><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">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">calendarId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">content</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.calendar.model.AclRule</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">contentChannel</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.calendar.model.Channel</td></tr><tr><t
d colspan="1" rowspan="1" class="confluenceTd">ruleId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td></tr></tbody></table></div><h3 id="GoogleCalendar-2.EndpointPrefixcalendars">2. Endpoint Prefix <em>calendars</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>calendars</code> as follows:</p><pre> google-calendar://calendars/endpoint?[options]
</pre><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">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">clear</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">delete</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">get</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">calendarId</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">calendar</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Calendar</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">insert</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">content</td><td colspan="1" rowspan="1" class="conf
luenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">calendar</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Calendar</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">patch</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, content</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" s
tyle="color: rgb(0,0,0);">com</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">calendar</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Calendar</span></pre></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">update</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">calendarId, content</td><td colspan="1" rowspan="1" class="confluenceTd"><pre class="prettyprint lang-java"><span class="pln" style="color: rgb(0,0,0);">com</span><span class="pun" style="co
lor: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">google</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">api</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">services</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="pln" style="color: rgb(0,0,0);">calendar</span><span class="pun" style="color: rgb(102,102,0);">.</span><span class="typ" style="color: rgb(102,0,102);">Calendar</span></pre></td></tr></tbody></table></div><h4 id="GoogleCalendar-URIOptionsforcalendars">URI Options for <em>calendars</em></h4><hr><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">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">calendarId</td><td colspan="1" rowspan="1" class="confluenceTd">String</td
></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">content</td><td colspan="1" rowspan="1" class="confluenceTd">com.google.api.services.calendar.model.Calendar</td></tr></tbody></table></div><h3 id="GoogleCalendar-3.EndpointPrefixchannels">3. Endpoint Prefix <em>channels</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>channels</code> as follows:</p><pre> google-calendar://channels/endpoint?[options]
</pre><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">Shorthand Alias</th><th colspan="1" rowspan="1" class="confluenceTh">Options</th><th colspan="1" rowspan="1" class="confluenceTh">Result Body Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">stop</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">contentChannel</td><td colspan="1" rowspan="1" class="confluenceTd"> </td></tr></tbody></table></div><h4 id="GoogleCalendar-URIOptionsforchannels">URI Options for <em>channels</em></h4><hr><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">Type</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">contentChannel</td><td colspan="1" rowspan="1" cl
ass="confluenceTd">com.google.api.services.calendar.model.Channel</td></tr></tbody></table></div><h3 id="GoogleCalendar-4.EndpointPrefixcolors">4. Endpoint Prefix <em>colors</em></h3><hr><p>The following endpoints can be invoked with the prefix <code>colors</code> as follows:</p><pre> google-calendar://colors/endpoint?[options]