Class AppEngineCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

com.google.auth.oauth2.AppEngineCredentials

All Implemented Interfaces:

QuotaProjectIdProvider, ServiceAccountSigner, Serializable

class AppEngineCredentials
extends GoogleCredentials
implements ServiceAccountSigner

OAuth2 credentials representing the built-in service account for Google App Engine.

Instances of this class use reflection to access AppIdentityService in AppEngine SDK.

Nested Class Summary

Nested classes/interfaces inherited from class GoogleCredentials

GoogleCredentials.Builder

Nested classes/interfaces inherited from class OAuth2Credentials

OAuth2Credentials.AsyncRefreshResult, OAuth2Credentials.CacheState, OAuth2Credentials.CredentialsChangedListener, OAuth2Credentials.FutureCallbackToMetadataCallbackAdapter, OAuth2Credentials.OAuthValue, OAuth2Credentials.RefreshTask, OAuth2Credentials.RefreshTaskListener

Nested classes/interfaces inherited from interface ServiceAccountSigner

ServiceAccountSigner.SigningException

Field Summary

Fields

Modifier and Type	Field	Description
private String	account
(package private) static final String	APP_IDENTITY_SERVICE_CLASS
(package private) static final String	APP_IDENTITY_SERVICE_FACTORY_CLASS
private Object	appIdentityService
private static final String	GET_ACCESS_TOKEN_METHOD
(package private) static final String	GET_ACCESS_TOKEN_RESULT_CLASS
private static final String	GET_ACCESS_TOKEN_RESULT_METHOD
private static final String	GET_APP_IDENTITY_SERVICE_METHOD
private static final String	GET_EXPIRATION_TIME_METHOD
private static final String	GET_SERVICE_ACCOUNT_NAME_METHOD
private static final String	GET_SIGNATURE_METHOD
private Method	getAccessToken
private Method	getAccessTokenResult
private Method	getExpirationTime
private Method	getSignature
private final Collection<String>	scopes
private final boolean	scopesRequired
private static final long	serialVersionUID
private static final String	SIGN_FOR_APP_METHOD
private Method	signForApp
(package private) static final String	SIGNING_RESULT_CLASS

Fields inherited from class GoogleCredentials

GDCH_SERVICE_ACCOUNT_FILE_TYPE, QUOTA_PROJECT_ID_HEADER_KEY, quotaProjectId, SERVICE_ACCOUNT_FILE_TYPE, USER_FILE_TYPE

Fields inherited from class OAuth2Credentials

clock, DEFAULT_EXPIRATION_MARGIN, DEFAULT_REFRESH_MARGIN, lock, refreshTask

Fields inherited from class Credentials

GOOGLE_DEFAULT_UNIVERSE

Constructor Summary

Constructors

Constructor	Description
AppEngineCredentials(Collection<String> scopes, Collection<String> defaultScopes)
AppEngineCredentials(Collection<String> scopes, Collection<String> defaultScopes, AppEngineCredentials unscoped)

Method Summary

Modifier and Type	Method	Description
GoogleCredentials	createScoped(Collection<String> scopes)	If the credentials support scopes, creates a copy of the identity with the specified scopes, invalidates the existing scoped access token; otherwise, return the same instance.
GoogleCredentials	createScoped(Collection<String> scopes, Collection<String> defaultScopes)	If the credentials support scopes, creates a copy of the identity with the specified scopes and default scopes; otherwise, returns the same instance.
boolean	createScopedRequired()	Indicates whether the credentials require scopes to be specified via a call to GoogleCredentials.createScoped(Collection) before use.
boolean	equals(Object obj)
(package private) Class<?>	forName(String className)
String	getAccount()	Returns the service account associated with the signer.
int	hashCode()
private void	init()
private void	readObject(ObjectInputStream input)
AccessToken	refreshAccessToken()	Refresh the access token by getting it from the App Identity service.
byte[]	sign(byte[] toSign)	Signs the provided bytes using the private key associated with the service account.
String	toString()

Methods inherited from class GoogleCredentials

addQuotaProjectIdToRequestMetadata, create, create, createDelegated, createScoped, createWithCustomRetryStrategy, createWithQuotaProject, fromStream, fromStream, getAdditionalHeaders, getApplicationDefault, getApplicationDefault, getQuotaProjectId, getUniverseDomain, isDefaultUniverseDomain, isExplicitUniverseDomain, newBuilder, toBuilder, toStringHelper

Methods inherited from class OAuth2Credentials

addChangeListener, getAccessToken, getAuthenticationType, getExpirationMargin, getFromServiceLoader, getRefreshMargin, getRequestMetadata, getRequestMetadata, getRequestMetadataInternal, hasRequestMetadata, hasRequestMetadataOnly, newInstance, refresh, refreshIfExpired, removeChangeListener

Methods inherited from class Credentials

blockingGetToCallback, getMetricsCredentialType, getRequestMetadata

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

APP_IDENTITY_SERVICE_FACTORY_CLASS

static final String APP_IDENTITY_SERVICE_FACTORY_CLASS

See Also:

• Constant Field Values

APP_IDENTITY_SERVICE_CLASS

static final String APP_IDENTITY_SERVICE_CLASS

See Also:

• Constant Field Values

GET_ACCESS_TOKEN_RESULT_CLASS

static final String GET_ACCESS_TOKEN_RESULT_CLASS

See Also:

• Constant Field Values

SIGNING_RESULT_CLASS

static final String SIGNING_RESULT_CLASS

See Also:

• Constant Field Values

GET_APP_IDENTITY_SERVICE_METHOD

private static final String GET_APP_IDENTITY_SERVICE_METHOD

See Also:

• Constant Field Values

GET_ACCESS_TOKEN_RESULT_METHOD

private static final String GET_ACCESS_TOKEN_RESULT_METHOD

See Also:

• Constant Field Values

GET_ACCESS_TOKEN_METHOD

private static final String GET_ACCESS_TOKEN_METHOD

See Also:

• Constant Field Values

GET_EXPIRATION_TIME_METHOD

private static final String GET_EXPIRATION_TIME_METHOD

See Also:

• Constant Field Values

GET_SERVICE_ACCOUNT_NAME_METHOD

private static final String GET_SERVICE_ACCOUNT_NAME_METHOD

See Also:

• Constant Field Values

SIGN_FOR_APP_METHOD

private static final String SIGN_FOR_APP_METHOD

See Also:

• Constant Field Values

GET_SIGNATURE_METHOD

private static final String GET_SIGNATURE_METHOD

See Also:

• Constant Field Values

scopes

private final Collection<String> scopes

scopesRequired

private final boolean scopesRequired

appIdentityService

private transient Object appIdentityService

getAccessToken

private transient Method getAccessToken

getAccessTokenResult

private transient Method getAccessTokenResult

getExpirationTime

private transient Method getExpirationTime

signForApp

private transient Method signForApp

getSignature

private transient Method getSignature

account

private transient String account

Constructor Details

AppEngineCredentials

AppEngineCredentials(Collection<String> scopes,
 Collection<String> defaultScopes)
              throws IOException

Throws:

IOException

AppEngineCredentials

AppEngineCredentials(Collection<String> scopes,
 Collection<String> defaultScopes,
 AppEngineCredentials unscoped)

Method Details

init

private void init()
           throws IOException

Throws:

IOException

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

Refresh the access token by getting it from the App Identity service.

Overrides:

refreshAccessToken in class OAuth2Credentials

Returns:

never

Throws:

IOException

createScopedRequired

public boolean createScopedRequired()

Description copied from class: GoogleCredentials

Indicates whether the credentials require scopes to be specified via a call to GoogleCredentials.createScoped(Collection) before use.

Overrides:

createScopedRequired in class GoogleCredentials

Returns:

Whether the credentials require scopes to be specified.

createScoped

public GoogleCredentials createScoped(Collection<String> scopes)

Description copied from class: GoogleCredentials

If the credentials support scopes, creates a copy of the identity with the specified scopes, invalidates the existing scoped access token; otherwise, return the same instance.

Overrides:

createScoped in class GoogleCredentials

Parameters:

scopes - Collection of scopes to request.

Returns:

GoogleCredentials with requested scopes.

createScoped

public GoogleCredentials createScoped(Collection<String> scopes,
 Collection<String> defaultScopes)

Description copied from class: GoogleCredentials

If the credentials support scopes, creates a copy of the identity with the specified scopes and default scopes; otherwise, returns the same instance. This is mainly used by client libraries.

Overrides:

createScoped in class GoogleCredentials

Parameters:

scopes - Collection of scopes to request.

defaultScopes - Collection of default scopes to request.

Returns:

GoogleCredentials with requested scopes.

getAccount

public String getAccount()

Description copied from interface: ServiceAccountSigner

Returns the service account associated with the signer.

Specified by:

getAccount in interface ServiceAccountSigner

Returns:

The service account associated with the signer.

sign

public byte[] sign(byte[] toSign)

Description copied from interface: ServiceAccountSigner

Signs the provided bytes using the private key associated with the service account.

Specified by:

sign in interface ServiceAccountSigner

Parameters:

toSign - bytes to sign

Returns:

signed bytes

hashCode

public int hashCode()

Overrides:

hashCode in class GoogleCredentials

toString

public String toString()

Overrides:

toString in class GoogleCredentials

equals

public boolean equals(Object obj)

Overrides:

equals in class GoogleCredentials

readObject

private void readObject(ObjectInputStream input)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

forName

Class<?> forName(String className)
          throws ClassNotFoundException

Throws:

ClassNotFoundException