alluxio.extensions

Interface ExtensionFactory<T,S>

Type Parameters:

T - The type of instance to be created

S - the type of configuration to be used when creating the extension

All Known Subinterfaces:

UnderFileSystemFactory

All Known Implementing Classes:

COSUnderFileSystemFactory, GCSUnderFileSystemFactory, HdfsUnderFileSystemFactory, LocalUnderFileSystemFactory, OSSUnderFileSystemFactory, S3AUnderFileSystemFactory, SwiftUnderFileSystemFactory, WasbUnderFileSystemFactory

public interface ExtensionFactory<T,S>

A factory class for creating instance of T based on configuration S.

Method Summary

Modifier and Type	Method and Description
T	create(String path, S conf) Creates a new extension for the given path.
boolean	supportsPath(String path, S conf) Gets whether this factory supports the given path and thus whether calling the #create(String, S) can succeed for this path.

Method Detail

create

T create(String path,
         @Nullable
         S conf)

Creates a new extension for the given path. An IllegalArgumentException is thrown if this factory does not support extension for the given path or if the configuration provided is insufficient to create an extension.

Parameters:

path - file path with scheme for which the extension will be created

conf - optional configuration object for the extension, may be null

Returns:

the new extension

supportsPath

boolean supportsPath(String path,
                     @Nullable
                     S conf)

Gets whether this factory supports the given path and thus whether calling the #create(String, S) can succeed for this path.

Parameters:

path - file path with scheme for which the extension will be created

conf - optional configuration object for the extension, may be null

Returns:

true if the path is supported, false otherwise