com.google.auth.oauth2

Class GoogleCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CloudShellCredentials, ComputeEngineCredentials, ServiceAccountCredentials, UserCredentials

public class GoogleCredentials
extends OAuth2Credentials

Base type for credentials for authorizing calls to Google APIs using OAuth2.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.auth.oauth2.OAuth2Credentials

OAuth2Credentials.CredentialsChangedListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GoogleCredentials() Default constructor.
	GoogleCredentials(AccessToken accessToken) Constructor with explicit access token.

Method Summary

Methods

Modifier and Type	Method and Description
GoogleCredentials	createDelegated(String user) If the credentials support domain-wide delegation, creates a copy of the identity so that it impersonates the specified user; otherwise, returns the same instance.
GoogleCredentials	createScoped(Collection<String> scopes) If the credentials support scopes, creates a copy of the the identity with the specified scopes; otherwise, returns the same instance.
boolean	createScopedRequired() Indicates whether the credentials require scopes to be specified via a call to {link GoogleCredentials#createScoped} before use.
static GoogleCredentials	fromStream(InputStream credentialsStream) Returns credentials defined by a JSON file stream.
static GoogleCredentials	fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory) Returns credentials defined by a JSON file stream.
static GoogleCredentials	getApplicationDefault() Returns the Application Default Credentials.
static GoogleCredentials	getApplicationDefault(HttpTransportFactory transportFactory) Returns the Application Default Credentials.

Methods inherited from class com.google.auth.oauth2.OAuth2Credentials

addChangeListener, equals, getAccessToken, getAuthenticationType, getFromServiceLoader, getRequestMetadata, getRequestMetadata, hashCode, hasRequestMetadata, hasRequestMetadataOnly, newInstance, refresh, refreshAccessToken, toString, toStringHelper

Methods inherited from class com.google.auth.Credentials

blockingGetToCallback, getRequestMetadata

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GoogleCredentials

protected GoogleCredentials()

Default constructor.

GoogleCredentials

public GoogleCredentials(AccessToken accessToken)

Constructor with explicit access token.

Parameters:

accessToken - Initial or temporary access token.

Method Detail

getApplicationDefault

public static GoogleCredentials getApplicationDefault()
                                               throws IOException

Returns the Application Default Credentials.

Returns the Application Default Credentials which are used to identify and authorize the whole application. The following are searched (in order) to find the Application Default Credentials:

1. Credentials file pointed to by the GOOGLE_APPLICATION_CREDENTIALS environment variable
2. Credentials provided by the Google Cloud SDK gcloud auth application-default login command
3. Google App Engine built-in credentials
4. Google Cloud Shell built-in credentials
5. Google Compute Engine built-in credentials

Returns:

the credentials instance.

Throws:

IOException - if the credentials cannot be created in the current environment.

getApplicationDefault

public static GoogleCredentials getApplicationDefault(HttpTransportFactory transportFactory)
                                               throws IOException

Returns the Application Default Credentials.

Returns the Application Default Credentials which are used to identify and authorize the whole application. The following are searched (in order) to find the Application Default Credentials:

1. Credentials file pointed to by the GOOGLE_APPLICATION_CREDENTIALS environment variable
2. Credentials provided by the Google Cloud SDK gcloud auth application-default login command
3. Google App Engine built-in credentials
4. Google Cloud Shell built-in credentials
5. Google Compute Engine built-in credentials

Parameters:

transportFactory - HTTP transport factory, creates the transport used to get access tokens.

Returns:

the credentials instance.

Throws:

IOException - if the credentials cannot be created in the current environment.

fromStream

public static GoogleCredentials fromStream(InputStream credentialsStream)
                                    throws IOException

Returns credentials defined by a JSON file stream.

The stream can contain a Service Account key file in JSON format from the Google Developers Console or a stored user credential using the format supported by the Cloud SDK.

Parameters:

credentialsStream - the stream with the credential definition.

Returns:

the credential defined by the credentialsStream.

Throws:

IOException - if the credential cannot be created from the stream.

fromStream

public static GoogleCredentials fromStream(InputStream credentialsStream,
                           HttpTransportFactory transportFactory)
                                    throws IOException

Returns credentials defined by a JSON file stream.

The stream can contain a Service Account key file in JSON format from the Google Developers Console or a stored user credential using the format supported by the Cloud SDK.

Parameters:

credentialsStream - the stream with the credential definition.

transportFactory - HTTP transport factory, creates the transport used to get access tokens.

Returns:

the credential defined by the credentialsStream.

Throws:

IOException - if the credential cannot be created from the stream.

createScopedRequired

public boolean createScopedRequired()

Indicates whether the credentials require scopes to be specified via a call to {link GoogleCredentials#createScoped} before use.

createScoped

public GoogleCredentials createScoped(Collection<String> scopes)

If the credentials support scopes, creates a copy of the the identity with the specified scopes; otherwise, returns the same instance.

createDelegated

public GoogleCredentials createDelegated(String user)

If the credentials support domain-wide delegation, creates a copy of the identity so that it impersonates the specified user; otherwise, returns the same instance.