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

Class CustomTokenProviderAdapter

java.lang.Object

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

org.apache.hadoop.fs.azurebfs.oauth2.CustomTokenProviderAdapter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BoundDTExtension

public final class CustomTokenProviderAdapter
extends AccessTokenProvider
implements BoundDTExtension

Provides tokens based on custom implementation, following the Adapter Design Pattern.

Constructor Summary

Constructors

Constructor	Description
CustomTokenProviderAdapter(CustomTokenProviderAdaptee adaptee, int customTokenFetchRetryCount)	Constructs a token provider based on the custom token provider.

Method Summary

Modifier and Type	Method	Description
void	bind(java.net.URI fsURI, org.apache.hadoop.conf.Configuration conf)	Bind to the filesystem by passing the binding call on to any custom token provider adaptee which implements BoundDTExtension.
void	close()
protected CustomTokenProviderAdaptee	getCustomTokenProviderAdaptee()
java.lang.String	getUserAgentSuffix()	Get a suffix for the UserAgent suffix of HTTP requests, which can be used to identify the principal making ABFS requests.
protected AzureADToken	refreshToken()	the method to fetch the access token.

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

getToken, isTokenAboutToExpire

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hadoop.fs.azurebfs.extensions.BoundDTExtension

getCanonicalServiceName

Constructor Detail

CustomTokenProviderAdapter

public CustomTokenProviderAdapter(CustomTokenProviderAdaptee adaptee,
                                  int customTokenFetchRetryCount)

Constructs a token provider based on the custom token provider.

Parameters:

adaptee - the custom token provider

customTokenFetchRetryCount - max retry count for customTokenFetch

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

bind

public void bind(java.net.URI fsURI,
                 org.apache.hadoop.conf.Configuration conf)
          throws java.io.IOException

Bind to the filesystem by passing the binding call on to any custom token provider adaptee which implements BoundDTExtension. No-op if they don't.

Specified by:

bind in interface BoundDTExtension

Parameters:

fsURI - URI of the filesystem.

conf - configuration of this extension.

Throws:

java.io.IOException - failure.

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

getUserAgentSuffix

public java.lang.String getUserAgentSuffix()

Get a suffix for the UserAgent suffix of HTTP requests, which can be used to identify the principal making ABFS requests. If the adaptee is a BoundDTExtension, it is queried for a UA Suffix; otherwise "" is returned.

Specified by:

getUserAgentSuffix in interface BoundDTExtension

Returns:

an empty string, or a key=value string to be added to the UA header.

getCustomTokenProviderAdaptee

@VisibleForTesting
protected CustomTokenProviderAdaptee getCustomTokenProviderAdaptee()