com.google.auth.oauth2

Class GdchCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

com.google.auth.oauth2.GdchCredentials

All Implemented Interfaces:

QuotaProjectIdProvider, Serializable

public class GdchCredentials
extends GoogleCredentials

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GdchCredentials.Builder

Nested classes/interfaces inherited from class com.google.auth.oauth2.OAuth2Credentials

OAuth2Credentials.CredentialsChangedListener

Field Summary

Fields inherited from class com.google.auth.oauth2.GoogleCredentials

quotaProjectId

Fields inherited from class com.google.auth.Credentials

GOOGLE_DEFAULT_UNIVERSE

Method Summary

Modifier and Type	Method and Description
GdchCredentials	createWithGdchAudience(URI apiAudience) Create a copy of GDCH credentials with the specified audience.
boolean	equals(Object obj)
static GdchCredentials	fromStream(InputStream credentialsStream) Returns credentials defined by a GdchCredentials key file in JSON format from the Google Developers Console.
static GdchCredentials	fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory) Returns credentials defined by a GdchCredentials key file in JSON format from the Google Developers Console.
URI	getApiAudience()
String	getCaCertPath()
PrivateKey	getPrivateKey()
String	getPrivateKeyId()
String	getProjectId() The projectId value for a Credential type.
String	getServiceIdentityName()
URI	getTokenServerUri()
HttpTransportFactory	getTransportFactory()
int	hashCode()
static GdchCredentials.Builder	newBuilder()
AccessToken	refreshAccessToken() Refresh the OAuth2 access token by getting a new access token using a JSON Web Token (JWT).
GdchCredentials.Builder	toBuilder()
String	toString()

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

create, create, createDelegated, createScoped, createScoped, createScoped, createScopedRequired, createWithCustomRetryStrategy, createWithQuotaProject, getAdditionalHeaders, getApplicationDefault, getApplicationDefault, getCredentialInfo, getQuotaProjectId, getUniverseDomain, isExplicitUniverseDomain, toStringHelper

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

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

Methods inherited from class com.google.auth.Credentials

blockingGetToCallback, getMetricsCredentialType, getRequestMetadata

Methods inherited from class java.lang.Object

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

Method Detail

fromStream

public static GdchCredentials fromStream(InputStream credentialsStream)
                                  throws IOException

Returns credentials defined by a GdchCredentials key file in JSON format from the Google Developers Console.

Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information, refer to documentation.

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 GdchCredentials fromStream(InputStream credentialsStream,
                                         HttpTransportFactory transportFactory)
                                  throws IOException

Returns credentials defined by a GdchCredentials key file in JSON format from the Google Developers Console.

Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information, refer to documentation.

Parameters:

credentialsStream - the stream with the credential definition.

transportFactory - HTTP transport factory, creates the transport used to get access tokens.

Returns:

the credential defined by the credentialsStream.

Throws:

IOException - if the credential cannot be created from the stream.

createWithGdchAudience

public GdchCredentials createWithGdchAudience(URI apiAudience)
                                       throws IOException

Create a copy of GDCH credentials with the specified audience.

Parameters:

apiAudience - The intended audience for GDCH credentials.

Throws:

IOException

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

Refresh the OAuth2 access token by getting a new access token using a JSON Web Token (JWT).

For GDCH credentials, this class creates a self-signed JWT, and sends to the GDCH authentication endpoint (tokenServerUri) to exchange an access token for the intended api audience (apiAudience).

Overrides:

refreshAccessToken in class OAuth2Credentials

Returns:

never

Throws:

IOException

getProjectId

public final String getProjectId()

Description copied from class: GoogleCredentials

The projectId value for a Credential type. Since not all GoogleCredentials subclass have a projectId associated, the projectId may be null. A subset of GoogleCredentials subclasses will override to return their projectId.

Overrides:

getProjectId in class GoogleCredentials

Returns:

the projectId set in the GDCH SA Key file or the user set projectId

getPrivateKeyId

public final String getPrivateKeyId()

getPrivateKey

public final PrivateKey getPrivateKey()

getServiceIdentityName

public final String getServiceIdentityName()

getTokenServerUri

public final URI getTokenServerUri()

getApiAudience

public final URI getApiAudience()

getTransportFactory

public final HttpTransportFactory getTransportFactory()

getCaCertPath

public final String getCaCertPath()

newBuilder

public static GdchCredentials.Builder newBuilder()

toBuilder

public GdchCredentials.Builder toBuilder()

Overrides:

toBuilder in class GoogleCredentials

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