com.google.cloud.hadoop.util

Class CredentialConfiguration

java.lang.Object

com.google.cloud.hadoop.util.CredentialConfiguration

Direct Known Subclasses:

EntriesCredentialConfiguration

public class CredentialConfiguration
extends java.lang.Object

Configuration for how components should obtain Credentials.

Constructor Summary

Constructors

Constructor and Description
CredentialConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientId()
java.lang.String	getClientSecret()
com.google.api.client.auth.oauth2.Credential	getCredential(java.util.List<java.lang.String> scopes) Get the credential as configured.
java.lang.String	getOAuthCredentialFile()
java.lang.String	getProxyAddress()
java.lang.String	getProxyPassword()
java.lang.String	getProxyUsername()
java.lang.String	getServiceAccountEmail()
java.lang.String	getServiceAccountJsonKeyFile()
java.lang.String	getServiceAccountKeyFile()
java.lang.String	getServiceAccountPrivateKey()
java.lang.String	getServiceAccountPrivateKeyId()
HttpTransportFactory.HttpTransportType	getTransportType()
boolean	isNullCredentialEnabled()
boolean	isServiceAccountEnabled()
void	setClientId(java.lang.String clientId)
void	setClientSecret(java.lang.String clientSecret)
void	setEnableServiceAccounts(boolean enableServiceAccounts)
void	setNullCredentialEnabled(boolean nullCredentialEnabled)
void	setOAuthCredentialFile(java.lang.String oAuthCredentialFile)
void	setProxyAddress(java.lang.String proxyAddress)
void	setProxyPassword(java.lang.String proxyPassword)
void	setProxyUsername(java.lang.String proxyUsername)
void	setServiceAccountEmail(java.lang.String serviceAccountEmail)
void	setServiceAccountJsonKeyFile(java.lang.String serviceAccountJsonKeyFile)
void	setServiceAccountKeyFile(java.lang.String serviceAccountKeyFile)
void	setServiceAccountPrivateKey(java.lang.String serviceAccountPrivateKey)
void	setServiceAccountPrivateKeyId(java.lang.String serviceAccountPrivateKeyId)
void	setTransportType(HttpTransportFactory.HttpTransportType transportType)
boolean	shouldUseMetadataService()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialConfiguration

public CredentialConfiguration()

Method Detail

getCredential

public com.google.api.client.auth.oauth2.Credential getCredential(java.util.List<java.lang.String> scopes)
                                                           throws java.io.IOException,
                                                                  java.security.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:

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

java.io.IOException

java.security.GeneralSecurityException

shouldUseMetadataService

public boolean shouldUseMetadataService()

getOAuthCredentialFile

public java.lang.String getOAuthCredentialFile()

setOAuthCredentialFile

public void setOAuthCredentialFile(java.lang.String oAuthCredentialFile)

isNullCredentialEnabled

public boolean isNullCredentialEnabled()

setNullCredentialEnabled

public void setNullCredentialEnabled(boolean nullCredentialEnabled)

isServiceAccountEnabled

public boolean isServiceAccountEnabled()

getServiceAccountPrivateKeyId

public java.lang.String getServiceAccountPrivateKeyId()

setServiceAccountPrivateKeyId

public void setServiceAccountPrivateKeyId(java.lang.String serviceAccountPrivateKeyId)

getServiceAccountPrivateKey

public java.lang.String getServiceAccountPrivateKey()

setServiceAccountPrivateKey

public void setServiceAccountPrivateKey(java.lang.String serviceAccountPrivateKey)

setEnableServiceAccounts

public void setEnableServiceAccounts(boolean enableServiceAccounts)

getServiceAccountEmail

public java.lang.String getServiceAccountEmail()

setServiceAccountEmail

public void setServiceAccountEmail(java.lang.String serviceAccountEmail)

getServiceAccountKeyFile

public java.lang.String getServiceAccountKeyFile()

setServiceAccountKeyFile

public void setServiceAccountKeyFile(java.lang.String serviceAccountKeyFile)

getServiceAccountJsonKeyFile

public java.lang.String getServiceAccountJsonKeyFile()

setServiceAccountJsonKeyFile

public void setServiceAccountJsonKeyFile(java.lang.String serviceAccountJsonKeyFile)

getClientId

public java.lang.String getClientId()

setClientId

public void setClientId(java.lang.String clientId)

getClientSecret

public java.lang.String getClientSecret()

setClientSecret

public void setClientSecret(java.lang.String clientSecret)

getTransportType

public HttpTransportFactory.HttpTransportType getTransportType()

setTransportType

public void setTransportType(HttpTransportFactory.HttpTransportType transportType)

getProxyAddress

public java.lang.String getProxyAddress()

setProxyAddress

public void setProxyAddress(java.lang.String proxyAddress)

getProxyUsername

public java.lang.String getProxyUsername()

setProxyUsername

public void setProxyUsername(java.lang.String proxyUsername)

getProxyPassword

public java.lang.String getProxyPassword()

setProxyPassword

public void setProxyPassword(java.lang.String proxyPassword)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object