com.google.api.client.auth.oauth2

Interface CredentialRefreshListener

All Known Implementing Classes:

CredentialStoreRefreshListener, DataStoreCredentialRefreshListener

public interface CredentialRefreshListener

Listener for refresh token results.

These methods are called from Credential.refreshToken() after a response has been received from refreshing the token. onTokenResponse(com.google.api.client.auth.oauth2.Credential, com.google.api.client.auth.oauth2.TokenResponse) is called on a successful HTTP response, and onTokenErrorResponse(com.google.api.client.auth.oauth2.Credential, com.google.api.client.auth.oauth2.TokenErrorResponse) is called on an error HTTP response.

Since:

1.7

Author:

Yaniv Inbar

Method Summary

Modifier and Type	Method and Description
void	onTokenErrorResponse(Credential credential, TokenErrorResponse tokenErrorResponse) Notifies of an error token response from Credential.refreshToken().
void	onTokenResponse(Credential credential, TokenResponse tokenResponse) Notifies of a successful token response from Credential.refreshToken().

Method Detail

onTokenResponse

void onTokenResponse(Credential credential,
                     TokenResponse tokenResponse)
              throws IOException

Notifies of a successful token response from Credential.refreshToken().

Typical use is to provide functionality like persisting the access token in a data store. Implementations can assume proper thread synchronization is already taken care of inside Credential.refreshToken(). Implementations can also assume that Credential.setAccessToken(java.lang.String), Credential.setRefreshToken(java.lang.String), and Credential.setExpiresInSeconds(java.lang.Long) have already been called previously with the information from the TokenResponse.

Parameters:

credential - credential on which the token refresh applied

tokenResponse - token response

Throws:

IOException

onTokenErrorResponse

void onTokenErrorResponse(Credential credential,
                          TokenErrorResponse tokenErrorResponse)
                   throws IOException

Notifies of an error token response from Credential.refreshToken().

Typical use is to provide functionality like removing persistence of the access token from the data store. Implementations can assume proper thread synchronization is already taken care of inside Credential.refreshToken(). Implementations can also assume that Credential.setAccessToken(java.lang.String), and Credential.setExpiresInSeconds(java.lang.Long) have already been called previously with null to clear their values.

Parameters:

credential - credential on which the token refresh applied

tokenErrorResponse - token error response or null for none supplied

Throws:

IOException