alluxio.underfs.hdfs

Class HdfsUnderFileSystemFactory

java.lang.Object

alluxio.underfs.hdfs.HdfsUnderFileSystemFactory

All Implemented Interfaces:

ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>, UnderFileSystemFactory

Direct Known Subclasses:

OzoneUnderFileSystemFactory

@ThreadSafe
public class HdfsUnderFileSystemFactory
extends Object
implements UnderFileSystemFactory

Factory for creating HdfsUnderFileSystem. It caches created HdfsUnderFileSystems, using the scheme and authority pair as the key.

Constructor Summary

Constructors

Constructor and Description
HdfsUnderFileSystemFactory() Constructs a new HdfsUnderFileSystemFactory.

Method Summary

Modifier and Type	Method and Description
UnderFileSystem	create(String path, UnderFileSystemConfiguration conf) Creates a new client for accessing the given path.
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 UnderFileSystemFactory.create(String, UnderFileSystemConfiguration) can succeed for this path.
boolean	supportsPath(String path, UnderFileSystemConfiguration conf) Gets whether this factory supports the given path and thus whether calling the UnderFileSystemFactory.create(String, UnderFileSystemConfiguration) can succeed for this path.

Methods inherited from class java.lang.Object

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

Constructor Detail

HdfsUnderFileSystemFactory

public HdfsUnderFileSystemFactory()

Constructs a new HdfsUnderFileSystemFactory.

Method Detail

create

public UnderFileSystem create(String path,
                              UnderFileSystemConfiguration conf)

Description copied from interface: UnderFileSystemFactory

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>

Specified by:

create in interface UnderFileSystemFactory

Parameters:

path - file path

conf - configuration object for the UFS

Returns:

the client

supportsPath

public boolean supportsPath(String path)

Description copied from interface: UnderFileSystemFactory

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

Specified by:

supportsPath in interface UnderFileSystemFactory

Parameters:

path - file path

Returns:

true if the path is supported, false otherwise

supportsPath

public boolean supportsPath(String path,
                            UnderFileSystemConfiguration conf)

Description copied from interface: UnderFileSystemFactory

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

Specified by:

supportsPath in interface ExtensionFactory<UnderFileSystem,UnderFileSystemConfiguration>

Specified by:

supportsPath in interface UnderFileSystemFactory

Parameters:

path - file path

conf - configuration object for the UFS

Returns:

true if the path is supported, false otherwise

getVersion

public String getVersion()

Description copied from interface: UnderFileSystemFactory

Get the version supported by this factory.

Specified by:

getVersion in interface UnderFileSystemFactory

Returns:

the version string