org.ctoolkit.restapi.client.googleapis

Class GoogleApiProxyFactory

java.lang.Object

org.ctoolkit.restapi.client.googleapis.GoogleApiProxyFactory

public abstract class GoogleApiProxyFactory
extends Object

The factory to build proxy instance to allow authenticated calls to Google APIs on behalf of the application instead of an end-user by OAuth 2.0.

OAuth 2.0 allows users to share specific data with application (for example, contact lists) while keeping their usernames, passwords, and other information private.

Author:

Aurel Medvegy

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.eventbus.EventBus	eventBus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GoogleApiProxyFactory(Map<String,String> credential, com.google.common.eventbus.EventBus eventBus, org.ctoolkit.restapi.client.provider.AuthKeyProvider keyProvider) Create factory instance.

Method Summary

Methods

Modifier and Type	Method and Description
org.ctoolkit.restapi.client.ApiToken<? extends com.google.api.client.http.HttpRequestInitializer>	authorize(Collection<String> scopes, String userAccount, String prefix) Creates the thread-safe Google-specific implementation of the OAuth 2.0.
protected void	configureHttpRequest(com.google.api.client.http.HttpRequest request, int numberOfRetries, int readTimeout) Configure HTTP request right before execution.
String	getApiKey(String prefix) Returns value set by ApiCredential.setApiKey(String) or defined by property file.
String	getApplicationName(String prefix) Returns value set by ApiCredential.setApplicationName(String) or defined by property file.
String	getClientId(String prefix) Returns value set by ApiCredential.setClientId(String) or defined by property file.
String	getEndpointUrl(String prefix) Returns value set by ApiCredential.setEndpointUrl(String) or defined by property file.
String	getFileName(String prefix) Returns value set by ApiCredential.setFileName(String) or defined by property file.
String	getFileNameJsonStream(String prefix) Returns value set by ApiCredential.setFileNameJsonStream(String) or defined by property file.
com.google.api.client.http.HttpTransport	getHttpTransport() Returns singleton instance of the HTTP transport.
com.google.api.client.json.JsonFactory	getJsonFactory() Returns singleton instance of the JSON factory.
int	getNumberOfRetries(String prefix) Returns value set by ApiCredential.setNumberOfRetries(int) or defined by property file.
String	getProjectId(String prefix) Returns value set by ApiCredential.setProjectId(String) or defined by property file.
int	getReadTimeout(String prefix) Returns value set by ApiCredential.setRequestReadTimeout(int) or defined by property file.
String	getServiceAccountEmail(String prefix) Returns value set by ApiCredential.setServiceAccountEmail(String) or defined by property file.
InputStream	getServiceAccountJsonStream(String prefix) Returns the Google APIs service account key as JSON.
URL	getServiceAccountPrivateKeyP12Resource(String prefix)
InputStream	getServiceAccountPrivateKeyP12Stream(String prefix)
boolean	isCredentialOn(String prefix) Returns value set by ApiCredential.setCredentialOn(boolean) or defined by property file.
boolean	isDisableGZipContent(String prefix) Returns value set by ApiCredential.setDisableGZipContent(boolean) (boolean)} or defined by property file.
boolean	isJsonConfiguration(String prefix)
com.google.api.client.http.HttpRequestInitializer	newRequestConfig(String prefix, com.google.api.client.http.HttpResponseInterceptor interceptor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eventBus

protected final com.google.common.eventbus.EventBus eventBus

Constructor Detail

GoogleApiProxyFactory

protected GoogleApiProxyFactory(@Nonnull
                     Map<String,String> credential,
                     @Nonnull
                     com.google.common.eventbus.EventBus eventBus,
                     @Nullable
                     org.ctoolkit.restapi.client.provider.AuthKeyProvider keyProvider)

Create factory instance.

Method Detail

getHttpTransport

public final com.google.api.client.http.HttpTransport getHttpTransport()
                                                                throws GeneralSecurityException,
                                                                       IOException

Returns singleton instance of the HTTP transport.

Throws:

GeneralSecurityException

IOException

getJsonFactory

public final com.google.api.client.json.JsonFactory getJsonFactory()

Returns singleton instance of the JSON factory.

getProjectId

public String getProjectId(@Nullable
                  String prefix)

Returns value set by ApiCredential.setProjectId(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the project ID

Throws:

MissingResourceException - if default credential was requested and haven't been found

getClientId

public String getClientId(@Nullable
                 String prefix)

Returns value set by ApiCredential.setClientId(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the client ID

Throws:

MissingResourceException - if default credential was requested and haven't been found

isDisableGZipContent

public final boolean isDisableGZipContent(@Nullable
                           String prefix)

Returns value set by ApiCredential.setDisableGZipContent(boolean) (boolean)} or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

true to disable GZip compression. Otherwise HTTP content will be compressed.

getServiceAccountEmail

public final String getServiceAccountEmail(@Nullable
                            String prefix)

Returns value set by ApiCredential.setServiceAccountEmail(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the service email

Throws:

MissingResourceException - if default credential was requested and haven't been found

getApplicationName

public final String getApplicationName(@Nullable
                        String prefix)

Returns value set by ApiCredential.setApplicationName(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the application name

Throws:

MissingResourceException - if default credential was requested and haven't been found

getFileName

public final String getFileName(@Nullable
                 String prefix)

Returns value set by ApiCredential.setFileName(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the file name path

Throws:

MissingResourceException - if default credential was requested and haven't been found

getFileNameJsonStream

public final String getFileNameJsonStream(@Nullable
                           String prefix)

Returns value set by ApiCredential.setFileNameJsonStream(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the file name path

Throws:

MissingResourceException - if default credential was requested and haven't been found

getApiKey

public final String getApiKey(@Nullable
               String prefix)

Returns value set by ApiCredential.setApiKey(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the API key

Throws:

MissingResourceException - if default credential was requested and haven't been found

getEndpointUrl

public final String getEndpointUrl(@Nullable
                    String prefix)

Returns value set by ApiCredential.setEndpointUrl(String) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the endpoint URL

Throws:

MissingResourceException - if default credential was requested and haven't been found

getNumberOfRetries

public int getNumberOfRetries(@Nullable
                     String prefix)

Returns value set by ApiCredential.setNumberOfRetries(int) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the number of configured retries

getReadTimeout

public int getReadTimeout(@Nullable
                 String prefix)

Returns value set by ApiCredential.setRequestReadTimeout(int) or defined by property file. If specific credential wouldn't not be found, default will be returned 20000 (20 seconds).

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the request read timeout in milliseconds

isCredentialOn

public final boolean isCredentialOn(@Nullable
                     String prefix)

Returns value set by ApiCredential.setCredentialOn(boolean) or defined by property file. If specific credential wouldn't not be found, default will be returned.

Parameters:

prefix - the prefix used to identify specific credential or null for default

Returns:

the true if credential will be used to authenticate

authorize

public org.ctoolkit.restapi.client.ApiToken<? extends com.google.api.client.http.HttpRequestInitializer> authorize(Collection<String> scopes,
                                                                                                          String userAccount,
                                                                                                          String prefix)
                                                                                                            throws GeneralSecurityException,
                                                                                                                   IOException

Creates the thread-safe Google-specific implementation of the OAuth 2.0.

Parameters:

scopes - the space-separated OAuth scopes to use with the service account flow or null for none.

userAccount - the email address. If you want to impersonate a user account, specify the email address. Useful for domain-wide delegation.

Returns:

the thread-safe credential instance

Throws:

GeneralSecurityException, - IOException

GeneralSecurityException

IOException

isJsonConfiguration

public boolean isJsonConfiguration(String prefix)

getServiceAccountPrivateKeyP12Resource

public URL getServiceAccountPrivateKeyP12Resource(String prefix)

getServiceAccountJsonStream

public InputStream getServiceAccountJsonStream(String prefix)

Returns the Google APIs service account key as JSON.

Parameters:

prefix - the prefix used to identify specific credential

Returns:

the service account key as JSON

getServiceAccountPrivateKeyP12Stream

public InputStream getServiceAccountPrivateKeyP12Stream(String prefix)

newRequestConfig

public com.google.api.client.http.HttpRequestInitializer newRequestConfig(@Nullable
                                                                 String prefix,
                                                                 @Nullable
                                                                 com.google.api.client.http.HttpResponseInterceptor interceptor)

configureHttpRequest

protected final void configureHttpRequest(@Nonnull
                        com.google.api.client.http.HttpRequest request,
                        int numberOfRetries,
                        int readTimeout)

Configure HTTP request right before execution.

Parameters:

request - the HTTP request

numberOfRetries - the number of configured retries

readTimeout - the request read timeout in milliseconds