Package org.apache.hadoop.ipc

Class ProtobufRpcEngine2.Invoker

java.lang.Object

org.apache.hadoop.ipc.ProtobufRpcEngine2.Invoker

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.reflect.InvocationHandler, RpcInvocationHandler

Enclosing class:

ProtobufRpcEngine2

protected static class ProtobufRpcEngine2.Invoker
extends java.lang.Object
implements RpcInvocationHandler

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Invoker(java.lang.Class<?> protocol, java.net.InetSocketAddress addr, UserGroupInformation ticket, Configuration conf, javax.net.SocketFactory factory, int rpcTimeout, RetryPolicy connectionRetryPolicy, java.util.concurrent.atomic.AtomicBoolean fallbackToSimpleAuth, AlignmentContext alignmentContext)
protected	Invoker(java.lang.Class<?> protocol, Client.ConnectionId connId, Configuration conf, javax.net.SocketFactory factory, AlignmentContext alignmentContext)	This constructor takes a connectionId, instead of creating a new one.

Method Summary

Modifier and Type	Method	Description
void	close()
protected Writable	constructRpcRequest(java.lang.reflect.Method method, org.apache.hadoop.thirdparty.protobuf.Message theRequest)
protected long	getClientProtocolVersion()
Client.ConnectionId	getConnectionId()	Returns the connection id associated with the InvocationHandler instance.
protected java.lang.String	getProtocolName()
org.apache.hadoop.thirdparty.protobuf.Message	invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)	This is the client side invoker of RPC method.

Methods inherited from class java.lang.Object

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

Constructor Detail

Invoker

protected Invoker(java.lang.Class<?> protocol,
                  java.net.InetSocketAddress addr,
                  UserGroupInformation ticket,
                  Configuration conf,
                  javax.net.SocketFactory factory,
                  int rpcTimeout,
                  RetryPolicy connectionRetryPolicy,
                  java.util.concurrent.atomic.AtomicBoolean fallbackToSimpleAuth,
                  AlignmentContext alignmentContext)
           throws java.io.IOException

Throws:

java.io.IOException

Invoker

protected Invoker(java.lang.Class<?> protocol,
                  Client.ConnectionId connId,
                  Configuration conf,
                  javax.net.SocketFactory factory,
                  AlignmentContext alignmentContext)

This constructor takes a connectionId, instead of creating a new one.

Parameters:

protocol - input protocol.

connId - input connId.

conf - input Configuration.

factory - input factory.

alignmentContext - Alignment context

Method Detail

invoke

public org.apache.hadoop.thirdparty.protobuf.Message invoke(java.lang.Object proxy,
                                                            java.lang.reflect.Method method,
                                                            java.lang.Object[] args)
                                                     throws org.apache.hadoop.thirdparty.protobuf.ServiceException

This is the client side invoker of RPC method. It only throws ServiceException, since the invocation proxy expects only ServiceException to be thrown by the method in case protobuf service. ServiceException has the following causes:

1. Exceptions encountered on the client side in this method are set as cause in ServiceException as is.
2. Exceptions from the server are wrapped in RemoteException and are set as cause in ServiceException

Note that the client calling protobuf RPC methods, must handle ServiceException by getting the cause from the ServiceException. If the cause is RemoteException, then unwrap it to get the exception thrown by the server.

Specified by:

invoke in interface java.lang.reflect.InvocationHandler

Throws:

org.apache.hadoop.thirdparty.protobuf.ServiceException

constructRpcRequest

protected Writable constructRpcRequest(java.lang.reflect.Method method,
                                       org.apache.hadoop.thirdparty.protobuf.Message theRequest)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

getConnectionId

public Client.ConnectionId getConnectionId()

Description copied from interface: RpcInvocationHandler

Returns the connection id associated with the InvocationHandler instance.

Specified by:

getConnectionId in interface RpcInvocationHandler

Returns:

ConnectionId

getClientProtocolVersion

protected long getClientProtocolVersion()

getProtocolName

protected java.lang.String getProtocolName()