Package org.apache.hadoop.fs.azurebfs.oauth2

Class AccessTokenProvider

java.lang.Object

org.apache.hadoop.fs.azurebfs.oauth2.AccessTokenProvider

Direct Known Subclasses:

ClientCredsTokenProvider, CustomTokenProviderAdapter, MsiTokenProvider, RefreshTokenBasedTokenProvider, UserPasswordTokenProvider, WorkloadIdentityTokenProvider

public abstract class AccessTokenProvider
extends java.lang.Object

Returns an Azure Active Directory token when requested. The provider can cache the token if it has already retrieved one. If it does, then the provider is responsible for checking expiry and refreshing as needed. In other words, this is is a token cache that fetches tokens when requested, if the cached token has expired.

Constructor Summary

Constructors

Constructor	Description
AccessTokenProvider()

Method Summary

Modifier and Type	Method	Description
AzureADToken	getToken()	returns the AzureADToken cached (or retrieved) by this instance.
protected boolean	isTokenAboutToExpire()	Checks if the token is about to expire in the next 5 minutes.
protected abstract AzureADToken	refreshToken()	the method to fetch the access token.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessTokenProvider

public AccessTokenProvider()

Method Detail

getToken

public AzureADToken getToken()
                      throws java.io.IOException

returns the AzureADToken cached (or retrieved) by this instance.

Returns:

AzureADToken containing the access token

Throws:

java.io.IOException - if there is an error fetching the token

refreshToken

protected abstract AzureADToken refreshToken()
                                      throws java.io.IOException

the method to fetch the access token. Derived classes should override this method to actually get the token from Azure Active Directory. This method will be called initially, and then once when the token is about to expire.

Returns:

AzureADToken containing the access token

Throws:

java.io.IOException - if there is an error fetching the token

isTokenAboutToExpire

protected boolean isTokenAboutToExpire()

Checks if the token is about to expire in the next 5 minutes. The 5 minute allowance is to allow for clock skew and also to allow for token to be refreshed in that much time.

Returns:

true if the token is expiring in next 5 minutes