com.google.auth.oauth2

Class UserCredentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.GoogleCredentials

com.google.auth.oauth2.UserCredentials

All Implemented Interfaces:

Serializable

public class UserCredentials
extends GoogleCredentials

OAuth2 Credentials representing a user's identity and consent.

See Also:

Serialized Form

Nested Class Summary

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

OAuth2Credentials.CredentialsChangedListener

Constructor Summary

Constructors

Constructor and Description
UserCredentials(String clientId, String clientSecret, String refreshToken) Constructor with minimum information and default behavior.
UserCredentials(String clientId, String clientSecret, String refreshToken, AccessToken accessToken) Constructor to allow both refresh token and initial access token for 3LO scenarios.
UserCredentials(String clientId, String clientSecret, String refreshToken, AccessToken accessToken, HttpTransportFactory transportFactory, URI tokenServerUri) Constructor with all parameters allowing custom transport and server URL.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static UserCredentials	fromStream(InputStream credentialsStream) Returns credentials defined by a JSON file stream using the format supported by the Cloud SDK.
static UserCredentials	fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory) Returns credentials defined by a JSON file stream using the format supported by the Cloud SDK.
String	getClientId() Returns client ID of the credential from the console.
String	getClientSecret() Returns client secret of the credential from the console.
String	getRefreshToken() Returns the refresh token resulting from a OAuth2 consent flow.
int	hashCode()
AccessToken	refreshAccessToken() Refreshes the OAuth2 access token by getting a new access token from the refresh token
String	toString()

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

createDelegated, createScoped, createScopedRequired, getApplicationDefault, getApplicationDefault

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

addChangeListener, getAccessToken, getAuthenticationType, getFromServiceLoader, getRequestMetadata, getRequestMetadata, hasRequestMetadata, hasRequestMetadataOnly, newInstance, refresh, toStringHelper

Methods inherited from class com.google.auth.Credentials

blockingGetToCallback, getRequestMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

UserCredentials

public UserCredentials(String clientId,
                       String clientSecret,
                       String refreshToken)

Constructor with minimum information and default behavior.

Parameters:

clientId - Client ID of the credential from the console.

clientSecret - Client ID of the credential from the console.

refreshToken - A refresh token resulting from a OAuth2 consent flow.

UserCredentials

public UserCredentials(String clientId,
                       String clientSecret,
                       String refreshToken,
                       AccessToken accessToken)

Constructor to allow both refresh token and initial access token for 3LO scenarios.

Parameters:

clientId - Client ID of the credential from the console.

clientSecret - Client ID of the credential from the console.

refreshToken - A refresh token resulting from a OAuth2 consent flow.

accessToken - Initial or temporary access token.

UserCredentials

public UserCredentials(String clientId,
                       String clientSecret,
                       String refreshToken,
                       AccessToken accessToken,
                       HttpTransportFactory transportFactory,
                       URI tokenServerUri)

Constructor with all parameters allowing custom transport and server URL.

Parameters:

clientId - Client ID of the credential from the console.

clientSecret - Client ID of the credential from the console.

refreshToken - A refresh token resulting from a OAuth2 consent flow.

accessToken - Initial or temporary access token.

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

tokenServerUri - URI of the end point that provides tokens.

Method Detail

fromStream

public static UserCredentials fromStream(InputStream credentialsStream)
                                  throws IOException

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

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

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

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.

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

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

Overrides:

refreshAccessToken in class OAuth2Credentials

Throws:

IOException - from derived implementations

getClientId

public final String getClientId()

Returns client ID of the credential from the console.

Returns:

client ID

getClientSecret

public final String getClientSecret()

Returns client secret of the credential from the console.

Returns:

client secret

getRefreshToken

public final String getRefreshToken()

Returns the refresh token resulting from a OAuth2 consent flow.

Returns:

refresh token

hashCode

public int hashCode()

Overrides:

hashCode in class OAuth2Credentials

toString

public String toString()

Overrides:

toString in class OAuth2Credentials

equals

public boolean equals(Object obj)

Overrides:

equals in class OAuth2Credentials