alluxio.worker.dora

Interface DoraWorker

All Superinterfaces:

DataWorker, Server<WorkerNetAddress>, SessionCleanable, Worker

All Known Implementing Classes:

PagedDoraWorker

public interface DoraWorker
extends DataWorker, SessionCleanable

A block worker in the Alluxio system.

Method Summary

Modifier and Type	Method and Description
void	completeFile(String path, CompleteFilePOptions options, String uuid) Complete writing a file.
com.google.common.util.concurrent.ListenableFuture<List<RouteFailure>>	copy(List<Route> routes, UfsReadOptions readOptions, WriteOptions writeOptions) Copies files from src to dst.
void	createDirectory(String path, CreateDirectoryPOptions options) Create a directory.
OpenFileHandle	createFile(String path, CreateFilePOptions options) Create File.
BlockReader	createFileReader(String fileId, long offset, boolean positionShort, Protocol.OpenUfsBlockOptions options) Creates the file reader to read from Alluxio dora.
BlockWriter	createFileWriter(String fileId, String ufsPath) Creates the file writer to write to Alluxio dora.
void	delete(String path, DeletePOptions options) Delete a file.
boolean	exists(String path, ExistsPOptions options) Check existence of a file or dir.
WorkerNetAddress	getAddress() Get the address of the Dora Worker.
FileInfo	getFileInfo(String fileId, GetStatusPOptions options) Gets the file information.
UfsStatus[]	listStatus(String path, ListStatusPOptions options) List status from Under File System.
com.google.common.util.concurrent.ListenableFuture<LoadFileResponse>	load(boolean loadData, boolean skipIfExists, List<UfsStatus> ufsStatuses, UfsReadOptions options) Loads the metadata and data of files from UFS to Alluxio.
com.google.common.util.concurrent.ListenableFuture<List<RouteFailure>>	move(List<Route> routes, UfsReadOptions readOptions, WriteOptions writeOptions) Moves files from src to dst.
void	rename(String src, String dst, RenamePOptions options) Rename src to dst.
void	setAttribute(String path, SetAttributePOptions options) Set Attributes for a file or dir.

Methods inherited from interface alluxio.worker.DataWorker

getWorkerId

Methods inherited from interface alluxio.Server

close, getDependencies, getName, getServices, start, stop

Methods inherited from interface alluxio.worker.SessionCleanable

cleanupSession

Method Detail

getFileInfo

FileInfo getFileInfo(String fileId,
                     GetStatusPOptions options)
              throws IOException,
                     AccessControlException

Gets the file information.

Parameters:

fileId - the file id

options - the options for the GetStatusPRequest

Returns:

the file info

Throws:

IOException

AccessControlException

listStatus

@Nullable
UfsStatus[] listStatus(String path,
                                 ListStatusPOptions options)
                          throws IOException,
                                 AccessControlException

List status from Under File System. Please refer to UnderFileSystem.listStatus().

Parameters:

path - the path of a dir or file

options - the option for listStatus()

Returns:

An array with the statuses of the files and directories in the directory denoted by this abstract pathname. The array will be empty if the directory is empty. Returns null if this abstract pathname does not denote a directory.

Throws:

IOException

AccessControlException

createFileReader

BlockReader createFileReader(String fileId,
                             long offset,
                             boolean positionShort,
                             Protocol.OpenUfsBlockOptions options)
                      throws IOException,
                             AccessControlException

Creates the file reader to read from Alluxio dora. Owner of this block reader must close it or lock will leak.

Parameters:

fileId - the ID of the UFS file

offset - the offset within the block

positionShort - whether the operation is using positioned read to a small buffer size

options - the options

Returns:

a block reader to read data from

Throws:

IOException - if it fails to get block reader

AccessControlException

createFileWriter

BlockWriter createFileWriter(String fileId,
                             String ufsPath)
                      throws AccessControlException,
                             IOException

Creates the file writer to write to Alluxio dora. Owner of this block writer must close it or lock will leak.

Parameters:

fileId - the ID of the UFS file

ufsPath - the path of UFS file

Returns:

the block writer for the local file

Throws:

AccessControlException

IOException

load

com.google.common.util.concurrent.ListenableFuture<LoadFileResponse> load(boolean loadData,
                                                                          boolean skipIfExists,
                                                                          List<UfsStatus> ufsStatuses,
                                                                          UfsReadOptions options)
                                                                   throws AccessControlException,
                                                                          IOException

Loads the metadata and data of files from UFS to Alluxio.

Parameters:

loadData - true if data should also be loaded, otherwise metadata only

skipIfExists - true if data loading should be skipped if it's already loaded

ufsStatuses - the files to load

options -

Returns:

a list of failed files

Throws:

AccessControlException

IOException

copy

com.google.common.util.concurrent.ListenableFuture<List<RouteFailure>> copy(List<Route> routes,
                                                                            UfsReadOptions readOptions,
                                                                            WriteOptions writeOptions)

Copies files from src to dst.

Parameters:

routes - the files to copy

readOptions - the options for reading

writeOptions - the options for writing

Returns:

a list of failed files

move

com.google.common.util.concurrent.ListenableFuture<List<RouteFailure>> move(List<Route> routes,
                                                                            UfsReadOptions readOptions,
                                                                            WriteOptions writeOptions)

Moves files from src to dst.

Parameters:

routes - the files to move

readOptions - the options for reading

writeOptions - the options for writing

Returns:

a list of failed files

createFile

OpenFileHandle createFile(String path,
                          CreateFilePOptions options)
                   throws AccessControlException,
                          IOException

Create File.

Parameters:

path - the path of this file

options - the options for this operation

Returns:

a open file handle including a unique uuid

Throws:

AccessControlException

IOException

completeFile

void completeFile(String path,
                  CompleteFilePOptions options,
                  String uuid)
           throws IOException,
                  AccessControlException

Complete writing a file. This operation will verify the supplied uuid matching its open handle.

Parameters:

path - the path of this file

options - the options for this operation

uuid - the uuid string of its file open handle

Throws:

IOException

AccessControlException

delete

void delete(String path,
            DeletePOptions options)
     throws IOException,
            AccessControlException

Delete a file.

Parameters:

path - the path of this file

options - the options for this operation

Throws:

IOException

AccessControlException

rename

void rename(String src,
            String dst,
            RenamePOptions options)
     throws IOException,
            AccessControlException

Rename src to dst.

Parameters:

src - the source file/dir

dst - the destination file/dir

options - the options for this operations

Throws:

IOException

AccessControlException

createDirectory

void createDirectory(String path,
                     CreateDirectoryPOptions options)
              throws IOException,
                     AccessControlException

Create a directory.

Parameters:

path - the directory name

options - the options for this operations

Throws:

IOException

AccessControlException

exists

boolean exists(String path,
               ExistsPOptions options)
        throws IOException

Check existence of a file or dir.

Parameters:

path - the path of this file or dir

options - the options of this operation

Returns:

true if the file or dir exists, false otherwise

Throws:

IOException

setAttribute

void setAttribute(String path,
                  SetAttributePOptions options)
           throws IOException

Set Attributes for a file or dir.

Parameters:

path - the pth of this file or dir

options - the options of this operation

Throws:

IOException

getAddress

WorkerNetAddress getAddress()

Get the address of the Dora Worker.

Returns:

worker address