alluxio.underfs.local

Class LocalUnderFileSystem

java.lang.Object

alluxio.underfs.BaseUnderFileSystem

alluxio.underfs.ConsistentUnderFileSystem

alluxio.underfs.local.LocalUnderFileSystem

All Implemented Interfaces:

AtomicFileOutputStreamCallback, UnderFileSystem, java.io.Closeable, java.lang.AutoCloseable

@ThreadSafe
public class LocalUnderFileSystem
extends ConsistentUnderFileSystem
implements AtomicFileOutputStreamCallback

Local FS UnderFileSystem implementation.

This is primarily intended for local unit testing and single machine mode. In principle, it can also be used on a system where a shared file system (e.g. NFS) is mounted at the same path on every node of the system. However, it is generally preferable to use a proper distributed file system for that scenario.

Nested Class Summary

Nested classes/interfaces inherited from interface alluxio.underfs.UnderFileSystem

UnderFileSystem.Factory, UnderFileSystem.SpaceType

Field Summary

Fields inherited from class alluxio.underfs.BaseUnderFileSystem

mUfsConf, mUri

Constructor Summary

Constructors

Constructor and Description
LocalUnderFileSystem(AlluxioURI uri, UnderFileSystemConfiguration ufsConf) Constructs a new LocalUnderFileSystem.

Method Summary

Modifier and Type	Method and Description
void	cleanup()
void	close()
void	connectFromMaster(java.lang.String hostname)
void	connectFromWorker(java.lang.String hostname)
java.io.OutputStream	create(java.lang.String path, CreateOptions options)
java.io.OutputStream	createDirect(java.lang.String path, CreateOptions options)
boolean	deleteDirectory(java.lang.String path, DeleteOptions options)
boolean	deleteFile(java.lang.String path)
boolean	exists(java.lang.String path)
long	getBlockSizeByte(java.lang.String path)
UfsDirectoryStatus	getDirectoryStatus(java.lang.String path)
java.util.List<java.lang.String>	getFileLocations(java.lang.String path)
java.util.List<java.lang.String>	getFileLocations(java.lang.String path, FileLocationOptions options)
UfsFileStatus	getFileStatus(java.lang.String path)
long	getSpace(java.lang.String path, UnderFileSystem.SpaceType type)
UfsStatus	getStatus(java.lang.String path)
java.lang.String	getUnderFSType()
boolean	isDirectory(java.lang.String path)
boolean	isFile(java.lang.String path)
UfsStatus[]	listStatus(java.lang.String path)
boolean	mkdirs(java.lang.String path, MkdirsOptions options)
java.io.InputStream	open(java.lang.String path, OpenOptions options)
boolean	renameDirectory(java.lang.String src, java.lang.String dst)
boolean	renameFile(java.lang.String src, java.lang.String dst)
void	setMode(java.lang.String path, short mode)
void	setOwner(java.lang.String path, java.lang.String user, java.lang.String group)
boolean	supportsFlush()

Methods inherited from class alluxio.underfs.ConsistentUnderFileSystem

createNonexistingFile, createNonexistingFile, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, isExistingDirectory, openExistingFile, openExistingFile, renameRenamableDirectory, renameRenamableFile

Methods inherited from class alluxio.underfs.BaseUnderFileSystem

create, deleteDirectory, getAclPair, getActiveSyncInfo, getFingerprint, getOperationMode, getPhysicalStores, isObjectStorage, isSeekable, listStatus, mkdirs, open, resolveUri, setAclEntries, startActiveSyncPolling, startSync, stopActiveSyncPolling, stopSync, supportsActiveSync, validatePath

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.underfs.UnderFileSystem

create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, getAclPair, getActiveSyncInfo, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, getFingerprint, getOperationMode, getPhysicalStores, isExistingDirectory, isObjectStorage, isSeekable, listStatus, mkdirs, open, openExistingFile, openExistingFile, renameRenamableDirectory, renameRenamableFile, resolveUri, setAclEntries, startActiveSyncPolling, startSync, stopActiveSyncPolling, stopSync, supportsActiveSync

Constructor Detail

LocalUnderFileSystem

public LocalUnderFileSystem(AlluxioURI uri,
                            UnderFileSystemConfiguration ufsConf)

Constructs a new LocalUnderFileSystem.

Parameters:

uri - the AlluxioURI for this UFS

ufsConf - UFS configuration

Method Detail

getUnderFSType

public java.lang.String getUnderFSType()

Specified by:

getUnderFSType in interface UnderFileSystem

cleanup

public void cleanup()
             throws java.io.IOException

Specified by:

cleanup in interface UnderFileSystem

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

create

public java.io.OutputStream create(java.lang.String path,
                                   CreateOptions options)
                            throws java.io.IOException

Specified by:

create in interface UnderFileSystem

Throws:

java.io.IOException

createDirect

public java.io.OutputStream createDirect(java.lang.String path,
                                         CreateOptions options)
                                  throws java.io.IOException

Specified by:

createDirect in interface AtomicFileOutputStreamCallback

Throws:

java.io.IOException

deleteDirectory

public boolean deleteDirectory(java.lang.String path,
                               DeleteOptions options)
                        throws java.io.IOException

Specified by:

deleteDirectory in interface UnderFileSystem

Throws:

java.io.IOException

deleteFile

public boolean deleteFile(java.lang.String path)
                   throws java.io.IOException

Specified by:

deleteFile in interface UnderFileSystem

Throws:

java.io.IOException

exists

public boolean exists(java.lang.String path)
               throws java.io.IOException

Specified by:

exists in interface UnderFileSystem

Overrides:

exists in class BaseUnderFileSystem

Throws:

java.io.IOException

getBlockSizeByte

public long getBlockSizeByte(java.lang.String path)
                      throws java.io.IOException

Specified by:

getBlockSizeByte in interface UnderFileSystem

Throws:

java.io.IOException

getDirectoryStatus

public UfsDirectoryStatus getDirectoryStatus(java.lang.String path)
                                      throws java.io.IOException

Specified by:

getDirectoryStatus in interface UnderFileSystem

Throws:

java.io.IOException

getFileLocations

public java.util.List<java.lang.String> getFileLocations(java.lang.String path)
                                                  throws java.io.IOException

Specified by:

getFileLocations in interface UnderFileSystem

Throws:

java.io.IOException

getFileLocations

public java.util.List<java.lang.String> getFileLocations(java.lang.String path,
                                                         FileLocationOptions options)
                                                  throws java.io.IOException

Specified by:

getFileLocations in interface UnderFileSystem

Throws:

java.io.IOException

getFileStatus

public UfsFileStatus getFileStatus(java.lang.String path)
                            throws java.io.IOException

Specified by:

getFileStatus in interface UnderFileSystem

Throws:

java.io.IOException

getSpace

public long getSpace(java.lang.String path,
                     UnderFileSystem.SpaceType type)
              throws java.io.IOException

Specified by:

getSpace in interface UnderFileSystem

Throws:

java.io.IOException

getStatus

public UfsStatus getStatus(java.lang.String path)
                    throws java.io.IOException

Specified by:

getStatus in interface UnderFileSystem

Throws:

java.io.IOException

isDirectory

public boolean isDirectory(java.lang.String path)
                    throws java.io.IOException

Specified by:

isDirectory in interface UnderFileSystem

Throws:

java.io.IOException

isFile

public boolean isFile(java.lang.String path)
               throws java.io.IOException

Specified by:

isFile in interface UnderFileSystem

Throws:

java.io.IOException

listStatus

public UfsStatus[] listStatus(java.lang.String path)
                       throws java.io.IOException

Specified by:

listStatus in interface UnderFileSystem

Throws:

java.io.IOException

mkdirs

public boolean mkdirs(java.lang.String path,
                      MkdirsOptions options)
               throws java.io.IOException

Specified by:

mkdirs in interface UnderFileSystem

Throws:

java.io.IOException

open

public java.io.InputStream open(java.lang.String path,
                                OpenOptions options)
                         throws java.io.IOException

Specified by:

open in interface UnderFileSystem

Throws:

java.io.IOException

renameDirectory

public boolean renameDirectory(java.lang.String src,
                               java.lang.String dst)
                        throws java.io.IOException

Specified by:

renameDirectory in interface UnderFileSystem

Throws:

java.io.IOException

renameFile

public boolean renameFile(java.lang.String src,
                          java.lang.String dst)
                   throws java.io.IOException

Specified by:

renameFile in interface UnderFileSystem

Throws:

java.io.IOException

setOwner

public void setOwner(java.lang.String path,
                     java.lang.String user,
                     java.lang.String group)
              throws java.io.IOException

Specified by:

setOwner in interface UnderFileSystem

Throws:

java.io.IOException

setMode

public void setMode(java.lang.String path,
                    short mode)
             throws java.io.IOException

Specified by:

setMode in interface UnderFileSystem

Throws:

java.io.IOException

connectFromMaster

public void connectFromMaster(java.lang.String hostname)
                       throws java.io.IOException

Specified by:

connectFromMaster in interface UnderFileSystem

Throws:

java.io.IOException

connectFromWorker

public void connectFromWorker(java.lang.String hostname)
                       throws java.io.IOException

Specified by:

connectFromWorker in interface UnderFileSystem

Throws:

java.io.IOException

supportsFlush

public boolean supportsFlush()
                      throws java.io.IOException

Specified by:

supportsFlush in interface UnderFileSystem

Throws:

java.io.IOException