org.ctoolkit.restapi.client.googleapis

Class GoogleApiCredential

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.ctoolkit.restapi.client.googleapis.GoogleApiCredential

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class GoogleApiCredential
extends Properties

The Google API credential holder represents a map of credential used to authenticate client calls to APIs. Default credential will be always used if any specific wouldn't be found. Specific credential are optional unless default credential are defined.

Values are part of the binding thus available via injection like:

   public class MyClass {
     @Inject @Named("credential.default.clientId") String clientId;
     ...
   }

Author:

Aurel Medvegy

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
GoogleApiCredential() Creates default credential used to authenticate all calls unless specified another instance for a specific API.
GoogleApiCredential(Properties defaults) Creates credential map used to authenticate API calls.
GoogleApiCredential(String prefix) Creates specific credential used to authenticate calls to a specific API.

Method Summary

Methods

Modifier and Type	Method and Description
GoogleApiCredential	setApiKey(String apiKey) Sets the API Key to be used with any API that supports it.
GoogleApiCredential	setApplicationName(String applicationName) Sets the name of the client application.
GoogleApiCredential	setClientId(String clientId) Sets the Google API OAuth 2.0 Client ID Credential.
GoogleApiCredential	setCredentialOn(boolean credentialOn) Sets the boolean identification whether current environment should use these credential in order to authenticate client calls or use cloud native environment for authentication.
GoogleApiCredential	setEndpointUrl(String endpointUrl) Sets the backend service API endpoint URL to be called.
GoogleApiCredential	setFileName(String fileName) Sets the path name to the private key file.
GoogleApiCredential	setNumberOfRetries(int numberOfRetries) Sets the number of retries that will be allowed to execute before the request will be terminated or 0 to not retry requests.
GoogleApiCredential	setProjectId(String projectId) Sets the Google Cloud Project ID also known as applicationId (AppId).
GoogleApiCredential	setServiceAccountEmail(String serviceEmail) Sets the service account ID (typically an e-mail address).

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GoogleApiCredential

public GoogleApiCredential()

Creates default credential used to authenticate all calls unless specified another instance for a specific API. Setting following properties will be configured as default credential.

• setProjectId(String)
• setClientId(String)
• setServiceAccountEmail(String)
• setApplicationName(String)
• setFileName(String)
• setApiKey(String)
• setEndpointUrl(String)
• setCredentialOn(boolean)
• setNumberOfRetries(int)

GoogleApiCredential

public GoogleApiCredential(String prefix)

Creates specific credential used to authenticate calls to a specific API. Setting following properties will be configured as specific credential - prefix based.

• setProjectId(String)
• setClientId(String)
• setServiceAccountEmail(String)
• setApplicationName(String)
• setFileName(String)
• setApiKey(String)
• setEndpointUrl(String)
• setCredentialOn(boolean)
• setNumberOfRetries(int)

Parameters:

prefix - the prefix used to identify specific credential

GoogleApiCredential

public GoogleApiCredential(Properties defaults)

Creates credential map used to authenticate API calls. It's client responsibility to make sure that map has at least a default credential configured.

• credential.default.projectId
• credential.default.clientId
• credential.default.serviceAccountEmail
• credential.default.appName
• credential.default.fileName
• credential.default.apiKey
• credential.default.endpointUrl
• credential.default.credentialOn
• credential.default.numberOfRetries
• credential.drive.projectId
• credential.drive.clientId
• ..

Parameters:

defaults - map of credential

Method Detail

setProjectId

public GoogleApiCredential setProjectId(String projectId)

Sets the Google Cloud Project ID also known as applicationId (AppId).

Parameters:

projectId - the application ID

Returns:

this instance to chain

setClientId

public GoogleApiCredential setClientId(String clientId)

Sets the Google API OAuth 2.0 Client ID Credential.

Parameters:

clientId - the Client ID

Returns:

this instance to chain

setServiceAccountEmail

public GoogleApiCredential setServiceAccountEmail(String serviceEmail)

Sets the service account ID (typically an e-mail address).

Parameters:

serviceEmail - the service email

Returns:

this instance to chain

setApplicationName

public GoogleApiCredential setApplicationName(String applicationName)

Sets the name of the client application. If the application name is null or blank, the application will use default name Constants.DEFAULT_APP_NAME.

Parameters:

applicationName - the application name to be used as caller name

Returns:

this instance to chain

setFileName

public GoogleApiCredential setFileName(String fileName)

Sets the path name to the private key file.

Use package relative path for example '/biz/turnonline/server/impl/PrivateKeyFile.p12' or locate the private key file in resource package org.ctoolkit.restapi.client.googleapis directory -> 'PrivateKeyFile.p12'.

Parameters:

fileName - the relative path to file

Returns:

this instance to chain

setApiKey

public GoogleApiCredential setApiKey(String apiKey)

Sets the API Key to be used with any API that supports it.

Parameters:

apiKey - the API Key to be set

Returns:

this instance to chain

setEndpointUrl

public GoogleApiCredential setEndpointUrl(String endpointUrl)

Sets the backend service API endpoint URL to be called.

Parameters:

endpointUrl - the endpoint URL to be set

Returns:

this instance to chain

setCredentialOn

public GoogleApiCredential setCredentialOn(boolean credentialOn)

Sets the boolean identification whether current environment should use these credential in order to authenticate client calls or use cloud native environment for authentication.

Parameters:

credentialOn - true use these credential in order to authenticate calls

Returns:

this instance to chain

setNumberOfRetries

public GoogleApiCredential setNumberOfRetries(int numberOfRetries)

Sets the number of retries that will be allowed to execute before the request will be terminated or 0 to not retry requests.

The default value is 1.

Parameters:

numberOfRetries - the number of retries

Returns:

this instance to chain

See Also:

HttpRequest.setNumberOfRetries(int)