com.google.api.client.auth.oauth2

Class RefreshTokenRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public class RefreshTokenRequest
extends TokenRequest

OAuth 2.0 request to refresh an access token using a refresh token as specified in Refreshing an Access Token.

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

Sample usage:

  static void refreshAccessToken() throws IOException {
    try {
      TokenResponse response =
          new RefreshTokenRequest(new NetHttpTransport(), new JacksonFactory(), new GenericUrl(
              "https://server.example.com/token"), "tGzv3JOkF0XG5Qx2TlKWIA")
              .setClientAuthentication(
                  new BasicAuthentication("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());
      }
    }
  }
 

Some OAuth 2.0 providers don't support BasicAuthentication but instead support ClientParametersAuthentication. In the above sample code, simply replace the class name and it will work the same way.

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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RefreshTokenRequest(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.GenericUrl tokenServerUrl, String refreshToken)

Method Summary

Methods

Modifier and Type	Method and Description
String	getRefreshToken() Returns the refresh token issued to the client.
RefreshTokenRequest	set(String fieldName, Object value)
RefreshTokenRequest	setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication) Sets the client authentication or null for none.
RefreshTokenRequest	setGrantType(String grantType) Sets the grant type ("authorization_code", "password", "client_credentials", "refresh_token" or absolute URI of the extension grant type).
RefreshTokenRequest	setRefreshToken(String refreshToken) Sets the refresh token issued to the client.
RefreshTokenRequest	setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer) Sets the HTTP request initializer or null for none.
RefreshTokenRequest	setScopes(Iterable<String> scopes) Sets the list of scopes (as specified in Access Token Scope) or null for none.
RefreshTokenRequest	setScopes(String... scopes) Sets the list of scopes (as specified in Access Token Scope) or null for none.
RefreshTokenRequest	setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl) Sets the token server URL.

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

execute, 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

RefreshTokenRequest

public RefreshTokenRequest(com.google.api.client.http.HttpTransport transport,
                   com.google.api.client.json.JsonFactory jsonFactory,
                   com.google.api.client.http.GenericUrl tokenServerUrl,
                   String refreshToken)

Parameters:

transport - HTTP transport

jsonFactory - JSON factory

tokenServerUrl - token server URL

refreshToken - refresh token issued to the client

Method Detail

setRequestInitializer

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

Description copied from class: TokenRequest

Sets the HTTP request initializer or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setRequestInitializer in class TokenRequest

setTokenServerUrl

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

Description copied from class: TokenRequest

Sets the token server URL.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setTokenServerUrl in class TokenRequest

setScopes

public RefreshTokenRequest setScopes(String... scopes)

Description copied from class: TokenRequest

Sets the list of scopes (as specified in Access Token Scope) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setScopes in class TokenRequest

Parameters:

scopes - list of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes)

setScopes

public RefreshTokenRequest setScopes(Iterable<String> scopes)

Description copied from class: TokenRequest

Sets the list of scopes (as specified in Access Token Scope) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setScopes in class TokenRequest

Parameters:

scopes - list of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes)

setGrantType

public RefreshTokenRequest setGrantType(String grantType)

Description copied from class: TokenRequest

Sets the grant type ("authorization_code", "password", "client_credentials", "refresh_token" or absolute URI of the extension grant type).

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setGrantType in class TokenRequest

setClientAuthentication

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

Description copied from class: TokenRequest

Sets the client authentication or null for none.

The recommended initializer by the specification is BasicAuthentication. All authorization servers must support that. A common alternative is ClientParametersAuthentication. An alternative client authentication method may be provided that implements HttpRequestInitializer.

This HTTP request execute interceptor is guaranteed to be the last execute interceptor before the request is executed, and after any execute interceptor set by the TokenRequest.getRequestInitializer().

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

setClientAuthentication in class TokenRequest

getRefreshToken

public final String getRefreshToken()

Returns the refresh token issued to the client.

setRefreshToken

public RefreshTokenRequest setRefreshToken(String refreshToken)

Sets the refresh token issued to the client.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

set

public RefreshTokenRequest set(String fieldName,
                      Object value)

Overrides:

set in class TokenRequest