Class CloudShellCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

com.google.auth.oauth2.CloudShellCredentials

All Implemented Interfaces:

QuotaProjectIdProvider, Serializable

public class CloudShellCredentials
extends GoogleCredentials

OAuth2 credentials representing the built-in service account for Google Cloud Shell.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CloudShellCredentials.Builder

Nested classes/interfaces inherited from class OAuth2Credentials

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

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ACCESS_TOKEN_INDEX
private final int	authPort
protected static final String	GET_AUTH_TOKEN_REQUEST	The Cloud Shell back authorization channel uses serialized Javascript Protobuffers, preceded by the message length and a new line character.
protected static final byte[]	GET_AUTH_TOKEN_REQUEST_BYTES
private static final int	READ_TIMEOUT_MS
private static final long	serialVersionUID

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

Modifier	Constructor	Description
private	CloudShellCredentials(CloudShellCredentials.Builder builder)

Method Summary

Modifier and Type	Method	Description
static CloudShellCredentials	create(int authPort)
boolean	equals(Object obj)
protected int	getAuthPort()
int	hashCode()
static CloudShellCredentials.Builder	newBuilder()
AccessToken	refreshAccessToken()	Method to refresh the access token according to the specific type of credentials.
CloudShellCredentials.Builder	toBuilder()
String	toString()

Methods inherited from class GoogleCredentials

addQuotaProjectIdToRequestMetadata, create, create, createDelegated, createScoped, createScoped, createScoped, createScopedRequired, createWithCustomRetryStrategy, createWithQuotaProject, fromStream, fromStream, getAdditionalHeaders, getApplicationDefault, getApplicationDefault, getQuotaProjectId, getUniverseDomain, isDefaultUniverseDomain, isExplicitUniverseDomain, 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

ACCESS_TOKEN_INDEX

private static final int ACCESS_TOKEN_INDEX

See Also:

• Constant Field Values

READ_TIMEOUT_MS

private static final int READ_TIMEOUT_MS

See Also:

• Constant Field Values

GET_AUTH_TOKEN_REQUEST

protected static final String GET_AUTH_TOKEN_REQUEST

The Cloud Shell back authorization channel uses serialized Javascript Protobuffers, preceded by the message length and a new line character. However, the request message has no content, so a token request consists of an empty JsPb, and its 2 character length prefix.

See Also:

• Constant Field Values

GET_AUTH_TOKEN_REQUEST_BYTES

protected static final byte[] GET_AUTH_TOKEN_REQUEST_BYTES

authPort

private final int authPort

Constructor Details

CloudShellCredentials

private CloudShellCredentials(CloudShellCredentials.Builder builder)

Method Details

create

public static CloudShellCredentials create(int authPort)

getAuthPort

protected int getAuthPort()

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

Description copied from class: OAuth2Credentials

Method to refresh the access token according to the specific type of credentials.

Throws IllegalStateException if not overridden since direct use of OAuth2Credentials is only for temporary or non-refreshing access tokens.

Overrides:

refreshAccessToken in class OAuth2Credentials

Returns:

never

Throws:

IOException

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

toBuilder

public CloudShellCredentials.Builder toBuilder()

Overrides:

toBuilder in class GoogleCredentials

newBuilder

public static CloudShellCredentials.Builder newBuilder()