alluxio.master.file

Class FileSystemMasterClientServiceHandler

java.lang.Object

alluxio.master.file.FileSystemMasterClientServiceHandler

All Implemented Interfaces:

AlluxioService.Iface, FileSystemMasterClientService.Iface

@NotThreadSafe
public final class FileSystemMasterClientServiceHandler
extends Object
implements FileSystemMasterClientService.Iface

This class is a Thrift handler for file system master RPCs invoked by an Alluxio client.

Method Summary

Modifier and Type	Method and Description
CheckConsistencyTResponse	checkConsistency(String path, CheckConsistencyTOptions options) Checks the consistency of the files and directores with the path as the root of the subtree
CompleteFileTResponse	completeFile(String path, CompleteFileTOptions options) Marks a file as completed.
CreateDirectoryTResponse	createDirectory(String path, CreateDirectoryTOptions options) Creates a directory.
CreateFileTResponse	createFile(String path, CreateFileTOptions options) Creates a file.
FreeTResponse	free(String path, boolean recursive, FreeTOptions options) Frees the given file or directory from Alluxio.
GetFilePathTResponse	getFilePath(GetFilePathTOptions options) Returns the file path of a file id.
GetMountTableTResponse	getMountTable() Returns a map from each Alluxio path to information of corresponding mount point
GetNewBlockIdForFileTResponse	getNewBlockIdForFile(String path, GetNewBlockIdForFileTOptions options) Generates a new block id for the given file.
GetServiceVersionTResponse	getServiceVersion(GetServiceVersionTOptions options) Returns the version of the master service.
GetStatusTResponse	getStatus(String path, GetStatusTOptions options) Returns the status of the file or directory.
ListStatusTResponse	listStatus(String path, ListStatusTOptions options) If the path points to a file, the method returns a singleton with its file information.
LoadMetadataTResponse	loadMetadata(String alluxioPath, boolean recursive, LoadMetadataTOptions options) Deprecated. since version 1.1 and will be removed in version 2.0
MountTResponse	mount(String alluxioPath, String ufsPath, MountTOptions options) Creates a new "mount point", mounts the given UFS path in the Alluxio namespace at the given path.
DeleteTResponse	remove(String path, boolean recursive, DeleteTOptions options) Deletes a file or a directory and returns whether the remove operation succeeded.
RenameTResponse	rename(String srcPath, String dstPath, RenameTOptions options) Renames a file or a directory.
ScheduleAsyncPersistenceTResponse	scheduleAsyncPersistence(String path, ScheduleAsyncPersistenceTOptions options) Schedules async persistence.
SetAttributeTResponse	setAttribute(String path, SetAttributeTOptions options) Sets file or directory attributes.
UnmountTResponse	unmount(String alluxioPath, UnmountTOptions options) Deletes an existing "mount point", voiding the Alluxio namespace at the given path.
UpdateUfsModeTResponse	updateUfsMode(String ufsPath, UpdateUfsModeTOptions options) Updates the ufs mode for a ufs path under one or more mount points.

Methods inherited from class java.lang.Object

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

Method Detail

getServiceVersion

public GetServiceVersionTResponse getServiceVersion(GetServiceVersionTOptions options)

Description copied from interface: AlluxioService.Iface

Returns the version of the master service. NOTE: The version should be updated every time a backwards incompatible API change occurs.

Specified by:

getServiceVersion in interface AlluxioService.Iface

Parameters:

options - the method options

checkConsistency

public CheckConsistencyTResponse checkConsistency(String path,
                                                  CheckConsistencyTOptions options)
                                           throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Checks the consistency of the files and directores with the path as the root of the subtree

Specified by:

checkConsistency in interface FileSystemMasterClientService.Iface

Parameters:

path - the root of the subtree to check

options - the method options

Throws:

AlluxioTException

completeFile

public CompleteFileTResponse completeFile(String path,
                                          CompleteFileTOptions options)
                                   throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Marks a file as completed.

Specified by:

completeFile in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

createDirectory

public CreateDirectoryTResponse createDirectory(String path,
                                                CreateDirectoryTOptions options)
                                         throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Creates a directory.

Specified by:

createDirectory in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the directory

options - the method options

Throws:

AlluxioTException

createFile

public CreateFileTResponse createFile(String path,
                                      CreateFileTOptions options)
                               throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Creates a file.

Specified by:

createFile in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the options for creating the file

Throws:

AlluxioTException

free

public FreeTResponse free(String path,
                          boolean recursive,
                          FreeTOptions options)
                   throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Frees the given file or directory from Alluxio.

Specified by:

free in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

recursive - whether to free recursively

options - the options for freeing a path

Throws:

AlluxioTException

getNewBlockIdForFile

public GetNewBlockIdForFileTResponse getNewBlockIdForFile(String path,
                                                          GetNewBlockIdForFileTOptions options)
                                                   throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Generates a new block id for the given file.

Specified by:

getNewBlockIdForFile in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

getFilePath

public GetFilePathTResponse getFilePath(GetFilePathTOptions options)
                                 throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Returns the file path of a file id.

Specified by:

getFilePath in interface FileSystemMasterClientService.Iface

Parameters:

options - the file id

Throws:

AlluxioTException

getStatus

public GetStatusTResponse getStatus(String path,
                                    GetStatusTOptions options)
                             throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Returns the status of the file or directory.

Specified by:

getStatus in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

options - the method options

Throws:

AlluxioTException

listStatus

public ListStatusTResponse listStatus(String path,
                                      ListStatusTOptions options)
                               throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

If the path points to a file, the method returns a singleton with its file information. If the path points to a directory, the method returns a list with file information for the directory contents.

Specified by:

listStatus in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

options - listStatus options

Throws:

AlluxioTException

loadMetadata

@Deprecated
public LoadMetadataTResponse loadMetadata(String alluxioPath,
                                                      boolean recursive,
                                                      LoadMetadataTOptions options)
                                               throws AlluxioTException

Deprecated. since version 1.1 and will be removed in version 2.0

Loads metadata for the object identified by the given Alluxio path from UFS into Alluxio. THIS METHOD IS DEPRECATED SINCE VERSION 1.1 AND WILL BE REMOVED IN VERSION 2.0.

Specified by:

loadMetadata in interface FileSystemMasterClientService.Iface

Parameters:

alluxioPath - the path of the under file system

recursive - whether to load metadata recursively

options - the method options

Throws:

AlluxioTException

mount

public MountTResponse mount(String alluxioPath,
                            String ufsPath,
                            MountTOptions options)
                     throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Creates a new "mount point", mounts the given UFS path in the Alluxio namespace at the given path. The path should not exist and should not be nested under any existing mount point.

Specified by:

mount in interface FileSystemMasterClientService.Iface

Parameters:

alluxioPath - the path of alluxio mount point

ufsPath - the path of the under file system

options - the options for creating the mount point

Throws:

AlluxioTException

getMountTable

public GetMountTableTResponse getMountTable()
                                     throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Returns a map from each Alluxio path to information of corresponding mount point

Specified by:

getMountTable in interface FileSystemMasterClientService.Iface

Throws:

AlluxioTException

remove

public DeleteTResponse remove(String path,
                              boolean recursive,
                              DeleteTOptions options)
                       throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Deletes a file or a directory and returns whether the remove operation succeeded. NOTE: Unfortunately, the method cannot be called "delete" as that is a reserved Thrift keyword.

Specified by:

remove in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

recursive - whether to remove recursively

options - the options for deleting the file

Throws:

AlluxioTException

rename

public RenameTResponse rename(String srcPath,
                              String dstPath,
                              RenameTOptions options)
                       throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Renames a file or a directory.

Specified by:

rename in interface FileSystemMasterClientService.Iface

Parameters:

srcPath - the source path of the file or directory

dstPath - the desination path of the file

options - the method options

Throws:

AlluxioTException

scheduleAsyncPersistence

public ScheduleAsyncPersistenceTResponse scheduleAsyncPersistence(String path,
                                                                  ScheduleAsyncPersistenceTOptions options)
                                                           throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Schedules async persistence.

Specified by:

scheduleAsyncPersistence in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file

options - the method options

Throws:

AlluxioTException

setAttribute

public SetAttributeTResponse setAttribute(String path,
                                          SetAttributeTOptions options)
                                   throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Sets file or directory attributes.

Specified by:

setAttribute in interface FileSystemMasterClientService.Iface

Parameters:

path - the path of the file or directory

options - the method options

Throws:

AlluxioTException

unmount

public UnmountTResponse unmount(String alluxioPath,
                                UnmountTOptions options)
                         throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Deletes an existing "mount point", voiding the Alluxio namespace at the given path. The path should correspond to an existing mount point. Any files in its subtree that are backed by UFS will be persisted before they are removed from the Alluxio namespace.

Specified by:

unmount in interface FileSystemMasterClientService.Iface

Parameters:

alluxioPath - the path of the alluxio mount point

options - the method options

Throws:

AlluxioTException

updateUfsMode

public UpdateUfsModeTResponse updateUfsMode(String ufsPath,
                                            UpdateUfsModeTOptions options)
                                     throws AlluxioTException

Description copied from interface: FileSystemMasterClientService.Iface

Updates the ufs mode for a ufs path under one or more mount points.

Specified by:

updateUfsMode in interface FileSystemMasterClientService.Iface

Parameters:

ufsPath - the ufs path

options - the method options

Throws:

AlluxioTException