GoogleCalendar Component

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>
        

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

GoogleCalendarComponent

The GoogleCalendar Component can be configured with the options below. These options can be provided using the component's bean property configuration of type org.apache.camel.component.google.calendar.GoogleCalendarConfiguration.

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.

1. Endpoint Prefix acl

The following endpoints can be invoked with the prefix acl as follows:

        google-calendar://acl/endpoint?[options]
    

com.google.api.services.calendar.model.Acl

URI Options for acl

2. Endpoint Prefix calendars

The following endpoints can be invoked with the prefix calendars as follows:

        google-calendar://calendars/endpoint?[options]
    

com.google.api.services.calendar.Calendar

com.google.api.services.calendar.Calendar

com.google.api.services.calendar.Calendar

com.google.api.services.calendar.Calendar

URI Options for calendars

3. Endpoint Prefix channels

The following endpoints can be invoked with the prefix channels as follows:

        google-calendar://channels/endpoint?[options]
    

URI Options for channels

4. Endpoint Prefix colors

The following endpoints can be invoked with the prefix colors as follows:

        google-calendar://colors/endpoint?[options]
    

com.google.api.services.calendar.model.Colors

URI Options for colors

5. Endpoint Prefix events

The following endpoints can be invoked with the prefix events as follows:

        google-calendar://events/endpoint?[options]
    

com.google.api.services.calendar.model.Events

com.google.api.services.calendar.model.Events

URI Options for events

6. Endpoint Prefix freebusy

The following endpoints can be invoked with the prefix freebusy as follows:

        google-calendar://freebusy/endpoint?[options]
    

URI Options for freebusy

7. Endpoint Prefix list

The following endpoints can be invoked with the prefix list as follows:

        google-calendar://list/endpoint?[options]
    

com.google.api.services.calendar.model.CalendarListEntry

com.google.api.services.calendar.model.CalendarListEntry

com.google.api.services.calendar.model.CalendarList

com.google.api.services.calendar.model.CalendarListEntry

com.google.api.services.calendar.model.CalendarListEntry

URI Options for list

8. Endpoint Prefix settings

The following endpoints can be invoked with the prefix settings as follows:

        google-calendar://settings/endpoint?[options]
    

com.google.api.services.calendar.model.Setting

com.google.api.services.calendar.model.Settings

URI Options for settings

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.