org.apache.bookkeeper.conf

Class ClientConfiguration

java.lang.Object

org.apache.commons.configuration.event.EventSource

org.apache.commons.configuration.AbstractConfiguration

org.apache.commons.configuration.CompositeConfiguration

org.apache.bookkeeper.conf.AbstractConfiguration

org.apache.bookkeeper.conf.ClientConfiguration

All Implemented Interfaces:

Cloneable, org.apache.commons.configuration.Configuration

public class ClientConfiguration
extends AbstractConfiguration

Configuration settings for client side

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ADD_ENTRY_TIMEOUT_SEC
protected static String	CLIENT_TCP_NODELAY
protected static String	DIGEST_TYPE
protected static String	NUM_WORKER_THREADS
protected static String	PASSWD
protected static String	READ_ENTRY_TIMEOUT_SEC
protected static String	READ_TIMEOUT
protected static String	SPECULATIVE_READ_TIMEOUT
protected static String	THROTTLE
protected static String	TIMEOUT_TASK_INTERVAL_MILLIS
protected static String	ZK_SERVERS
protected static String	ZK_TIMEOUT

Fields inherited from class org.apache.bookkeeper.conf.AbstractConfiguration

AVAILABLE_NODE, LEDGER_MANAGER_FACTORY_CLASS, LEDGER_MANAGER_TYPE, METASTORE_IMPL_CLASS, METASTORE_MAX_ENTRIES_PER_SCAN, REREPLICATION_ENTRY_BATCH_SIZE, ZK_LEDGERS_ROOT_PATH

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration

END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN

Constructor Summary

Constructors

Constructor and Description
ClientConfiguration() Construct a default client-side configuration
ClientConfiguration(AbstractConfiguration conf) Construct a client-side configuration using a base configuration

Method Summary

Methods

Modifier and Type	Method and Description
int	getAddEntryTimeout() Get the timeout for add request.
BookKeeper.DigestType	getBookieRecoveryDigestType() Get digest type used in bookkeeper admin
byte[]	getBookieRecoveryPasswd() Get passwd used in bookkeeper admin
boolean	getClientTcpNoDelay() Is tcp connection no delay.
int	getNumWorkerThreads() Get the number of worker threads.
int	getReadEntryTimeout() Get the timeout for read entry.
int	getReadTimeout() Deprecated. use getReadEntryTimeout() or getAddEntryTimeout() instead
int	getSpeculativeReadTimeout() Get the period of time after which a speculative entry read should be triggered.
int	getThrottleValue() Get throttle value
long	getTimeoutTaskIntervalMillis() Get the interval between successive executions of the PerChannelBookieClient's TimeoutTask.
String	getZkServers() Get zookeeper servers to connect
int	getZkTimeout() Get zookeeper timeout
ClientConfiguration	setAddEntryTimeout(int timeout) Set timeout for add entry request.
ClientConfiguration	setBookieRecoveryDigestType(BookKeeper.DigestType digestType) Set digest type used in bookkeeper admin.
ClientConfiguration	setBookieRecoveryPasswd(byte[] passwd) Set passwd used in bookkeeper admin.
ClientConfiguration	setClientTcpNoDelay(boolean noDelay) Set socket nodelay setting.
ClientConfiguration	setNumWorkerThreads(int numThreads) Set the number of worker threads.
ClientConfiguration	setReadEntryTimeout(int timeout) Set the timeout for read entry request.
ClientConfiguration	setReadTimeout(int timeout) Deprecated. use setReadEntryTimeout(int) or setAddEntryTimeout(int) instead
ClientConfiguration	setSpeculativeReadTimeout(int timeout) Set the speculative read timeout.
ClientConfiguration	setThrottleValue(int throttle) Set throttle value.
ClientConfiguration	setTimeoutTaskIntervalMillis(long timeoutMillis)
ClientConfiguration	setZkServers(String zkServers) Set zookeeper servers to connect
ClientConfiguration	setZkTimeout(int zkTimeout) Set zookeeper timeout

Methods inherited from class org.apache.bookkeeper.conf.AbstractConfiguration

getLedgerManagerFactoryClass, getLedgerManagerType, getMetastoreImplClass, getMetastoreMaxEntriesPerScan, getRereplicationEntryBatchSize, getZkAvailableBookiesPath, getZkLedgersRootPath, loadConf, loadConf, loadConf, setLedgerManagerFactoryClass, setLedgerManagerFactoryClassName, setLedgerManagerType, setMetastoreImplClass, setMetastoreMaxEntriesPerScan, setRereplicationEntryBatchSize, setZkLedgersRootPath

Methods inherited from class org.apache.commons.configuration.CompositeConfiguration

addConfiguration, addPropertyDirect, clear, clearPropertyDirect, clone, containsKey, getConfiguration, getInMemoryConfiguration, getKeys, getKeys, getList, getNumberOfConfigurations, getProperty, getSource, getStringArray, isEmpty, removeConfiguration, setDelimiterParsingDisabled, setListDelimiter

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration

addErrorLogListener, addProperty, append, clearProperty, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getSubstitutor, interpolate, interpolate, interpolatedConfiguration, interpolateHelper, isDelimiterParsingDisabled, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setLogger, setProperty, setThrowExceptionOnMissing, subset

Methods inherited from class org.apache.commons.configuration.event.EventSource

addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents

Methods inherited from class java.lang.Object

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

Field Detail

ZK_TIMEOUT

protected static final String ZK_TIMEOUT

See Also:

Constant Field Values

ZK_SERVERS

protected static final String ZK_SERVERS

See Also:

Constant Field Values

THROTTLE

protected static final String THROTTLE

See Also:

Constant Field Values

DIGEST_TYPE

protected static final String DIGEST_TYPE

See Also:

Constant Field Values

PASSWD

protected static final String PASSWD

See Also:

Constant Field Values

CLIENT_TCP_NODELAY

protected static final String CLIENT_TCP_NODELAY

See Also:

Constant Field Values

READ_TIMEOUT

protected static final String READ_TIMEOUT

See Also:

Constant Field Values

SPECULATIVE_READ_TIMEOUT

protected static final String SPECULATIVE_READ_TIMEOUT

See Also:

Constant Field Values

ADD_ENTRY_TIMEOUT_SEC

protected static final String ADD_ENTRY_TIMEOUT_SEC

See Also:

Constant Field Values

READ_ENTRY_TIMEOUT_SEC

protected static final String READ_ENTRY_TIMEOUT_SEC

See Also:

Constant Field Values

TIMEOUT_TASK_INTERVAL_MILLIS

protected static final String TIMEOUT_TASK_INTERVAL_MILLIS

See Also:

Constant Field Values

NUM_WORKER_THREADS

protected static final String NUM_WORKER_THREADS

See Also:

Constant Field Values

Constructor Detail

ClientConfiguration

public ClientConfiguration()

Construct a default client-side configuration

ClientConfiguration

public ClientConfiguration(AbstractConfiguration conf)

Construct a client-side configuration using a base configuration

Parameters:

conf - Base configuration

Method Detail

getThrottleValue

public int getThrottleValue()

Get throttle value

Returns:

throttle value

See Also:

setThrottleValue(int)

setThrottleValue

public ClientConfiguration setThrottleValue(int throttle)

Set throttle value. Since BookKeeper process requests in asynchrous way, it will holds those pending request in queue. You may easily run it out of memory if producing too many requests than the capability of bookie servers can handle. To prevent that from happeding, you can set a throttle value here.

Parameters:

throttle - Throttle Value

Returns:

client configuration

getBookieRecoveryDigestType

public BookKeeper.DigestType getBookieRecoveryDigestType()

Get digest type used in bookkeeper admin

Returns:

digest type

See Also:

setBookieRecoveryDigestType(org.apache.bookkeeper.client.BookKeeper.DigestType)

setBookieRecoveryDigestType

public ClientConfiguration setBookieRecoveryDigestType(BookKeeper.DigestType digestType)

Set digest type used in bookkeeper admin. Digest Type and Passwd used to open ledgers for admin tool For now, assume that all ledgers were created with the same DigestType and password. In the future, this admin tool will need to know for each ledger, what was the DigestType and password used to create it before it can open it. These values will come from System properties, though fixed defaults are defined here.

Parameters:

digestType - Digest Type

Returns:

client configuration

getBookieRecoveryPasswd

public byte[] getBookieRecoveryPasswd()

Get passwd used in bookkeeper admin

Returns:

password

See Also:

setBookieRecoveryPasswd(byte[])

setBookieRecoveryPasswd

public ClientConfiguration setBookieRecoveryPasswd(byte[] passwd)

Set passwd used in bookkeeper admin. Digest Type and Passwd used to open ledgers for admin tool For now, assume that all ledgers were created with the same DigestType and password. In the future, this admin tool will need to know for each ledger, what was the DigestType and password used to create it before it can open it. These values will come from System properties, though fixed defaults are defined here.

Parameters:

passwd - Password

Returns:

client configuration

getClientTcpNoDelay

public boolean getClientTcpNoDelay()

Is tcp connection no delay.

Returns:

tcp socket nodelay setting

See Also:

setClientTcpNoDelay(boolean)

setClientTcpNoDelay

public ClientConfiguration setClientTcpNoDelay(boolean noDelay)

Set socket nodelay setting. This settings is used to enabled/disabled Nagle's algorithm, which is a means of improving the efficiency of TCP/IP networks by reducing the number of packets that need to be sent over the network. If you are sending many small messages, such that more than one can fit in a single IP packet, setting client.tcpnodelay to false to enable Nagle algorithm can provide better performance.
Default value is true.

Parameters:

noDelay - NoDelay setting

Returns:

client configuration

getZkServers

public String getZkServers()

Get zookeeper servers to connect

Returns:

zookeeper servers

setZkServers

public ClientConfiguration setZkServers(String zkServers)

Set zookeeper servers to connect

Parameters:

zkServers - ZooKeeper servers to connect

getZkTimeout

public int getZkTimeout()

Get zookeeper timeout

Returns:

zookeeper client timeout

setZkTimeout

public ClientConfiguration setZkTimeout(int zkTimeout)

Set zookeeper timeout

Parameters:

zkTimeout - ZooKeeper client timeout

Returns:

client configuration

getReadTimeout

@Deprecated
public int getReadTimeout()

Deprecated. use getReadEntryTimeout() or getAddEntryTimeout() instead

Get the socket read timeout. This is the number of seconds we wait without hearing a response from a bookie before we consider it failed. The default is 5 seconds.

Returns:

the current read timeout in seconds

setReadTimeout

@Deprecated
public ClientConfiguration setReadTimeout(int timeout)

Deprecated. use setReadEntryTimeout(int) or setAddEntryTimeout(int) instead

Set the socket read timeout.

Parameters:

timeout - The new read timeout in seconds

Returns:

client configuration

See Also:

getReadTimeout()

getAddEntryTimeout

public int getAddEntryTimeout()

Get the timeout for add request. This is the number of seconds we wait without hearing a response for add request from a bookie before we consider it failed. The default value is 5 second for backwards compatibility.

Returns:

add entry timeout.

setAddEntryTimeout

public ClientConfiguration setAddEntryTimeout(int timeout)

Set timeout for add entry request.

Parameters:

timeout - The new add entry timeout in seconds.

Returns:

client configuration.

See Also:

getAddEntryTimeout()

getReadEntryTimeout

public int getReadEntryTimeout()

Get the timeout for read entry. This is the number of seconds we wait without hearing a response for read entry request from a bookie before we consider it failed. By default, we use socket timeout specified at getReadTimeout().

Returns:

read entry timeout.

setReadEntryTimeout

public ClientConfiguration setReadEntryTimeout(int timeout)

Set the timeout for read entry request.

Parameters:

timeout - The new read entry timeout in seconds.

Returns:

client configuration.

See Also:

getReadEntryTimeout()

getTimeoutTaskIntervalMillis

public long getTimeoutTaskIntervalMillis()

Get the interval between successive executions of the PerChannelBookieClient's TimeoutTask. This value is in milliseconds. Every X milliseconds, the timeout task will be executed and it will error out entries that have timed out. We do it more aggressive to not accumulate pending requests due to slow responses.

Returns:

setTimeoutTaskIntervalMillis

public ClientConfiguration setTimeoutTaskIntervalMillis(long timeoutMillis)

getNumWorkerThreads

public int getNumWorkerThreads()

Get the number of worker threads. This is the number of worker threads used by bookkeeper client to submit operations.

Returns:

the number of worker threads

setNumWorkerThreads

public ClientConfiguration setNumWorkerThreads(int numThreads)

Set the number of worker threads.

NOTE: setting the number of worker threads after BookKeeper object is constructed will not take any effect on the number of threads in the pool.

Parameters:

numThreads - number of worker threads used for bookkeeper

Returns:

client configuration

See Also:

getNumWorkerThreads()

getSpeculativeReadTimeout

public int getSpeculativeReadTimeout()

Get the period of time after which a speculative entry read should be triggered. A speculative entry read is sent to the next replica bookie before an error or response has been received for the previous entry read request. A speculative entry read is only sent if we have not heard from the current replica bookie during the entire read operation which may comprise of many entries. Speculative reads allow the client to avoid having to wait for the connect timeout in the case that a bookie has failed. It induces higher load on the network and on bookies. This should be taken into account before changing this configuration value.

Returns:

the speculative read timeout in milliseconds. Default 2000.

See Also:

LedgerHandle.asyncReadEntries(long, long, org.apache.bookkeeper.client.AsyncCallback.ReadCallback, java.lang.Object)

setSpeculativeReadTimeout

public ClientConfiguration setSpeculativeReadTimeout(int timeout)

Set the speculative read timeout. A lower timeout will reduce read latency in the case of a failed bookie, while increasing the load on bookies and the network. The default is 2000 milliseconds. A value of 0 will disable speculative reads completely.

Parameters:

timeout - the timeout value, in milliseconds

Returns:

client configuration

See Also:

getSpeculativeReadTimeout()