alluxio.client.file

Class BaseFileSystem

java.lang.Object

alluxio.client.file.BaseFileSystem

All Implemented Interfaces:

FileSystem

Direct Known Subclasses:

LineageFileSystem

@PublicApi
 @ThreadSafe
public class BaseFileSystem
extends Object
implements FileSystem

Default implementation of the FileSystem interface. Developers can extend this class instead of implementing the interface. This implementation reads and writes data through FileInStream and FileOutStream. This class is thread safe.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.client.file.FileSystem

FileSystem.Factory

Field Summary

Fields

Modifier and Type	Field and Description
protected FileSystemContext	mFileSystemContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseFileSystem(FileSystemContext context) Constructs a new base file system.

Method Summary

Modifier and Type	Method and Description
void	createDirectory(AlluxioURI path) Convenience method for FileSystem.createDirectory(AlluxioURI, CreateDirectoryOptions) with default options.
void	createDirectory(AlluxioURI path, CreateDirectoryOptions options) Creates a directory.
FileOutStream	createFile(AlluxioURI path) Convenience method for FileSystem.createFile(AlluxioURI, CreateFileOptions) with default options.
FileOutStream	createFile(AlluxioURI path, CreateFileOptions options) Creates a file.
void	delete(AlluxioURI path) Convenience method for FileSystem.delete(AlluxioURI, DeleteOptions) with default options.
void	delete(AlluxioURI path, DeleteOptions options) Deletes a file or a directory.
boolean	exists(AlluxioURI path) Convenience method for FileSystem.exists(AlluxioURI, ExistsOptions) with default options.
boolean	exists(AlluxioURI path, ExistsOptions options) Checks whether a path exists in Alluxio space.
void	free(AlluxioURI path) Convenience method for FileSystem.free(AlluxioURI, FreeOptions) with default options.
void	free(AlluxioURI path, FreeOptions options) Evicts any data under the given path from Alluxio space, but does not delete the data from the UFS.
static BaseFileSystem	get(FileSystemContext context)
Map<String,MountPointInfo>	getMountTable() Lists all mount points and their corresponding under storage addresses.
URIStatus	getStatus(AlluxioURI path) Convenience method for FileSystem.getStatus(AlluxioURI, GetStatusOptions) with default options.
URIStatus	getStatus(AlluxioURI path, GetStatusOptions options) Gets the URIStatus object that represents the metadata of an Alluxio path.
List<URIStatus>	listStatus(AlluxioURI path) Convenience method for FileSystem.listStatus(AlluxioURI, ListStatusOptions) with default options.
List<URIStatus>	listStatus(AlluxioURI path, ListStatusOptions options) If the path is a directory, returns the URIStatus of all the direct entries in it.
void	loadMetadata(AlluxioURI path) Deprecated. since version 1.1 and will be removed in version 2.0
void	loadMetadata(AlluxioURI path, LoadMetadataOptions options) Deprecated. since version 1.1 and will be removed in version 2.0
void	mount(AlluxioURI alluxioPath, AlluxioURI ufsPath) Convenience method for FileSystem.mount(AlluxioURI, AlluxioURI, MountOptions) with default options.
void	mount(AlluxioURI alluxioPath, AlluxioURI ufsPath, MountOptions options) Mounts a UFS subtree to the given Alluxio path.
FileInStream	openFile(AlluxioURI path) Convenience method for FileSystem.openFile(AlluxioURI, OpenFileOptions) with default options.
FileInStream	openFile(AlluxioURI path, OpenFileOptions options) Opens a file for reading.
void	rename(AlluxioURI src, AlluxioURI dst) Convenience method for FileSystem.rename(AlluxioURI, AlluxioURI, RenameOptions) with default options.
void	rename(AlluxioURI src, AlluxioURI dst, RenameOptions options) Renames an existing Alluxio path to another Alluxio path in Alluxio.
void	setAttribute(AlluxioURI path) Convenience method for FileSystem.setAttribute(AlluxioURI, SetAttributeOptions) with default options.
void	setAttribute(AlluxioURI path, SetAttributeOptions options) Sets any number of a path's attributes, such as TTL and pin status.
void	unmount(AlluxioURI path) Convenience method for FileSystem.unmount(AlluxioURI, UnmountOptions) with default options.
void	unmount(AlluxioURI path, UnmountOptions options) Unmounts a UFS subtree identified by the given Alluxio path.

Methods inherited from class java.lang.Object

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

Field Detail

mFileSystemContext

protected final FileSystemContext mFileSystemContext

Constructor Detail

BaseFileSystem

protected BaseFileSystem(FileSystemContext context)

Constructs a new base file system.

Parameters:

context - file system context

Method Detail

get

public static BaseFileSystem get(FileSystemContext context)

Parameters:

context - file system context

Returns:

a BaseFileSystem

createDirectory

public void createDirectory(AlluxioURI path)
                     throws FileAlreadyExistsException,
                            InvalidPathException,
                            IOException,
                            AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.createDirectory(AlluxioURI, CreateDirectoryOptions) with default options.

Specified by:

createDirectory in interface FileSystem

Parameters:

path - the path of the directory to create in Alluxio space

Throws:

FileAlreadyExistsException - if there is already a file or directory at the given path

InvalidPathException - if the path is invalid

IOException

AlluxioException

createDirectory

public void createDirectory(AlluxioURI path,
                            CreateDirectoryOptions options)
                     throws FileAlreadyExistsException,
                            InvalidPathException,
                            IOException,
                            AlluxioException

Description copied from interface: FileSystem

Creates a directory.

Specified by:

createDirectory in interface FileSystem

Parameters:

path - the path of the directory to create in Alluxio space

options - options to associate with this operation

Throws:

FileAlreadyExistsException - if there is already a file or directory at the given path

InvalidPathException - if the path is invalid

IOException

AlluxioException

createFile

public FileOutStream createFile(AlluxioURI path)
                         throws FileAlreadyExistsException,
                                InvalidPathException,
                                IOException,
                                AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.createFile(AlluxioURI, CreateFileOptions) with default options.

Specified by:

createFile in interface FileSystem

Parameters:

path - the path of the file to create in Alluxio space

Returns:

a FileOutStream which will write data to the newly created file

Throws:

FileAlreadyExistsException - if there is already a file at the given path

InvalidPathException - if the path is invalid

IOException

AlluxioException

createFile

public FileOutStream createFile(AlluxioURI path,
                                CreateFileOptions options)
                         throws FileAlreadyExistsException,
                                InvalidPathException,
                                IOException,
                                AlluxioException

Description copied from interface: FileSystem

Creates a file.

Specified by:

createFile in interface FileSystem

Parameters:

path - the path of the file to create in Alluxio space

options - options to associate with this operation

Returns:

a FileOutStream which will write data to the newly created file

Throws:

FileAlreadyExistsException - if there is already a file at the given path

InvalidPathException - if the path is invalid

IOException

AlluxioException

delete

public void delete(AlluxioURI path)
            throws DirectoryNotEmptyException,
                   FileDoesNotExistException,
                   IOException,
                   AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.delete(AlluxioURI, DeleteOptions) with default options.

Specified by:

delete in interface FileSystem

Parameters:

path - the path to delete in Alluxio space

Throws:

DirectoryNotEmptyException - if recursive is false and the path is a nonempty directory

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

delete

public void delete(AlluxioURI path,
                   DeleteOptions options)
            throws DirectoryNotEmptyException,
                   FileDoesNotExistException,
                   IOException,
                   AlluxioException

Description copied from interface: FileSystem

Deletes a file or a directory.

Specified by:

delete in interface FileSystem

Parameters:

path - the path to delete in Alluxio space

options - options to associate with this operation

Throws:

DirectoryNotEmptyException - if recursive is false and the path is a nonempty directory

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

exists

public boolean exists(AlluxioURI path)
               throws InvalidPathException,
                      IOException,
                      AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.exists(AlluxioURI, ExistsOptions) with default options.

Specified by:

exists in interface FileSystem

Parameters:

path - the path in question

Returns:

true if the path exists, false otherwise

Throws:

InvalidPathException - if the path is invalid

IOException

AlluxioException

exists

public boolean exists(AlluxioURI path,
                      ExistsOptions options)
               throws InvalidPathException,
                      IOException,
                      AlluxioException

Description copied from interface: FileSystem

Checks whether a path exists in Alluxio space.

Specified by:

exists in interface FileSystem

Parameters:

path - the path in question

options - options to associate with this operation

Returns:

true if the path exists, false otherwise

Throws:

InvalidPathException - if the path is invalid

IOException

AlluxioException

free

public void free(AlluxioURI path)
          throws FileDoesNotExistException,
                 IOException,
                 AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.free(AlluxioURI, FreeOptions) with default options.

Specified by:

free in interface FileSystem

Parameters:

path - the path to free in Alluxio space

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

free

public void free(AlluxioURI path,
                 FreeOptions options)
          throws FileDoesNotExistException,
                 IOException,
                 AlluxioException

Description copied from interface: FileSystem

Evicts any data under the given path from Alluxio space, but does not delete the data from the UFS. The metadata will still be present in Alluxio space after this operation.

Specified by:

free in interface FileSystem

Parameters:

path - the path to free in Alluxio space

options - options to associate with this operation

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

getStatus

public URIStatus getStatus(AlluxioURI path)
                    throws FileDoesNotExistException,
                           IOException,
                           AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.getStatus(AlluxioURI, GetStatusOptions) with default options.

Specified by:

getStatus in interface FileSystem

Parameters:

path - the path to obtain information about

Returns:

the URIStatus of the file

Throws:

FileDoesNotExistException - if the path does not exist

IOException

AlluxioException

getStatus

public URIStatus getStatus(AlluxioURI path,
                           GetStatusOptions options)
                    throws FileDoesNotExistException,
                           IOException,
                           AlluxioException

Description copied from interface: FileSystem

Gets the URIStatus object that represents the metadata of an Alluxio path.

Specified by:

getStatus in interface FileSystem

Parameters:

path - the path to obtain information about

options - options to associate with this operation

Returns:

the URIStatus of the file

Throws:

FileDoesNotExistException - if the path does not exist

IOException

AlluxioException

listStatus

public List<URIStatus> listStatus(AlluxioURI path)
                           throws FileDoesNotExistException,
                                  IOException,
                                  AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.listStatus(AlluxioURI, ListStatusOptions) with default options.

Specified by:

listStatus in interface FileSystem

Parameters:

path - the path to list information about

Returns:

a list of URIStatuss containing information about the files and directories which are children of the given path

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

listStatus

public List<URIStatus> listStatus(AlluxioURI path,
                                  ListStatusOptions options)
                           throws FileDoesNotExistException,
                                  IOException,
                                  AlluxioException

Description copied from interface: FileSystem

If the path is a directory, returns the URIStatus of all the direct entries in it. Otherwise returns a list with a single URIStatus element for the file.

Specified by:

listStatus in interface FileSystem

Parameters:

path - the path to list information about

options - options to associate with this operation

Returns:

a list of URIStatuss containing information about the files and directories which are children of the given path

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

loadMetadata

@Deprecated
public void loadMetadata(AlluxioURI path)
                              throws FileDoesNotExistException,
                                     IOException,
                                     AlluxioException

Deprecated. since version 1.1 and will be removed in version 2.0

Convenience method for FileSystem.loadMetadata(AlluxioURI, LoadMetadataOptions) with default options.

Specified by:

loadMetadata in interface FileSystem

Parameters:

path - the path for which to load metadata from UFS

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

loadMetadata

@Deprecated
public void loadMetadata(AlluxioURI path,
                                     LoadMetadataOptions options)
                              throws FileDoesNotExistException,
                                     IOException,
                                     AlluxioException

Deprecated. since version 1.1 and will be removed in version 2.0

Loads metadata about a path in the UFS to Alluxio. No data will be transferred.

Specified by:

loadMetadata in interface FileSystem

Parameters:

path - the path for which to load metadata from UFS

options - options to associate with this operation

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

mount

public void mount(AlluxioURI alluxioPath,
                  AlluxioURI ufsPath)
           throws IOException,
                  AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.mount(AlluxioURI, AlluxioURI, MountOptions) with default options.

Specified by:

mount in interface FileSystem

Parameters:

alluxioPath - an Alluxio path to mount the data to

ufsPath - a UFS path to mount the data from

Throws:

IOException

AlluxioException

mount

public void mount(AlluxioURI alluxioPath,
                  AlluxioURI ufsPath,
                  MountOptions options)
           throws IOException,
                  AlluxioException

Description copied from interface: FileSystem

Mounts a UFS subtree to the given Alluxio path. The Alluxio path is expected not to exist as the method creates it. If the path already exists, a AlluxioException will be thrown. This method does not transfer any data or metadata from the UFS. It simply establishes the connection between the given Alluxio path and UFS path.

Specified by:

mount in interface FileSystem

Parameters:

alluxioPath - an Alluxio path to mount the data to

ufsPath - a UFS path to mount the data from

options - options to associate with this operation

Throws:

IOException

AlluxioException

getMountTable

public Map<String,MountPointInfo> getMountTable()
                                         throws IOException,
                                                AlluxioException

Description copied from interface: FileSystem

Lists all mount points and their corresponding under storage addresses.

Specified by:

getMountTable in interface FileSystem

Returns:

a map from String to MountPointInfo

Throws:

IOException

AlluxioException

openFile

public FileInStream openFile(AlluxioURI path)
                      throws FileDoesNotExistException,
                             IOException,
                             AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.openFile(AlluxioURI, OpenFileOptions) with default options.

Specified by:

openFile in interface FileSystem

Parameters:

path - the file to read from

Returns:

a FileInStream for the given path

Throws:

FileDoesNotExistException - if the given file does not exist

IOException

AlluxioException

openFile

public FileInStream openFile(AlluxioURI path,
                             OpenFileOptions options)
                      throws FileDoesNotExistException,
                             IOException,
                             AlluxioException

Description copied from interface: FileSystem

Opens a file for reading.

Specified by:

openFile in interface FileSystem

Parameters:

path - the file to read from

options - options to associate with this operation

Returns:

a FileInStream for the given path

Throws:

FileDoesNotExistException - if the given file does not exist

IOException

AlluxioException

rename

public void rename(AlluxioURI src,
                   AlluxioURI dst)
            throws FileDoesNotExistException,
                   IOException,
                   AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.rename(AlluxioURI, AlluxioURI, RenameOptions) with default options.

Specified by:

rename in interface FileSystem

Parameters:

src - the path of the source, this must already exist

dst - the path of the destination, this path should not exist

Throws:

FileDoesNotExistException - if the given file does not exist

IOException

AlluxioException

rename

public void rename(AlluxioURI src,
                   AlluxioURI dst,
                   RenameOptions options)
            throws FileDoesNotExistException,
                   IOException,
                   AlluxioException

Description copied from interface: FileSystem

Renames an existing Alluxio path to another Alluxio path in Alluxio. This operation will be propagated in the underlying storage if the path is persisted.

Specified by:

rename in interface FileSystem

Parameters:

src - the path of the source, this must already exist

dst - the path of the destination, this path should not exist

options - options to associate with this operation

Throws:

FileDoesNotExistException - if the given file does not exist

IOException

AlluxioException

setAttribute

public void setAttribute(AlluxioURI path)
                  throws FileDoesNotExistException,
                         IOException,
                         AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.setAttribute(AlluxioURI, SetAttributeOptions) with default options.

Specified by:

setAttribute in interface FileSystem

Parameters:

path - the path to set attributes for

Throws:

FileDoesNotExistException - if the given file does not exist

IOException

AlluxioException

setAttribute

public void setAttribute(AlluxioURI path,
                         SetAttributeOptions options)
                  throws FileDoesNotExistException,
                         IOException,
                         AlluxioException

Description copied from interface: FileSystem

Sets any number of a path's attributes, such as TTL and pin status.

Specified by:

setAttribute in interface FileSystem

Parameters:

path - the path to set attributes for

options - options to associate with this operation

Throws:

FileDoesNotExistException - if the given file does not exist

IOException

AlluxioException

unmount

public void unmount(AlluxioURI path)
             throws IOException,
                    AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.unmount(AlluxioURI, UnmountOptions) with default options.

Specified by:

unmount in interface FileSystem

Parameters:

path - an Alluxio path, this must be a mount point

Throws:

IOException

AlluxioException

unmount

public void unmount(AlluxioURI path,
                    UnmountOptions options)
             throws IOException,
                    AlluxioException

Description copied from interface: FileSystem

Unmounts a UFS subtree identified by the given Alluxio path. The Alluxio path match a previously mounted path. The contents of the subtree rooted at this path are removed from Alluxio but the corresponding UFS subtree is left untouched.

Specified by:

unmount in interface FileSystem

Parameters:

path - an Alluxio path, this must be a mount point

options - options to associate with this operation

Throws:

IOException

AlluxioException