org.apache.hadoop.hbase.ipc

Class CoprocessorRpcUtils

java.lang.Object

org.apache.hadoop.hbase.ipc.CoprocessorRpcUtils

@InterfaceAudience.Private
public final class CoprocessorRpcUtils
extends Object

Utilities for handling coprocessor rpc service calls.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoprocessorRpcUtils.BlockingRpcCallback<R> Simple RpcCallback implementation providing a Future-like BlockingRpcCallback.get() method, which will block util the instance's BlockingRpcCallback.run(Object) method has been called.

Method Summary

Modifier and Type	Method and Description
static IOException	getControllerException(RpcController controller) Retreivies exception stored during RPC invocation.
static ClientProtos.CoprocessorServiceRequest	getCoprocessorServiceRequest(Descriptors.MethodDescriptor method, Message request)
static ClientProtos.CoprocessorServiceRequest	getCoprocessorServiceRequest(Descriptors.MethodDescriptor method, Message request, byte[] row, byte[] regionName)
static Descriptors.MethodDescriptor	getMethodDescriptor(String methodName, Descriptors.ServiceDescriptor serviceDesc)
static Message	getRequest(Service service, Descriptors.MethodDescriptor methodDesc, org.apache.hbase.thirdparty.com.google.protobuf.ByteString shadedRequest)
static Message	getResponse(ClientProtos.CoprocessorServiceResponse result, Message responsePrototype)
static ClientProtos.CoprocessorServiceResponse	getResponse(Message result, byte[] regionName)
static String	getServiceName(Descriptors.ServiceDescriptor service) Returns the name to use for coprocessor service calls.
static void	setControllerException(RpcController controller, IOException ioe) Stores an exception encountered during RPC invocation so it can be passed back through to the client.

Methods inherited from class java.lang.Object

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

Method Detail

getServiceName

public static String getServiceName(Descriptors.ServiceDescriptor service)

Returns the name to use for coprocessor service calls. For core HBase services (in the hbase.pb protobuf package), this returns the unqualified name in order to provide backward compatibility across the package name change. For all other services, the fully-qualified service name is used.

getCoprocessorServiceRequest

public static ClientProtos.CoprocessorServiceRequest getCoprocessorServiceRequest(Descriptors.MethodDescriptor method,
                                                                                  Message request)

getCoprocessorServiceRequest

public static ClientProtos.CoprocessorServiceRequest getCoprocessorServiceRequest(Descriptors.MethodDescriptor method,
                                                                                  Message request,
                                                                                  byte[] row,
                                                                                  byte[] regionName)

getMethodDescriptor

public static Descriptors.MethodDescriptor getMethodDescriptor(String methodName,
                                                               Descriptors.ServiceDescriptor serviceDesc)
                                                        throws UnknownProtocolException

Throws:

UnknownProtocolException

getRequest

public static Message getRequest(Service service,
                                 Descriptors.MethodDescriptor methodDesc,
                                 org.apache.hbase.thirdparty.com.google.protobuf.ByteString shadedRequest)
                          throws IOException

Throws:

IOException

getResponse

public static Message getResponse(ClientProtos.CoprocessorServiceResponse result,
                                  Message responsePrototype)
                           throws IOException

Throws:

IOException

getResponse

public static ClientProtos.CoprocessorServiceResponse getResponse(Message result,
                                                                  byte[] regionName)

setControllerException

public static void setControllerException(RpcController controller,
                                          IOException ioe)

Stores an exception encountered during RPC invocation so it can be passed back through to the client.

Parameters:

controller - the controller instance provided by the client when calling the service

ioe - the exception encountered

getControllerException

@Nullable
public static IOException getControllerException(RpcController controller)
                                                    throws IOException

Retreivies exception stored during RPC invocation.

Parameters:

controller - the controller instance provided by the client when calling the service

Returns:

exception if any, or null; Will return DoNotRetryIOException for string represented failure causes in controller.

Throws:

IOException