@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.SpaceType
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)
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)
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. |
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, renameRenamableFile
create, deleteDirectory, getAclPair, getActiveSyncInfo, getConfiguration, getFingerprint, getOperationMode, getPhysicalStores, isObjectStorage, isSeekable, listStatus, mkdirs, open, resolveUri, setAclEntries, startActiveSyncPolling, startSync, stopActiveSyncPolling, stopSync, supportsActiveSync, validatePath
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
create, createNonexistingFile, createNonexistingFile, deleteDirectory, deleteExistingDirectory, deleteExistingDirectory, deleteExistingFile, getAclPair, getActiveSyncInfo, getConfiguration, getExistingDirectoryStatus, getExistingFileStatus, getExistingStatus, getFingerprint, getOperationMode, getPhysicalStores, isExistingDirectory, isObjectStorage, isSeekable, listStatus, mkdirs, open, openExistingFile, openExistingFile, renameRenamableDirectory, renameRenamableFile, resolveUri, setAclEntries, startActiveSyncPolling, startSync, stopActiveSyncPolling, stopSync, supportsActiveSync
public LocalUnderFileSystem(AlluxioURI uri, UnderFileSystemConfiguration ufsConf)
LocalUnderFileSystem
.uri
- the AlluxioURI
for this UFSufsConf
- UFS configurationpublic String getUnderFSType()
UnderFileSystem
getUnderFSType
in interface UnderFileSystem
public void cleanup() throws IOException
UnderFileSystem
cleanup
in interface UnderFileSystem
IOException
public void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
IOException
public OutputStream create(String path, CreateOptions options) throws IOException
UnderFileSystem
CreateOptions
.
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 UnderFileSystem
path
- the file nameoptions
- the options for createOutputStream
objectIOException
public OutputStream createDirect(String path, CreateOptions options) throws IOException
AtomicFileOutputStreamCallback
CreateOptions
. This stream
writes directly to the underlying storage without any atomicity guarantees.createDirect
in interface AtomicFileOutputStreamCallback
path
- the file nameoptions
- the options for createOutputStream
objectIOException
public boolean deleteDirectory(String path, DeleteOptions options) throws IOException
UnderFileSystem
deleteDirectory
in interface UnderFileSystem
path
- of the directory to deleteoptions
- for directory delete semanticsIOException
public boolean deleteFile(String path) throws IOException
UnderFileSystem
deleteFile
in interface UnderFileSystem
path
- of the file to deleteIOException
public boolean exists(String path) throws IOException
UnderFileSystem
exists
in interface UnderFileSystem
exists
in class BaseUnderFileSystem
path
- the absolute pathIOException
public long getBlockSizeByte(String path) throws IOException
UnderFileSystem
getBlockSizeByte
in interface UnderFileSystem
path
- the file nameIOException
public UfsDirectoryStatus getDirectoryStatus(String path) throws IOException
UnderFileSystem
getDirectoryStatus
in interface UnderFileSystem
path
- the path to the directoryFileNotFoundException
- when the path does not existIOException
public List<String> getFileLocations(String path) throws IOException
UnderFileSystem
getFileLocations
in interface UnderFileSystem
path
- the file nameIOException
public List<String> getFileLocations(String path, FileLocationOptions options) throws IOException
UnderFileSystem
getFileLocations
in interface UnderFileSystem
path
- the file nameoptions
- method optionsIOException
public UfsFileStatus getFileStatus(String path) throws IOException
UnderFileSystem
getFileStatus
in interface UnderFileSystem
path
- the path to the fileFileNotFoundException
- when the path does not existIOException
public long getSpace(String path, UnderFileSystem.SpaceType type) throws IOException
UnderFileSystem
getSpace
in interface UnderFileSystem
path
- the path to querytype
- the type of queriesIOException
public UfsStatus getStatus(String path) throws IOException
UnderFileSystem
getStatus
in interface UnderFileSystem
path
- the path to get the statusFileNotFoundException
- when the path does not existIOException
public boolean isDirectory(String path) throws IOException
UnderFileSystem
isDirectory
in interface UnderFileSystem
path
- the absolute directory pathIOException
public boolean isFile(String path) throws IOException
UnderFileSystem
isFile
in interface UnderFileSystem
path
- the absolute file pathIOException
public 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 UnderFileSystem
path
- the abstract pathname to listnull
if this abstract pathname does not denote a directory.IOException
public boolean mkdirs(String path, MkdirsOptions options) throws IOException
UnderFileSystem
MkdirsOptions
. If the folder already exists, the method returns false.mkdirs
in interface UnderFileSystem
path
- the folder to createoptions
- the options for mkdirstrue
if and only if the directory was created; false
otherwiseIOException
public InputStream open(String path, OpenOptions options) throws IOException
UnderFileSystem
InputStream
for a file in under filesystem at the indicated path.open
in interface UnderFileSystem
path
- the file nameoptions
- to open input streamInputStream
objectIOException
public boolean renameDirectory(String src, String dst) throws IOException
UnderFileSystem
src
to dst
in under file system.renameDirectory
in interface UnderFileSystem
src
- the source directory pathdst
- the destination directory pathIOException
public boolean renameFile(String src, String dst) throws IOException
UnderFileSystem
src
to dst
in under file system.renameFile
in interface UnderFileSystem
src
- the source file pathdst
- the destination file pathIOException
public void setOwner(String path, String user, String group) throws IOException
UnderFileSystem
setOwner
in interface UnderFileSystem
path
- the path of the fileuser
- the new owner to set, unchanged if nullgroup
- the new group to set, unchanged if nullIOException
public void setMode(String path, short mode) throws IOException
UnderFileSystem
setMode
in interface UnderFileSystem
path
- the path of the filemode
- the mode to set in short format, e.g. 0777IOException
public void connectFromMaster(String hostname) throws IOException
UnderFileSystem
Depending on the implementation this may be a no-op
connectFromMaster
in interface UnderFileSystem
hostname
- the host that wants to connect to the under file systemIOException
public void connectFromWorker(String hostname) throws IOException
UnderFileSystem
Depending on the implementation this may be a no-op
connectFromWorker
in interface UnderFileSystem
hostname
- the host that wants to connect to the under file systemIOException
public boolean supportsFlush() throws IOException
UnderFileSystem
supportsFlush
in interface UnderFileSystem
IOException
Copyright © 2023. All Rights Reserved.