Class GoogleRefreshTokenRequest (2.1.0)

Version 2.1.0

• 2.7.0 (latest)
• 2.6.0
• 2.5.1
• 2.4.1
• 2.1.2
• 2.0.1
• 1.35.2
• 1.34.1
• 1.33.4

public class GoogleRefreshTokenRequest extends 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 GsonFactory(),
         "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.

Inheritance

Object > java.util.AbstractMap > com.google.api.client.util.GenericData > com.google.api.client.auth.oauth2.TokenRequest > com.google.api.client.auth.oauth2.RefreshTokenRequest > GoogleRefreshTokenRequest

Inherited Members

com.google.api.client.auth.oauth2.RefreshTokenRequest.getRefreshToken()

com.google.api.client.auth.oauth2.RefreshTokenRequest.set(java.lang.String,java.lang.Object)

com.google.api.client.auth.oauth2.RefreshTokenRequest.setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor)

com.google.api.client.auth.oauth2.RefreshTokenRequest.setGrantType(java.lang.String)

com.google.api.client.auth.oauth2.RefreshTokenRequest.setRefreshToken(java.lang.String)

com.google.api.client.auth.oauth2.RefreshTokenRequest.setRequestInitializer(com.google.api.client.http.HttpRequestInitializer)

com.google.api.client.auth.oauth2.RefreshTokenRequest.setResponseClass(java.lang.Class<? extends com.google.api.client.auth.oauth2.TokenResponse>)

com.google.api.client.auth.oauth2.RefreshTokenRequest.setScopes(java.util.Collection<java.lang.String>)

com.google.api.client.auth.oauth2.RefreshTokenRequest.setTokenServerUrl(com.google.api.client.http.GenericUrl)

com.google.api.client.auth.oauth2.TokenRequest.execute()

com.google.api.client.auth.oauth2.TokenRequest.executeUnparsed()

com.google.api.client.auth.oauth2.TokenRequest.getClientAuthentication()

com.google.api.client.auth.oauth2.TokenRequest.getGrantType()

com.google.api.client.auth.oauth2.TokenRequest.getJsonFactory()

com.google.api.client.auth.oauth2.TokenRequest.getRequestInitializer()

com.google.api.client.auth.oauth2.TokenRequest.getResponseClass()

com.google.api.client.auth.oauth2.TokenRequest.getScopes()

com.google.api.client.auth.oauth2.TokenRequest.getTokenServerUrl()

com.google.api.client.auth.oauth2.TokenRequest.getTransport()

com.google.api.client.util.GenericData.clone()

com.google.api.client.util.GenericData.entrySet()

com.google.api.client.util.GenericData.equals(java.lang.Object)

com.google.api.client.util.GenericData.get(java.lang.Object)

com.google.api.client.util.GenericData.getClassInfo()

com.google.api.client.util.GenericData.getUnknownKeys()

com.google.api.client.util.GenericData.hashCode()

com.google.api.client.util.GenericData.put(java.lang.String,java.lang.Object)

com.google.api.client.util.GenericData.putAll(java.util.Map<? extends java.lang.String,?>)

com.google.api.client.util.GenericData.remove(java.lang.Object)

com.google.api.client.util.GenericData.setUnknownKeys(java.util.Map<java.lang.String,java.lang.Object>)

com.google.api.client.util.GenericData.toString()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

AbstractMap.clear()

AbstractMap.containsKey(Object)

AbstractMap.containsValue(Object)

AbstractMap.isEmpty()

AbstractMap.keySet()

AbstractMap.put(K,V)

AbstractMap.putAll(Map<? extends K,? extends V>)

AbstractMap.size()

AbstractMap.values()

Constructors

GoogleRefreshTokenRequest(HttpTransport transport, JsonFactory jsonFactory, String refreshToken, String clientId, String clientSecret)

public GoogleRefreshTokenRequest(HttpTransport transport, JsonFactory jsonFactory, String refreshToken, String clientId, String clientSecret)

Parameters

Name	Description
transport	com.google.api.client.http.HttpTransport HTTP transport
jsonFactory	com.google.api.client.json.JsonFactory JSON factory
refreshToken	String refresh token issued to the client
clientId	String client identifier issued to the client during the registration process
clientSecret	String client secret

Methods

execute()

public GoogleTokenResponse execute()

Returns

Type	Description
GoogleTokenResponse

Overrides

com.google.api.client.auth.oauth2.TokenRequest.execute()

Exceptions

Type	Description
IOException

set(String fieldName, Object value)

public GoogleRefreshTokenRequest set(String fieldName, Object value)

Parameters

Name	Description
fieldName	String
value	Object

Returns

Type	Description
GoogleRefreshTokenRequest

Overrides

com.google.api.client.auth.oauth2.RefreshTokenRequest.set(java.lang.String,java.lang.Object)

setClientAuthentication(HttpExecuteInterceptor clientAuthentication)

public GoogleRefreshTokenRequest setClientAuthentication(HttpExecuteInterceptor clientAuthentication)

Parameter

Name	Description
clientAuthentication	com.google.api.client.http.HttpExecuteInterceptor

Returns

Type	Description
GoogleRefreshTokenRequest

Overrides

com.google.api.client.auth.oauth2.RefreshTokenRequest.setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor)

setGrantType(String grantType)

public GoogleRefreshTokenRequest setGrantType(String grantType)

Parameter

Name	Description
grantType	String

Returns

Type	Description
GoogleRefreshTokenRequest

Overrides

com.google.api.client.auth.oauth2.RefreshTokenRequest.setGrantType(java.lang.String)

setRefreshToken(String refreshToken)

public GoogleRefreshTokenRequest setRefreshToken(String refreshToken)

Parameter

Name	Description
refreshToken	String

Returns

Type	Description
GoogleRefreshTokenRequest

Overrides

com.google.api.client.auth.oauth2.RefreshTokenRequest.setRefreshToken(java.lang.String)

setRequestInitializer(HttpRequestInitializer requestInitializer)

public GoogleRefreshTokenRequest setRequestInitializer(HttpRequestInitializer requestInitializer)

Parameter

Name	Description
requestInitializer	com.google.api.client.http.HttpRequestInitializer

Returns

Type	Description
GoogleRefreshTokenRequest

Overrides

com.google.api.client.auth.oauth2.RefreshTokenRequest.setRequestInitializer(com.google.api.client.http.HttpRequestInitializer)

setScopes(Collection<String> scopes)

public GoogleRefreshTokenRequest setScopes(Collection<String> scopes)

Parameter

Name	Description
scopes	Collection<String>

Returns

Type	Description
GoogleRefreshTokenRequest

Overrides

com.google.api.client.auth.oauth2.RefreshTokenRequest.setScopes(java.util.Collection<java.lang.String>)

setTokenServerUrl(GenericUrl tokenServerUrl)

public GoogleRefreshTokenRequest setTokenServerUrl(GenericUrl tokenServerUrl)

Parameter

Name	Description
tokenServerUrl	com.google.api.client.http.GenericUrl

Returns

Type	Description
GoogleRefreshTokenRequest

Overrides

com.google.api.client.auth.oauth2.RefreshTokenRequest.setTokenServerUrl(com.google.api.client.http.GenericUrl)