Repository: camel Updated Branches: refs/heads/master 31a2f9836 -> 34eb77f2c
Added camel-google-calendar docs to gitbook Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/7df0e267 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/7df0e267 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/7df0e267 Branch: refs/heads/master Commit: 7df0e267afbec4a80720881ae9f59e8c8eff9f85 Parents: 31a2f98 Author: Andrea Cosentino <anco...@gmail.com> Authored: Sat Apr 2 12:21:31 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Sat Apr 2 12:21:31 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/google-calendar.adoc | 155 +++++++++++++++++++ docs/user-manual/en/SUMMARY.md | 1 + 2 files changed, 156 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/7df0e267/components/camel-google-calendar/src/main/docs/google-calendar.adoc ---------------------------------------------------------------------- diff --git a/components/camel-google-calendar/src/main/docs/google-calendar.adoc b/components/camel-google-calendar/src/main/docs/google-calendar.adoc new file mode 100644 index 0000000..ba369a4 --- /dev/null +++ b/components/camel-google-calendar/src/main/docs/google-calendar.adoc @@ -0,0 +1,155 @@ +[[GoogleCalendar-GoogleCalendarComponent]] +GoogleCalendar Component +~~~~~~~~~~~~~~~~~~~~~~~~ + +''''' + +*Available as of Camel 2.15* + +[[GoogleCalendar-ComponentDescription]] +Component Description +^^^^^^^^^^^^^^^^^^^^^ + +The Google Calendar component provides access +to http://google.com/calendar[Google Calendar] via +the https://developers.google.com/google-apps/calendar/v3/reference/[Google +Calendar Web APIs]. + +Google Calendar uses +the https://developers.google.com/accounts/docs/OAuth2[OAuth 2.0 +protocol] for authenticating a Google account and authorizing access to +user data. Before you can use this component, you will need +to https://developers.google.com/google-apps/calendar/auth[create an +account and generate OAuth credentials]. Credentials comprise of a +clientId, clientSecret, and a refreshToken. A handy resource for +generating a long-lived refreshToken is +the https://developers.google.com/oauthplayground[OAuth playground]. + +Maven users will need to add the following dependency to their pom.xml +for this component: + +---------------------------------------------------------- + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-google-calendar</artifactId> + <version>2.15.0</version> + </dependency> + +---------------------------------------------------------- + +[[GoogleCalendar-options]] +1. Google Calendar Options +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +// component options: START +The Google Calendar component supports 2 options which are listed below. + + + +[width="100%",cols="2s,1m,8",options="header"] +|======================================================================= +| Name | Java Type | Description +| configuration | GoogleCalendarConfiguration | To use the shared configuration +| clientFactory | GoogleCalendarClientFactory | To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory +|======================================================================= +// component options: END + + + + +// endpoint options: START +The Google Calendar component supports 16 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| apiName | common | | GoogleCalendarApiName | *Required* What kind of operation to perform +| methodName | common | | String | *Required* What sub operation to use for the selected operation +| accessToken | common | | String | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. +| applicationName | common | | String | Google calendar application name. Example would be camel-google-calendar/1.0 +| clientId | common | | String | Client ID of the calendar application +| clientSecret | common | | String | Client secret of the calendar application +| emailAddress | common | | String | The emailAddress of the Google Service Account. +| inBody | common | | String | Sets the name of a parameter to be passed in the exchange In Body +| p12FileName | common | | String | The name of the p12 file which has the private key to use with the Google Service Account. +| refreshToken | common | | String | OAuth 2 refresh 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. +| scopes | common | https://www.googleapis.com/auth/calendar | List | Specifies the level of permissions you want a calendar application to have to a user account. See https://developers.google.com/google-apps/calendar/auth for more info. +| user | common | | String | The email address of the user the application is trying to impersonate in the service account flow +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +// endpoint options: END + +[[GoogleCalendar-URIFormat]] +URI Format +^^^^^^^^^^ + +The GoogleCalendar Component uses the following URI format: + +------------------------------------------------------------ + google-calendar://endpoint-prefix/endpoint?[options] + +------------------------------------------------------------ + +Endpoint prefix can be one of: + +* acl +* calendars +* channels +* colors +* events +* freebusy +* list +* settings + +[[GoogleCalendar-ProducerEndpoints]] +Producer Endpoints +^^^^^^^^^^^^^^^^^^ + +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. + +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 +*`inBody`* that in turn should contain the name of the endpoint option +whose value will be contained in the Camel Exchange In message. + +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 `CamelGoogleCalendar.<option>`. Note that the `inBody` option +overrides message header, i.e. the endpoint option `inBody=option` would +override a `CamelGoogleCalendar.option` header. + + +[[GoogleCalendar-ConsumerEndpoints]] +Consumer Endpoints +^^^^^^^^^^^^^^^^^^ + +Any of the producer endpoints can be used as a consumer endpoint. +Consumer endpoints can use +http://camel.apache.org/polling-consumer.html#PollingConsumer-ScheduledPollConsumerOptions[Scheduled +Poll Consumer Options] with a `consumer.` prefix to schedule endpoint +invocation. Consumer endpoints that return an array or collection will +generate one exchange per element, and their routes will be executed +once for each exchange. + +[[GoogleCalendar-MessageHeaders]] +Message Headers +^^^^^^^^^^^^^^^ + +Any URI option can be provided in a message header for producer +endpoints with a `CamelGoogleCalendar.` prefix. + +[[GoogleCalendar-MessageBody]] +Message Body +^^^^^^^^^^^^ + +All result message bodies utilize objects provided by the underlying +APIs used by the GoogleCalendarComponent. Producer endpoints can specify +the option name for incoming message body in the `inBody` endpoint URI +parameter. For endpoints that return an array or collection, a consumer +endpoint will map every element to distinct messages.    http://git-wip-us.apache.org/repos/asf/camel/blob/7df0e267/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index b80f02b..0b04436 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -136,6 +136,7 @@ * [Geocoder](geocoder.adoc) * [Git](git.adoc) * [Github](github.adoc) + * [Google Calendar](google-calendar.adoc) * [Ironmq](ironmq.adoc) * [JMS](jms.adoc) * [JMX](jmx.adoc)
