alluxio

Class AbstractMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

All Implemented Interfaces:

Client, Closeable, AutoCloseable

Direct Known Subclasses:

AbstractJobMasterClient, BlockMasterClient, FileSystemMasterClient, FileSystemMasterClient, RaftJournalServiceClient, RetryHandlingBlockMasterClient, RetryHandlingFileSystemMasterClient, RetryHandlingMetaMasterClient, RetryHandlingMetaMasterConfigClient, RetryHandlingMetaMasterMasterClient, RetryHandlingMetaMasterProxyClient, RetryHandlingMetricsMasterClient, RetryHandlingTableMasterClient

@ThreadSafe
public abstract class AbstractMasterClient
extends AbstractClient

The base class for master clients.

Nested Class Summary

Nested classes/interfaces inherited from class alluxio.AbstractClient

AbstractClient.RpcCallable<V>

Field Summary

Fields inherited from class alluxio.AbstractClient

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

Constructor Summary

Constructors

Constructor and Description
AbstractMasterClient(MasterClientContext clientConf) Creates a new master client base and default the selection policy to primary master.
AbstractMasterClient(MasterClientContext clientConf, MasterSelectionPolicy selectionPolicy) Creates a new master client base.
AbstractMasterClient(MasterClientContext clientConf, MasterSelectionPolicy selectionPolicy, java.util.function.Supplier<RetryPolicy> retryPolicySupplier) Creates a new master client without a specific address.
AbstractMasterClient(MasterClientContext clientConf, java.util.function.Supplier<RetryPolicy> retryPolicySupplier) Creates a new master client without a specific address.

Method Summary

Modifier and Type	Method and Description
protected void	afterDisconnect() This method is called after the connection is disconnected.
protected void	beforeConnect() This method is called before the connection is connected.
InetSocketAddress	getConfAddress() By default, return the same underlying address as AbstractClient.getRemoteSockAddress().
protected GrpcServerAddress	queryGrpcServerAddress() AbstractClient works with Grpc Servers.

Methods inherited from class alluxio.AbstractClient

afterConnect, beforeDisconnect, checkVersion, close, connect, connectWithRuntimeException, createChannel, disconnect, getRemoteHostName, getRemoteServiceType, getRemoteServiceVersion, getRemoteSockAddress, getServiceName, getServiceVersion, isClosed, isConnected, retryRPC, retryRPC

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMasterClient

public AbstractMasterClient(MasterClientContext clientConf)

Creates a new master client base and default the selection policy to primary master.

Parameters:

clientConf - master client configuration

AbstractMasterClient

public AbstractMasterClient(MasterClientContext clientConf,
                            MasterSelectionPolicy selectionPolicy)

Creates a new master client base.

Parameters:

clientConf - master client configuration

selectionPolicy - master selection policy: which master the client should connect to

AbstractMasterClient

public AbstractMasterClient(MasterClientContext clientConf,
                            java.util.function.Supplier<RetryPolicy> retryPolicySupplier)

Creates a new master client without a specific address. The client defaults to connect to the primary master.

Parameters:

clientConf - master client configuration

retryPolicySupplier - retry policy to use

AbstractMasterClient

public AbstractMasterClient(MasterClientContext clientConf,
                            MasterSelectionPolicy selectionPolicy,
                            java.util.function.Supplier<RetryPolicy> retryPolicySupplier)

Creates a new master client without a specific address.

Parameters:

clientConf - master client configuration

selectionPolicy - master selection policy: which master the client should connect to

retryPolicySupplier - retry policy to use

Method Detail

getConfAddress

public InetSocketAddress getConfAddress()
                                 throws UnavailableException

Description copied from class: AbstractClient

By default, return the same underlying address as AbstractClient.getRemoteSockAddress(). Child classes should override this implementation if they intend to have different address to fetch configuration.

Specified by:

getConfAddress in interface Client

Overrides:

getConfAddress in class AbstractClient

Returns:

the remote address of the configuration server

Throws:

UnavailableException - if address cannot be determined

beforeConnect

protected void beforeConnect()
                      throws IOException

Description copied from class: AbstractClient

This method is called before the connection is connected. Implementations should add any additional operations before the connection is connected. loading the cluster defaults

Overrides:

beforeConnect in class AbstractClient

Throws:

IOException

afterDisconnect

protected void afterDisconnect()

Description copied from class: AbstractClient

This method is called after the connection is disconnected. Implementations should clean up any additional state created for the connection.

Overrides:

afterDisconnect in class AbstractClient

queryGrpcServerAddress

protected GrpcServerAddress queryGrpcServerAddress()
                                            throws UnavailableException

Description copied from class: AbstractClient

AbstractClient works with Grpc Servers. Child classes should only override this method to query the address of the grpc server they talk to. The conversion from GrpcServerAddress to more generic SocketAddress required by Client.getRemoteSockAddress() is handled by this class.

Specified by:

queryGrpcServerAddress in class AbstractClient

Returns:

the GrpcServerAddress of the remote server

Throws:

UnavailableException - if address can't be determined