Class OAuth2Credentials (1.38.0)

publicclass OAuth2CredentialsextendsCredentials

Base type for Credentials using OAuth2.

Inheritance

Object > Credentials > OAuth2Credentials

Inherited Members

publicstaticT<T>getFromServiceLoader(Class<?extendsT>clazz,TdefaultInstance)

Returns the first service provider from the given service loader.

protectedstaticT<T>newInstance(StringclassName)

publicstaticOAuth2Credentialscreate(AccessTokenaccessToken)

Returns the credentials instance from the given access token.

publicstaticOAuth2Credentials.BuildernewBuilder()

protectedOAuth2Credentials()

Default constructor.

protectedOAuth2Credentials(AccessTokenaccessToken)

Constructor with explicit access token.

protectedOAuth2Credentials(AccessTokenaccessToken,DurationrefreshMargin,DurationexpirationMargin)

publicfinalvoidaddChangeListener(OAuth2Credentials.CredentialsChangedListenerlistener)

Adds a listener that is notified when the Credentials data changes.

This is called when token content changes, such as when the access token is refreshed. This is typically used by code caching the access token.

publicbooleanequals(Objectobj)

Object.equals(Object)

publicfinalAccessTokengetAccessToken()

Returns the cached access token.

If not set, you should call #refresh() to fetch and cache an access token.

protectedMap<String,List<String>>getAdditionalHeaders()

Provide additional headers to return as request metadata.

publicStringgetAuthenticationType()

A constant string name describing the authentication technology.

E.g. "OAuth2", "SSL". For use by the transport layer to determine whether it supports the type of authentication in the case where Credentials#hasRequestMetadataOnly is false. Also serves as a debugging helper.

Credentials.getAuthenticationType()

publicMap<String,List<String>>getRequestMetadata(URIuri)

Provide the request metadata by ensuring there is a current access token and providing it as an authorization bearer token.

Credentials.getRequestMetadata(URI uri)

publicvoidgetRequestMetadata(URIuri,Executorexecutor,RequestMetadataCallbackcallback)

Get the current request metadata without blocking.

This should be called by the transport layer on each request, and the data should be populated in headers or other context. The implementation can either call the callback inline or asynchronously. Either way it should never block in this method. The executor is provided for tasks that may block.

The default implementation will just call #getRequestMetadata(URI) then the callback from the given executor.

The convention for handling binary data is for the key in the returned map to end with "-bin" and for the corresponding values to be base64 encoded.

Credentials.getRequestMetadata(URI uri, Executor executor, RequestMetadataCallback callback)

protectedMap<String,List<String>>getRequestMetadataInternal()

publicbooleanhasRequestMetadata()

Whether the credentials have metadata entries that should be added to each request.

This should be called by the transport layer to see if Credentials#getRequestMetadata should be used for each request.

Credentials.hasRequestMetadata()

publicbooleanhasRequestMetadataOnly()

Indicates whether or not the Auth mechanism works purely by including request metadata.

This is meant for the transport layer. If this is true a transport does not need to take actions other than including the request metadata. If this is false, a transport must specifically know about the authentication technology to support it, and should fail to accept the credentials otherwise.

Credentials.hasRequestMetadataOnly()

publicinthashCode()

Object.hashCode()

publicvoidrefresh()

Request a new token regardless of the current token state. If the current token is not expired, it will still be returned during the refresh.

Credentials.refresh()

publicAccessTokenrefreshAccessToken()

Method to refresh the access token according to the specific type of credentials.

Throws IllegalStateException if not overridden since direct use of OAuth2Credentials is only for temporary or non-refreshing access tokens.

publicvoidrefreshIfExpired()

Refresh these credentials only if they have expired or are expiring imminently.

publicfinalvoidremoveChangeListener(OAuth2Credentials.CredentialsChangedListenerlistener)

Removes a listener that was added previously.

publicOAuth2Credentials.BuildertoBuilder()

publicStringtoString()

Object.toString()