Package org.apache.hadoop.fs.azurebfs.extensions

Class ExtensionHelper

java.lang.Object

org.apache.hadoop.fs.azurebfs.extensions.ExtensionHelper

@LimitedPrivate("authorization-subsystems")
@Unstable
public final class ExtensionHelper
extends java.lang.Object

Classes to help with use of extensions, expecially those implementing @BoundDTExtension.

Method Summary

Modifier and Type	Method	Description
static void	bind(java.lang.Object extension, java.net.URI uri, org.apache.hadoop.conf.Configuration conf)	If the passed in extension class implements BoundDTExtension then it will have its BoundDTExtension.bind(URI, Configuration) method called.
static void	close(java.lang.Object extension)	Close an extension if it is closeable.
static java.lang.String	getCanonicalServiceName(java.lang.Object extension, java.lang.String def)	Invoke BoundDTExtension.getCanonicalServiceName() or return the default value.
static java.lang.String	getUserAgentSuffix(java.lang.Object extension, java.lang.String def)	Invoke BoundDTExtension.getUserAgentSuffix() or return the default value.
static <V> java.util.Optional<V>	ifBoundDTExtension(java.lang.Object extension, java.util.function.Function<? super BoundDTExtension,? extends V> fn)	Invoke an operation on an object if it implements the BoundDTExtension interface; returns an optional value.

Methods inherited from class java.lang.Object

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

Method Detail

bind

public static void bind(java.lang.Object extension,
                        java.net.URI uri,
                        org.apache.hadoop.conf.Configuration conf)
                 throws java.io.IOException

If the passed in extension class implements BoundDTExtension then it will have its BoundDTExtension.bind(URI, Configuration) method called.

Parameters:

extension - extension to examine and maybe invoke

uri - URI of the filesystem.

conf - configuration of this extension.

Throws:

java.io.IOException - failure during binding.

close

public static void close(java.lang.Object extension)

Close an extension if it is closeable. Any error raised is caught and logged.

Parameters:

extension - extension instance.

getUserAgentSuffix

public static java.lang.String getUserAgentSuffix(java.lang.Object extension,
                                                  java.lang.String def)

Invoke BoundDTExtension.getUserAgentSuffix() or return the default value.

Parameters:

extension - extension to invoke

def - default if the class is of the wrong type.

Returns:

a user agent suffix

getCanonicalServiceName

public static java.lang.String getCanonicalServiceName(java.lang.Object extension,
                                                       java.lang.String def)

Invoke BoundDTExtension.getCanonicalServiceName() or return the default value.

Parameters:

extension - extension to invoke

def - default if the class is of the wrong type.

Returns:

a canonical service name.

ifBoundDTExtension

public static <V> java.util.Optional<V> ifBoundDTExtension(java.lang.Object extension,
                                                           java.util.function.Function<? super BoundDTExtension,? extends V> fn)

Invoke an operation on an object if it implements the BoundDTExtension interface; returns an optional value.

Type Parameters:

V - return type of te function.

Parameters:

extension - the extension to invoke.

fn - function to apply

Returns:

an optional value which, if not empty, contains the return value of the invoked function. If empty: the object was not of a compatible type.