alluxio

Class AbstractClient

java.lang.Object

alluxio.AbstractClient

All Implemented Interfaces:

Client, Closeable, AutoCloseable

Direct Known Subclasses:

AbstractMasterClient

@ThreadSafe
public abstract class AbstractClient
extends Object
implements Client

The base class for clients.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractClient.RpcCallable<V> The RPC to be executed in retryRPC(alluxio.AbstractClient.RpcCallable<V>, org.slf4j.Logger, java.lang.String, java.lang.String, java.lang.Object...).

Field Summary

Fields

Modifier and Type	Field and Description
protected InetSocketAddress	mAddress
protected GrpcChannel	mChannel Underlying channel to the target service.
protected boolean	mClosed Is true if this client was closed by the user.
protected InetSocketAddress	mConfAddress Address to load configuration, which may differ from mAddress.
protected boolean	mConnected Is true if this client is currently connected.
protected ClientContext	mContext
protected long	mServiceVersion Stores the service version; used for detecting incompatible client-server pairs.
protected ServiceVersionClientServiceGrpc.ServiceVersionClientServiceBlockingStub	mVersionService

Constructor Summary

Constructors

Constructor and Description
AbstractClient(ClientContext context, InetSocketAddress address) Creates a new client base.
AbstractClient(ClientContext context, InetSocketAddress address, java.util.function.Supplier<RetryPolicy> retryPolicySupplier) Creates a new client base.

Method Summary

Modifier and Type	Method and Description
protected void	afterConnect() This method is called after the connection is made to the remote.
protected void	afterDisconnect() This method is called after the connection is disconnected.
protected void	beforeConnect() This method is called before the connection is connected.
protected void	beforeDisconnect() This method is called before the connection is disconnected.
protected void	checkVersion(long clientVersion) Checks that the service version is compatible with the client.
void	close() Closes the connection with the remote permanently.
void	connect() Connects with the remote.
void	disconnect() Closes the connection with the Alluxio remote and does the necessary cleanup.
InetSocketAddress	getAddress()
InetSocketAddress	getConfAddress()
protected abstract ServiceType	getRemoteServiceType()
protected long	getRemoteServiceVersion()
protected abstract String	getServiceName()
protected abstract long	getServiceVersion()
boolean	isClosed()
boolean	isConnected() Returns the connected status of the client.
protected <V> V	retryRPC(AbstractClient.RpcCallable<V> rpc, org.slf4j.Logger logger, String rpcName, String description, Object... args) Tries to execute an RPC defined as a AbstractClient.RpcCallable.
protected <V> V	retryRPC(RetryPolicy retryPolicy, AbstractClient.RpcCallable<V> rpc, org.slf4j.Logger logger, String rpcName, String description, Object... args)

Methods inherited from class java.lang.Object

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

Field Detail

mAddress

protected InetSocketAddress mAddress

mConfAddress

protected InetSocketAddress mConfAddress

Address to load configuration, which may differ from mAddress.

mChannel

protected GrpcChannel mChannel

Underlying channel to the target service.

mVersionService

protected ServiceVersionClientServiceGrpc.ServiceVersionClientServiceBlockingStub mVersionService

mConnected

protected boolean mConnected

Is true if this client is currently connected.

mClosed

protected volatile boolean mClosed

Is true if this client was closed by the user. No further actions are possible after the client is closed.

mServiceVersion

protected long mServiceVersion

Stores the service version; used for detecting incompatible client-server pairs.

mContext

protected ClientContext mContext

Constructor Detail

AbstractClient

public AbstractClient(ClientContext context,
                      InetSocketAddress address)

Creates a new client base.

Parameters:

context - information required to connect to Alluxio

address - the address

AbstractClient

public AbstractClient(ClientContext context,
                      InetSocketAddress address,
                      java.util.function.Supplier<RetryPolicy> retryPolicySupplier)

Creates a new client base.

Parameters:

context - information required to connect to Alluxio

address - the address

retryPolicySupplier - factory for retry policies to be used when performing RPCs

Method Detail

getRemoteServiceType

protected abstract ServiceType getRemoteServiceType()

Returns:

the type of remote service

getRemoteServiceVersion

protected long getRemoteServiceVersion()
                                throws AlluxioStatusException

Throws:

AlluxioStatusException

getServiceName

protected abstract String getServiceName()

Returns:

a string representing the specific service

getServiceVersion

protected abstract long getServiceVersion()

Returns:

the client service version

checkVersion

protected void checkVersion(long clientVersion)
                     throws IOException

Checks that the service version is compatible with the client.

Parameters:

clientVersion - the client version

Throws:

IOException

afterConnect

protected void afterConnect()
                     throws IOException

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

Throws:

IOException

beforeConnect

protected void beforeConnect()
                      throws IOException

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

Throws:

IOException

afterDisconnect

protected void afterDisconnect()

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

beforeDisconnect

protected void beforeDisconnect()

This method is called before the connection is disconnected. Implementations should add any additional operations before the connection is disconnected.

connect

public void connect()
             throws AlluxioStatusException

Connects with the remote.

Specified by:

connect in interface Client

Throws:

AlluxioStatusException

disconnect

public void disconnect()

Closes the connection with the Alluxio remote and does the necessary cleanup. It should be used if the client has not connected with the remote for a while, for example.

Specified by:

disconnect in interface Client

isConnected

public boolean isConnected()

Description copied from interface: Client

Returns the connected status of the client.

Specified by:

isConnected in interface Client

Returns:

true if this client is connected to the remote

close

public void close()

Closes the connection with the remote permanently. This instance should be not be reused after closing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getAddress

public InetSocketAddress getAddress()
                             throws UnavailableException

Specified by:

getAddress in interface Client

Returns:

the InetSocketAddress of the remote

Throws:

UnavailableException - if the primary address cannot be determined

getConfAddress

public InetSocketAddress getConfAddress()
                                 throws UnavailableException

Specified by:

getConfAddress in interface Client

Returns:

the InetSocketAddress of the configuration remote

Throws:

UnavailableException - if the primary address cannot be determined

retryRPC

protected <V> V retryRPC(AbstractClient.RpcCallable<V> rpc,
                         org.slf4j.Logger logger,
                         String rpcName,
                         String description,
                         Object... args)
                  throws AlluxioStatusException

Tries to execute an RPC defined as a AbstractClient.RpcCallable. Metrics will be recorded based on the provided rpc name. If a UnavailableException occurs, a reconnection will be tried through connect() and the action will be re-executed.

Type Parameters:

V - type of return value of the RPC call

Parameters:

rpc - the RPC call to be executed

logger - the logger to use for this call

rpcName - the human readable name of the RPC call

description - the format string of the description, used for logging

args - the arguments for the description

Returns:

the return value of the RPC call

Throws:

AlluxioStatusException

retryRPC

protected <V> V retryRPC(RetryPolicy retryPolicy,
                         AbstractClient.RpcCallable<V> rpc,
                         org.slf4j.Logger logger,
                         String rpcName,
                         String description,
                         Object... args)
                  throws AlluxioStatusException

Throws:

AlluxioStatusException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Client

Returns:

whether the client is closed