alluxio.client.keyvalue

Class KeyValueMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.client.keyvalue.KeyValueMasterClient

All Implemented Interfaces:

Client, Closeable, AutoCloseable

@ThreadSafe
public final class KeyValueMasterClient
extends AbstractMasterClient

A wrapper for the thrift client to interact with the key-value master, used by Alluxio clients. This wrapper provides thread safety, and retry mechanism.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Field Summary

Fields inherited from class alluxio.AbstractClient

mAddress, mClosed, mConnected, mProtocol, mServiceVersion

Constructor Summary

Constructors

Constructor and Description
KeyValueMasterClient(MasterClientConfig conf) Creates a new key-value master client.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
void	completePartition(AlluxioURI path, PartitionInfo info) Marks a partition complete and adds it to an incomplete key-value store.
void	completeStore(AlluxioURI path) Marks a key-value store complete.
void	createStore(AlluxioURI path) Creates a new key-value store.
void	deleteStore(AlluxioURI path) Deletes a completed key-value store.
protected AlluxioService.Client	getClient()
List<PartitionInfo>	getPartitionInfo(AlluxioURI path) Gets a list of partitions of a given key-value store.
protected String	getServiceName()
protected long	getServiceVersion()
void	renameStore(AlluxioURI oldPath, AlluxioURI newPath) Renames a completed key-value store.

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

Constructor Detail

KeyValueMasterClient

public KeyValueMasterClient(MasterClientConfig conf)

Creates a new key-value master client.

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()
                     throws IOException

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

Throws:

IOException

completePartition

public void completePartition(AlluxioURI path,
                              PartitionInfo info)
                       throws IOException

Marks a partition complete and adds it to an incomplete key-value store.

Parameters:

path - URI of the key-value store

info - information of this completed partition

Throws:

IOException

completeStore

public void completeStore(AlluxioURI path)
                   throws IOException

Marks a key-value store complete.

Parameters:

path - URI of the key-value store

Throws:

IOException

createStore

public void createStore(AlluxioURI path)
                 throws IOException

Creates a new key-value store.

Parameters:

path - URI of the key-value store

Throws:

IOException

getPartitionInfo

public List<PartitionInfo> getPartitionInfo(AlluxioURI path)
                                     throws IOException

Gets a list of partitions of a given key-value store.

Parameters:

path - URI of the key-value store

Returns:

a list of partition information

Throws:

IOException

deleteStore

public void deleteStore(AlluxioURI path)
                 throws IOException

Deletes a completed key-value store.

Parameters:

path - URI of the store

Throws:

IOException

renameStore

public void renameStore(AlluxioURI oldPath,
                        AlluxioURI newPath)
                 throws IOException

Renames a completed key-value store.

Parameters:

oldPath - old URI of the store

newPath - new URI of the store

Throws:

IOException