@ThreadSafe public class LocalUnderFileSystem extends ConsistentUnderFileSystem implements AtomicFileOutputStreamCallback
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.
UnderFileSystem.Factory, UnderFileSystem.SpaceTypeEMPTY_ACL, mUfsConf, mUri| Constructor and Description |
|---|
LocalUnderFileSystem(AlluxioURI uri,
UnderFileSystemConfiguration ufsConf)
Constructs a new
LocalUnderFileSystem. |
| Modifier and Type | Method and Description |
|---|---|
void |
cleanup()
Cleans up the under file system.
|
void |
close() |
void |
connectFromMaster(String hostname)
Takes any necessary actions required to establish a connection to the under file system from
the given master host e.g.
|
void |
connectFromWorker(String hostname)
Takes any necessary actions required to establish a connection to the under file system from
the given worker host e.g.
|
OutputStream |
create(String path,
CreateOptions options)
Creates a file in the under file system with the specified
CreateOptions. |
OutputStream |
createDirect(String path,
CreateOptions options)
Creates a file in the under file system with the specified
CreateOptions. |
boolean |
deleteDirectory(String path,
DeleteOptions options)
Deletes a directory from the under file system with the indicated name.
|
boolean |
deleteFile(String path)
Deletes a file from the under file system with the indicated name.
|
boolean |
exists(String path)
Checks if a file or directory exists in under file system.
|
long |
getBlockSizeByte(String path)
Gets the block size of a file in under file system, in bytes.
|
UfsDirectoryStatus |
getDirectoryStatus(String path)
Gets the directory status.
|
List<String> |
getFileLocations(String path)
Gets the list of locations of the indicated path.
|
List<String> |
getFileLocations(String path,
FileLocationOptions options)
Gets the list of locations of the indicated path given options.
|
UfsFileStatus |
getFileStatus(String path,
GetStatusOptions options)
Gets the file status.
|
long |
getSpace(String path,
UnderFileSystem.SpaceType type)
Queries the under file system about the space of the indicated path (e.g., space left, space
used and etc).
|
UfsStatus |
getStatus(String path,
GetStatusOptions options)
Gets the file or directory status.
|
String |
getUnderFSType()
Returns the name of the under filesystem implementation.
|
boolean |
isDirectory(String path)
Checks if a directory exists in under file system.
|
boolean |
isFile(String path)
Checks if a file exists in under file system.
|
UfsStatus[] |
listStatus(String path)
Returns an array of statuses of the files and directories in the directory denoted by this
abstract pathname.
|
boolean |
mkdirs(String path,
MkdirsOptions options)
Creates the directory named by this abstract pathname, with specified
MkdirsOptions. |
InputStream |
open(String path,
OpenOptions options)
Opens an
InputStream for a file in under filesystem at the indicated path. |
LocalPositionReader |
openPositionRead(String path,
long fileLength)
Opens a file for position read.
|
boolean |
renameDirectory(String src,
String dst)
Renames a directory from
src to dst in under file system. |
boolean |
renameFile(String src,
String dst)
Renames a file from
src to dst in under file system. |
void |
setMode(String path,
short mode)
Changes posix file mode.
|
void |
setOwner(String path,
String user,
String group)
Sets the user and group of the given path.
|
boolean |
supportsFlush()
Whether this type of UFS supports flush.
|
createNonexistingFile, createNonexistingFile, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, isExistingDirectory, openExistingFile, openExistingFile, renameRenamableDirectory, renameRenamableFilecreate, deleteDirectory, getAclPair, getConfiguration, getFingerprint, getOperationMode, getParsedFingerprint, getParsedFingerprint, getPhysicalStores, isObjectStorage, isSeekable, listStatus, listStatusIterable, mkdirs, open, performListingAsync, resolveUri, setAclEntries, validatePathclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreate, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, getAclPair, getConfiguration, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, getFileStatus, getFingerprint, getOperationMode, getParsedFingerprint, getParsedFingerprint, getPhysicalStores, getStatus, getTemporaryToken, isExistingDirectory, isObjectStorage, isSeekable, isTemporaryConnectionToken, listStatus, listStatuses, listStatusIterable, mkdirs, open, openExistingFile, openExistingFile, refreshTemporaryToken, renameRenamableDirectory, renameRenamableFile, resolveUri, setAclEntries, setTemporaryTokenRefreshContextperformListingAsyncpublic LocalUnderFileSystem(AlluxioURI uri, UnderFileSystemConfiguration ufsConf)
LocalUnderFileSystem.uri - the AlluxioURI for this UFSufsConf - UFS configurationpublic String getUnderFSType()
UnderFileSystemgetUnderFSType in interface UnderFileSystempublic void cleanup()
throws IOException
UnderFileSystemcleanup in interface UnderFileSystemIOExceptionpublic void close()
throws IOException
close in interface Closeableclose in interface AutoCloseableclose in class BaseUnderFileSystemIOExceptionpublic OutputStream create(String path, CreateOptions options) throws IOException
UnderFileSystemCreateOptions.
Implementations should make sure that the path under creation appears in listings only
after a successful close and that contents are written in its entirety or not at all.create in interface UnderFileSystempath - the file nameoptions - the options for createOutputStream objectIOExceptionpublic OutputStream createDirect(String path, CreateOptions options) throws IOException
AtomicFileOutputStreamCallbackCreateOptions. This stream
writes directly to the underlying storage without any atomicity guarantees.createDirect in interface AtomicFileOutputStreamCallbackpath - the file nameoptions - the options for createOutputStream objectIOExceptionpublic boolean deleteDirectory(String path, DeleteOptions options) throws IOException
UnderFileSystemdeleteDirectory in interface UnderFileSystempath - of the directory to deleteoptions - for directory delete semanticsIOExceptionpublic boolean deleteFile(String path) throws IOException
UnderFileSystemdeleteFile in interface UnderFileSystempath - of the file to deleteIOExceptionpublic boolean exists(String path) throws IOException
UnderFileSystemexists in interface UnderFileSystemexists in class BaseUnderFileSystempath - the absolute pathIOExceptionpublic long getBlockSizeByte(String path) throws IOException
UnderFileSystemgetBlockSizeByte in interface UnderFileSystempath - the file nameIOExceptionpublic UfsDirectoryStatus getDirectoryStatus(String path) throws IOException
UnderFileSystemgetDirectoryStatus in interface UnderFileSystempath - the path to the directoryFileNotFoundException - when the path does not existIOExceptionpublic List<String> getFileLocations(String path) throws IOException
UnderFileSystemgetFileLocations in interface UnderFileSystempath - the file nameIOExceptionpublic List<String> getFileLocations(String path, FileLocationOptions options) throws IOException
UnderFileSystemgetFileLocations in interface UnderFileSystempath - the file nameoptions - method optionsIOExceptionpublic UfsFileStatus getFileStatus(String path, GetStatusOptions options) throws IOException
UnderFileSystemgetFileStatus in interface UnderFileSystempath - the path to the fileoptions - method optionsFileNotFoundException - when the path does not existIOExceptionpublic long getSpace(String path, UnderFileSystem.SpaceType type) throws IOException
UnderFileSystemgetSpace in interface UnderFileSystempath - the path to querytype - the type of queriesIOExceptionpublic UfsStatus getStatus(String path, GetStatusOptions options) throws IOException
UnderFileSystemgetStatus in interface UnderFileSystempath - the path to get the statusoptions - method optionsFileNotFoundException - when the path does not existIOExceptionpublic boolean isDirectory(String path) throws IOException
UnderFileSystemisDirectory in interface UnderFileSystempath - the absolute directory pathIOExceptionpublic boolean isFile(String path) throws IOException
UnderFileSystemisFile in interface UnderFileSystempath - the absolute file pathIOExceptionpublic UfsStatus[] listStatus(String path) throws IOException
UnderFileSystem
If this abstract pathname does not denote a directory, then this method returns null.
Otherwise an array of statuses is returned, one for each file or directory in the directory.
Names denoting the directory itself and the directory's parent directory are not included in
the result. Each string is a file name rather than a complete path.
There is no guarantee that the name strings in the resulting array will appear in any specific order; they are not, in particular, guaranteed to appear in alphabetical order.
listStatus in interface UnderFileSystempath - the abstract pathname to listnull if this abstract pathname does not denote a directory.IOExceptionpublic boolean mkdirs(String path, MkdirsOptions options) throws IOException
UnderFileSystemMkdirsOptions. If the folder already exists, the method returns false.mkdirs in interface UnderFileSystempath - the folder to createoptions - the options for mkdirstrue if and only if the directory was created; false otherwiseIOExceptionpublic InputStream open(String path, OpenOptions options) throws IOException
UnderFileSystemInputStream for a file in under filesystem at the indicated path.open in interface UnderFileSystempath - the file nameoptions - to open input streamInputStream objectIOExceptionpublic LocalPositionReader openPositionRead(String path, long fileLength)
UnderFileSystemopenPositionRead in interface UnderFileSystempath - the path to readfileLength - the file lengthpublic boolean renameDirectory(String src, String dst) throws IOException
UnderFileSystemsrc to dst in under file system.renameDirectory in interface UnderFileSystemsrc - the source directory pathdst - the destination directory pathIOExceptionpublic boolean renameFile(String src, String dst) throws IOException
UnderFileSystemsrc to dst in under file system.renameFile in interface UnderFileSystemsrc - the source file pathdst - the destination file pathIOExceptionpublic void setOwner(String path, String user, String group) throws IOException
UnderFileSystemsetOwner in interface UnderFileSystempath - the path of the fileuser - the new owner to set, unchanged if nullgroup - the new group to set, unchanged if nullIOExceptionpublic void setMode(String path, short mode) throws IOException
UnderFileSystemsetMode in interface UnderFileSystempath - the path of the filemode - the mode to set in short format, e.g. 0777IOExceptionpublic void connectFromMaster(String hostname) throws IOException
UnderFileSystemDepending on the implementation this may be a no-op
connectFromMaster in interface UnderFileSystemhostname - the host that wants to connect to the under file systemIOExceptionpublic void connectFromWorker(String hostname) throws IOException
UnderFileSystemDepending on the implementation this may be a no-op
connectFromWorker in interface UnderFileSystemhostname - the host that wants to connect to the under file systemIOExceptionpublic boolean supportsFlush()
throws IOException
UnderFileSystemsupportsFlush in interface UnderFileSystemIOExceptionCopyright © 2023. All Rights Reserved.