org.apache.hadoop.hbase.client

Class ConnectionUtils

java.lang.Object

org.apache.hadoop.hbase.client.ConnectionUtils

@InterfaceAudience.Private
public class ConnectionUtils
extends Object

Utility used by client connections.

Constructor Summary

Constructors

Constructor and Description
ConnectionUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static long	addJitter(long pause, float jitter) Adds / subs a 10% jitter to a pause time.
static ClusterConnection	createShortCircuitConnection(org.apache.hadoop.conf.Configuration conf, ExecutorService pool, User user, ServerName serverName, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface admin, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface client) Creates a short-circuit connection that can bypass the RPC layer (serialization, deserialization, networking, etc..) when talking to a local server.
static ClusterConnection	createShortCircuitHConnection(Connection conn, ServerName serverName, org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface admin, org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface client) Deprecated.
static long	getPauseTime(long pause, int tries) Calculate pause time.
static NonceGenerator	injectNonceGeneratorForTesting(ClusterConnection conn, NonceGenerator cnm)
static void	setServerSideHConnectionRetriesConfig(org.apache.hadoop.conf.Configuration c, String sn, org.apache.commons.logging.Log log) Changes the configuration to set the number of retries needed when using HConnection internally, e.g.
static void	setupMasterlessConnection(org.apache.hadoop.conf.Configuration conf) Setup the connection class, so that it will not depend on master being online.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionUtils

public ConnectionUtils()

Method Detail

getPauseTime

public static long getPauseTime(long pause,
                int tries)

Calculate pause time. Built on HConstants.RETRY_BACKOFF.

Parameters:

pause -

tries -

Returns:

How long to wait after tries retries

addJitter

public static long addJitter(long pause,
             float jitter)

Adds / subs a 10% jitter to a pause time. Minimum is 1.

Parameters:

pause - the expected pause.

jitter - the jitter ratio, between 0 and 1, exclusive.

injectNonceGeneratorForTesting

public static NonceGenerator injectNonceGeneratorForTesting(ClusterConnection conn,
                                            NonceGenerator cnm)

Parameters:

conn - The connection for which to replace the generator.

cnm - Replaces the nonce generator used, for testing.

Returns:

old nonce generator.

setServerSideHConnectionRetriesConfig

public static void setServerSideHConnectionRetriesConfig(org.apache.hadoop.conf.Configuration c,
                                         String sn,
                                         org.apache.commons.logging.Log log)

Changes the configuration to set the number of retries needed when using HConnection internally, e.g. for updating catalog tables, etc. Call this method before we create any Connections.

Parameters:

c - The Configuration instance to set the retries into.

log - Used to log what we set in here.

createShortCircuitHConnection

@Deprecated
public static ClusterConnection createShortCircuitHConnection(Connection conn,
                                                         ServerName serverName,
                                                         org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface admin,
                                                         org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface client)

Deprecated.

Adapt a HConnection so that it can bypass the RPC layer (serialization, deserialization, networking, etc..) -- i.e. short-circuit -- when talking to a local server.

Parameters:

conn - the connection to adapt

serverName - the local server name

admin - the admin interface of the local server

client - the client interface of the local server

Returns:

an adapted/decorated HConnection

createShortCircuitConnection

public static ClusterConnection createShortCircuitConnection(org.apache.hadoop.conf.Configuration conf,
                                             ExecutorService pool,
                                             User user,
                                             ServerName serverName,
                                             org.apache.hadoop.hbase.protobuf.generated.AdminProtos.AdminService.BlockingInterface admin,
                                             org.apache.hadoop.hbase.protobuf.generated.ClientProtos.ClientService.BlockingInterface client)
                                                      throws IOException

Creates a short-circuit connection that can bypass the RPC layer (serialization, deserialization, networking, etc..) when talking to a local server.

Parameters:

conf - the current configuration

pool - the thread pool to use for batch operations

user - the user the connection is for

serverName - the local server name

admin - the admin interface of the local server

client - the client interface of the local server

Returns:

a short-circuit connection.

Throws:

IOException

setupMasterlessConnection

public static void setupMasterlessConnection(org.apache.hadoop.conf.Configuration conf)

Setup the connection class, so that it will not depend on master being online. Used for testing

Parameters:

conf - configuration to set