Package alluxio.underfs
Interface UnderFileSystemFactory
-
- All Superinterfaces:
ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>
@PublicApi public interface UnderFileSystemFactory extends ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>
Interface for under file system factories.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description UnderFileSystem
create(java.lang.String path, UnderFileSystemConfiguration conf)
Creates a new client for accessing the given path.default java.lang.String
getVersion()
Get the version supported by this factory.boolean
supportsPath(java.lang.String path)
Gets whether this factory supports the given path and thus whether calling thecreate(String, UnderFileSystemConfiguration)
can succeed for this path.default boolean
supportsPath(java.lang.String path, UnderFileSystemConfiguration conf)
Gets whether this factory supports the given path and thus whether calling thecreate(String, UnderFileSystemConfiguration)
can succeed for this path.
-
-
-
Method Detail
-
create
UnderFileSystem create(java.lang.String path, UnderFileSystemConfiguration conf)
Creates a new client for accessing the given path. AnIllegalArgumentException
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 interfaceExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>
- Parameters:
path
- file pathconf
- configuration object for the UFS- Returns:
- the client
-
supportsPath
boolean supportsPath(java.lang.String path)
Gets whether this factory supports the given path and thus whether calling thecreate(String, UnderFileSystemConfiguration)
can succeed for this path.- Parameters:
path
- file path- Returns:
- true if the path is supported, false otherwise
-
supportsPath
default boolean supportsPath(java.lang.String path, UnderFileSystemConfiguration conf)
Gets whether this factory supports the given path and thus whether calling thecreate(String, UnderFileSystemConfiguration)
can succeed for this path.- Specified by:
supportsPath
in interfaceExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>
- Parameters:
path
- file pathconf
- configuration object for the UFS- Returns:
- true if the path is supported, false otherwise
-
getVersion
default java.lang.String getVersion()
Get the version supported by this factory.- Returns:
- the version string
-
-