CredentialFactory (util 1.4.5 API)

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 List<String> DATASTORE_SCOPES

static List<String> GCS_SCOPES

Fields
Modifier and Type	Field and Description
`static List<String>`	`DATASTORE_SCOPES`
`static List<String>`	`GCS_SCOPES`

Constructor Summary

Constructors
Constructor and Description

CredentialFactory()

Constructors
Constructor and Description
`CredentialFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.auth.oauth2.Credential`	`getCredentialFromFileCredentialStoreForInstalledApp(String clientId, String clientSecret, String filePath, List<String> scopes)` 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(String serviceAccountJsonKeyFile, List<String> scopes)` 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(String serviceAccountEmail, String privateKeyFile, List<String> scopes)` Initializes OAuth2 credential from a private keyfile, as described in OAuth2 Service Accounts.
`com.google.api.client.auth.oauth2.Credential`	`getDatastoreCredential(String clientId, String clientSecret)` Initializes OAuth2 credential and obtains authorization to access Datastore.
`com.google.api.client.auth.oauth2.Credential`	`getStorageCredential(String clientId, String clientSecret)` Initializes OAuth2 credential and obtains authorization to access GCS.

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 List<String> GCS_SCOPES

DATASTORE_SCOPES

public static final List<String> DATASTORE_SCOPES

Constructor Detail
- CredentialFactory
```
public CredentialFactory()
```

Method Detail

getCredentialFromMetadataServiceAccount

public 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(String serviceAccountEmail,
                                                                                              String privateKeyFile,
                                                                                              List<String> scopes)
                                                                                       throws IOException,
                                                                                              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.
Throws:: IOException; GeneralSecurityException

getCredentialFromJsonKeyFile

public com.google.api.client.auth.oauth2.Credential getCredentialFromJsonKeyFile(String serviceAccountJsonKeyFile,
                                                                                 List<String> scopes)
                                                                          throws IOException,
                                                                                 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.
Throws:: IOException; GeneralSecurityException

getCredentialFromFileCredentialStoreForInstalledApp

public com.google.api.client.auth.oauth2.Credential getCredentialFromFileCredentialStoreForInstalledApp(String clientId,
                                                                                                        String clientSecret,
                                                                                                        String filePath,
                                                                                                        List<String> scopes)
                                                                                                 throws IOException,
                                                                                                        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
Returns:: credential with desired scopes, possibly obtained from loading filePath.
Throws:: IOException - on IO error; GeneralSecurityException

getStorageCredential

public com.google.api.client.auth.oauth2.Credential getStorageCredential(String clientId,
                                                                         String clientSecret)
                                                                  throws IOException,
                                                                         GeneralSecurityException

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:: IOException - on IO error; GeneralSecurityException

getDatastoreCredential

public com.google.api.client.auth.oauth2.Credential getDatastoreCredential(String clientId,
                                                                           String clientSecret)
                                                                    throws IOException,
                                                                           GeneralSecurityException

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:: IOException - on IO error; GeneralSecurityException

Class CredentialFactory