com.google.cloud.hadoop.util

Class CredentialFactory

java.lang.Object

com.google.cloud.hadoop.util.CredentialFactory

public class CredentialFactory
extends java.lang.Object

Miscellaneous helper methods for getting a Credential from various sources.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CredentialFactory.ComputeCredentialWithRetry A subclass of ComputeCredential that properly sets request initializers.
static class	CredentialFactory.CredentialHttpRetryInitializer Simple HttpRequestInitializer that retries requests that result in 5XX response codes and IO Exceptions with an exponential backoff.
static class	CredentialFactory.GoogleCredentialWithRetry A subclass of GoogleCredential that properly wires specified HttpRequestInitializer through the @{link Credential#executeRefreshToken} override.

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableList<java.lang.String>	DATASTORE_SCOPES
static com.google.common.collect.ImmutableList<java.lang.String>	GCS_SCOPES

Constructor Summary

Constructors

Constructor and Description
CredentialFactory()

Method Summary

Modifier and Type	Method and Description
com.google.api.client.auth.oauth2.Credential	getApplicationDefaultCredentials(java.util.List<java.lang.String> scopes, com.google.api.client.http.HttpTransport transport) Get Google Application Default Credentials as described in Google Application Default Credentials
com.google.api.client.auth.oauth2.Credential	getCredentialFromFileCredentialStoreForInstalledApp(java.lang.String clientId, java.lang.String clientSecret, java.lang.String filePath, java.util.List<java.lang.String> scopes) Deprecated. Caller should provide HttpTransport
com.google.api.client.auth.oauth2.Credential	getCredentialFromFileCredentialStoreForInstalledApp(java.lang.String clientId, java.lang.String clientSecret, java.lang.String filePath, java.util.List<java.lang.String> scopes, com.google.api.client.http.HttpTransport transport) Initialized OAuth2 credential for the "installed application" flow; where the credential typically represents an actual end user (instead of a service account), and is stored as a refresh token in a local FileCredentialStore.
com.google.api.client.auth.oauth2.Credential	getCredentialFromJsonKeyFile(java.lang.String file, java.util.List<java.lang.String> scopes) Deprecated. Caller should provide HttpTransport
com.google.api.client.auth.oauth2.Credential	getCredentialFromJsonKeyFile(java.lang.String serviceAccountJsonKeyFile, java.util.List<java.lang.String> scopes, com.google.api.client.http.HttpTransport transport) Get credentials listed in a JSON file.
com.google.api.client.auth.oauth2.Credential	getCredentialFromMetadataServiceAccount() Initializes OAuth2 credential using preconfigured ServiceAccount settings on the local GCE VM.
com.google.api.client.auth.oauth2.Credential	getCredentialFromPrivateKeyServiceAccount(java.lang.String serviceAccountEmail, java.lang.String privateKeyFile, java.util.List<java.lang.String> scopes) Deprecated. Caller should provide HttpTransport
com.google.api.client.auth.oauth2.Credential	getCredentialFromPrivateKeyServiceAccount(java.lang.String serviceAccountEmail, java.lang.String privateKeyFile, java.util.List<java.lang.String> scopes, com.google.api.client.http.HttpTransport transport) Initializes OAuth2 credential from a private keyfile, as described in OAuth2 Service Accounts.
com.google.api.client.auth.oauth2.Credential	getCredentialsFromSAParameters(java.lang.String privateKeyId, java.lang.String privateKeyPem, java.lang.String serviceAccountEmail, java.util.List<java.lang.String> scopes, com.google.api.client.http.HttpTransport transport)
com.google.api.client.auth.oauth2.Credential	getDatastoreCredential(java.lang.String clientId, java.lang.String clientSecret) Deprecated.
com.google.api.client.auth.oauth2.Credential	getStorageCredential(java.lang.String clientId, java.lang.String clientSecret) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

GCS_SCOPES

public static final com.google.common.collect.ImmutableList<java.lang.String> GCS_SCOPES

DATASTORE_SCOPES

public static final com.google.common.collect.ImmutableList<java.lang.String> DATASTORE_SCOPES

Constructor Detail

CredentialFactory

public CredentialFactory()

Method Detail

getCredentialFromMetadataServiceAccount

public com.google.api.client.auth.oauth2.Credential getCredentialFromMetadataServiceAccount()
                                                                                     throws java.io.IOException,
                                                                                            java.security.GeneralSecurityException

Initializes OAuth2 credential using preconfigured ServiceAccount settings on the local GCE VM. See: Authenticating from Google Compute Engine.

Throws:

java.io.IOException

java.security.GeneralSecurityException

getCredentialFromPrivateKeyServiceAccount

public com.google.api.client.auth.oauth2.Credential getCredentialFromPrivateKeyServiceAccount(java.lang.String serviceAccountEmail,
                                                                                              java.lang.String privateKeyFile,
                                                                                              java.util.List<java.lang.String> scopes,
                                                                                              com.google.api.client.http.HttpTransport transport)
                                                                                       throws java.io.IOException,
                                                                                              java.security.GeneralSecurityException

Initializes OAuth2 credential from a private keyfile, as described in OAuth2 Service Accounts.

Parameters:

serviceAccountEmail - Email address of the service account associated with the keyfile.

privateKeyFile - Full local path to private keyfile.

scopes - List of well-formed desired scopes to use with the credential.

transport - The HttpTransport used for authorization

Throws:

java.io.IOException

java.security.GeneralSecurityException

getCredentialFromJsonKeyFile

public com.google.api.client.auth.oauth2.Credential getCredentialFromJsonKeyFile(java.lang.String serviceAccountJsonKeyFile,
                                                                                 java.util.List<java.lang.String> scopes,
                                                                                 com.google.api.client.http.HttpTransport transport)
                                                                          throws java.io.IOException,
                                                                                 java.security.GeneralSecurityException

Get credentials listed in a JSON file.

Parameters:

serviceAccountJsonKeyFile - A file path pointing to a JSON file containing credentials.

scopes - The OAuth scopes that the credential should be valid for.

transport - The HttpTransport used for authorization

Throws:

java.io.IOException

java.security.GeneralSecurityException

getCredentialsFromSAParameters

public com.google.api.client.auth.oauth2.Credential getCredentialsFromSAParameters(java.lang.String privateKeyId,
                                                                                   java.lang.String privateKeyPem,
                                                                                   java.lang.String serviceAccountEmail,
                                                                                   java.util.List<java.lang.String> scopes,
                                                                                   com.google.api.client.http.HttpTransport transport)
                                                                            throws java.io.IOException

Throws:

java.io.IOException

getCredentialFromFileCredentialStoreForInstalledApp

public com.google.api.client.auth.oauth2.Credential getCredentialFromFileCredentialStoreForInstalledApp(java.lang.String clientId,
                                                                                                        java.lang.String clientSecret,
                                                                                                        java.lang.String filePath,
                                                                                                        java.util.List<java.lang.String> scopes,
                                                                                                        com.google.api.client.http.HttpTransport transport)
                                                                                                 throws java.io.IOException,
                                                                                                        java.security.GeneralSecurityException

Initialized OAuth2 credential for the "installed application" flow; where the credential typically represents an actual end user (instead of a service account), and is stored as a refresh token in a local FileCredentialStore.

Parameters:

clientId - OAuth2 client ID identifying the 'installed app'

clientSecret - OAuth2 client secret

filePath - full path to a ".json" file for storing the credential

scopes - list of well-formed scopes desired in the credential

transport - The HttpTransport used for authorization

Returns:

credential with desired scopes, possibly obtained from loading filePath.

Throws:

java.io.IOException - on IO error

java.security.GeneralSecurityException

getStorageCredential

@Deprecated
public com.google.api.client.auth.oauth2.Credential getStorageCredential(java.lang.String clientId,
                                                                                     java.lang.String clientSecret)
                                                                              throws java.io.IOException,
                                                                                     java.security.GeneralSecurityException

Deprecated.

Initializes OAuth2 credential and obtains authorization to access GCS.

Parameters:

clientId - OAuth2 client ID

clientSecret - OAuth2 client secret

Returns:

credential that allows access to GCS

Throws:

java.io.IOException - on IO error

java.security.GeneralSecurityException

getDatastoreCredential

@Deprecated
public com.google.api.client.auth.oauth2.Credential getDatastoreCredential(java.lang.String clientId,
                                                                                       java.lang.String clientSecret)
                                                                                throws java.io.IOException,
                                                                                       java.security.GeneralSecurityException

Deprecated.

Initializes OAuth2 credential and obtains authorization to access Datastore.

Parameters:

clientId - OAuth2 client ID

clientSecret - OAuth2 client secret

Returns:

credential that allows access to Datastore

Throws:

java.io.IOException - on IO error

java.security.GeneralSecurityException

getCredentialFromPrivateKeyServiceAccount

@Deprecated
public com.google.api.client.auth.oauth2.Credential getCredentialFromPrivateKeyServiceAccount(java.lang.String serviceAccountEmail,
                                                                                                          java.lang.String privateKeyFile,
                                                                                                          java.util.List<java.lang.String> scopes)
                                                                                                   throws java.io.IOException,
                                                                                                          java.security.GeneralSecurityException

Deprecated. Caller should provide HttpTransport

Throws:

java.io.IOException

java.security.GeneralSecurityException

getCredentialFromJsonKeyFile

@Deprecated
public com.google.api.client.auth.oauth2.Credential getCredentialFromJsonKeyFile(java.lang.String file,
                                                                                             java.util.List<java.lang.String> scopes)
                                                                                      throws java.io.IOException,
                                                                                             java.security.GeneralSecurityException

Deprecated. Caller should provide HttpTransport

Throws:

java.io.IOException

java.security.GeneralSecurityException

getCredentialFromFileCredentialStoreForInstalledApp

@Deprecated
public com.google.api.client.auth.oauth2.Credential getCredentialFromFileCredentialStoreForInstalledApp(java.lang.String clientId,
                                                                                                                    java.lang.String clientSecret,
                                                                                                                    java.lang.String filePath,
                                                                                                                    java.util.List<java.lang.String> scopes)
                                                                                                             throws java.io.IOException,
                                                                                                                    java.security.GeneralSecurityException

Deprecated. Caller should provide HttpTransport

Throws:

java.io.IOException

java.security.GeneralSecurityException

getApplicationDefaultCredentials

public com.google.api.client.auth.oauth2.Credential getApplicationDefaultCredentials(java.util.List<java.lang.String> scopes,
                                                                                     com.google.api.client.http.HttpTransport transport)
                                                                              throws java.io.IOException,
                                                                                     java.security.GeneralSecurityException

Get Google Application Default Credentials as described in Google Application Default Credentials

Parameters:

scopes - The OAuth scopes that the credential should be valid for.

Throws:

java.io.IOException

java.security.GeneralSecurityException