alluxio.client.file.cache

Class LocalCacheFileSystem

java.lang.Object

alluxio.client.file.DelegatingFileSystem

alluxio.client.file.cache.LocalCacheFileSystem

All Implemented Interfaces:

FileSystem, Closeable, AutoCloseable

public class LocalCacheFileSystem
extends DelegatingFileSystem

A FileSystem implementation with a local cache.

Nested Class Summary

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

FileSystem.Factory

Field Summary

Fields inherited from class alluxio.client.file.DelegatingFileSystem

mDelegatedFileSystem

Constructor Summary

Constructors

Constructor and Description
LocalCacheFileSystem(CacheManager cacheManage, FileSystem fs, AlluxioConfiguration conf)

Method Summary

Modifier and Type	Method and Description
AlluxioConfiguration	getConf()
FileInStream	openFile(AlluxioURI path, OpenFilePOptions options) Opens a file for reading.
FileInStream	openFile(URIStatus status, OpenFilePOptions options) Opens a file for reading.
PositionReader	openPositionRead(AlluxioURI path, OpenFilePOptions options) Opens a file for position reading.
PositionReader	openPositionRead(URIStatus status, OpenFilePOptions options) Opens a file for reading.

Methods inherited from class alluxio.client.file.DelegatingFileSystem

checkAccess, close, createDirectory, createFile, delete, exists, free, getBlockLocations, getBlockLocations, getDoraCacheFileSystem, getJobProgress, getMountTable, getStatus, getUfsBaseFileSystem, getUnderlyingFileSystem, isClosed, iterateStatus, listStatus, listStatusPartial, loadMetadata, mount, needsSync, persist, rename, reverseResolve, setAcl, setAttribute, stopJob, submitJob, 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, getMountTable, getStatus, iterateStatus, listStatus, loadMetadata, mount, openFile, openPositionRead, persist, rename, setAcl, setAttribute, unmount

Constructor Detail

LocalCacheFileSystem

public LocalCacheFileSystem(CacheManager cacheManage,
                            FileSystem fs,
                            AlluxioConfiguration conf)

Parameters:

cacheManage - cache manager

fs - a FileSystem instance to query on local cache miss

conf - the configuration, only respected for the first call

Method Detail

getConf

public AlluxioConfiguration getConf()

Specified by:

getConf in interface FileSystem

Overrides:

getConf in class DelegatingFileSystem

Returns:

the configuration which the FileSystem is using to connect to Alluxio

openFile

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

Description copied from interface: FileSystem

Opens a file for reading.

Specified by:

openFile in interface FileSystem

Overrides:

openFile in class DelegatingFileSystem

Parameters:

path - the file to read from

options - options to associate with this operation

Returns:

a FileInStream for the given path

Throws:

FileDoesNotExistException - when path does not exist

OpenDirectoryException - when path is a directory

FileIncompleteException - when path is a file and is not completed yet

IOException

AlluxioException

openFile

public FileInStream openFile(URIStatus status,
                             OpenFilePOptions options)
                      throws IOException,
                             AlluxioException

Description copied from interface: FileSystem

Opens a file for reading.

Specified by:

openFile in interface FileSystem

Overrides:

openFile in class DelegatingFileSystem

Parameters:

status - status of the file to read from

options - options to associate with this operation

Returns:

a FileInStream for the given path

Throws:

FileDoesNotExistException - when path does not exist

OpenDirectoryException - when path is a directory

FileIncompleteException - when path is a file and is not completed yet

IOException

AlluxioException

openPositionRead

public PositionReader openPositionRead(AlluxioURI path,
                                       OpenFilePOptions options)
                                throws FileDoesNotExistException

Description copied from interface: FileSystem

Opens a file for position reading.

Specified by:

openPositionRead in interface FileSystem

Overrides:

openPositionRead in class DelegatingFileSystem

Parameters:

path - the file to read from

options - options to associate with this operation

Returns:

a PositionReader for the given path

Throws:

FileDoesNotExistException

openPositionRead

public PositionReader openPositionRead(URIStatus status,
                                       OpenFilePOptions options)

Description copied from interface: FileSystem

Opens a file for reading.

Specified by:

openPositionRead in interface FileSystem

Overrides:

openPositionRead in class DelegatingFileSystem

Parameters:

status - status of the file to read from

options - options to associate with this operation

Returns:

a PositionReader for the given path