Class OAuth2CredentialsWithRefresh

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

com.google.auth.oauth2.OAuth2CredentialsWithRefresh

All Implemented Interfaces:

Serializable

public class OAuth2CredentialsWithRefresh
extends OAuth2Credentials

A refreshable alternative to OAuth2Credentials.

To enable automatic token refreshes, you must provide an OAuth2CredentialsWithRefresh.OAuth2RefreshHandler.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OAuth2CredentialsWithRefresh.Builder
static interface	OAuth2CredentialsWithRefresh.OAuth2RefreshHandler	Interface for the refresh handler.

Nested classes/interfaces inherited from class OAuth2Credentials

OAuth2Credentials.AsyncRefreshResult, OAuth2Credentials.CacheState, OAuth2Credentials.CredentialsChangedListener, OAuth2Credentials.FutureCallbackToMetadataCallbackAdapter, OAuth2Credentials.OAuthValue, OAuth2Credentials.RefreshTask, OAuth2Credentials.RefreshTaskListener

Field Summary

Fields

Modifier and Type	Field	Description
private final OAuth2CredentialsWithRefresh.OAuth2RefreshHandler	refreshHandler

Fields inherited from class OAuth2Credentials

clock, DEFAULT_EXPIRATION_MARGIN, DEFAULT_REFRESH_MARGIN, lock, refreshTask

Fields inherited from class Credentials

GOOGLE_DEFAULT_UNIVERSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OAuth2CredentialsWithRefresh(AccessToken accessToken, OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler)
protected	OAuth2CredentialsWithRefresh(OAuth2CredentialsWithRefresh.Builder builder)

Method Summary

Modifier and Type	Method	Description
OAuth2CredentialsWithRefresh.OAuth2RefreshHandler	getRefreshHandler()	Returns the provided OAuth2CredentialsWithRefresh.OAuth2RefreshHandler.
static OAuth2CredentialsWithRefresh.Builder	newBuilder()
AccessToken	refreshAccessToken()	Refreshes the access token using the provided OAuth2CredentialsWithRefresh.OAuth2RefreshHandler.

Methods inherited from class OAuth2Credentials

addChangeListener, create, equals, getAccessToken, getAdditionalHeaders, getAuthenticationType, getExpirationMargin, getFromServiceLoader, getRefreshMargin, getRequestMetadata, getRequestMetadata, getRequestMetadataInternal, hashCode, hasRequestMetadata, hasRequestMetadataOnly, newInstance, refresh, refreshIfExpired, removeChangeListener, toBuilder, toString

Methods inherited from class Credentials

blockingGetToCallback, getMetricsCredentialType, getRequestMetadata, getUniverseDomain

Methods inherited from class Object

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

Field Details

refreshHandler

private final OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler

Constructor Details

OAuth2CredentialsWithRefresh

protected OAuth2CredentialsWithRefresh(OAuth2CredentialsWithRefresh.Builder builder)

OAuth2CredentialsWithRefresh

protected OAuth2CredentialsWithRefresh(AccessToken accessToken,
 OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler)

Method Details

refreshAccessToken

public AccessToken refreshAccessToken()
                               throws IOException

Refreshes the access token using the provided OAuth2CredentialsWithRefresh.OAuth2RefreshHandler.

Overrides:

refreshAccessToken in class OAuth2Credentials

Returns:

never

Throws:

IOException

getRefreshHandler

public OAuth2CredentialsWithRefresh.OAuth2RefreshHandler getRefreshHandler()

Returns the provided OAuth2CredentialsWithRefresh.OAuth2RefreshHandler.

newBuilder

public static OAuth2CredentialsWithRefresh.Builder newBuilder()