Class UserCredentials (1.3.0)

Version 1.3.0

• 1.28.0 (latest)
• 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 UserCredentials extends GoogleCredentials implements QuotaProjectIdProvider, IdTokenProvider

OAuth2 Credentials representing a user's identity and consent.

Inheritance

Object > Credentials > OAuth2Credentials > GoogleCredentials > UserCredentials

Implements

QuotaProjectIdProvider, IdTokenProvider

Inherited Members

Credentials.blockingGetToCallback(URI,RequestMetadataCallback)

Credentials.getRequestMetadata()

GoogleCredentials.create(AccessToken)

GoogleCredentials.createDelegated(String)

GoogleCredentials.createScoped(String)

GoogleCredentials.createScoped(Collection<String>)

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

GoogleCredentials.createScopedRequired()

GoogleCredentials.fromStream(InputStream)

GoogleCredentials.fromStream(InputStream,HttpTransportFactory)

GoogleCredentials.getApplicationDefault()

GoogleCredentials.getApplicationDefault(HttpTransportFactory)

GoogleCredentials.newBuilder()

GoogleCredentials.toBuilder()

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

OAuth2Credentials.<T>newInstance(String)

OAuth2Credentials.addChangeListener(OAuth2Credentials.CredentialsChangedListener)

OAuth2Credentials.equals(Object)

OAuth2Credentials.getAccessToken()

OAuth2Credentials.getAdditionalHeaders()

OAuth2Credentials.getAuthenticationType()

OAuth2Credentials.getRequestMetadata(URI)

OAuth2Credentials.getRequestMetadata(URI,Executor,RequestMetadataCallback)

OAuth2Credentials.getRequestMetadataInternal()

OAuth2Credentials.hasRequestMetadata()

OAuth2Credentials.hasRequestMetadataOnly()

OAuth2Credentials.hashCode()

OAuth2Credentials.refresh()

OAuth2Credentials.refreshAccessToken()

OAuth2Credentials.refreshIfExpired()

OAuth2Credentials.removeChangeListener(OAuth2Credentials.CredentialsChangedListener)

OAuth2Credentials.toString()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

OAuth2Credentials.equals(Object obj)

fromStream(InputStream credentialsStream)

public static UserCredentials fromStream(InputStream credentialsStream)

Returns credentials defined by a JSON file stream using the format supported by the Cloud SDK.

Parameter

Name	Description
credentialsStream	InputStream the stream with the credential definition.

Returns

Type	Description
UserCredentials	the credential defined by the credentialsStream.

Exceptions

Type	Description
IOException	if the credential cannot be created from the stream.

fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory)

public static UserCredentials fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory)

Returns credentials defined by a JSON file stream using the format supported by the Cloud SDK.

Parameters

Name	Description
credentialsStream	InputStream the stream with the credential definition.
transportFactory	HttpTransportFactory HTTP transport factory, creates the transport used to get access tokens.

Returns

Type	Description
UserCredentials	the credential defined by the credentialsStream.

Exceptions

Type	Description
IOException	if the credential cannot be created from the stream.

getAdditionalHeaders()

protected Map<String,List<String>> getAdditionalHeaders()

Provide additional headers to return as request metadata.

Returns

Type	Description
Map<String,List<String>>

Overrides

OAuth2Credentials.getAdditionalHeaders()

getClientId()

public final String getClientId()

Returns client ID of the credential from the console.

Returns

Type	Description
String	client ID

getClientSecret()

public final String getClientSecret()

Returns client secret of the credential from the console.

Returns

Type	Description
String	client secret

getQuotaProjectId()

public String getQuotaProjectId()

Returns

Type	Description
String

getRefreshToken()

public final String getRefreshToken()

Returns the refresh token resulting from a OAuth2 consent flow.

Returns

Type	Description
String	refresh token

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

OAuth2Credentials.hashCode()

idTokenWithAudience(String targetAudience, List<IdTokenProvider.Option> options)

public IdToken idTokenWithAudience(String targetAudience, List<IdTokenProvider.Option> options)

Returns a Google ID Token from the refresh token response.

Parameters

Name	Description
targetAudience	String This can't be used for UserCredentials.
options	List<Option> list of Credential specific options for the token. Currently unused for UserCredentials.

Returns

Type	Description
IdToken	IdToken object which includes the raw id_token, expiration and audience

Exceptions

Type	Description
IOException	if the attempt to get an IdToken failed

newBuilder()

public static UserCredentials.Builder newBuilder()

Returns

Type	Description
UserCredentials.Builder

refreshAccessToken()

public AccessToken refreshAccessToken()

Refreshes the OAuth2 access token by getting a new access token from the refresh token

Returns

Type	Description
AccessToken

Overrides

OAuth2Credentials.refreshAccessToken()

Exceptions

Type	Description
IOException

save(String filePath)

public void save(String filePath)

Saves the end user credentials into the given file path.

Parameter

Name	Description
filePath	String Path to file where to store the credentials

Exceptions

Type	Description
IOException	An error storing the credentials.

toBuilder()

public UserCredentials.Builder toBuilder()

Returns

Type	Description
UserCredentials.Builder

Overrides

GoogleCredentials.toBuilder()

toString()

public String toString()

Returns

Type	Description
String

Overrides

OAuth2Credentials.toString()