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

public class UserCredentials
extends GoogleCredentials

OAuth2 Credentials representing a user's identity and consent.

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, com.google.api.client.http.HttpTransport transport, com.google.api.client.http.GenericUrl tokenServerUrl) Constructor with all parameters allowing custom transport and server URL.

Method Summary

Modifier and Type	Method and Description
AccessToken	refreshAccessToken() Refreshes the OAuth2 access token by getting a new access token from the refresh token

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

createScoped, createScopedRequired, fromStream, fromStream, getApplicationDefault, getApplicationDefault

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

getAuthenticationType, getRequestMetadata, hasRequestMetadata, hasRequestMetadataOnly, refresh

Methods inherited from class com.google.auth.Credentials

getRequestMetadata

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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,
                       com.google.api.client.http.HttpTransport transport,
                       com.google.api.client.http.GenericUrl tokenServerUrl)

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.

transport - HTTP object used to get access tokens.

tokenServerUrl - URL of the end point that provides tokens.

Method Detail

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

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

Specified by:

refreshAccessToken in class OAuth2Credentials

Throws:

IOException