alluxio.client.meta

Class RetryHandlingMetaMasterClient

java.lang.Object

alluxio.AbstractClient

alluxio.AbstractMasterClient

alluxio.client.meta.RetryHandlingMetaMasterClient

All Implemented Interfaces:

Client, MetaMasterClient, Closeable, AutoCloseable

@ThreadSafe
public class RetryHandlingMetaMasterClient
extends AbstractMasterClient
implements MetaMasterClient

A wrapper for the gRPC client to interact with the meta master.

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
RetryHandlingMetaMasterClient(MasterClientContext conf) Creates a new meta 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.
BackupStatus	backup(BackupPRequest backupRequest) Takes a backup.
String	checkpoint() Creates a checkpoint in the primary master journal system.
BackupStatus	getBackupStatus(UUID backupId) Queries the status of a backup.
ConfigCheckReport	getConfigReport() Gets the server-side configuration check report.
MasterInfo	getMasterInfo(Set<MasterInfoField> fields)
protected ServiceType	getRemoteServiceType()
protected String	getServiceName()
protected long	getServiceVersion()
List<ProxyStatus>	listProxyStatus() Lists information of all known proxy instances from the primary master.

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

RetryHandlingMetaMasterClient

public RetryHandlingMetaMasterClient(MasterClientContext conf)

Creates a new meta master client.

Parameters:

conf - master client configuration

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

backup

public BackupStatus backup(BackupPRequest backupRequest)
                    throws IOException

Description copied from interface: MetaMasterClient

Takes a backup. Note: If backup request ask for async execution, it will return after initiating the backup. Status for the in-progress backup will be returned. MetaMasterClient.getBackupStatus(java.util.UUID) should be called for querying the status of the on-going backup. Note: When leader has no standby in an HA cluster, it will reject backup. This could be allowed by passing "AllowLeader" option in the request.

Specified by:

backup in interface MetaMasterClient

Parameters:

backupRequest - the backup request

Returns:

status of backup

Throws:

IOException

getBackupStatus

public BackupStatus getBackupStatus(UUID backupId)
                             throws IOException

Description copied from interface: MetaMasterClient

Queries the status of a backup.

Specified by:

getBackupStatus in interface MetaMasterClient

Parameters:

backupId - backup id

Returns:

the status of the latest backup

Throws:

IOException

getConfigReport

public ConfigCheckReport getConfigReport()
                                  throws IOException

Description copied from interface: MetaMasterClient

Gets the server-side configuration check report.

Specified by:

getConfigReport in interface MetaMasterClient

Returns:

configuration check report

Throws:

IOException

getMasterInfo

public MasterInfo getMasterInfo(Set<MasterInfoField> fields)
                         throws IOException

Specified by:

getMasterInfo in interface MetaMasterClient

Parameters:

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

Returns:

the requested master info

Throws:

IOException

checkpoint

public String checkpoint()
                  throws IOException

Description copied from interface: MetaMasterClient

Creates a checkpoint in the primary master journal system.

Specified by:

checkpoint in interface MetaMasterClient

Returns:

the hostname of the master that did the checkpoint

Throws:

IOException

listProxyStatus

public List<ProxyStatus> listProxyStatus()
                                  throws IOException

Description copied from interface: MetaMasterClient

Lists information of all known proxy instances from the primary master.

Specified by:

listProxyStatus in interface MetaMasterClient

Returns:

the list of proxy status

Throws:

IOException