alluxio.client.file

Class BaseFileSystem

java.lang.Object

alluxio.client.file.BaseFileSystem

All Implemented Interfaces:

FileSystem, Closeable, AutoCloseable

@PublicApi
 @ThreadSafe
public class BaseFileSystem
extends Object
implements FileSystem

Default implementation of the FileSystem interface. Developers can extend this class instead of implementing the interface. This implementation reads and writes data through FileInStream and FileOutStream. This class is thread safe.

Nested Class Summary

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

FileSystem.Cache, FileSystem.Factory, FileSystem.FileSystemKey

Field Summary

Fields

Modifier and Type	Field and Description
protected AlluxioBlockStore	mBlockStore
protected boolean	mCachingEnabled
protected FileSystemContext	mFsContext

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseFileSystem(FileSystemContext fsContext, boolean cachingEnabled) Constructs a new base file system.

Method Summary

Modifier and Type	Method and Description
void	close() Shuts down the FileSystem.
static BaseFileSystem	create(FileSystemContext context)
static BaseFileSystem	create(FileSystemContext context, boolean cachingEnabled)
void	createDirectory(alluxio.AlluxioURI path) Convenience method for FileSystem.createDirectory(AlluxioURI, CreateDirectoryPOptions) with default options.
void	createDirectory(alluxio.AlluxioURI path, alluxio.grpc.CreateDirectoryPOptions options) Creates a directory.
FileOutStream	createFile(alluxio.AlluxioURI path) Convenience method for FileSystem.createFile(AlluxioURI, CreateFilePOptions) with default options.
FileOutStream	createFile(alluxio.AlluxioURI path, alluxio.grpc.CreateFilePOptions options) Creates a file.
void	delete(alluxio.AlluxioURI path) Convenience method for FileSystem.delete(AlluxioURI, DeletePOptions) with default options.
void	delete(alluxio.AlluxioURI path, alluxio.grpc.DeletePOptions options) Deletes a file or a directory.
boolean	exists(alluxio.AlluxioURI path) Convenience method for FileSystem.exists(AlluxioURI, ExistsPOptions) with default options.
boolean	exists(alluxio.AlluxioURI path, alluxio.grpc.ExistsPOptions options) Checks whether a path exists in Alluxio space.
void	free(alluxio.AlluxioURI path) Convenience method for FileSystem.free(AlluxioURI, FreePOptions) with default options.
void	free(alluxio.AlluxioURI path, alluxio.grpc.FreePOptions options) Evicts any data under the given path from Alluxio space, but does not delete the data from the UFS.
List<alluxio.wire.BlockLocationInfo>	getBlockLocations(alluxio.AlluxioURI path) Builds a list of BlockLocationInfo for the given file.
alluxio.conf.AlluxioConfiguration	getConf()
Map<String,alluxio.wire.MountPointInfo>	getMountTable() Lists all mount points and their corresponding under storage addresses.
alluxio.client.file.URIStatus	getStatus(alluxio.AlluxioURI path) Convenience method for FileSystem.getStatus(AlluxioURI, GetStatusPOptions) with default options.
alluxio.client.file.URIStatus	getStatus(alluxio.AlluxioURI path, alluxio.grpc.GetStatusPOptions options) Gets the URIStatus object that represents the metadata of an Alluxio path.
List<alluxio.wire.SyncPointInfo>	getSyncPathList() Lists all the actively synced paths.
boolean	isClosed() If there are operations currently running and close is called concurrently the behavior is undefined.
List<alluxio.client.file.URIStatus>	listStatus(alluxio.AlluxioURI path) Convenience method for FileSystem.listStatus(AlluxioURI, ListStatusPOptions) with default options.
List<alluxio.client.file.URIStatus>	listStatus(alluxio.AlluxioURI path, alluxio.grpc.ListStatusPOptions options) If the path is a directory, returns the URIStatus of all the direct entries in it.
void	mount(alluxio.AlluxioURI alluxioPath, alluxio.AlluxioURI ufsPath) Convenience method for FileSystem.mount(AlluxioURI, AlluxioURI, MountPOptions) with default options.
void	mount(alluxio.AlluxioURI alluxioPath, alluxio.AlluxioURI ufsPath, alluxio.grpc.MountPOptions options) Mounts a UFS subtree to the given Alluxio path.
FileInStream	openFile(alluxio.AlluxioURI path) Convenience method for FileSystem.openFile(AlluxioURI, OpenFilePOptions) with default options.
FileInStream	openFile(alluxio.AlluxioURI path, alluxio.grpc.OpenFilePOptions options) Opens a file for reading.
void	persist(alluxio.AlluxioURI path) Convenience method for FileSystem.persist(AlluxioURI, ScheduleAsyncPersistencePOptions) which uses the default ScheduleAsyncPersistencePOptions.
void	persist(alluxio.AlluxioURI path, alluxio.grpc.ScheduleAsyncPersistencePOptions options) Schedules the given path to be asynchronously persisted to the under file system.
void	rename(alluxio.AlluxioURI src, alluxio.AlluxioURI dst) Convenience method for FileSystem.rename(AlluxioURI, AlluxioURI, RenamePOptions) with default options.
void	rename(alluxio.AlluxioURI src, alluxio.AlluxioURI dst, alluxio.grpc.RenamePOptions options) Renames an existing Alluxio path to another Alluxio path in Alluxio.
void	setAcl(alluxio.AlluxioURI path, alluxio.grpc.SetAclAction action, List<alluxio.security.authorization.AclEntry> entries) Convenience method for FileSystem.setAcl(AlluxioURI, SetAclAction, List, SetAclPOptions) with default options.
void	setAcl(alluxio.AlluxioURI path, alluxio.grpc.SetAclAction action, List<alluxio.security.authorization.AclEntry> entries, alluxio.grpc.SetAclPOptions options) Sets the ACL for a path.
void	setAttribute(alluxio.AlluxioURI path) Convenience method for FileSystem.setAttribute(AlluxioURI, SetAttributePOptions) with default options.
void	setAttribute(alluxio.AlluxioURI path, alluxio.grpc.SetAttributePOptions options) Sets any number of a path's attributes, such as TTL and pin status.
void	startSync(alluxio.AlluxioURI path) Starts the active syncing process on an Alluxio path.
void	stopSync(alluxio.AlluxioURI path) Stops the active syncing process on an Alluxio path.
void	unmount(alluxio.AlluxioURI path) Convenience method for FileSystem.unmount(AlluxioURI, UnmountPOptions) with default options.
void	unmount(alluxio.AlluxioURI path, alluxio.grpc.UnmountPOptions options) Unmounts a UFS subtree identified by the given Alluxio path.
void	updateMount(alluxio.AlluxioURI alluxioPath, alluxio.grpc.MountPOptions options) Updates the options for an existing mount point.

Methods inherited from class java.lang.Object

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

Field Detail

mFsContext

protected final FileSystemContext mFsContext

mBlockStore

protected final AlluxioBlockStore mBlockStore

mCachingEnabled

protected final boolean mCachingEnabled

Constructor Detail

BaseFileSystem

protected BaseFileSystem(FileSystemContext fsContext,
                         boolean cachingEnabled)

Constructs a new base file system.

Parameters:

fsContext - file system context

Method Detail

create

public static BaseFileSystem create(FileSystemContext context)

Parameters:

context - the FileSystemContext to use for client operations

Returns:

a BaseFileSystem

create

public static BaseFileSystem create(FileSystemContext context,
                                    boolean cachingEnabled)

Parameters:

context - the FileSystemContext to use for client operations

cachingEnabled - whether or not this FileSystem should remove itself from the Factory cache when closed

Returns:

a BaseFileSystem

close

public void close()
           throws IOException

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

Throws:

IOException

isClosed

public boolean isClosed()

Description copied from interface: FileSystem

If there are operations currently running and close is called concurrently the behavior is undefined. After closing a FileSystem, any operations that are performed result in undefined behavior.

Specified by:

isClosed in interface FileSystem

Returns:

whether or not this FileSystem has been closed

createDirectory

public void createDirectory(alluxio.AlluxioURI path)
                     throws alluxio.exception.FileAlreadyExistsException,
                            alluxio.exception.InvalidPathException,
                            IOException,
                            alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.createDirectory(AlluxioURI, CreateDirectoryPOptions) with default options.

Specified by:

createDirectory in interface FileSystem

Parameters:

path - the path of the directory to create in Alluxio space

Throws:

alluxio.exception.FileAlreadyExistsException - if there is already a file or directory at the given path

alluxio.exception.InvalidPathException - if the path is invalid

IOException

alluxio.exception.AlluxioException

createDirectory

public void createDirectory(alluxio.AlluxioURI path,
                            alluxio.grpc.CreateDirectoryPOptions options)
                     throws alluxio.exception.FileAlreadyExistsException,
                            alluxio.exception.InvalidPathException,
                            IOException,
                            alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Creates a directory.

Specified by:

createDirectory in interface FileSystem

Parameters:

path - the path of the directory to create in Alluxio space

options - options to associate with this operation

Throws:

alluxio.exception.FileAlreadyExistsException - if there is already a file or directory at the given path

alluxio.exception.InvalidPathException - if the path is invalid

IOException

alluxio.exception.AlluxioException

createFile

public FileOutStream createFile(alluxio.AlluxioURI path)
                         throws alluxio.exception.FileAlreadyExistsException,
                                alluxio.exception.InvalidPathException,
                                IOException,
                                alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.createFile(AlluxioURI, CreateFilePOptions) with default options.

Specified by:

createFile in interface FileSystem

Parameters:

path - the path of the file to create in Alluxio space

Returns:

a FileOutStream which will write data to the newly created file

Throws:

alluxio.exception.FileAlreadyExistsException - if there is already a file at the given path

alluxio.exception.InvalidPathException - if the path is invalid

IOException

alluxio.exception.AlluxioException

createFile

public FileOutStream createFile(alluxio.AlluxioURI path,
                                alluxio.grpc.CreateFilePOptions options)
                         throws alluxio.exception.FileAlreadyExistsException,
                                alluxio.exception.InvalidPathException,
                                IOException,
                                alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Creates a file.

Specified by:

createFile in interface FileSystem

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:

alluxio.exception.FileAlreadyExistsException - if there is already a file at the given path

alluxio.exception.InvalidPathException - if the path is invalid

IOException

alluxio.exception.AlluxioException

delete

public void delete(alluxio.AlluxioURI path)
            throws alluxio.exception.DirectoryNotEmptyException,
                   alluxio.exception.FileDoesNotExistException,
                   IOException,
                   alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.delete(AlluxioURI, DeletePOptions) with default options.

Specified by:

delete in interface FileSystem

Parameters:

path - the path to delete in Alluxio space

Throws:

alluxio.exception.DirectoryNotEmptyException - if recursive is false and the path is a nonempty directory

alluxio.exception.FileDoesNotExistException - if the given path does not exist

IOException

alluxio.exception.AlluxioException

delete

public void delete(alluxio.AlluxioURI path,
                   alluxio.grpc.DeletePOptions options)
            throws alluxio.exception.DirectoryNotEmptyException,
                   alluxio.exception.FileDoesNotExistException,
                   IOException,
                   alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Deletes a file or a directory.

Specified by:

delete in interface FileSystem

Parameters:

path - the path to delete in Alluxio space

options - options to associate with this operation

Throws:

alluxio.exception.DirectoryNotEmptyException - if recursive is false and the path is a nonempty directory

alluxio.exception.FileDoesNotExistException - if the given path does not exist

IOException

alluxio.exception.AlluxioException

exists

public boolean exists(alluxio.AlluxioURI path)
               throws alluxio.exception.InvalidPathException,
                      IOException,
                      alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.exists(AlluxioURI, ExistsPOptions) with default options.

Specified by:

exists in interface FileSystem

Parameters:

path - the path in question

Returns:

true if the path exists, false otherwise

Throws:

alluxio.exception.InvalidPathException - if the path is invalid

IOException

alluxio.exception.AlluxioException

exists

public boolean exists(alluxio.AlluxioURI path,
                      alluxio.grpc.ExistsPOptions options)
               throws IOException,
                      alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Checks whether a path exists in Alluxio space.

Specified by:

exists in interface FileSystem

Parameters:

path - the path in question

options - options to associate with this operation

Returns:

true if the path exists, false otherwise

Throws:

alluxio.exception.InvalidPathException - if the path is invalid

IOException

alluxio.exception.AlluxioException

free

public void free(alluxio.AlluxioURI path)
          throws alluxio.exception.FileDoesNotExistException,
                 IOException,
                 alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.free(AlluxioURI, FreePOptions) with default options.

Specified by:

free in interface FileSystem

Parameters:

path - the path to free in Alluxio space

Throws:

alluxio.exception.FileDoesNotExistException - if the given path does not exist

IOException

alluxio.exception.AlluxioException

free

public void free(alluxio.AlluxioURI path,
                 alluxio.grpc.FreePOptions options)
          throws alluxio.exception.FileDoesNotExistException,
                 IOException,
                 alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Evicts any data under the given path from Alluxio space, but does not delete the data from the UFS. The metadata will still be present in Alluxio space after this operation.

Specified by:

free in interface FileSystem

Parameters:

path - the path to free in Alluxio space

options - options to associate with this operation

Throws:

alluxio.exception.FileDoesNotExistException - if the given path does not exist

IOException

alluxio.exception.AlluxioException

getBlockLocations

public List<alluxio.wire.BlockLocationInfo> getBlockLocations(alluxio.AlluxioURI path)
                                                       throws IOException,
                                                              alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Builds a list of BlockLocationInfo for the given file. Each list item contains a list of WorkerNetAddress which allows a user to determine the physical location of a block of the given file stored within Alluxio. In the case where data is stored in a UFS, but not in Alluxio this function will only include a WorkerNetAddress if the block stored in the UFS is co-located with an Alluxio worker. However if there are no co-located Alluxio workers for the block, then the behavior is controlled by the PropertyKey.USER_UFS_BLOCK_LOCATION_ALL_FALLBACK_ENABLED . If this property is set to true then every Alluxio worker will be returned. Blocks which are stored in the UFS and are *not* co-located with any Alluxio worker will return an empty list. If the file block is within Alluxio *and* the UFS then this will only return Alluxio workers which currently store the block.

Specified by:

getBlockLocations in interface FileSystem

Parameters:

path - the path to get block info for

Returns:

a list of blocks with the workers whose hosts have the blocks. The blocks may not necessarily be stored in Alluxio. The blocks are returned in the order of their sequences in file.

Throws:

alluxio.exception.FileDoesNotExistException - if the given path does not exist

IOException

alluxio.exception.AlluxioException

getConf

public alluxio.conf.AlluxioConfiguration getConf()

Specified by:

getConf in interface FileSystem

Returns:

the configuration which the FileSystem is using to connect to Alluxio

getStatus

public alluxio.client.file.URIStatus getStatus(alluxio.AlluxioURI path)
                                        throws alluxio.exception.FileDoesNotExistException,
                                               IOException,
                                               alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.getStatus(AlluxioURI, GetStatusPOptions) with default options.

Specified by:

getStatus in interface FileSystem

Parameters:

path - the path to obtain information about

Returns:

the URIStatus of the file

Throws:

alluxio.exception.FileDoesNotExistException - if the path does not exist

IOException

alluxio.exception.AlluxioException

getStatus

public alluxio.client.file.URIStatus getStatus(alluxio.AlluxioURI path,
                                               alluxio.grpc.GetStatusPOptions options)
                                        throws alluxio.exception.FileDoesNotExistException,
                                               IOException,
                                               alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Gets the URIStatus object that represents the metadata of an Alluxio path.

Specified by:

getStatus in interface FileSystem

Parameters:

path - the path to obtain information about

options - options to associate with this operation

Returns:

the URIStatus of the file

Throws:

alluxio.exception.FileDoesNotExistException - if the path does not exist

IOException

alluxio.exception.AlluxioException

listStatus

public List<alluxio.client.file.URIStatus> listStatus(alluxio.AlluxioURI path)
                                               throws alluxio.exception.FileDoesNotExistException,
                                                      IOException,
                                                      alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.listStatus(AlluxioURI, ListStatusPOptions) with default options.

Specified by:

listStatus in interface FileSystem

Parameters:

path - the path to list information about

Returns:

a list of URIStatuss containing information about the files and directories which are children of the given path

Throws:

alluxio.exception.FileDoesNotExistException - if the given path does not exist

IOException

alluxio.exception.AlluxioException

listStatus

public List<alluxio.client.file.URIStatus> listStatus(alluxio.AlluxioURI path,
                                                      alluxio.grpc.ListStatusPOptions options)
                                               throws alluxio.exception.FileDoesNotExistException,
                                                      IOException,
                                                      alluxio.exception.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

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:

alluxio.exception.FileDoesNotExistException - if the given path does not exist

IOException

alluxio.exception.AlluxioException

mount

public void mount(alluxio.AlluxioURI alluxioPath,
                  alluxio.AlluxioURI ufsPath)
           throws IOException,
                  alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.mount(AlluxioURI, AlluxioURI, MountPOptions) with default options.

Specified by:

mount in interface FileSystem

Parameters:

alluxioPath - an Alluxio path to mount the data to

ufsPath - a UFS path to mount the data from

Throws:

IOException

alluxio.exception.AlluxioException

mount

public void mount(alluxio.AlluxioURI alluxioPath,
                  alluxio.AlluxioURI ufsPath,
                  alluxio.grpc.MountPOptions options)
           throws IOException,
                  alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Mounts a UFS subtree to the given Alluxio path. The Alluxio path is expected not to exist as the method creates it. If the path already exists, a AlluxioException will be thrown. This method does not transfer any data or metadata from the UFS. It simply establishes the connection between the given Alluxio path and UFS path.

Specified by:

mount in interface FileSystem

Parameters:

alluxioPath - an Alluxio path to mount the data to

ufsPath - a UFS path to mount the data from

options - options to associate with this operation

Throws:

IOException

alluxio.exception.AlluxioException

updateMount

public void updateMount(alluxio.AlluxioURI alluxioPath,
                        alluxio.grpc.MountPOptions options)
                 throws IOException,
                        alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Updates the options for an existing mount point.

Specified by:

updateMount in interface FileSystem

Parameters:

alluxioPath - the Alluxio path of the mount point

options - options for this mount point

Throws:

IOException

alluxio.exception.AlluxioException

getMountTable

public Map<String,alluxio.wire.MountPointInfo> getMountTable()
                                                      throws IOException,
                                                             alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Lists all mount points and their corresponding under storage addresses.

Specified by:

getMountTable in interface FileSystem

Returns:

a map from String to MountPointInfo

Throws:

IOException

alluxio.exception.AlluxioException

getSyncPathList

public List<alluxio.wire.SyncPointInfo> getSyncPathList()
                                                 throws IOException,
                                                        alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Lists all the actively synced paths.

Specified by:

getSyncPathList in interface FileSystem

Returns:

a list of actively synced paths

Throws:

IOException

alluxio.exception.AlluxioException

persist

public void persist(alluxio.AlluxioURI path)
             throws alluxio.exception.FileDoesNotExistException,
                    IOException,
                    alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.persist(AlluxioURI, ScheduleAsyncPersistencePOptions) which uses the default ScheduleAsyncPersistencePOptions.

Specified by:

persist in interface FileSystem

Parameters:

path - the uri of the file to persist

Throws:

alluxio.exception.FileDoesNotExistException

IOException

alluxio.exception.AlluxioException

persist

public void persist(alluxio.AlluxioURI path,
                    alluxio.grpc.ScheduleAsyncPersistencePOptions options)
             throws alluxio.exception.FileDoesNotExistException,
                    IOException,
                    alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Schedules the given path to be asynchronously persisted to the under file system. To persist synchronously please see FileSystemUtils#persistAndWait(FileSystem, AlluxioURI).

Specified by:

persist in interface FileSystem

Parameters:

path - the uri of the file to persist

options - the options to use when submitting persist the path

Throws:

alluxio.exception.FileDoesNotExistException

IOException

alluxio.exception.AlluxioException

openFile

public FileInStream openFile(alluxio.AlluxioURI path)
                      throws alluxio.exception.FileDoesNotExistException,
                             IOException,
                             alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.openFile(AlluxioURI, OpenFilePOptions) with default options.

Specified by:

openFile in interface FileSystem

Parameters:

path - the file to read from

Returns:

a FileInStream for the given path

Throws:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

openFile

public FileInStream openFile(alluxio.AlluxioURI path,
                             alluxio.grpc.OpenFilePOptions options)
                      throws alluxio.exception.FileDoesNotExistException,
                             IOException,
                             alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Opens a file for reading.

Specified by:

openFile in interface FileSystem

Parameters:

path - the file to read from

options - options to associate with this operation

Returns:

a FileInStream for the given path

Throws:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

rename

public void rename(alluxio.AlluxioURI src,
                   alluxio.AlluxioURI dst)
            throws alluxio.exception.FileDoesNotExistException,
                   IOException,
                   alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.rename(AlluxioURI, AlluxioURI, RenamePOptions) with default options.

Specified by:

rename in interface FileSystem

Parameters:

src - the path of the source, this must already exist

dst - the path of the destination, this path should not exist

Throws:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

rename

public void rename(alluxio.AlluxioURI src,
                   alluxio.AlluxioURI dst,
                   alluxio.grpc.RenamePOptions options)
            throws alluxio.exception.FileDoesNotExistException,
                   IOException,
                   alluxio.exception.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

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:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

setAcl

public void setAcl(alluxio.AlluxioURI path,
                   alluxio.grpc.SetAclAction action,
                   List<alluxio.security.authorization.AclEntry> entries)
            throws alluxio.exception.FileDoesNotExistException,
                   IOException,
                   alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.setAcl(AlluxioURI, SetAclAction, List, SetAclPOptions) with default options.

Specified by:

setAcl in interface FileSystem

Parameters:

path - the path to set the ACL for

action - the set action to perform

entries - the ACL entries

Throws:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

setAcl

public void setAcl(alluxio.AlluxioURI path,
                   alluxio.grpc.SetAclAction action,
                   List<alluxio.security.authorization.AclEntry> entries,
                   alluxio.grpc.SetAclPOptions options)
            throws alluxio.exception.FileDoesNotExistException,
                   IOException,
                   alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Sets the ACL for a path.

Specified by:

setAcl in interface FileSystem

Parameters:

path - the path to set the ACL for

action - the set action to perform

entries - the ACL entries

options - options to associate with this operation

Throws:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

setAttribute

public void setAttribute(alluxio.AlluxioURI path)
                  throws alluxio.exception.FileDoesNotExistException,
                         IOException,
                         alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.setAttribute(AlluxioURI, SetAttributePOptions) with default options.

Specified by:

setAttribute in interface FileSystem

Parameters:

path - the path to set attributes for

Throws:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

setAttribute

public void setAttribute(alluxio.AlluxioURI path,
                         alluxio.grpc.SetAttributePOptions options)
                  throws alluxio.exception.FileDoesNotExistException,
                         IOException,
                         alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Sets any number of a path's attributes, such as TTL and pin status.

Specified by:

setAttribute in interface FileSystem

Parameters:

path - the path to set attributes for

options - options to associate with this operation

Throws:

alluxio.exception.FileDoesNotExistException - if the given file does not exist

IOException

alluxio.exception.AlluxioException

startSync

public void startSync(alluxio.AlluxioURI path)
               throws alluxio.exception.FileDoesNotExistException,
                      IOException,
                      alluxio.exception.AlluxioException

Starts the active syncing process on an Alluxio path.

Specified by:

startSync in interface FileSystem

Parameters:

path - the path to sync

Throws:

alluxio.exception.FileDoesNotExistException

IOException

alluxio.exception.AlluxioException

stopSync

public void stopSync(alluxio.AlluxioURI path)
              throws alluxio.exception.FileDoesNotExistException,
                     IOException,
                     alluxio.exception.AlluxioException

Stops the active syncing process on an Alluxio path.

Specified by:

stopSync in interface FileSystem

Parameters:

path - the path to stop syncing

Throws:

alluxio.exception.FileDoesNotExistException

IOException

alluxio.exception.AlluxioException

unmount

public void unmount(alluxio.AlluxioURI path)
             throws IOException,
                    alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Convenience method for FileSystem.unmount(AlluxioURI, UnmountPOptions) with default options.

Specified by:

unmount in interface FileSystem

Parameters:

path - an Alluxio path, this must be a mount point

Throws:

IOException

alluxio.exception.AlluxioException

unmount

public void unmount(alluxio.AlluxioURI path,
                    alluxio.grpc.UnmountPOptions options)
             throws IOException,
                    alluxio.exception.AlluxioException

Description copied from interface: FileSystem

Unmounts a UFS subtree identified by the given Alluxio path. The Alluxio path match a previously mounted path. The contents of the subtree rooted at this path are removed from Alluxio but the corresponding UFS subtree is left untouched.

Specified by:

unmount in interface FileSystem

Parameters:

path - an Alluxio path, this must be a mount point

options - options to associate with this operation

Throws:

IOException

alluxio.exception.AlluxioException