GoogleDrive

GoogleDrive Component

Available as of Camel 2.14

The Google Drive component provides access to the Google Drive file storage service via the Google Drive Web APIs.

Google Drive 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-drive</artifactId>
            <version>2.14-SNAPSHOT</version>
    </dependency>
        

URI Format

The GoogleDrive Component uses the following URI format:

        google-drive://endpoint-prefix/endpoint?[options]
    

Endpoint prefix can be one of:

• drive-about
• drive-apps
• drive-changes
• drive-channels
• drive-children
• drive-comments
• drive-files
• drive-parents
• drive-permissions
• drive-properties
• drive-realtime
• drive-replies
• drive-revisions

GoogleDriveComponent

The GoogleDrive 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.drive.GoogleDriveConfiguration.

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 CamelGoogleDrive.<option>. Note that the inBody option overrides message header, i.e. the endpoint option inBody=option would override a CamelGoogleDrive.option header.

For more information on the endpoints and options see API documentation at: https://developers.google.com/drive/v2/reference/

1. Endpoint Prefix drive-about

The following endpoints can be invoked with the prefix drive-about as follows:

        google-drive://drive-about/endpoint?[options]
    

URI Options for drive-about

2. Endpoint Prefix drive-apps

The following endpoints can be invoked with the prefix drive-apps as follows:

        google-drive://drive-apps/endpoint?[options]
    

URI Options for drive-apps

3. Endpoint Prefix drive-changes

The following endpoints can be invoked with the prefix drive-changes as follows:

        google-drive://drive-changes/endpoint?[options]
    

URI Options for drive-changes

4. Endpoint Prefix drive-channels

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

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

URI Options for drive-channels

5. Endpoint Prefix drive-children

The following endpoints can be invoked with the prefix drive-children as follows:

        google-drive://drive-children/endpoint?[options]
    

URI Options for drive-children

6. Endpoint Prefix drive-comments

The following endpoints can be invoked with the prefix drive-comments as follows:

        google-drive://drive-comments/endpoint?[options]
    

URI Options for drive-comments

7. Endpoint Prefix drive-files

The following endpoints can be invoked with the prefix drive-files as follows:

        google-drive://drive-files/endpoint?[options]
    

URI Options for drive-files

8. Endpoint Prefix drive-parents

The following endpoints can be invoked with the prefix drive-parents as follows:

        google-drive://drive-parents/endpoint?[options]
    

URI Options for drive-parents

9. Endpoint Prefix drive-permissions

The following endpoints can be invoked with the prefix drive-permissions as follows:

        google-drive://drive-permissions/endpoint?[options]
    

URI Options for drive-permissions

10. Endpoint Prefix drive-properties

The following endpoints can be invoked with the prefix drive-properties as follows:

        google-drive://drive-properties/endpoint?[options]
    

URI Options for drive-properties

11. Endpoint Prefix drive-realtime

The following endpoints can be invoked with the prefix drive-realtime as follows:

        google-drive://drive-realtime/endpoint?[options]
    

URI Options for drive-realtime

12. Endpoint Prefix drive-replies

The following endpoints can be invoked with the prefix drive-replies as follows:

        google-drive://drive-replies/endpoint?[options]
    

URI Options for drive-replies

13. Endpoint Prefix drive-revisions

The following endpoints can be invoked with the prefix drive-revisions as follows:

        google-drive://drive-revisions/endpoint?[options]
    

URI Options for drive-revisions

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 CamelGoogleDrive. prefix.

Message Body

All result message bodies utilize objects provided by the underlying APIs used by the GoogleDriveComponent. 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.