alluxio

Class RpcUtils

java.lang.Object

alluxio.RpcUtils

public final class RpcUtils
extends Object

Utilities for handling server RPC calls. There are three types of RPC calls: 1. RPCs that only throw AlluxioException 2. RPCs that throw AlluxioException and IOException 3. Netty RPCs For each of these, there are two types of methods 1. call(callable) - for internal methods, executes the method without any logging or metrics 2. call(logger, callable, method name, failureOk, method description, arguments...) - for client initiated methods, executes the method with logging and metrics. If failureOk is set, non-fatal errors will only be logged at the DEBUG level and failure metrics will not be recorded.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RpcUtils.NettyRpcCallable<T> An interface representing a netty RPC callable.
static interface	RpcUtils.RpcCallable<T> An interface representing a callable which can only throw Alluxio exceptions.
static interface	RpcUtils.RpcCallableThrowsIOException<T> An interface representing a callable which can only throw Alluxio or IO exceptions.

Method Summary

Modifier and Type	Method and Description
static <T> T	call(org.slf4j.Logger logger, RpcUtils.RpcCallable<T> callable, String methodName, boolean failureOk, String description, Object... args) Calls the given RpcUtils.RpcCallable and handles any exceptions thrown.
static <T> T	call(org.slf4j.Logger logger, RpcUtils.RpcCallable<T> callable, String methodName, String description, Object... args) Calls the given RpcUtils.RpcCallable and handles any exceptions thrown.
static <T> T	call(org.slf4j.Logger logger, RpcUtils.RpcCallableThrowsIOException<T> callable, String methodName, boolean failureOk, String description, Object... args) Calls the given RpcUtils.RpcCallableThrowsIOException and handles any exceptions thrown.
static <T> T	call(org.slf4j.Logger logger, RpcUtils.RpcCallableThrowsIOException<T> callable, String methodName, String description, Object... args) Calls the given RpcUtils.RpcCallableThrowsIOException and handles any exceptions thrown.
static <T> T	call(RpcUtils.RpcCallable<T> callable) Calls the given RpcUtils.RpcCallable and handles any exceptions thrown.
static <T> T	call(RpcUtils.RpcCallableThrowsIOException<T> callable) Calls the given RpcUtils.RpcCallableThrowsIOException and handles any exceptions thrown.
static <T> T	nettyRPCAndLog(org.slf4j.Logger logger, RpcUtils.NettyRpcCallable<T> callable, String methodName, String description, Object... args) Handles a netty RPC callable with logging.

Methods inherited from class java.lang.Object

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

Method Detail

call

public static <T> T call(RpcUtils.RpcCallable<T> callable)
                  throws AlluxioTException

Calls the given RpcUtils.RpcCallable and handles any exceptions thrown. No call history or errors will be logged. This method should be used for internal RPCs.

Type Parameters:

T - the return type of the callable

Parameters:

callable - the callable to call

Returns:

the return value from calling the callable

Throws:

AlluxioTException - if the callable throws an exception

call

public static <T> T call(org.slf4j.Logger logger,
                         RpcUtils.RpcCallable<T> callable,
                         String methodName,
                         String description,
                         Object... args)
                  throws AlluxioTException

Calls the given RpcUtils.RpcCallable and handles any exceptions thrown. If the RPC fails, a warning or error will be logged.

Type Parameters:

T - the return type of the callable

Parameters:

logger - the logger to use for this call

callable - the callable to call

methodName - the name of the method, used for metrics

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

args - the arguments for the description

Returns:

the return value from calling the callable

Throws:

AlluxioTException - if the callable throws an exception

call

public static <T> T call(org.slf4j.Logger logger,
                         RpcUtils.RpcCallable<T> callable,
                         String methodName,
                         boolean failureOk,
                         String description,
                         Object... args)
                  throws AlluxioTException

Calls the given RpcUtils.RpcCallable and handles any exceptions thrown. The failureOk parameter indicates whether or not AlluxioExceptions are expected results (for example it would be false for the exists() call). In this case, we do not log the failure or increment failure metrics. When a RuntimeException is thrown, we always treat it as a failure and log an error and increment metrics.

Type Parameters:

T - the return type of the callable

Parameters:

logger - the logger to use for this call

callable - the callable to call

methodName - the name of the method, used for metrics

failureOk - whether failures are expected (affects logging and metrics)

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

args - the arguments for the description

Returns:

the return value from calling the callable

Throws:

AlluxioTException - if the callable throws an exception

call

public static <T> T call(RpcUtils.RpcCallableThrowsIOException<T> callable)
                  throws AlluxioTException

Calls the given RpcUtils.RpcCallableThrowsIOException and handles any exceptions thrown. No call history or errors will be logged. This method should be used for internal RPCs.

Type Parameters:

T - the return type of the callable

Parameters:

callable - the callable to call

Returns:

the return value from calling the callable

Throws:

AlluxioTException - if the callable throws an exception

call

public static <T> T call(org.slf4j.Logger logger,
                         RpcUtils.RpcCallableThrowsIOException<T> callable,
                         String methodName,
                         String description,
                         Object... args)
                  throws AlluxioTException

Calls the given RpcUtils.RpcCallableThrowsIOException and handles any exceptions thrown. If the RPC fails, a warning or error will be logged.

Type Parameters:

T - the return type of the callable

Parameters:

logger - the logger to use for this call

callable - the callable to call

methodName - the name of the method, used for metrics

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

args - the arguments for the description

Returns:

the return value from calling the callable

Throws:

AlluxioTException - if the callable throws an exception

call

public static <T> T call(org.slf4j.Logger logger,
                         RpcUtils.RpcCallableThrowsIOException<T> callable,
                         String methodName,
                         boolean failureOk,
                         String description,
                         Object... args)
                  throws AlluxioTException

Calls the given RpcUtils.RpcCallableThrowsIOException and handles any exceptions thrown. The failureOk parameter indicates whether or not AlluxioExceptions and IOExceptions are expected results (for example it would be false for the exists() call). In this case, we do not log the failure or increment failure metrics. When a RuntimeException is thrown, we always treat it as a failure and log an error and increment metrics.

Type Parameters:

T - the return type of the callable

Parameters:

logger - the logger to use for this call

callable - the callable to call

methodName - the name of the method, used for metrics

failureOk - whether failures are expected (affects logging and metrics)

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

args - the arguments for the description

Returns:

the return value from calling the callable

Throws:

AlluxioTException - if the callable throws an exception

nettyRPCAndLog

public static <T> T nettyRPCAndLog(org.slf4j.Logger logger,
                                   RpcUtils.NettyRpcCallable<T> callable,
                                   String methodName,
                                   String description,
                                   Object... args)

Handles a netty RPC callable with logging.

Type Parameters:

T - the return type of the callable

Parameters:

logger - the logger to use for this call

callable - the callable to call

methodName - the name of the method, used for metrics

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

args - the arguments for the description

Returns:

the rpc result