LibraryToggle FramesPrintFeedback

Name

GAuth — implement a Google-specific OAuth consumer

Overview

The GAuth component is used by web applications to implement a Google-specific OAuth consumer. Although this component belongs to the Camel Components for Google App Engine (GAE), it can also be used to OAuth-enable non-GAE web applications. For a detailed description of Google's OAuth implementation refer to the Google OAuth API reference.

Options

Table 4.1 lists the options for a GAuth endpoint.

Table 4.1. GAuth options

NameRequiredDescription
callbacktrue [a]Specifies the URL to where users are redirected after having granted or denied access.
scopetrue [b] Specifies the URL identifying the service(s) to be accessed. To specify more than one scope, list each one separated with a comma.
consumerKeytrue [c] Specifies the domain identifying the web application. This is the domain used when registering the application with Google. For a non-registered application use anonymous.
consumerSecretif keyLoaderRef is not specified[c]Specifies the consumer secret of the web application. The consumer secret is generated when registering the application with Google. It is needed if the HMAC-SHA1 signature method shall be used. For a non-registered application use anonymous.
keyLoaderRefif consumerSecret is not specified[c]

Specifies a reference to a private key loader in the registry.

The camel-gae module contains two key loaders:

  • GAuthPk8Loader—loads a private key from a PKCS#8 file

  • GAuthJksLoader—loads a private key from a Java key store. It is needed if the RSA-SHA1 signature method shall be used.

These classes are defined in the org.apache.camel.component.gae.auth package.

authorizeBindingReffalseSpecifies a reference to a OutboundBinding<GAuthEndpoint, GoogleOAuthParameters, GoogleOAuthParameters> in the registry for customizing how an exchange is bound to GoogleOAuthParameters. This binding is used for the authorization phase.
upgradeBindingReffalseSpecifies a reference to a OutboundBinding<GAuthEndpoint, GoogleOAuthParameters, GoogleOAuthParameters> in the registry for customizing how an exchange is bound to GoogleOAuthParameters. This binding is used for the token upgrade phase.

[a] can alternatively be set via the GAuthAuthorizeBinding.GAUTH_CALLBACK message header

[b] can alternatively be set via GAuthAuthorizeBinding.GAUTH_SCOPE message header

[c] can alternatively be set on component-level


Comments powered by Disqus