ConnectionConfiguration (Apache HBase

java.lang.Object
- org.apache.hadoop.hbase.client.ConnectionConfiguration

```
@InterfaceAudience.Private
public class ConnectionConfiguration
extends Object
```
Configuration parameters for the connection. Configuration is a heavy weight registry that does a lot of string operations and regex matching. Method calls into Configuration account for high CPU usage and have huge performance impact. This class caches connection-related configuration values in the ConnectionConfiguration object so that expensive conf.getXXX() calls are avoided every time HTable, etc is instantiated. see HBASE-12128

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY`
`static String`	`HBASE_CLIENT_META_SCANNER_TIMEOUT`
`static String`	`HBASE_CLIENT_PAUSE_FOR_SERVER_OVERLOADED` Parameter name for client pause when server is overloaded, denoted by an exception where `HBaseServerException.isServerOverloaded(Throwable)` is true.
`static String`	`HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS`
`static boolean`	`HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS_DEFAULT`
`static int`	`MAX_KEYVALUE_SIZE_DEFAULT`
`static String`	`MAX_KEYVALUE_SIZE_KEY`
`static String`	`PRIMARY_CALL_TIMEOUT_MICROSECOND`
`static int`	`PRIMARY_CALL_TIMEOUT_MICROSECOND_DEFAULT`
`static String`	`PRIMARY_SCAN_TIMEOUT_MICROSECOND`
`static int`	`PRIMARY_SCAN_TIMEOUT_MICROSECOND_DEFAULT`
`static String`	`WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS`
`static long`	`WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS_DEFAULT`
`static String`	`WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS`
`static long`	`WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS_DEFAULT`
`static long`	`WRITE_BUFFER_SIZE_DEFAULT`
`static String`	`WRITE_BUFFER_SIZE_KEY`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ConnectionConfiguration()
Constructor This is for internal testing purpose (using the default value).

Constructors
Modifier	Constructor and Description
`protected`	`ConnectionConfiguration()` Constructor This is for internal testing purpose (using the default value).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getMaxKeyValueSize()`
`int`	`getMetaOperationTimeout()`
`int`	`getMetaReadRpcTimeout()`
`int`	`getMetaReplicaCallTimeoutMicroSecondScan()`
`int`	`getMetaScanTimeout()`
`int`	`getOperationTimeout()`
`long`	`getPauseMillis()`
`long`	`getPauseMillisForServerOverloaded()`
`int`	`getPrimaryCallTimeoutMicroSecond()`
`int`	`getReadRpcTimeout()`
`int`	`getReplicaCallTimeoutMicroSecondScan()`
`int`	`getRetriesNumber()`
`int`	`getRpcTimeout()`
`int`	`getScannerCaching()`
`long`	`getScannerMaxResultSize()`
`int`	`getScanTimeout()`
`long`	`getWriteBufferPeriodicFlushTimeoutMs()`
`long`	`getWriteBufferPeriodicFlushTimerTickMs()`
`long`	`getWriteBufferSize()`
`int`	`getWriteRpcTimeout()`
`boolean`	`isClientScannerAsyncPrefetch()`
`boolean`	`isUseScannerTimeoutForNextCalls()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WRITE_BUFFER_SIZE_KEY
```
public static final String WRITE_BUFFER_SIZE_KEY
```
    See Also:
    
    Constant Field Values
  - WRITE_BUFFER_SIZE_DEFAULT
```
public static final long WRITE_BUFFER_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS
```
public static final String WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS
```
public static final String WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS
```
    See Also:
    
    Constant Field Values
  - WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS_DEFAULT
```
public static final long WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS_DEFAULT
```
public static final long WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - MAX_KEYVALUE_SIZE_KEY
```
public static final String MAX_KEYVALUE_SIZE_KEY
```
    See Also:
    
    Constant Field Values
  - MAX_KEYVALUE_SIZE_DEFAULT
```
public static final int MAX_KEYVALUE_SIZE_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PRIMARY_CALL_TIMEOUT_MICROSECOND
```
public static final String PRIMARY_CALL_TIMEOUT_MICROSECOND
```
    See Also:
    
    Constant Field Values
  - PRIMARY_CALL_TIMEOUT_MICROSECOND_DEFAULT
```
public static final int PRIMARY_CALL_TIMEOUT_MICROSECOND_DEFAULT
```
    See Also:
    
    Constant Field Values
  - PRIMARY_SCAN_TIMEOUT_MICROSECOND
```
public static final String PRIMARY_SCAN_TIMEOUT_MICROSECOND
```
    See Also:
    
    Constant Field Values
  - PRIMARY_SCAN_TIMEOUT_MICROSECOND_DEFAULT
```
public static final int PRIMARY_SCAN_TIMEOUT_MICROSECOND_DEFAULT
```
    See Also:
    
    Constant Field Values
  - HBASE_CLIENT_PAUSE_FOR_SERVER_OVERLOADED
```
public static final String HBASE_CLIENT_PAUSE_FOR_SERVER_OVERLOADED
```
    Parameter name for client pause when server is overloaded, denoted by an exception where HBaseServerException.isServerOverloaded(Throwable) is true.
    
    See Also:
    
    Constant Field Values
  - HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY
```
public static final String HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY
```
    See Also:
    
    Constant Field Values
  - HBASE_CLIENT_META_SCANNER_TIMEOUT
```
public static final String HBASE_CLIENT_META_SCANNER_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS
```
public static final String HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS
```
    See Also:
    
    Constant Field Values
  - HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS_DEFAULT
```
public static final boolean HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS_DEFAULT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConnectionConfiguration
```
protected ConnectionConfiguration()
```
    Constructor This is for internal testing purpose (using the default value). In real usage, we should read the configuration from the Configuration object.
- Method Detail
  - getReadRpcTimeout
```
public int getReadRpcTimeout()
```
  - getMetaReadRpcTimeout
```
public int getMetaReadRpcTimeout()
```
  - getWriteRpcTimeout
```
public int getWriteRpcTimeout()
```
  - getWriteBufferSize
```
public long getWriteBufferSize()
```
  - getWriteBufferPeriodicFlushTimeoutMs
```
public long getWriteBufferPeriodicFlushTimeoutMs()
```
  - getWriteBufferPeriodicFlushTimerTickMs
```
public long getWriteBufferPeriodicFlushTimerTickMs()
```
  - getMetaOperationTimeout
```
public int getMetaOperationTimeout()
```
  - getOperationTimeout
```
public int getOperationTimeout()
```
  - getScannerCaching
```
public int getScannerCaching()
```
  - getPrimaryCallTimeoutMicroSecond
```
public int getPrimaryCallTimeoutMicroSecond()
```
  - getReplicaCallTimeoutMicroSecondScan
```
public int getReplicaCallTimeoutMicroSecondScan()
```
  - getMetaReplicaCallTimeoutMicroSecondScan
```
public int getMetaReplicaCallTimeoutMicroSecondScan()
```
  - getRetriesNumber
```
public int getRetriesNumber()
```
  - getMaxKeyValueSize
```
public int getMaxKeyValueSize()
```
  - getScannerMaxResultSize
```
public long getScannerMaxResultSize()
```
  - isClientScannerAsyncPrefetch
```
public boolean isClientScannerAsyncPrefetch()
```
  - getRpcTimeout
```
public int getRpcTimeout()
```
  - getScanTimeout
```
public int getScanTimeout()
```
  - isUseScannerTimeoutForNextCalls
```
public boolean isUseScannerTimeoutForNextCalls()
```
  - getMetaScanTimeout
```
public int getMetaScanTimeout()
```
  - getPauseMillis
```
public long getPauseMillis()
```
  - getPauseMillisForServerOverloaded
```
public long getPauseMillisForServerOverloaded()
```

Class ConnectionConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WRITE_BUFFER_SIZE_KEY

WRITE_BUFFER_SIZE_DEFAULT

WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS

WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS

WRITE_BUFFER_PERIODIC_FLUSH_TIMEOUT_MS_DEFAULT

WRITE_BUFFER_PERIODIC_FLUSH_TIMERTICK_MS_DEFAULT

MAX_KEYVALUE_SIZE_KEY

MAX_KEYVALUE_SIZE_DEFAULT

PRIMARY_CALL_TIMEOUT_MICROSECOND

PRIMARY_CALL_TIMEOUT_MICROSECOND_DEFAULT

PRIMARY_SCAN_TIMEOUT_MICROSECOND

PRIMARY_SCAN_TIMEOUT_MICROSECOND_DEFAULT

HBASE_CLIENT_PAUSE_FOR_SERVER_OVERLOADED

HBASE_CLIENT_META_READ_RPC_TIMEOUT_KEY

HBASE_CLIENT_META_SCANNER_TIMEOUT

HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS

HBASE_CLIENT_USE_SCANNER_TIMEOUT_PERIOD_FOR_NEXT_CALLS_DEFAULT

Constructor Detail

ConnectionConfiguration

Method Detail

getReadRpcTimeout

getMetaReadRpcTimeout

getWriteRpcTimeout

getWriteBufferSize

getWriteBufferPeriodicFlushTimeoutMs

getWriteBufferPeriodicFlushTimerTickMs

getMetaOperationTimeout

getOperationTimeout

getScannerCaching

getPrimaryCallTimeoutMicroSecond

getReplicaCallTimeoutMicroSecondScan

getMetaReplicaCallTimeoutMicroSecondScan

getRetriesNumber

getMaxKeyValueSize

getScannerMaxResultSize

isClientScannerAsyncPrefetch

getRpcTimeout

getScanTimeout

isUseScannerTimeoutForNextCalls

getMetaScanTimeout

getPauseMillis

getPauseMillisForServerOverloaded