alluxio.client.block

Class RetryHandlingBlockMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.client.block.RetryHandlingBlockMasterClient

All Implemented Interfaces:

Client, BlockMasterClient, Closeable, AutoCloseable

@ThreadSafe
public final class RetryHandlingBlockMasterClient
extends AbstractMasterClient
implements BlockMasterClient

A wrapper for the gRPC client to interact with the block master, used by alluxio clients.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Nested classes/interfaces inherited from interface alluxio.client.block.BlockMasterClient

BlockMasterClient.Factory

Field Summary

Fields inherited from class alluxio.AbstractClient

mAlwaysEnableTLS, mChannel, mClosed, mConnected, mContext, mServerAddress, mServiceVersion, mVersionService

Constructor Summary

Constructors

Constructor and Description
RetryHandlingBlockMasterClient(MasterClientContext conf) Creates a new block master client.
RetryHandlingBlockMasterClient(MasterClientContext conf, InetSocketAddress address) Creates a new block master client.
RetryHandlingBlockMasterClient(MasterClientContext conf, InetSocketAddress address, java.util.function.Supplier<RetryPolicy> retryPolicy) Creates a new block 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	decommissionWorker(DecommissionWorkerPOptions options) Decommission a worker.
BlockInfo	getBlockInfo(long blockId) Returns the BlockInfo for a block id.
BlockMasterInfo	getBlockMasterInfo(Set<BlockMasterInfo.BlockMasterInfoField> fields)
long	getCapacityBytes() Gets the total Alluxio capacity in bytes, on all the tiers of all the workers.
List<WorkerInfo>	getLostWorkerInfoList() Gets the worker information of lost workers.
protected ServiceType	getRemoteServiceType()
protected String	getServiceName()
protected long	getServiceVersion()
long	getUsedBytes() Gets the total amount of used space in bytes, on all the tiers of all the workers.
List<WorkerInfo>	getWorkerInfoList() Gets the worker information of live workers(support older version Alluxio server).
List<WorkerLostStorageInfo>	getWorkerLostStorage()
List<WorkerInfo>	getWorkerReport(GetWorkerReportOptions options) Gets the worker information of selected workers and selected fields for report CLI.
void	removeDisabledWorker(RemoveDisabledWorkerPOptions options) Revert disabling a worker, enabling it to register to the cluster.

Methods inherited from class alluxio.AbstractMasterClient

afterDisconnect, beforeConnect, getConfAddress, queryGrpcServerAddress

Methods inherited from class alluxio.AbstractClient

beforeDisconnect, checkVersion, close, connect, connectWithRuntimeException, createChannel, disconnect, getRemoteHostName, getRemoteServiceVersion, getRemoteSockAddress, isClosed, 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, getConfAddress, getRemoteHostName, getRemoteSockAddress, isClosed, isConnected

Methods inherited from interface java.io.Closeable

close

Constructor Detail

RetryHandlingBlockMasterClient

public RetryHandlingBlockMasterClient(MasterClientContext conf)

Creates a new block master client.

Parameters:

conf - master client configuration

RetryHandlingBlockMasterClient

public RetryHandlingBlockMasterClient(MasterClientContext conf,
                                      InetSocketAddress address)

Creates a new block master client.

Parameters:

conf - master client configuration

address - the master address the client connects to

RetryHandlingBlockMasterClient

public RetryHandlingBlockMasterClient(MasterClientContext conf,
                                      InetSocketAddress address,
                                      java.util.function.Supplier<RetryPolicy> retryPolicy)

Creates a new block master client.

Parameters:

conf - master client configuration

address - the master address the client connects to

retryPolicy - retry policy to use

Method Detail

getRemoteServiceType

protected ServiceType getRemoteServiceType()

Specified by:

getRemoteServiceType in class AbstractClient

Returns:

the expected type of remote service

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

getWorkerInfoList

public List<WorkerInfo> getWorkerInfoList()
                                   throws IOException

Description copied from interface: BlockMasterClient

Gets the worker information of live workers(support older version Alluxio server).

Specified by:

getWorkerInfoList in interface BlockMasterClient

Returns:

a list of worker information

Throws:

IOException

getLostWorkerInfoList

public List<WorkerInfo> getLostWorkerInfoList()
                                       throws IOException

Description copied from interface: BlockMasterClient

Gets the worker information of lost workers.

Specified by:

getLostWorkerInfoList in interface BlockMasterClient

Returns:

a list of lost worker information

Throws:

IOException

removeDisabledWorker

public void removeDisabledWorker(RemoveDisabledWorkerPOptions options)
                          throws IOException

Description copied from interface: BlockMasterClient

Revert disabling a worker, enabling it to register to the cluster.

Specified by:

removeDisabledWorker in interface BlockMasterClient

Parameters:

options - contains the info used to find the target worker(s)

Throws:

IOException

getWorkerReport

public List<WorkerInfo> getWorkerReport(GetWorkerReportOptions options)
                                 throws IOException

Description copied from interface: BlockMasterClient

Gets the worker information of selected workers and selected fields for report CLI.

Specified by:

getWorkerReport in interface BlockMasterClient

Parameters:

options - the client defined worker and field ranges

Returns:

a list of worker information

Throws:

IOException

getWorkerLostStorage

public List<WorkerLostStorageInfo> getWorkerLostStorage()
                                                 throws IOException

Specified by:

getWorkerLostStorage in interface BlockMasterClient

Returns:

a list of worker lost storage information

Throws:

IOException

getBlockInfo

public BlockInfo getBlockInfo(long blockId)
                       throws IOException

Description copied from interface: BlockMasterClient

Returns the BlockInfo for a block id.

Specified by:

getBlockInfo in interface BlockMasterClient

Parameters:

blockId - the block id to get the BlockInfo for

Returns:

the BlockInfo

Throws:

IOException

getBlockMasterInfo

public BlockMasterInfo getBlockMasterInfo(Set<BlockMasterInfo.BlockMasterInfoField> fields)
                                   throws IOException

Specified by:

getBlockMasterInfo in interface BlockMasterClient

Parameters:

fields - optional list of fields to query; if null all fields will be queried

Returns:

the BlockMasterInfo block master information

Throws:

IOException

getCapacityBytes

public long getCapacityBytes()
                      throws IOException

Description copied from interface: BlockMasterClient

Gets the total Alluxio capacity in bytes, on all the tiers of all the workers.

Specified by:

getCapacityBytes in interface BlockMasterClient

Returns:

total capacity in bytes

Throws:

IOException

getUsedBytes

public long getUsedBytes()
                  throws IOException

Description copied from interface: BlockMasterClient

Gets the total amount of used space in bytes, on all the tiers of all the workers.

Specified by:

getUsedBytes in interface BlockMasterClient

Returns:

amount of used space in bytes

Throws:

IOException

decommissionWorker

public void decommissionWorker(DecommissionWorkerPOptions options)
                        throws IOException

Description copied from interface: BlockMasterClient

Decommission a worker.

Specified by:

decommissionWorker in interface BlockMasterClient

Parameters:

options - method options

Throws:

AlluxioStatusException - if something goes wrong

IOException