com.google.auth.oauth2

Class GoogleCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

Direct Known Subclasses:

ComputeEngineCredentials, ServiceAccountCredentials, UserCredentials

public abstract class GoogleCredentials
extends OAuth2Credentials

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

Constructor Summary

Constructors

Constructor and Description
GoogleCredentials()

Method Summary

Methods

Modifier and Type	Method and Description
GoogleCredentials	createScoped(Collection<String> scopes) If the credentials support scopes, create a copy of the the idenitity 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, com.google.api.client.http.HttpTransport transport) Returns credentials defined by a JSON file stream.
static GoogleCredentials	getApplicationDefault() Returns the Application Default Credentials.
static GoogleCredentials	getApplicationDefault(com.google.api.client.http.HttpTransport transport) Returns the Application Default Credentials.

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

getAuthenticationType, getRequestMetadata, hasRequestMetadata, hasRequestMetadataOnly, refresh, refreshAccessToken

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleCredentials

public GoogleCredentials()

Method Detail

getApplicationDefault

public static GoogleCredentials getApplicationDefault()
                                               throws IOException

Returns the Application Default Credentials.

Returns the Application Default Credentials which are credentials that identify and authorize the whole application. This is the built-in service account if running on Google Compute Engine or the credentials file from the path in the environment variable GOOGLE_APPLICATION_CREDENTIALS.

Returns:

the credentials instance.

Throws:

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

getApplicationDefault

public static GoogleCredentials getApplicationDefault(com.google.api.client.http.HttpTransport transport)
                                               throws IOException

Returns the Application Default Credentials.

Returns the Application Default Credentials which are credentials that identify and authorize the whole application. This is the built-in service account if running on Google Compute Engine or the credentials file from the path in the environment variable GOOGLE_APPLICATION_CREDENTIALS.

Parameters:

transport - the transport for Http calls.

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,
                           com.google.api.client.http.HttpTransport transport)
                                    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.

transport - the transport for Http calls.

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, create a copy of the the idenitity with the specified scopes, otherwise returns the same instance.