Package com.google.auth.oauth2
Class OAuth2CredentialsWithRefresh
java.lang.Object
com.google.auth.Credentials
com.google.auth.oauth2.OAuth2Credentials
com.google.auth.oauth2.OAuth2CredentialsWithRefresh
- All Implemented Interfaces:
Serializable
A refreshable alternative to
OAuth2Credentials
.
To enable automatic token refreshes, you must provide an OAuth2CredentialsWithRefresh.OAuth2RefreshHandler
.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static interface
Interface for the refresh handler.Nested classes/interfaces inherited from class com.google.auth.oauth2.OAuth2Credentials
OAuth2Credentials.AsyncRefreshResult, OAuth2Credentials.CacheState, OAuth2Credentials.CredentialsChangedListener, OAuth2Credentials.FutureCallbackToMetadataCallbackAdapter, OAuth2Credentials.OAuthValue, OAuth2Credentials.RefreshTask, OAuth2Credentials.RefreshTaskListener
-
Field Summary
FieldsFields inherited from class com.google.auth.oauth2.OAuth2Credentials
clock, DEFAULT_EXPIRATION_MARGIN, DEFAULT_REFRESH_MARGIN, lock, refreshTask
Fields inherited from class com.google.auth.Credentials
GOOGLE_DEFAULT_UNIVERSE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
OAuth2CredentialsWithRefresh
(AccessToken accessToken, OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler) protected
-
Method Summary
Modifier and TypeMethodDescriptionReturns the providedOAuth2CredentialsWithRefresh.OAuth2RefreshHandler
.Refreshes the access token using the providedOAuth2CredentialsWithRefresh.OAuth2RefreshHandler
.Methods inherited from class com.google.auth.oauth2.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 com.google.auth.Credentials
blockingGetToCallback, getMetricsCredentialType, getRequestMetadata, getUniverseDomain
-
Field Details
-
refreshHandler
-
-
Constructor Details
-
OAuth2CredentialsWithRefresh
-
OAuth2CredentialsWithRefresh
protected OAuth2CredentialsWithRefresh(AccessToken accessToken, OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler)
-
-
Method Details
-
refreshAccessToken
Refreshes the access token using the providedOAuth2CredentialsWithRefresh.OAuth2RefreshHandler
.- Overrides:
refreshAccessToken
in classOAuth2Credentials
- Returns:
- never
- Throws:
IOException
-
getRefreshHandler
Returns the providedOAuth2CredentialsWithRefresh.OAuth2RefreshHandler
. -
newBuilder
-