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

Class GoogleTokenResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.client.auth.oauth2.TokenResponse

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public class GoogleTokenResponse
extends com.google.api.client.auth.oauth2.TokenResponse

Google OAuth 2.0 JSON model for a successful access token response as specified in Successful Response, including an ID token as specified in OpenID Connect Session Management 1.0.

This response object is the result of GoogleAuthorizationCodeTokenRequest.execute() and GoogleRefreshTokenRequest.execute(). Use parseIdToken() to parse the GoogleIdToken and then call GoogleIdTokenVerifier.verify(GoogleIdToken).

Implementation is not thread-safe.

Upgrade warning: in prior version 1.13 this extended IdTokenResponse, but starting with version 1.14 it now extends TokenResponse.

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
GoogleTokenResponse()

Method Summary

Methods

Modifier and Type	Method and Description
GoogleTokenResponse	clone()
String	getIdToken() Returns the ID token.
GoogleIdToken	parseIdToken() Parses using GoogleIdToken.parse(JsonFactory, String) based on the JSON factory and ID token.
GoogleTokenResponse	set(String fieldName, Object value)
GoogleTokenResponse	setAccessToken(String accessToken)
GoogleTokenResponse	setExpiresInSeconds(Long expiresIn)
GoogleTokenResponse	setIdToken(String idToken) Sets the ID token.
GoogleTokenResponse	setRefreshToken(String refreshToken)
GoogleTokenResponse	setScope(String scope)
GoogleTokenResponse	setTokenType(String tokenType)
boolean	verifyIdToken(GoogleIdTokenVerifier verifier) Deprecated. (scheduled to be removed in 1.15) Use GoogleIdTokenVerifier.verify(GoogleIdToken) with parseIdToken()

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

getAccessToken, getExpiresInSeconds, getRefreshToken, getScope, getTokenType

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

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

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleTokenResponse

public GoogleTokenResponse()

Method Detail

setAccessToken

public GoogleTokenResponse setAccessToken(String accessToken)

Overrides:

setAccessToken in class com.google.api.client.auth.oauth2.TokenResponse

setTokenType

public GoogleTokenResponse setTokenType(String tokenType)

Overrides:

setTokenType in class com.google.api.client.auth.oauth2.TokenResponse

setExpiresInSeconds

public GoogleTokenResponse setExpiresInSeconds(Long expiresIn)

Overrides:

setExpiresInSeconds in class com.google.api.client.auth.oauth2.TokenResponse

setRefreshToken

public GoogleTokenResponse setRefreshToken(String refreshToken)

Overrides:

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

setScope

public GoogleTokenResponse setScope(String scope)

Overrides:

setScope in class com.google.api.client.auth.oauth2.TokenResponse

getIdToken

public final String getIdToken()

Returns the ID token.

setIdToken

public GoogleTokenResponse setIdToken(String idToken)

Sets the ID token.

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

Upgrade warning: in prior version 1.13 null was allowed, but starting with version 1.14 null is not allowed.

parseIdToken

public GoogleIdToken parseIdToken()
                           throws IOException

Parses using GoogleIdToken.parse(JsonFactory, String) based on the JSON factory and ID token.

Throws:

IOException

verifyIdToken

@Deprecated
public boolean verifyIdToken(GoogleIdTokenVerifier verifier)
                      throws GeneralSecurityException,
                             IOException

Deprecated. (scheduled to be removed in 1.15) Use GoogleIdTokenVerifier.verify(GoogleIdToken) with parseIdToken()

Verifies the ID token as specified in GoogleIdTokenVerifier.verify(com.google.api.client.googleapis.auth.oauth2.GoogleIdToken) by passing it parseIdToken().

Parameters:

verifier - Google ID token verifier

Throws:

GeneralSecurityException

IOException

set

public GoogleTokenResponse set(String fieldName,
                      Object value)

Overrides:

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

clone

public GoogleTokenResponse clone()

Overrides:

clone in class com.google.api.client.auth.oauth2.TokenResponse