alluxio.client.file

Class MetadataCachingBaseFileSystem

java.lang.Object

alluxio.client.file.BaseFileSystem

alluxio.client.file.MetadataCachingBaseFileSystem

All Implemented Interfaces:

FileSystem, Closeable, AutoCloseable

@ThreadSafe
public class MetadataCachingBaseFileSystem
extends BaseFileSystem

FileSystem implementation with the capability of caching metadata of paths.

Nested Class Summary

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

FileSystem.Factory

Field Summary

Fields inherited from class alluxio.client.file.BaseFileSystem

mBlockStore, mClosed, mFsContext

Constructor Summary

Constructors

Constructor and Description
MetadataCachingBaseFileSystem(FileSystemContext context)

Method Summary

Modifier and Type	Method and Description
void	asyncUpdateFileAccessTime(AlluxioURI path) Asynchronously update file's last access time.
void	close() Shuts down the FileSystem.
void	createDirectory(AlluxioURI path, CreateDirectoryPOptions options) Creates a directory.
FileOutStream	createFile(AlluxioURI path, CreateFilePOptions options) Creates a file.
void	delete(AlluxioURI path, DeletePOptions options) Deletes a file or a directory.
void	dropMetadataCache(AlluxioURI uri) Drops metadata cache of a given uri and all its parents.
void	dropMetadataCacheAll() Drop all metadata cache.
long	getMetadataCacheSize()
URIStatus	getStatus(AlluxioURI path, GetStatusPOptions options) Gets the URIStatus object that represents the metadata of an Alluxio path.
void	iterateStatus(AlluxioURI path, ListStatusPOptions options, java.util.function.Consumer<? super URIStatus> action) Performs a specific action on each URIStatus in the result of FileSystem.listStatus(alluxio.AlluxioURI).
List<URIStatus>	listStatus(AlluxioURI path, ListStatusPOptions options) If the path is a directory, returns the URIStatus of all the direct entries in it.
void	rename(AlluxioURI src, AlluxioURI dst, RenamePOptions options) Renames an existing Alluxio path to another Alluxio path in Alluxio.

Methods inherited from class alluxio.client.file.BaseFileSystem

checkAccess, checkUri, exists, free, getBlockLocations, getConf, getMountTable, getSyncPathList, isClosed, loadMetadata, mount, openFile, openFile, persist, reverseResolve, setAcl, setAttribute, startSync, stopSync, unmount, updateMount

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.client.file.FileSystem

createDirectory, createFile, delete, exists, free, getStatus, iterateStatus, listStatus, loadMetadata, mount, openFile, persist, rename, setAcl, setAttribute, unmount

Constructor Detail

MetadataCachingBaseFileSystem

public MetadataCachingBaseFileSystem(FileSystemContext context)

Parameters:

context - the fs context

Method Detail

createDirectory

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

Description copied from interface: FileSystem

Creates a directory.

Specified by:

createDirectory in interface FileSystem

Overrides:

createDirectory in class BaseFileSystem

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,
                                CreateFilePOptions options)
                         throws IOException,
                                AlluxioException

Description copied from interface: FileSystem

Creates a file.

Specified by:

createFile in interface FileSystem

Overrides:

createFile in class BaseFileSystem

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,
                   DeletePOptions options)
            throws IOException,
                   AlluxioException

Description copied from interface: FileSystem

Deletes a file or a directory.

Specified by:

delete in interface FileSystem

Overrides:

delete in class BaseFileSystem

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

rename

public void rename(AlluxioURI src,
                   AlluxioURI dst,
                   RenamePOptions options)
            throws 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

Overrides:

rename in class BaseFileSystem

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

getStatus

public URIStatus getStatus(AlluxioURI path,
                           GetStatusPOptions 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

Overrides:

getStatus in class BaseFileSystem

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

iterateStatus

public void iterateStatus(AlluxioURI path,
                          ListStatusPOptions options,
                          java.util.function.Consumer<? super URIStatus> action)
                   throws FileDoesNotExistException,
                          IOException,
                          AlluxioException

Description copied from interface: FileSystem

Performs a specific action on each URIStatus in the result of FileSystem.listStatus(alluxio.AlluxioURI). This method is preferred when iterating over directories with a large number of files or sub-directories inside. The caller can proceed with partial result without waiting for all result returned.

Specified by:

iterateStatus in interface FileSystem

Overrides:

iterateStatus in class BaseFileSystem

Parameters:

path - the path to list information about

options - options to associate with this operation

action - action to apply on each URIStatus

Throws:

FileDoesNotExistException - if the given path does not exist

IOException

AlluxioException

listStatus

public List<URIStatus> listStatus(AlluxioURI path,
                                  ListStatusPOptions 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

Overrides:

listStatus in class BaseFileSystem

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

asyncUpdateFileAccessTime

public void asyncUpdateFileAccessTime(AlluxioURI path)

Asynchronously update file's last access time.

Parameters:

path - the path to the file

close

public void close()
           throws IOException

Description copied from class: BaseFileSystem

Shuts down the FileSystem. Closes all thread pools and resources used to perform operations. If any operations are called after closing the context the behavior is undefined.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class BaseFileSystem

Throws:

IOException

dropMetadataCache

public void dropMetadataCache(AlluxioURI uri)

Drops metadata cache of a given uri and all its parents.

Parameters:

uri - the uri need to drop metadata cache

dropMetadataCacheAll

public void dropMetadataCacheAll()

Drop all metadata cache.

getMetadataCacheSize

public long getMetadataCacheSize()

Returns:

metadata cache size