com.google.cloud.hadoop.util

Class EntriesCredentialConfiguration

java.lang.Object

com.google.cloud.hadoop.util.CredentialConfiguration

com.google.cloud.hadoop.util.EntriesCredentialConfiguration

public class EntriesCredentialConfiguration
extends CredentialConfiguration

CredentialConfiguration based on configuration objects that implement our Entries interface. When reading configuration this class makes use of a list of key prefixes that are each applied to key suffixes to create a complete configuration key. There is a base prefix of 'google.cloud.' that is included by the builder for each EntriesCredentialConfiguration created. When constructing, other prefixes can be specified. Prefixes specified later can be used to override the values of previously set values. In this way a set of global credentials can be specified for most connectors with an override specified for any connectors that need different credentials.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntriesCredentialConfiguration.Builder<B extends EntriesCredentialConfiguration.Builder<B,T>,T extends EntriesCredentialConfiguration> Builder for constructing CredentialConfiguration instances.
static interface	EntriesCredentialConfiguration.Entries The interface to interact with the configuration object.
static class	EntriesCredentialConfiguration.EntriesBuilder A builder for use without a subclasses of EntriesCredentialConfiguration.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_KEY_PREFIX All instances constructed using the builder will use "google.cloud" as the first prefix checked.
static String	CLIENT_ID_SUFFIX For OAuth-based Installed App authentication, the key suffix specifying the client ID for the credentials.
static String	CLIENT_SECRET_SUFFIX For OAuth-based Installed App authentication, the key suffix specifying the client secret for the credentials.
static String	ENABLE_NULL_CREDENTIAL_SUFFIX For unit-testing, the key suffix allowing null to be returned from credential creation instead of logging an error and aborting.
static String	ENABLE_SERVICE_ACCOUNTS_SUFFIX Key suffix used to disable service accounts.
static String	OAUTH_CLIENT_FILE_SUFFIX For OAuth-based Installed App authentication, the key suffix specifying the file containing credentials (JWT).
static String	SERVICE_ACCOUNT_EMAIL_SUFFIX Key suffix used to control which email address is associated with the service account.
static String	SERVICE_ACCOUNT_KEYFILE_SUFFIX Key suffix used to indicate the path to the service account p12 keyfile.

Fields inherited from class com.google.cloud.hadoop.util.CredentialConfiguration

LOG

Constructor Summary

Constructors

Constructor and Description
EntriesCredentialConfiguration(List<String> prefixes)

Method Summary

Methods

Modifier and Type	Method and Description
void	getConfigurationInto(EntriesCredentialConfiguration.Entries configuration) Gets our parameters and fills it into the specified configuration.
static EntriesCredentialConfiguration.EntriesBuilder	newEntriesBuilder() Create a builder for this class.
void	setConfiguration(EntriesCredentialConfiguration.Entries entries) Load configuration values from the provided configuration source.

Methods inherited from class com.google.cloud.hadoop.util.CredentialConfiguration

getClientId, getClientSecret, getCredential, getOAuthCredentialFile, getServiceAccountEmail, getServiceAccountKeyFile, isNullCredentialEnabled, isServiceAccountEnabled, setClientId, setClientSecret, setEnableServiceAccounts, setNullCredentialEnabled, setOAuthCredentialFile, setServiceAccountEmail, setServiceAccountKeyFile, shouldUseMetadataService, toString

Methods inherited from class java.lang.Object

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

Field Detail

BASE_KEY_PREFIX

public static final String BASE_KEY_PREFIX

All instances constructed using the builder will use "google.cloud" as the first prefix checked. Other prefixes can be added and will override values in the google.cloud prefix.

See Also:

Constant Field Values

ENABLE_SERVICE_ACCOUNTS_SUFFIX

public static final String ENABLE_SERVICE_ACCOUNTS_SUFFIX

Key suffix used to disable service accounts. A value of 'false' will disable the use of service accounts. The default is to use a service account.

See Also:

Constant Field Values

SERVICE_ACCOUNT_EMAIL_SUFFIX

public static final String SERVICE_ACCOUNT_EMAIL_SUFFIX

Key suffix used to control which email address is associated with the service account.

See Also:

Constant Field Values

SERVICE_ACCOUNT_KEYFILE_SUFFIX

public static final String SERVICE_ACCOUNT_KEYFILE_SUFFIX

Key suffix used to indicate the path to the service account p12 keyfile. If provided, triggers private keyfile service account authentication. The file will be required to be present on all nodes and at the same location on all nodes.

See Also:

Constant Field Values

CLIENT_ID_SUFFIX

public static final String CLIENT_ID_SUFFIX

For OAuth-based Installed App authentication, the key suffix specifying the client ID for the credentials.

See Also:

Constant Field Values

CLIENT_SECRET_SUFFIX

public static final String CLIENT_SECRET_SUFFIX

For OAuth-based Installed App authentication, the key suffix specifying the client secret for the credentials.

See Also:

Constant Field Values

OAUTH_CLIENT_FILE_SUFFIX

public static final String OAUTH_CLIENT_FILE_SUFFIX

For OAuth-based Installed App authentication, the key suffix specifying the file containing credentials (JWT).

See Also:

Constant Field Values

ENABLE_NULL_CREDENTIAL_SUFFIX

public static final String ENABLE_NULL_CREDENTIAL_SUFFIX

For unit-testing, the key suffix allowing null to be returned from credential creation instead of logging an error and aborting.

See Also:

Constant Field Values

Constructor Detail

EntriesCredentialConfiguration

public EntriesCredentialConfiguration(List<String> prefixes)

Method Detail

newEntriesBuilder

public static EntriesCredentialConfiguration.EntriesBuilder newEntriesBuilder()

Create a builder for this class.

getConfigurationInto

public void getConfigurationInto(EntriesCredentialConfiguration.Entries configuration)

Gets our parameters and fills it into the specified configuration. Typically the passed-in configuration is an empty instance of a configuration object that extends Entries.

setConfiguration

public void setConfiguration(EntriesCredentialConfiguration.Entries entries)

Load configuration values from the provided configuration source. For any key that does not have a corresponding value in the configuration, no changes will be made to the state of this object.