Class DataStoreCredentialRefreshListener

java.lang.Object

com.google.api.client.auth.oauth2.DataStoreCredentialRefreshListener

All Implemented Interfaces:

CredentialRefreshListener

@Beta
public final class DataStoreCredentialRefreshListener
extends Object
implements CredentialRefreshListener

Beta
Thread-safe OAuth 2.0 credential refresh listener that stores the refresh token response in the credential data store.

It needs to be added as a refresh listener using Credential.Builder.addRefreshListener(CredentialRefreshListener). Sample usage:

 static void addDataStoreCredentialRefreshListener(
     Credential.Builder credentialBuilder, String userId, DataStoreFactory dataStoreFactory)
     throws IOException {
   credentialBuilder.addRefreshListener(
       new DataStoreCredentialRefreshListener(userId, dataStoreFactory));
 }

Since:

1.6

Field Summary

Fields

Modifier and Type	Field	Description
private final com.google.api.client.util.store.DataStore<StoredCredential>	credentialDataStore	Stored credential data store.
private final String	userId	User ID whose credential is to be updated.

Constructor Summary

Constructors

Constructor	Description
DataStoreCredentialRefreshListener(String userId, com.google.api.client.util.store.DataStore<StoredCredential> credentialDataStore)
DataStoreCredentialRefreshListener(String userId, com.google.api.client.util.store.DataStoreFactory dataStoreFactory)	Constructor using StoredCredential.getDefaultDataStore(DataStoreFactory) for the stored credential data store.

Method Summary

Modifier and Type	Method	Description
com.google.api.client.util.store.DataStore<StoredCredential>	getCredentialDataStore()	Returns the stored credential data store.
void	makePersistent(Credential credential)	Stores the updated credential in the credential store.
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().

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

credentialDataStore

private final com.google.api.client.util.store.DataStore<StoredCredential> credentialDataStore

Stored credential data store.

userId

private final String userId

User ID whose credential is to be updated.

Constructor Details

DataStoreCredentialRefreshListener

public DataStoreCredentialRefreshListener(String userId,
 com.google.api.client.util.store.DataStoreFactory dataStoreFactory)
                                   throws IOException

Constructor using StoredCredential.getDefaultDataStore(DataStoreFactory) for the stored credential data store.

Parameters:

userId - user ID whose credential is to be updated

dataStoreFactory - data store factory

Throws:

IOException

DataStoreCredentialRefreshListener

public DataStoreCredentialRefreshListener(String userId,
 com.google.api.client.util.store.DataStore<StoredCredential> credentialDataStore)

Parameters:

userId - user ID whose credential is to be updated

credentialDataStore - stored credential data store

Method Details

onTokenResponse

public void onTokenResponse(Credential credential,
 TokenResponse tokenResponse)
                     throws IOException

Description copied from interface: CredentialRefreshListener

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(String), Credential.setRefreshToken(String), and Credential.setExpiresInSeconds(Long) have already been called previously with the information from the TokenResponse.

Specified by:

onTokenResponse in interface CredentialRefreshListener

Parameters:

credential - credential on which the token refresh applied

tokenResponse - token response

Throws:

IOException

onTokenErrorResponse

public void onTokenErrorResponse(Credential credential,
 TokenErrorResponse tokenErrorResponse)
                          throws IOException

Description copied from interface: CredentialRefreshListener

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(String), and Credential.setExpiresInSeconds(Long) have already been called previously with null to clear their values.

Specified by:

onTokenErrorResponse in interface CredentialRefreshListener

Parameters:

credential - credential on which the token refresh applied

tokenErrorResponse - token error response or null for none supplied

Throws:

IOException

getCredentialDataStore

public com.google.api.client.util.store.DataStore<StoredCredential> getCredentialDataStore()

Returns the stored credential data store.

makePersistent

public void makePersistent(Credential credential)
                    throws IOException

Stores the updated credential in the credential store.

Throws:

IOException