alluxio.client.file

Class RetryHandlingFileSystemMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.client.file.RetryHandlingFileSystemMasterClient

All Implemented Interfaces:

Client, FileSystemMasterClient, Closeable, AutoCloseable

@ThreadSafe
public final class RetryHandlingFileSystemMasterClient
extends AbstractMasterClient
implements FileSystemMasterClient

A wrapper for the thrift client to interact with the file system master, used by alluxio clients. Since thrift clients are not thread safe, this class is a wrapper to provide thread safety, and to provide retries.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

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

FileSystemMasterClient.Factory

Field Summary

Fields inherited from class alluxio.AbstractClient

mAddress, mClosed, mConnected, mProtocol, mServiceVersion

Constructor Summary

Constructors

Constructor and Description
RetryHandlingFileSystemMasterClient(MasterClientConfig conf) Creates a new RetryHandlingFileSystemMasterClient instance.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
List<AlluxioURI>	checkConsistency(AlluxioURI path, CheckConsistencyOptions options) Checks the consistency of Alluxio metadata against the under storage for all files and directories in a given subtree.
void	completeFile(AlluxioURI path, CompleteFileOptions options) Marks a file as completed.
void	createDirectory(AlluxioURI path, CreateDirectoryOptions options) Creates a new directory.
void	createFile(AlluxioURI path, CreateFileOptions options) Creates a new file.
void	delete(AlluxioURI path, DeleteOptions options) Deletes a file or a directory.
void	free(AlluxioURI path, FreeOptions options) Frees a file.
protected AlluxioService.Client	getClient()
String	getFilePath(GetFilePathTOptions options)
Map<String,MountPointInfo>	getMountTable() Lists all mount points and their corresponding under storage addresses.
long	getNewBlockIdForFile(AlluxioURI path)
protected String	getServiceName()
protected long	getServiceVersion()
URIStatus	getStatus(AlluxioURI path, GetStatusOptions options)
List<URIStatus>	listStatus(AlluxioURI path, ListStatusOptions options)
void	loadMetadata(AlluxioURI path, LoadMetadataOptions options) Loads the metadata of a file from the under file system.
void	mount(AlluxioURI alluxioPath, AlluxioURI ufsPath, MountOptions options) Mounts the given UFS path under the given Alluxio path.
void	rename(AlluxioURI src, AlluxioURI dst) Renames a file or a directory.
void	rename(AlluxioURI src, AlluxioURI dst, RenameOptions options) Renames a file or a directory.
void	scheduleAsyncPersist(AlluxioURI path) Schedules the async persistence of the given file.
void	setAttribute(AlluxioURI path, SetAttributeOptions options) Sets the file or directory attributes.
void	unmount(AlluxioURI alluxioPath) Unmounts the given Alluxio path.
void	updateUfsMode(AlluxioURI ufsUri, UpdateUfsModeOptions options) Updates the operation mode for the given ufs path.

Methods inherited from class alluxio.AbstractMasterClient

getAddress

Methods inherited from class alluxio.AbstractClient

afterDisconnect, beforeDisconnect, checkVersion, close, connect, disconnect, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

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

Methods inherited from interface alluxio.Client

connect, disconnect, getAddress, isConnected

Methods inherited from interface java.io.Closeable

close

Constructor Detail

RetryHandlingFileSystemMasterClient

public RetryHandlingFileSystemMasterClient(MasterClientConfig conf)

Creates a new RetryHandlingFileSystemMasterClient instance.

Parameters:

conf - master client configuration

Method Detail

getClient

protected AlluxioService.Client getClient()

Specified by:

getClient in class AbstractClient

Returns:

a Thrift service client

getServiceName

protected String getServiceName()

Specified by:

getServiceName in class AbstractClient

Returns:

a string representing the specific service

getServiceVersion

protected long getServiceVersion()

Specified by:

getServiceVersion in class AbstractClient

Returns:

the client service version

afterConnect

protected void afterConnect()

Description copied from class: AbstractClient

This method is called after the connection is made to the remote. Implementations should create internal state to finish the connection process.

Overrides:

afterConnect in class AbstractClient

checkConsistency

public List<AlluxioURI> checkConsistency(AlluxioURI path,
                                         CheckConsistencyOptions options)
                                  throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Checks the consistency of Alluxio metadata against the under storage for all files and directories in a given subtree.

Specified by:

checkConsistency in interface FileSystemMasterClient

Parameters:

path - the root of the subtree to check

options - method options

Returns:

a list of inconsistent files and directories

Throws:

AlluxioStatusException

createDirectory

public void createDirectory(AlluxioURI path,
                            CreateDirectoryOptions options)
                     throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Creates a new directory.

Specified by:

createDirectory in interface FileSystemMasterClient

Parameters:

path - the directory path

options - method options

Throws:

AlreadyExistsException - if the directory already exists

AlluxioStatusException

createFile

public void createFile(AlluxioURI path,
                       CreateFileOptions options)
                throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Creates a new file.

Specified by:

createFile in interface FileSystemMasterClient

Parameters:

path - the file path

options - method options

Throws:

AlreadyExistsException - if the file already exists

AlluxioStatusException

completeFile

public void completeFile(AlluxioURI path,
                         CompleteFileOptions options)
                  throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Marks a file as completed.

Specified by:

completeFile in interface FileSystemMasterClient

Parameters:

path - the file path

options - the method options

Throws:

AlluxioStatusException

delete

public void delete(AlluxioURI path,
                   DeleteOptions options)
            throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Deletes a file or a directory.

Specified by:

delete in interface FileSystemMasterClient

Parameters:

path - the path to delete

options - method options

Throws:

AlluxioStatusException

free

public void free(AlluxioURI path,
                 FreeOptions options)
          throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Frees a file.

Specified by:

free in interface FileSystemMasterClient

Parameters:

path - the path to free

options - method options

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

getFilePath

public String getFilePath(GetFilePathTOptions options)
                   throws AlluxioStatusException

Specified by:

getFilePath in interface FileSystemMasterClient

Parameters:

options - the getFilePath options

Returns:

the file path for the given file id

Throws:

AlluxioStatusException

getStatus

public URIStatus getStatus(AlluxioURI path,
                           GetStatusOptions options)
                    throws AlluxioStatusException

Specified by:

getStatus in interface FileSystemMasterClient

Parameters:

path - the file path

options - the getStatus options

Returns:

the file info for the given file id

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

getNewBlockIdForFile

public long getNewBlockIdForFile(AlluxioURI path)
                          throws AlluxioStatusException

Specified by:

getNewBlockIdForFile in interface FileSystemMasterClient

Parameters:

path - the file path

Returns:

the next blockId for the file

Throws:

AlluxioStatusException

getMountTable

public Map<String,MountPointInfo> getMountTable()
                                         throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Lists all mount points and their corresponding under storage addresses.

Specified by:

getMountTable in interface FileSystemMasterClient

Returns:

a map from String to MountPointInfo

Throws:

AlluxioStatusException

listStatus

public List<URIStatus> listStatus(AlluxioURI path,
                                  ListStatusOptions options)
                           throws AlluxioStatusException

Specified by:

listStatus in interface FileSystemMasterClient

Parameters:

path - the path to list

options - the listStatus options

Returns:

the list of file information for the given path

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

loadMetadata

public void loadMetadata(AlluxioURI path,
                         LoadMetadataOptions options)
                  throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Loads the metadata of a file from the under file system.

Specified by:

loadMetadata in interface FileSystemMasterClient

Parameters:

path - the path of the file to load metadata for

options - method options

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

mount

public void mount(AlluxioURI alluxioPath,
                  AlluxioURI ufsPath,
                  MountOptions options)
           throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Mounts the given UFS path under the given Alluxio path.

Specified by:

mount in interface FileSystemMasterClient

Parameters:

alluxioPath - the Alluxio path

ufsPath - the UFS path

options - mount options

Throws:

AlluxioStatusException

rename

public void rename(AlluxioURI src,
                   AlluxioURI dst)
            throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Renames a file or a directory.

Specified by:

rename in interface FileSystemMasterClient

Parameters:

src - the path to rename

dst - new file path

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

rename

public void rename(AlluxioURI src,
                   AlluxioURI dst,
                   RenameOptions options)
            throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Renames a file or a directory.

Specified by:

rename in interface FileSystemMasterClient

Parameters:

src - the path to rename

dst - new file path

options - rename options

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

setAttribute

public void setAttribute(AlluxioURI path,
                         SetAttributeOptions options)
                  throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Sets the file or directory attributes.

Specified by:

setAttribute in interface FileSystemMasterClient

Parameters:

path - the file or directory path

options - the file or directory attribute options to be set

Throws:

NotFoundException - if the path does not exist

AlluxioStatusException

scheduleAsyncPersist

public void scheduleAsyncPersist(AlluxioURI path)
                          throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Schedules the async persistence of the given file.

Specified by:

scheduleAsyncPersist in interface FileSystemMasterClient

Parameters:

path - the file path

Throws:

AlluxioStatusException

unmount

public void unmount(AlluxioURI alluxioPath)
             throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Unmounts the given Alluxio path.

Specified by:

unmount in interface FileSystemMasterClient

Parameters:

alluxioPath - the Alluxio path

Throws:

AlluxioStatusException

updateUfsMode

public void updateUfsMode(AlluxioURI ufsUri,
                          UpdateUfsModeOptions options)
                   throws AlluxioStatusException

Description copied from interface: FileSystemMasterClient

Updates the operation mode for the given ufs path. The path is required to be the scheme and authority only. For example, to update the mode for under storage at hdfs://ns/folder1 specify the argument as hdfs://ns/. Note: the mode for any other mounted under storage which shares the prefix (such as hdfs://ns/folder2) is also updated.

Specified by:

updateUfsMode in interface FileSystemMasterClient

Parameters:

ufsUri - the ufs path

options - the options to update ufs operation mode

Throws:

AlluxioStatusException