org.apache.hadoop.fs.azurebfs.extensions

Interface BoundDTExtension

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbfsDelegationTokenManager, CustomTokenProviderAdapter

@InterfaceAudience.LimitedPrivate(value="authorization-subsystems")
 @InterfaceStability.Unstable
public interface BoundDTExtension
extends Closeable

An optional extension for custom extensions, so as to support tighter integration. This interface can be implemented by either of a CustomDelegationTokenManager or a CustomTokenProviderAdaptee. In both cases, extra lifecycle operation will be invoked.

1. bind(URI, Configuration) will be invoked after initialize()
2. Closeable.close() will be invoked when the Filesystem instance is closed.

The getCanonicalServiceName() will be invoked on a Custom DT provider when the filesystem is asked for a Canonical Service Name. The getUserAgentSuffix() is invoked on a CustomTokenProviderAdaptee as the filesystem is initialized; the User Agent Suffix which it returns is included in the UA header used for the ABFS Client -and so logged in the ABFS access logs. This allows for token providers to to provide extra information about the caller for use in auditing requests.

Method Summary

Modifier and Type	Method and Description
void	bind(URI fsURI, org.apache.hadoop.conf.Configuration conf) Bind the extension to the specific instance of ABFS.
default String	getCanonicalServiceName() Get the canonical service name, which will be returned by FileSystem.getCanonicalServiceName() and so used to map the issued DT in credentials, including credential files collected for job submission.
default String	getUserAgentSuffix() Get a suffix for the UserAgent suffix of HTTP requests, which can be used to identify the principal making ABFS requests.

Methods inherited from interface java.io.Closeable

close

Method Detail

bind

void bind(URI fsURI,
          org.apache.hadoop.conf.Configuration conf)
   throws IOException

Bind the extension to the specific instance of ABFS. This happens during the ABFS's own initialization logic; it is unlikely to be completely instantiated at this point. Therefore, while a reference may be cached, implementations MUST NOT invoke methods on it.

Parameters:

fsURI - URI of the filesystem.

conf - configuration of this extension.

Throws:

IOException - failure during binding.

getCanonicalServiceName

default String getCanonicalServiceName()

Get the canonical service name, which will be returned by FileSystem.getCanonicalServiceName() and so used to map the issued DT in credentials, including credential files collected for job submission. If null is returned: fall back to the default filesystem logic. Only invoked on CustomDelegationTokenManager instances.

Returns:

the service name to be returned by the filesystem.

getUserAgentSuffix

default String getUserAgentSuffix()

Get a suffix for the UserAgent suffix of HTTP requests, which can be used to identify the principal making ABFS requests.

Returns:

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