alluxio.underfs

Interface UnderFileSystemFactory

All Superinterfaces:

ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>

All Known Implementing Classes:

COSUnderFileSystemFactory, GCSUnderFileSystemFactory, HdfsUnderFileSystemFactory, KodoUnderFileSystemFactory, LocalUnderFileSystemFactory, OSSUnderFileSystemFactory, OzoneUnderFileSystemFactory, S3AUnderFileSystemFactory, SwiftUnderFileSystemFactory, WasbUnderFileSystemFactory, WebUnderFileSystemFactory

@PublicApi
public interface UnderFileSystemFactory
extends ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>

Interface for under file system factories.

Method Summary

Modifier and Type	Method and Description
UnderFileSystem	create(String path, UnderFileSystemConfiguration conf) Creates a new client for accessing the given path.
default String	getVersion() Get the version supported by this factory.
boolean	supportsPath(String path) Gets whether this factory supports the given path and thus whether calling the create(String, UnderFileSystemConfiguration) can succeed for this path.
default boolean	supportsPath(String path, UnderFileSystemConfiguration conf) Gets whether this factory supports the given path and thus whether calling the create(String, UnderFileSystemConfiguration) can succeed for this path.

Method Detail

create

UnderFileSystem create(String path,
                       UnderFileSystemConfiguration conf)

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

Specified by:

create in interface ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>

Parameters:

path - file path

conf - configuration object for the UFS

Returns:

the client

supportsPath

boolean supportsPath(String path)

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

Parameters:

path - file path

Returns:

true if the path is supported, false otherwise

supportsPath

default boolean supportsPath(String path,
                             UnderFileSystemConfiguration conf)

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

Specified by:

supportsPath in interface ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>

Parameters:

path - file path

conf - configuration object for the UFS

Returns:

true if the path is supported, false otherwise

getVersion

default String getVersion()

Get the version supported by this factory.

Returns:

the version string