alluxio.client.file

Interface FileSystem

All Known Implementing Classes:

BaseFileSystem, LineageFileSystem

@PublicApi
public interface FileSystem

Basic file system interface supporting metadata operations and data operations. Developers should not implement this class but extend the default implementation provided by BaseFileSystem instead. This ensures any new methods added to the interface will be provided by the default implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FileSystem.Factory Factory for FileSystem.

Method Summary

Modifier and Type	Method and Description
void	createDirectory(AlluxioURI path) Convenience method for createDirectory(AlluxioURI, CreateDirectoryOptions) with default options.
void	createDirectory(AlluxioURI path, CreateDirectoryOptions options) Creates a directory.
FileOutStream	createFile(AlluxioURI path) Convenience method for createFile(AlluxioURI, CreateFileOptions) with default options.
FileOutStream	createFile(AlluxioURI path, CreateFileOptions options) Creates a file.
void	delete(AlluxioURI path) Convenience method for 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 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 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.
Map<String,MountPointInfo>	getMountTable() Lists all mount points and their corresponding under storage addresses.
URIStatus	getStatus(AlluxioURI path) Convenience method for 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 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 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 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 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 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 unmount(AlluxioURI, UnmountOptions) with default options.
void	unmount(AlluxioURI path, UnmountOptions options) Unmounts a UFS subtree identified by the given Alluxio path.

Method Detail

createDirectory

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

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

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

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

Creates a directory.

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

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

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

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

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

Creates a file.

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

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

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

Parameters:

path - the path to delete in Alluxio space

Throws:

FileDoesNotExistException - if the given path does not exist

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

IOException

AlluxioException

delete

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

Deletes a file or a directory.

Parameters:

path - the path to delete in Alluxio space

options - options to associate with this operation

Throws:

FileDoesNotExistException - if the given path does not exist

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

IOException

AlluxioException

exists

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

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

Parameters:

path - the path in question

Returns:

true if the path exists, false otherwise

Throws:

InvalidPathException - if the path is invalid

IOException

AlluxioException

exists

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

Checks whether a path exists in Alluxio space.

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

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

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

Parameters:

path - the path to free in Alluxio space

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

free

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

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.

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

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

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

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

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

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

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

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

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

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

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

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.

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
void loadMetadata(AlluxioURI path)
                       throws FileDoesNotExistException,
                              IOException,
                              AlluxioException

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

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

Parameters:

path - the path for which to load metadata from UFS

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

loadMetadata

@Deprecated
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.

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

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

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

Parameters:

alluxioPath - an Alluxio path to mount the data to

ufsPath - a UFS path to mount the data from

Throws:

IOException

AlluxioException

mount

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

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.

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

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

Lists all mount points and their corresponding under storage addresses.

Returns:

a map from String to MountPointInfo

Throws:

IOException

AlluxioException

openFile

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

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

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

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

Opens a file for reading.

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

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

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

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

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

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.

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

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

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

Parameters:

path - the path to set attributes for

Throws:

FileDoesNotExistException - if the given file does not exist

IOException

AlluxioException

setAttribute

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

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

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

void unmount(AlluxioURI path)
      throws IOException,
             AlluxioException

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

Parameters:

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

Throws:

IOException

AlluxioException

unmount

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

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.

Parameters:

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

options - options to associate with this operation

Throws:

IOException

AlluxioException