ConnectionConfiguration (Apache HBase 2.5.0 API)

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
`private boolean`	`clientScannerAsyncPrefetch`
`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.
`private static org.slf4j.Logger`	`LOG`
`static int`	`MAX_KEYVALUE_SIZE_DEFAULT`
`static String`	`MAX_KEYVALUE_SIZE_KEY`
`private int`	`maxKeyValueSize`
`private int`	`metaOperationTimeout`
`private int`	`metaReadRpcTimeout`
`private int`	`metaReplicaCallTimeoutMicroSecondScan`
`private int`	`metaScanTimeout`
`private int`	`operationTimeout`
`private long`	`pauseMs`
`private long`	`pauseMsForServerOverloaded`
`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`
`private int`	`primaryCallTimeoutMicroSecond`
`private int`	`readRpcTimeout`
`private int`	`replicaCallTimeoutMicroSecondScan`
`private int`	`retries`
`private int`	`rpcTimeout`
`private int`	`scannerCaching`
`private long`	`scannerMaxResultSize`
`private int`	`scanTimeout`
`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`
`private long`	`writeBufferPeriodicFlushTimeoutMs`
`private long`	`writeBufferPeriodicFlushTimerTickMs`
`private long`	`writeBufferSize`
`private int`	`writeRpcTimeout`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ConnectionConfiguration()` Constructor This is for internal testing purpose (using the default value).
`(package private)`	`ConnectionConfiguration(org.apache.hadoop.conf.Configuration conf)` Constructor

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()`

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

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

writeBufferSize
```
private final long writeBufferSize
```

writeBufferPeriodicFlushTimeoutMs

private final long writeBufferPeriodicFlushTimeoutMs

writeBufferPeriodicFlushTimerTickMs

private final long writeBufferPeriodicFlushTimerTickMs

metaOperationTimeout
```
private final int metaOperationTimeout
```

operationTimeout
```
private final int operationTimeout
```

scannerCaching
```
private final int scannerCaching
```

scannerMaxResultSize

private final long scannerMaxResultSize

primaryCallTimeoutMicroSecond

private final int primaryCallTimeoutMicroSecond

replicaCallTimeoutMicroSecondScan

private final int replicaCallTimeoutMicroSecondScan

metaReplicaCallTimeoutMicroSecondScan

private final int metaReplicaCallTimeoutMicroSecondScan

retries
```
private final int retries
```

maxKeyValueSize
```
private final int maxKeyValueSize
```

rpcTimeout
```
private final int rpcTimeout
```

readRpcTimeout
```
private final int readRpcTimeout
```

metaReadRpcTimeout
```
private final int metaReadRpcTimeout
```

writeRpcTimeout
```
private final int writeRpcTimeout
```

scanTimeout
```
private final int scanTimeout
```

metaScanTimeout
```
private final int metaScanTimeout
```

clientScannerAsyncPrefetch

private final boolean clientScannerAsyncPrefetch

pauseMs
```
private final long pauseMs
```

pauseMsForServerOverloaded

private final long pauseMsForServerOverloaded

Constructor Detail
- ConnectionConfiguration
```
ConnectionConfiguration(org.apache.hadoop.conf.Configuration conf)
```
  Constructor
  
  Parameters:
  
  conf - Configuration object
- 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()
```

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

LOG

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

writeBufferSize

writeBufferPeriodicFlushTimeoutMs

writeBufferPeriodicFlushTimerTickMs

metaOperationTimeout

operationTimeout

scannerCaching

scannerMaxResultSize

primaryCallTimeoutMicroSecond

replicaCallTimeoutMicroSecondScan

metaReplicaCallTimeoutMicroSecondScan

retries

maxKeyValueSize

rpcTimeout

readRpcTimeout

metaReadRpcTimeout

writeRpcTimeout

scanTimeout

metaScanTimeout

clientScannerAsyncPrefetch

pauseMs

pauseMsForServerOverloaded

Constructor Detail

ConnectionConfiguration

ConnectionConfiguration

Method Detail

getReadRpcTimeout

getMetaReadRpcTimeout

getWriteRpcTimeout

getWriteBufferSize

getWriteBufferPeriodicFlushTimeoutMs

getWriteBufferPeriodicFlushTimerTickMs

getMetaOperationTimeout

getOperationTimeout

getScannerCaching

getPrimaryCallTimeoutMicroSecond

getReplicaCallTimeoutMicroSecondScan

getMetaReplicaCallTimeoutMicroSecondScan

getRetriesNumber

getMaxKeyValueSize

getScannerMaxResultSize

isClientScannerAsyncPrefetch

getRpcTimeout

getScanTimeout

getMetaScanTimeout

getPauseMillis

getPauseMillisForServerOverloaded