com.google.cloud

Class AuthCredentials

java.lang.Object

com.google.cloud.AuthCredentials

All Implemented Interfaces:

Restorable<AuthCredentials>

Direct Known Subclasses:

AuthCredentials.AppEngineAuthCredentials, AuthCredentials.ApplicationDefaultAuthCredentials, AuthCredentials.NoAuthCredentials, AuthCredentials.OAuth2AuthCredentials, AuthCredentials.ServiceAccountAuthCredentials

public abstract class AuthCredentials
extends Object
implements Restorable<AuthCredentials>

Credentials for accessing Google Cloud services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthCredentials.AppEngineAuthCredentials Represents built-in credentials when running in Google App Engine.
static class	AuthCredentials.ApplicationDefaultAuthCredentials Represents Application Default Credentials, which are credentials that are inferred from the runtime environment.
static class	AuthCredentials.NoAuthCredentials A placeholder for credentials to signify that requests sent to the server should not be authenticated.
static class	AuthCredentials.OAuth2AuthCredentials Represents OAuth2 credentials.
static class	AuthCredentials.ServiceAccountAuthCredentials Represents service account credentials.

Constructor Summary

Constructors

Constructor and Description
AuthCredentials()

Method Summary

Methods

Modifier and Type	Method and Description
static AuthCredentials	createApplicationDefaults() Returns the Application Default Credentials.
static AuthCredentials.OAuth2AuthCredentials	createFor(String accessToken) Creates OAuth2 Credentials given the string representation of an access token.
static AuthCredentials.OAuth2AuthCredentials	createFor(String accessToken, Date expirationTime) Creates OAuth2 Credentials given the string representation of an access token and its expiration time.
static AuthCredentials.ServiceAccountAuthCredentials	createFor(String account, PrivateKey privateKey) Creates Service Account Credentials given an account id and a private key.
static AuthCredentials	createForAppEngine()
static AuthCredentials.ServiceAccountAuthCredentials	createForJson(InputStream jsonCredentialStream) Creates Service Account Credentials given a stream for credentials in JSON format.
abstract com.google.auth.oauth2.GoogleCredentials	credentials()
static AuthCredentials	noAuth() Creates a placeholder denoting that no credentials should be used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.cloud.Restorable

capture

Constructor Detail

AuthCredentials

public AuthCredentials()

Method Detail

credentials

public abstract com.google.auth.oauth2.GoogleCredentials credentials()

createForAppEngine

public static AuthCredentials createForAppEngine()

createApplicationDefaults

public static AuthCredentials createApplicationDefaults()
                                                 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 can be read 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

createFor

public static AuthCredentials.ServiceAccountAuthCredentials createFor(String account,
                                                      PrivateKey privateKey)

Creates Service Account Credentials given an account id and a private key.

For details on how to obtain Service Account Credentials see Service Account Authentication.

Parameters:

account - id of the Service Account

privateKey - private key associated to the account

Returns:

the credentials instance

createFor

public static AuthCredentials.OAuth2AuthCredentials createFor(String accessToken)

Creates OAuth2 Credentials given the string representation of an access token. The access token will not be automatically refreshed.

Parameters:

accessToken - string representation of an access token

Returns:

the credentials instance

createFor

public static AuthCredentials.OAuth2AuthCredentials createFor(String accessToken,
                                              Date expirationTime)

Creates OAuth2 Credentials given the string representation of an access token and its expiration time. The access token will not be automatically refreshed.

Parameters:

accessToken - string representation of an access token

Returns:

the credentials instance

noAuth

public static AuthCredentials noAuth()

Creates a placeholder denoting that no credentials should be used. This is typically useful when using the local service emulators, such as LocalDatastoreHelper and LocalResourceManagerHelper.

createForJson

public static AuthCredentials.ServiceAccountAuthCredentials createForJson(InputStream jsonCredentialStream)
                                                                   throws IOException

Creates Service Account Credentials given a stream for credentials in JSON format.

For details on how to obtain Service Account Credentials in JSON format see Service Account Authentication.

Parameters:

jsonCredentialStream - stream for Service Account Credentials in JSON format

Returns:

the credentials instance

Throws:

IOException - if the credentials cannot be created from the stream