Red Hat Summit第59章 GoogleCalendar
GoogleCalendar コンポーネント
リンクのコピーリンクがクリップボードにコピーされました!
Camel 2.15 以降で利用可能
コンポーネントの説明
リンクのコピーリンクがクリップボードにコピーされました!
Google Calendar コンポーネントは、Google カレンダー Web API 経由で Google カレンダー へのアクセスを提供します。
Google カレンダーは、OAuth 2.0 プロトコル を使用して Google アカウントを認証し、ユーザーデータへのアクセスを承認します。このコンポーネントを使用する前に、アカウントを作成し、OAuth クレデンシャル を生成 する必要があります。認証情報は、clientId、clientSecret、および refreshToken で設定されます。有効期間の長い refreshToken を生成するための便利なリソースは OAuth プレイグラウンドです。
Maven ユーザーは、このコンポーネントの pom.xml に以下の依存関係を追加する必要があります。
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-calendar</artifactId>
<version>2.17.0.redhat-630xxx</version>
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-calendar</artifactId>
<version>2.17.0.redhat-630xxx</version>
</dependency>URI 形式
リンクのコピーリンクがクリップボードにコピーされました!
GoogleCalendar コンポーネントは以下の URI 形式を使用します。
google-calendar://endpoint-prefix/endpoint?[options]
google-calendar://endpoint-prefix/endpoint?[options]
エンドポイント接頭辞は以下のいずれかになります。
- acl
- calendars
- channels
- colors
- events
- freebusy
- list
- settings
GoogleCalendarComponent
リンクのコピーリンクがクリップボードにコピーされました!
GoogleCalendar コンポーネントは、以下のオプションで設定できます。これらのオプションは、タイプ
org.apache.camel.component.google.calendar.GoogleCalendarConfiguration のコンポーネントの Bean プロパティー configuration を使用して提供できます。
| オプション | タイプ | |
|---|---|---|
accessToken
|
String
|
OAuth 2 アクセストークン通常、これは 1 時間後に期限切れになるため、長期間の使用には refreshToken が推奨されます。
|
applicationName
|
String
|
Google カレンダーアプリケーション名。たとえば、camel-google-calendar/1.0 です。
|
clientId
|
String
|
カレンダーアプリケーションのクライアント ID。 |
clientSecret
|
String
|
カレンダーアプリケーションのクライアントシークレット。 |
refreshToken
|
String
|
OAuth2 更新トークン。このトークンを使用すると、Google カレンダーコンポーネントは現在の有効期限が切れるたびに新しい accessToken を取得できます。アプリケーションが長期間使用する場合は必要となります。
|
scopes
|
List<String>
|
カレンダーアプリケーションでユーザーアカウントに必要なパーミッションのレベルを指定します。詳細は、https://developers.google.com/google-apps/calendar/auth を参照してください。 |
emailAddress
|
String
|
Camel 2.16.0: Google Service Account の
emailAddress。
|
p12FileName
|
String
|
Camel 2.16.0: Google サービスアカウントで使用する秘密鍵を持つ
.p12 ファイルの名前。
|
プロデューサーエンドポイント
リンクのコピーリンクがクリップボードにコピーされました!
プロデューサーエンドポイントはエンドポイント接頭辞を使用し、続いてエンドポイント名と以下で説明する関連オプションを使用できます。一部のエンドポイントには、短縮エイリアスを使用できます。エンドポイント URI には 接頭辞が含まれている必要があります。
必須ではないエンドポイントオプションは [] で示されます。エンドポイントに必須のオプションがない場合は、[] オプションのセットの 1 つを指定する必要があります。プロデューサーエンドポイントは、Camel Exchange In メッセージに含まれる値を持つ endpoint オプションの名前が含まれる必要がある特別なオプション
inBody を使用することもできます。
エンドポイントオプションは、エンドポイント URI またはメッセージヘッダーで動的に指定できます。メッセージヘッダー名は
CamelGoogleCalendar.<option> の形式である必要があります。inBody オプションはメッセージヘッダーを上書きすることに注意してください。つまり、エンドポイントオプション inBody=option は CamelGoogleCalendar.option ヘッダーを上書きすることに注意してください。
1.エンドポイント接頭辞 acl
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
acl で呼び出すことができます。
google-calendar://acl/endpoint?[options]
google-calendar://acl/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| delete | calendarId, ruleId | ||
| get | calendarId, ruleId | com.google.api.services.calendar.model.AclRule | |
| insert | calendarId, content | com.google.api.services.calendar.model.AclRule | |
| list | calendarId |
com.google.api.services.calendar.model.Acl
|
|
| patch | calendarId、content、ruleId | com.google.api.services.calendar.model.AclRule | |
| update | calendarId、content、ruleId | com.google.api.services.calendar.model.AclRule | |
| watch | calendarId, contentChannel | com.google.api.services.calendar.model.Channel |
aclの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| calendarId | 文字列 |
| content | com.google.api.services.calendar.model.AclRule |
| contentChannel | com.google.api.services.calendar.model.Channel |
| ruleId | 文字列 |
2.エンドポイント接頭辞 カレンダー
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
calendars で呼び出すことができます。
google-calendar://calendars/endpoint?[options]
google-calendar://calendars/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| clear | calendarId | ||
| delete | calendarId | ||
| get | calendarId |
com.google.api.services.calendar.Calendar
|
|
| insert | content |
com.google.api.services.calendar.Calendar
|
|
| patch | calendarId, content |
com.google.api.services.calendar.Calendar
|
|
| update | calendarId, content |
com.google.api.services.calendar.Calendar
|
カレンダーの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| calendarId | 文字列 |
| content | com.google.api.services.calendar.model.Calendar |
3.エンドポイント接頭辞 チャネル
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
channels で呼び出すことができます。
google-calendar://channels/endpoint?[options]
google-calendar://channels/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| stop | contentChannel |
チャネルの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| contentChannel | com.google.api.services.calendar.model.Channel |
4.エンドポイント接頭辞の 色
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
colors で呼び出すことができます。
google-calendar://colors/endpoint?[options]
google-calendar://colors/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| get |
com.google.api.services.calendar.model.Colors
|
色の URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|
5.エンドポイント接頭辞 イベント
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
events で呼び出すことができます。
google-calendar://events/endpoint?[options]
google-calendar://events/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| calendarImport | calendarId, content | com.google.api.services.calendar.model.Event | |
| delete | calendarId, eventId | ||
| get | calendarId, eventId | com.google.api.services.calendar.model.Event | |
| insert | calendarId, content | com.google.api.services.calendar.model.Event | |
| instances | calendarId, eventId |
com.google.api.services.calendar.model.Events
|
|
| list | calendarId |
com.google.api.services.calendar.model.Events
|
|
| move | calendarId、destination、eventId | com.google.api.services.calendar.model.Event | |
| patch | calendarId、content、eventId | com.google.api.services.calendar.model.Event | |
| quickAdd | calendarId, text | com.google.api.services.calendar.model.Event | |
| update | calendarId、content、eventId | com.google.api.services.calendar.model.Event | |
| watch | calendarId, contentChannel | com.google.api.services.calendar.model.Channel |
イベントの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| calendarId | 文字列 |
| content | com.google.api.services.calendar.model.Event |
| contentChannel | com.google.api.services.calendar.model.Channel |
| destination | 文字列 |
| eventId | 文字列 |
| text | 文字列 |
6.エンドポイント接頭辞 freebusy
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
freebusy で呼び出すことができます。
google-calendar://freebusy/endpoint?[options]
google-calendar://freebusy/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| query | content | com.google.api.services.calendar.model.FreeBusyResponse |
freebusyの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| content | com.google.api.services.calendar.model.FreeBusyRequest |
7.endpoint Prefix list
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
list で呼び出すことができます。
google-calendar://list/endpoint?[options]
google-calendar://list/endpoint?[options]| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| delete | calendarId | ||
| get | calendarId |
com.google.api.services.calendar.model.CalendarListEntry
|
|
| insert | content |
com.google.api.services.calendar.model.CalendarListEntry
|
|
| list |
com.google.api.services.calendar.model.CalendarList
|
||
| patch | calendarId, content |
com.google.api.services.calendar.model.CalendarListEntry
|
|
| update | calendarId, content |
com.google.api.services.calendar.model.CalendarListEntry
|
|
| watch | contentChannel | com.google.api.services.calendar.model.Channel |
listの URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| calendarId | 文字列 |
| content | com.google.api.services.calendar.model.CalendarListEntry |
| contentChannel | com.google.api.services.calendar.model.Channel |
8.エンドポイント接頭辞の 設定
リンクのコピーリンクがクリップボードにコピーされました!
以下のエンドポイントは、以下のように接頭辞
settings で呼び出すことができます。
google-calendar://settings/endpoint?[options]
google-calendar://settings/endpoint?[options]
| エンドポイント | 短縮形エイリアス | オプション | 結果ボディーのタイプ |
|---|---|---|---|
| get | 設定 |
com.google.api.services.calendar.model.Setting
|
|
| list |
com.google.api.services.calendar.model.Settings
|
||
| watch | contentChannel | com.google.api.services.calendar.model.Channel |
設定の URI オプション
リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | タイプ |
|---|---|
| contentChannel | com.google.api.services.calendar.model.Channel |
| 設定 | 文字列 |
コンシューマーエンドポイント
リンクのコピーリンクがクリップボードにコピーされました!
プロデューサーエンドポイントはいずれもコンシューマーエンドポイントとして使用できます。コンシューマーエンドポイントは、
consumer. 接頭辞が付い た Scheduled Poll Consumer オプション を使用して、エンドポイントの呼び出しをスケジュールできます。配列またはコレクションを返すコンシューマーエンドポイントは、要素ごとにエクスチェンジを 1 つ生成し、それらのルートはエクスチェンジごとに 1 回実行されます。
メッセージヘッダー
リンクのコピーリンクがクリップボードにコピーされました!
URI オプションは、
CamelGoogleCalendar. 接頭辞が付いたプロデューサーエンドポイントのメッセージヘッダーで指定できます。
メッセージボディー
リンクのコピーリンクがクリップボードにコピーされました!
すべての結果メッセージ本文は、GoogleCalendarComponent によって使用される基礎となる API によって提供されるオブジェクトを使用します。プロデューサーエンドポイントは、
inBody エンドポイント URI パラメーターに受信メッセージボディーのオプション名を指定できます。配列またはコレクションを返すエンドポイントの場合、コンシューマーエンドポイントはすべての要素を個別のメッセージにマップします。
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}