Class AppEngineCredentials (1.46.0)

1.46.0 (latest) 1.43.0 1.42.1 1.41.0 1.40.0 1.39.1 1.38.0 1.37.1 1.36.0 1.35.0 1.34.0 1.33.1 1.32.1 1.31.0 1.30.1 1.29.1-SNAPSHOT 1.28.0 1.27.0 1.26.0 1.25.0 1.24.1 1.20.0 1.19.0 1.18.0 1.7.0 1.6.1 1.4.0 1.3.0

public class AppEngineCredentials extends GoogleCredentials implements ServiceAccountSigner

OAuth2 credentials representing the built-in service account for Google App Engine. You should only use this class if you are running on AppEngine and are using urlfetch.

Fetches access tokens from the App Identity service.

Inheritance

Object > Credentials > OAuth2Credentials > GoogleCredentials > AppEngineCredentials

Implements

ServiceAccountSigner

Inherited Members

Credentials.blockingGetToCallback(URI,RequestMetadataCallback)

Credentials.getMetricsCredentialType()

Credentials.getRequestMetadata()

GoogleCredentials.create(AccessToken)

GoogleCredentials.create(String,AccessToken)

GoogleCredentials.createDelegated(String)

GoogleCredentials.createScoped(String)

GoogleCredentials.createScoped(Collection<String>)

GoogleCredentials.createScoped(Collection<String>,Collection<String>)

GoogleCredentials.createScopedRequired()

GoogleCredentials.createWithCustomRetryStrategy(boolean)

GoogleCredentials.createWithQuotaProject(String)

GoogleCredentials.equals(Object)

GoogleCredentials.fromStream(InputStream)

GoogleCredentials.fromStream(InputStream,HttpTransportFactory)

GoogleCredentials.getAdditionalHeaders()

GoogleCredentials.getApplicationDefault()

GoogleCredentials.getApplicationDefault(HttpTransportFactory)

GoogleCredentials.getCredentialInfo()

GoogleCredentials.getProjectId()

GoogleCredentials.getQuotaProjectId()

GoogleCredentials.getUniverseDomain()

GoogleCredentials.hashCode()

GoogleCredentials.isExplicitUniverseDomain()

GoogleCredentials.newBuilder()

GoogleCredentials.toBuilder()

GoogleCredentials.toString()

GoogleCredentials.toStringHelper()

OAuth2Credentials.<T>getFromServiceLoader(Class<? extends T>,T)

OAuth2Credentials.addChangeListener(OAuth2Credentials.CredentialsChangedListener)

OAuth2Credentials.getAccessToken()

OAuth2Credentials.getAuthenticationType()

OAuth2Credentials.getRequestMetadata(URI)

OAuth2Credentials.getRequestMetadata(URI,Executor,RequestMetadataCallback)

OAuth2Credentials.getRequestMetadataInternal()

OAuth2Credentials.hasRequestMetadata()

OAuth2Credentials.hasRequestMetadataOnly()

OAuth2Credentials.newInstance(String)

OAuth2Credentials.refresh()

OAuth2Credentials.refreshAccessToken()

OAuth2Credentials.refreshIfExpired()

OAuth2Credentials.removeChangeListener(OAuth2Credentials.CredentialsChangedListener)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder()

public static AppEngineCredentials.Builder newBuilder()

Returns
Type	Description
AppEngineCredentials.Builder

Methods

createScoped(Collection<String> scopes)

public 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.

Parameter
Name	Description
scopes	Collection<String>

Returns
Type	Description
GoogleCredentials

Overrides

GoogleCredentials.createScoped(Collection<String> scopes)

createScopedRequired()

public boolean createScopedRequired()

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

Returns
Type	Description
boolean

Overrides

GoogleCredentials.createScopedRequired()

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

GoogleCredentials.equals(Object obj)

getAccount()

public String getAccount()

Returns the service account associated with the signer.

Returns
Type	Description
String

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

GoogleCredentials.hashCode()

refreshAccessToken()

public AccessToken refreshAccessToken()

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

Returns
Type	Description
AccessToken

Overrides

OAuth2Credentials.refreshAccessToken()

Exceptions
Type	Description
IOException

sign(byte[] toSign)

public byte[] sign(byte[] toSign)

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

Parameter
Name	Description
toSign	byte[]

Returns
Type	Description
byte[]

toBuilder()

public AppEngineCredentials.Builder toBuilder()

Returns
Type	Description
AppEngineCredentials.Builder

Overrides

GoogleCredentials.toBuilder()

toString()

public String toString()

Returns a string representation of this credential, including request metadata and access token.

Security Warning: The output of this method includes the request metadata which contains the raw Bearer access token, and the raw access token value. Do not log this output in production environments as it may expose sensitive credentials.

Returns
Type	Description
String

Overrides

GoogleCredentials.toString()