com.google.api.client.googleapis.auth.oauth2

Class GoogleRefreshTokenRequest

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.auth.oauth2.TokenRequest

com.google.api.client.auth.oauth2.RefreshTokenRequest

com.google.api.client.googleapis.auth.oauth2.GoogleRefreshTokenRequest

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class GoogleRefreshTokenRequest
extends com.google.api.client.auth.oauth2.RefreshTokenRequest

Google-specific implementation of the OAuth 2.0 request to refresh an access token using a refresh token as specified in Refreshing an Access Token.

Use GoogleCredential to access protected resources from the resource server using the TokenResponse returned by execute(). On error, it will instead throw TokenResponseException.

Sample usage:

  static void refreshAccessToken() throws IOException {
    try {
      TokenResponse response =
          new GoogleRefreshTokenRequest(new NetHttpTransport(), new JacksonFactory(),
              "tGzv3JOkF0XG5Qx2TlKWIA", "s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw").execute();
      System.out.println("Access token: " + response.getAccessToken());
    } catch (TokenResponseException e) {
      if (e.getDetails() != null) {
        System.err.println("Error: " + e.getDetails().getError());
        if (e.getDetails().getErrorDescription() != null) {
          System.err.println(e.getDetails().getErrorDescription());
        }
        if (e.getDetails().getErrorUri() != null) {
          System.err.println(e.getDetails().getErrorUri());
        }
      } else {
        System.err.println(e.getMessage());
      }
    }
  }
 

Implementation is not thread-safe.

Since:

1.7

Author:

Yaniv Inbar

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleRefreshTokenRequest(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, java.lang.String refreshToken, java.lang.String clientId, java.lang.String clientSecret)

Method Summary

Methods

Modifier and Type	Method and Description
GoogleTokenResponse	execute()
GoogleRefreshTokenRequest	set(java.lang.String fieldName, java.lang.Object value)
GoogleRefreshTokenRequest	setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)
GoogleRefreshTokenRequest	setGrantType(java.lang.String grantType)
GoogleRefreshTokenRequest	setRefreshToken(java.lang.String refreshToken)
GoogleRefreshTokenRequest	setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer)
GoogleRefreshTokenRequest	setScopes(java.util.Collection<java.lang.String> scopes)
GoogleRefreshTokenRequest	setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl)

Methods inherited from class com.google.api.client.auth.oauth2.RefreshTokenRequest

getRefreshToken

Methods inherited from class com.google.api.client.auth.oauth2.TokenRequest

executeUnparsed, getClientAuthentication, getGrantType, getJsonFactory, getRequestInitializer, getScopes, getTokenServerUrl, getTransport

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleRefreshTokenRequest

public GoogleRefreshTokenRequest(com.google.api.client.http.HttpTransport transport,
                         com.google.api.client.json.JsonFactory jsonFactory,
                         java.lang.String refreshToken,
                         java.lang.String clientId,
                         java.lang.String clientSecret)

Parameters:

transport - HTTP transport

jsonFactory - JSON factory

refreshToken - refresh token issued to the client

clientId - client identifier issued to the client during the registration process

clientSecret - client secret

Method Detail

setRequestInitializer

public GoogleRefreshTokenRequest setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer)

Overrides:

setRequestInitializer in class com.google.api.client.auth.oauth2.RefreshTokenRequest

setTokenServerUrl

public GoogleRefreshTokenRequest setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl)

Overrides:

setTokenServerUrl in class com.google.api.client.auth.oauth2.RefreshTokenRequest

setScopes

public GoogleRefreshTokenRequest setScopes(java.util.Collection<java.lang.String> scopes)

Overrides:

setScopes in class com.google.api.client.auth.oauth2.RefreshTokenRequest

setGrantType

public GoogleRefreshTokenRequest setGrantType(java.lang.String grantType)

Overrides:

setGrantType in class com.google.api.client.auth.oauth2.RefreshTokenRequest

setClientAuthentication

public GoogleRefreshTokenRequest setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)

Overrides:

setClientAuthentication in class com.google.api.client.auth.oauth2.RefreshTokenRequest

setRefreshToken

public GoogleRefreshTokenRequest setRefreshToken(java.lang.String refreshToken)

Overrides:

setRefreshToken in class com.google.api.client.auth.oauth2.RefreshTokenRequest

execute

public GoogleTokenResponse execute()
                            throws java.io.IOException

Overrides:

execute in class com.google.api.client.auth.oauth2.TokenRequest

Throws:

java.io.IOException

set

public GoogleRefreshTokenRequest set(java.lang.String fieldName,
                            java.lang.Object value)

Overrides:

set in class com.google.api.client.auth.oauth2.RefreshTokenRequest