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

Class WorkloadIdentityTokenProvider

java.lang.Object

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

org.apache.hadoop.fs.azurebfs.oauth2.WorkloadIdentityTokenProvider

public class WorkloadIdentityTokenProvider
extends AccessTokenProvider

Provides tokens based on Azure AD Workload Identity.

Constructor Summary

Constructors

Constructor	Description
WorkloadIdentityTokenProvider(java.lang.String authority, java.lang.String tenantId, java.lang.String clientId, java.lang.String tokenFile)

Method Summary

Modifier and Type	Method	Description
protected boolean	isTokenAboutToExpire()	Checks if the token is about to expire as per base expiry logic.
protected AzureADToken	refreshToken()	the method to fetch the access token.

Methods inherited from class org.apache.hadoop.fs.azurebfs.oauth2.AccessTokenProvider

getToken

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkloadIdentityTokenProvider

public WorkloadIdentityTokenProvider(java.lang.String authority,
                                     java.lang.String tenantId,
                                     java.lang.String clientId,
                                     java.lang.String tokenFile)

Method Detail

refreshToken

protected AzureADToken refreshToken()
                             throws java.io.IOException

Description copied from class: AccessTokenProvider

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.

Specified by:

refreshToken in class AccessTokenProvider

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 as per base expiry logic. Otherwise, expire if there is a clock skew issue in the system.

Overrides:

isTokenAboutToExpire in class AccessTokenProvider

Returns:

true if the token is expiring in next 1 hour or if a token has never been fetched