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:
java.io.Serializable
public class OAuth2CredentialsWithRefresh extends OAuth2Credentials
A refreshable alternative toOAuth2Credentials
.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 com.google.auth.oauth2.OAuth2Credentials
OAuth2Credentials.AsyncRefreshResult, OAuth2Credentials.CacheState, OAuth2Credentials.CredentialsChangedListener, OAuth2Credentials.FutureCallbackToMetadataCallbackAdapter, OAuth2Credentials.OAuthValue, OAuth2Credentials.RefreshTask, OAuth2Credentials.RefreshTaskListener
-
-
Field Summary
Fields Modifier and Type Field Description private OAuth2CredentialsWithRefresh.OAuth2RefreshHandler
refreshHandler
-
Fields 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
Constructors Modifier Constructor Description protected
OAuth2CredentialsWithRefresh(AccessToken accessToken, OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler)
protected
OAuth2CredentialsWithRefresh(OAuth2CredentialsWithRefresh.Builder builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description OAuth2CredentialsWithRefresh.OAuth2RefreshHandler
getRefreshHandler()
Returns the providedOAuth2CredentialsWithRefresh.OAuth2RefreshHandler
.static OAuth2CredentialsWithRefresh.Builder
newBuilder()
AccessToken
refreshAccessToken()
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 Detail
-
refreshHandler
private final OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler
-
-
Constructor Detail
-
OAuth2CredentialsWithRefresh
protected OAuth2CredentialsWithRefresh(OAuth2CredentialsWithRefresh.Builder builder)
-
OAuth2CredentialsWithRefresh
protected OAuth2CredentialsWithRefresh(AccessToken accessToken, OAuth2CredentialsWithRefresh.OAuth2RefreshHandler refreshHandler)
-
-
Method Detail
-
refreshAccessToken
public AccessToken refreshAccessToken() throws java.io.IOException
Refreshes the access token using the providedOAuth2CredentialsWithRefresh.OAuth2RefreshHandler
.- Overrides:
refreshAccessToken
in classOAuth2Credentials
- Returns:
- never
- Throws:
java.io.IOException
-
getRefreshHandler
public OAuth2CredentialsWithRefresh.OAuth2RefreshHandler getRefreshHandler()
Returns the providedOAuth2CredentialsWithRefresh.OAuth2RefreshHandler
.
-
newBuilder
public static OAuth2CredentialsWithRefresh.Builder newBuilder()
-
-