GoogleCalendar Component

Table of Contents

Component Description
1. Google Calendar Options
URI Format
Producer Endpoints
Consumer Endpoints
Message Headers
Message Body

Available as of Camel 2.15

Component Description

The Google Calendar component provides access to Google Calendar via the Google Calendar Web APIs.

Google Calendar uses the 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 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 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>

1. Google Calendar Options

The Google Calendar component supports 2 options which are listed below.

{% raw %}

NameJava TypeDescription

configuration

GoogleCalendarConfiguration

To use the shared configuration

clientFactory

GoogleCalendarClientFactory

To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleCalendarClientFactory

{% endraw %}

The Google Calendar component supports 16 endpoint options which are listed below:

{% raw %}

NameGroupDefaultJava TypeDescription

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

consumer (advanced)

 

ExchangePattern

Sets the exchange pattern when the consumer creates an exchange.

synchronous

advanced

false

boolean

Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported).

{% endraw %}

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

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.

Consumer Endpoints

Any of the producer endpoints can be used as a consumer endpoint. Consumer endpoints can use 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.

Message Headers

Any URI option can be provided in a message header for producer endpoints with a CamelGoogleCalendar. prefix.

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.