com.google.cloud.hadoop.util

Class CredentialFactory

java.lang.Object

com.google.cloud.hadoop.util.CredentialFactory

public class CredentialFactory
extends 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<String>	DEFAULT_SCOPES

Constructor Summary

Constructors

Constructor and Description
CredentialFactory(CredentialOptions options)

Method Summary

Modifier and Type	Method and Description
com.google.api.client.auth.oauth2.Credential	getCredential(List<String> scopes) Get the credential as configured.
static 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(List<String> scopes, com.google.api.client.http.HttpTransport transport) Initializes OAuth2 credential from a private keyfile, as described in OAuth2 Service Accounts.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SCOPES

public static final com.google.common.collect.ImmutableList<String> DEFAULT_SCOPES

Constructor Detail

CredentialFactory

public CredentialFactory(CredentialOptions options)

Method Detail

getCredentialFromMetadataServiceAccount

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

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

Throws:

IOException

GeneralSecurityException

getCredentialFromPrivateKeyServiceAccount

public com.google.api.client.auth.oauth2.Credential getCredentialFromPrivateKeyServiceAccount(List<String> scopes,
                                                                                              com.google.api.client.http.HttpTransport transport)
                                                                                       throws IOException,
                                                                                              GeneralSecurityException

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

Parameters:

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

transport - The HttpTransport used for authorization

Throws:

IOException

GeneralSecurityException

getCredential

public com.google.api.client.auth.oauth2.Credential getCredential(List<String> scopes)
                                                           throws IOException,
                                                                  GeneralSecurityException

Get the credential as configured.

The following is the order in which properties are applied to create the Credential:

1. If service accounts are not disabled and no service account key file or service account parameters are set, use the metadata service.
2. If service accounts are not disabled and a service-account email and keyfile, or service account parameters are provided, use service account authentication with the given parameters.
3. If service accounts are disabled and client id, client secret and OAuth credential file is provided, use the Installed App authentication flow.
4. If service accounts are disabled and null credentials are enabled for unit testing, return null

Throws:

IllegalStateException - if none of the above conditions are met and a Credential cannot be created

IOException

GeneralSecurityException