org.apache.hadoop.hbase.ipc

Class ServerRpcConnection

java.lang.Object

org.apache.hadoop.hbase.ipc.ServerRpcConnection

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

NettyServerRpcConnection, SimpleServerRpcConnection

@InterfaceAudience.Private
abstract class ServerRpcConnection
extends Object
implements Closeable

Reads calls from a connection and queues them for handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ServerRpcConnection.ByteBuffByteInput

Field Summary

Fields

Modifier and Type	Field and Description
protected InetAddress	addr
protected boolean	authenticatedWithFallback
protected RpcServer.CallCleanup	callCleanup
protected Codec	codec Codec the client asked use.
protected org.apache.hadoop.io.compress.CompressionCodec	compressionCodec Compression codec the client asked us use.
protected Map<String,byte[]>	connectionAttributes
protected org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader	connectionHeader
protected boolean	connectionHeaderRead
private static io.opentelemetry.context.propagation.TextMapGetter<org.apache.hadoop.hbase.shaded.protobuf.generated.TracingProtos.RPCTInfo>	getter
protected String	hostAddress
protected SaslServerAuthenticationProvider	provider
protected int	remotePort
protected boolean	retryImmediatelySupported
protected RpcServer	rpcServer
protected SaslServerAuthenticationProviders	saslProviders
protected HBaseSaslRpcServer	saslServer
protected org.apache.hbase.thirdparty.com.google.protobuf.BlockingService	service
protected boolean	skipInitialSaslHandshake
protected org.apache.hadoop.security.UserGroupInformation	ugi
protected User	user
protected boolean	useSasl

Constructor Summary

Constructors

Constructor and Description
ServerRpcConnection(RpcServer rpcServer)

Method Summary

Modifier and Type	Method and Description
private boolean	authorizeConnection()
protected void	callCleanupIfNeeded()
abstract ServerCall<?>	createCall(int id, org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service, org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md, org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader header, org.apache.hbase.thirdparty.com.google.protobuf.Message param, CellScanner cellScanner, long size, InetAddress remoteAddress, int timeout, RpcServer.CallCleanup reqCleanup)
private org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream	createCis(ByteBuff buf)
private org.apache.hadoop.security.UserGroupInformation	createUser(org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader head)
protected void	disposeSasl()
private void	doBadPreambleHandling(String msg)
private void	doBadPreambleHandling(String msg, Exception e)
protected void	doRawSaslReply(SaslStatus status, org.apache.hadoop.io.Writable rv, String errorClass, String error) No protobuf encoding of raw sasl messages
protected abstract void	doRespond(RpcResponse resp)
(package private) void	finishSaslNegotiation()
private org.apache.hbase.thirdparty.com.google.protobuf.ByteString	getByteString(byte[] bytes)
protected RpcResponse	getErrorResponse(String msg, Exception e)
private String	getFatalConnectionString(int version, byte authByte)
String	getHostAddress()
InetAddress	getHostInetAddress()
(package private) HBaseSaslRpcServer	getOrCreateSaslServer()
int	getRemotePort()
org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo	getVersionInfo()
abstract boolean	isConnectionOpen()
(package private) boolean	isSimpleAuthentication()
private void	processConnectionHeader(ByteBuff buf)
void	processOneRpc(ByteBuff buf)
protected boolean	processPreamble(ByteBuffer preambleBuffer)
protected void	processRequest(ByteBuff buf) Has the request header and the request param and optionally encoded data buffer all in this one array.
private void	sendConnectionHeaderResponseIfNeeded() Send the response for connection header
private void	sendErrorResponseForCall(int id, long totalRequestSize, io.opentelemetry.api.trace.Span span, String msg, Throwable responseThrowable)
private void	setupCellBlockCodecs() Set up cell block codecs
private Pair<org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeaderResponse,CryptoAES>	setupCryptoCipher() Set up cipher for rpc encryption with Apache Commons Crypto.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Field Detail

getter

private static final io.opentelemetry.context.propagation.TextMapGetter<org.apache.hadoop.hbase.shaded.protobuf.generated.TracingProtos.RPCTInfo> getter

rpcServer

protected final RpcServer rpcServer

connectionHeaderRead

protected boolean connectionHeaderRead

callCleanup

protected RpcServer.CallCleanup callCleanup

hostAddress

protected String hostAddress

remotePort

protected int remotePort

addr

protected InetAddress addr

connectionHeader

protected org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader connectionHeader

connectionAttributes

protected Map<String,byte[]> connectionAttributes

codec

protected Codec codec

Codec the client asked use.

compressionCodec

protected org.apache.hadoop.io.compress.CompressionCodec compressionCodec

Compression codec the client asked us use.

service

protected org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service

provider

protected SaslServerAuthenticationProvider provider

skipInitialSaslHandshake

protected boolean skipInitialSaslHandshake

useSasl

protected boolean useSasl

saslServer

protected HBaseSaslRpcServer saslServer

authenticatedWithFallback

protected boolean authenticatedWithFallback

retryImmediatelySupported

protected boolean retryImmediatelySupported

user

protected User user

ugi

protected org.apache.hadoop.security.UserGroupInformation ugi

saslProviders

protected SaslServerAuthenticationProviders saslProviders

Constructor Detail

ServerRpcConnection

public ServerRpcConnection(RpcServer rpcServer)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getHostAddress

public String getHostAddress()

getHostInetAddress

public InetAddress getHostInetAddress()

getRemotePort

public int getRemotePort()

getVersionInfo

public org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo getVersionInfo()

getFatalConnectionString

private String getFatalConnectionString(int version,
                                        byte authByte)

setupCellBlockCodecs

private void setupCellBlockCodecs()
                           throws FatalConnectionException

Set up cell block codecs

Throws:

FatalConnectionException

setupCryptoCipher

private Pair<org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeaderResponse,CryptoAES> setupCryptoCipher()
                                                                                                                        throws FatalConnectionException

Set up cipher for rpc encryption with Apache Commons Crypto.

Throws:

FatalConnectionException

getByteString

private org.apache.hbase.thirdparty.com.google.protobuf.ByteString getByteString(byte[] bytes)

createUser

private org.apache.hadoop.security.UserGroupInformation createUser(org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader head)

disposeSasl

protected final void disposeSasl()

doRawSaslReply

protected final void doRawSaslReply(SaslStatus status,
                                    org.apache.hadoop.io.Writable rv,
                                    String errorClass,
                                    String error)
                             throws IOException

No protobuf encoding of raw sasl messages

Throws:

IOException

getOrCreateSaslServer

HBaseSaslRpcServer getOrCreateSaslServer()
                                  throws IOException

Throws:

IOException

finishSaslNegotiation

void finishSaslNegotiation()
                    throws IOException

Throws:

IOException

processOneRpc

public void processOneRpc(ByteBuff buf)
                   throws IOException,
                          InterruptedException

Throws:

IOException

InterruptedException

authorizeConnection

private boolean authorizeConnection()
                             throws IOException

Throws:

IOException

createCis

private org.apache.hbase.thirdparty.com.google.protobuf.CodedInputStream createCis(ByteBuff buf)

processConnectionHeader

private void processConnectionHeader(ByteBuff buf)
                              throws IOException

Throws:

IOException

sendConnectionHeaderResponseIfNeeded

private void sendConnectionHeaderResponseIfNeeded()
                                           throws FatalConnectionException

Send the response for connection header

Throws:

FatalConnectionException

doRespond

protected abstract void doRespond(RpcResponse resp)
                           throws IOException

Throws:

IOException

processRequest

protected void processRequest(ByteBuff buf)
                       throws IOException,
                              InterruptedException

Has the request header and the request param and optionally encoded data buffer all in this one array.

Will be overridden in tests.

Throws:

IOException

InterruptedException

sendErrorResponseForCall

private void sendErrorResponseForCall(int id,
                                      long totalRequestSize,
                                      io.opentelemetry.api.trace.Span span,
                                      String msg,
                                      Throwable responseThrowable)
                               throws IOException

Throws:

IOException

getErrorResponse

protected final RpcResponse getErrorResponse(String msg,
                                             Exception e)
                                      throws IOException

Throws:

IOException

doBadPreambleHandling

private void doBadPreambleHandling(String msg)
                            throws IOException

Throws:

IOException

doBadPreambleHandling

private void doBadPreambleHandling(String msg,
                                   Exception e)
                            throws IOException

Throws:

IOException

callCleanupIfNeeded

protected final void callCleanupIfNeeded()

processPreamble

protected final boolean processPreamble(ByteBuffer preambleBuffer)
                                 throws IOException

Throws:

IOException

isSimpleAuthentication

boolean isSimpleAuthentication()

isConnectionOpen

public abstract boolean isConnectionOpen()

createCall

public abstract ServerCall<?> createCall(int id,
                                         org.apache.hbase.thirdparty.com.google.protobuf.BlockingService service,
                                         org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md,
                                         org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader header,
                                         org.apache.hbase.thirdparty.com.google.protobuf.Message param,
                                         CellScanner cellScanner,
                                         long size,
                                         InetAddress remoteAddress,
                                         int timeout,
                                         RpcServer.CallCleanup reqCleanup)