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_QUORUM_TIMEOUT_SEC
protected static String	ADD_ENTRY_TIMEOUT_SEC
protected static String	BOOKIE_ERROR_THRESHOLD_PER_INTERVAL
protected static String	BOOKIE_HEALTH_CHECK_ENABLED
protected static String	BOOKIE_HEALTH_CHECK_INTERVAL_SECONDS
protected static String	BOOKIE_QUARANTINE_TIME_SECONDS
protected static String	CLIENT_AUTH_PROVIDER_FACTORY_CLASS
protected static String	CLIENT_CONNECT_TIMEOUT_MILLIS
protected static String	CLIENT_RECEIVEBUFFER_SIZE
protected static String	CLIENT_SENDBUFFER_SIZE
protected static String	CLIENT_TCP_NODELAY
protected static String	CLIENT_WRITEBUFFER_HIGH_WATER_MARK
protected static String	CLIENT_WRITEBUFFER_LOW_WATER_MARK
protected static String	DIGEST_TYPE
protected static String	ENABLE_TASK_EXECUTION_STATS
protected static String	ENSEMBLE_PLACEMENT_POLICY
protected static String	NUM_CHANNELS_PER_BOOKIE
protected static String	NUM_WORKER_THREADS
protected static String	PASSWD
protected static String	PCBC_TIMEOUT_TIMER_NUM_TICKS
protected static String	PCBC_TIMEOUT_TIMER_TICK_DURATION_MS
protected static String	READ_ENTRY_TIMEOUT_SEC
protected static String	READ_TIMEOUT
protected static String	SPECULATIVE_READ_TIMEOUT
protected static String	TASK_EXECUTION_WARN_TIME_MICROS
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, defaultLoader, 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
ClientConfiguration	enableBookieHealthCheck() Enables the bookie health check.
int	getAddEntryQuorumTimeout() Get the timeout for top-level add request.
int	getAddEntryTimeout() Get the timeout for add request.
long	getBookieErrorThresholdPerInterval() Get the error threshold for a bookie to be quarantined.
int	getBookieHealthCheckIntervalSeconds() Get the bookie health check interval in seconds.
int	getBookieQuarantineTimeSeconds() Get the time for which a bookie will be quarantined.
BookKeeper.DigestType	getBookieRecoveryDigestType() Get digest type used in bookkeeper admin
byte[]	getBookieRecoveryPasswd() Get passwd used in bookkeeper admin
String	getClientAuthProviderFactoryClass() Get the client authentication provider factory class name.
int	getClientConnectTimeoutMillis() Get client netty connect timeout in millis.
int	getClientReceiveBufferSize() Get client netty channel receive buffer size.
int	getClientSendBufferSize() Get client netty channel send buffer size.
boolean	getClientTcpNoDelay() Is tcp connection no delay.
int	getClientWriteBufferHighWaterMark() Get client netty channel write buffer high water mark.
int	getClientWriteBufferLowWaterMark() Get client netty channel write buffer low water mark.
boolean	getEnableTaskExecutionStats() Whether to enable recording task execution stats.
Class<? extends EnsemblePlacementPolicy>	getEnsemblePlacementPolicy() Get Ensemble Placement Policy Class.
int	getNumChannelsPerBookie() Get num channels per bookie.
int	getNumWorkerThreads() Get the number of worker threads.
int	getPCBCTimeoutTimerNumTicks() Get number of ticks that used for HashedWheelTimer that used by PCBC to timeout requests.
long	getPCBCTimeoutTimerTickDurationMs() Get the tick duration in milliseconds that used for the HashedWheelTimer that used by PCBC to timeout requests.
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.
long	getTaskExecutionWarnTimeMicros() Get task execution duration which triggers a warning.
int	getThrottleValue() Get throttle value
long	getTimeoutTaskIntervalMillis() Deprecated.
String	getZkServers() Get zookeeper servers to connect
int	getZkTimeout() Get zookeeper timeout
boolean	isBookieHealthCheckEnabled() Check if bookie health check is enabled.
ClientConfiguration	setAddEntryQuorumTimeout(int timeout) Set timeout for top-level add entry request.
ClientConfiguration	setAddEntryTimeout(int timeout) Set timeout for add entry request.
ClientConfiguration	setBookieErrorThresholdPerInterval(long thresholdPerInterval) Set the error threshold per interval (getBookieHealthCheckIntervalSeconds()) for a bookie before it is quarantined.
ClientConfiguration	setBookieHealthCheckInterval(int interval, TimeUnit unit) Set the bookie health check interval.
ClientConfiguration	setBookieQuarantineTime(int quarantineTime, TimeUnit unit) Set the time for which a bookie will be quarantined.
ClientConfiguration	setBookieRecoveryDigestType(BookKeeper.DigestType digestType) Set digest type used in bookkeeper admin.
ClientConfiguration	setBookieRecoveryPasswd(byte[] passwd) Set passwd used in bookkeeper admin.
ClientConfiguration	setClientAuthProviderFactoryClass(String factoryClass) Set the client authentication provider factory class name.
ClientConfiguration	setClientConnectTimeoutMillis(int connectTimeoutMillis) Set client netty connect timeout in millis.
ClientConfiguration	setClientReceiveBufferSize(int bufferSize) Set client netty channel receive buffer size.
ClientConfiguration	setClientSendBufferSize(int bufferSize) Set client netty channel send buffer size.
ClientConfiguration	setClientTcpNoDelay(boolean noDelay) Set socket nodelay setting.
ClientConfiguration	setClientWriteBufferHighWaterMark(int waterMark) Set client netty channel write buffer high water mark.
ClientConfiguration	setClientWriteBufferLowWaterMark(int waterMark) Set client netty channel write buffer low water mark.
ClientConfiguration	setEnableTaskExecutionStats(boolean enabled) Enable/Disable recording task execution stats.
ClientConfiguration	setEnsemblePlacementPolicy(Class<? extends EnsemblePlacementPolicy> policyClass) Set Ensemble Placement Policy Class.
ClientConfiguration	setNumChannelsPerBookie(int numChannelsPerBookie) Set num channels per bookie.
ClientConfiguration	setNumWorkerThreads(int numThreads) Set the number of worker threads.
ClientConfiguration	setPCBCTimeoutTimerNumTicks(int numTicks) Set number of ticks that used for HashedWheelTimer that used by PCBC to timeout request.
ClientConfiguration	setPCBCTimeoutTimerTickDurationMs(long tickDuration) Set the tick duration in milliseconds that used for HashedWheelTimer that used by PCBC to timeout requests.
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	setTaskExecutionWarnTimeMicros(long warnTime) Set task execution duration which triggers a warning.
ClientConfiguration	setThrottleValue(int throttle) Set throttle value.
ClientConfiguration	setTimeoutTaskIntervalMillis(long timeoutMillis) Deprecated.
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

CLIENT_SENDBUFFER_SIZE

protected static final String CLIENT_SENDBUFFER_SIZE

See Also:

Constant Field Values

CLIENT_RECEIVEBUFFER_SIZE

protected static final String CLIENT_RECEIVEBUFFER_SIZE

See Also:

Constant Field Values

CLIENT_WRITEBUFFER_LOW_WATER_MARK

protected static final String CLIENT_WRITEBUFFER_LOW_WATER_MARK

See Also:

Constant Field Values

CLIENT_WRITEBUFFER_HIGH_WATER_MARK

protected static final String CLIENT_WRITEBUFFER_HIGH_WATER_MARK

See Also:

Constant Field Values

CLIENT_CONNECT_TIMEOUT_MILLIS

protected static final String CLIENT_CONNECT_TIMEOUT_MILLIS

See Also:

Constant Field Values

NUM_CHANNELS_PER_BOOKIE

protected static final String NUM_CHANNELS_PER_BOOKIE

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

ADD_ENTRY_QUORUM_TIMEOUT_SEC

protected static final String ADD_ENTRY_QUORUM_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

PCBC_TIMEOUT_TIMER_TICK_DURATION_MS

protected static final String PCBC_TIMEOUT_TIMER_TICK_DURATION_MS

See Also:

Constant Field Values

PCBC_TIMEOUT_TIMER_NUM_TICKS

protected static final String PCBC_TIMEOUT_TIMER_NUM_TICKS

See Also:

Constant Field Values

BOOKIE_HEALTH_CHECK_ENABLED

protected static final String BOOKIE_HEALTH_CHECK_ENABLED

See Also:

Constant Field Values

BOOKIE_HEALTH_CHECK_INTERVAL_SECONDS

protected static final String BOOKIE_HEALTH_CHECK_INTERVAL_SECONDS

See Also:

Constant Field Values

BOOKIE_ERROR_THRESHOLD_PER_INTERVAL

protected static final String BOOKIE_ERROR_THRESHOLD_PER_INTERVAL

See Also:

Constant Field Values

BOOKIE_QUARANTINE_TIME_SECONDS

protected static final String BOOKIE_QUARANTINE_TIME_SECONDS

See Also:

Constant Field Values

NUM_WORKER_THREADS

protected static final String NUM_WORKER_THREADS

See Also:

Constant Field Values

ENSEMBLE_PLACEMENT_POLICY

protected static final String ENSEMBLE_PLACEMENT_POLICY

See Also:

Constant Field Values

ENABLE_TASK_EXECUTION_STATS

protected static final String ENABLE_TASK_EXECUTION_STATS

See Also:

Constant Field Values

TASK_EXECUTION_WARN_TIME_MICROS

protected static final String TASK_EXECUTION_WARN_TIME_MICROS

See Also:

Constant Field Values

CLIENT_AUTH_PROVIDER_FACTORY_CLASS

protected static final String CLIENT_AUTH_PROVIDER_FACTORY_CLASS

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 asynchronous 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 happening, you can set a throttle value here. Setting the throttle value to 0, will disable any throttling.

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

getClientSendBufferSize

public int getClientSendBufferSize()

Get client netty channel send buffer size.

Returns:

client netty channel send buffer size

setClientSendBufferSize

public ClientConfiguration setClientSendBufferSize(int bufferSize)

Set client netty channel send buffer size.

Parameters:

bufferSize - client netty channel send buffer size.

Returns:

client configuration.

getClientReceiveBufferSize

public int getClientReceiveBufferSize()

Get client netty channel receive buffer size.

Returns:

client netty channel receive buffer size.

setClientReceiveBufferSize

public ClientConfiguration setClientReceiveBufferSize(int bufferSize)

Set client netty channel receive buffer size.

Parameters:

bufferSize - netty channel receive buffer size.

Returns:

client configuration.

getClientWriteBufferLowWaterMark

public int getClientWriteBufferLowWaterMark()

Get client netty channel write buffer low water mark.

Returns:

netty channel write buffer low water mark.

setClientWriteBufferLowWaterMark

public ClientConfiguration setClientWriteBufferLowWaterMark(int waterMark)

Set client netty channel write buffer low water mark.

Parameters:

waterMark - netty channel write buffer low water mark.

Returns:

client configuration.

getClientWriteBufferHighWaterMark

public int getClientWriteBufferHighWaterMark()

Get client netty channel write buffer high water mark.

Returns:

netty channel write buffer high water mark.

setClientWriteBufferHighWaterMark

public ClientConfiguration setClientWriteBufferHighWaterMark(int waterMark)

Set client netty channel write buffer high water mark.

Parameters:

waterMark - netty channel write buffer high water mark.

Returns:

client configuration.

getClientConnectTimeoutMillis

public int getClientConnectTimeoutMillis()

Get client netty connect timeout in millis.

Returns:

client netty connect timeout in millis.

setClientConnectTimeoutMillis

public ClientConfiguration setClientConnectTimeoutMillis(int connectTimeoutMillis)

Set client netty connect timeout in millis.

Parameters:

connectTimeoutMillis - client netty connect timeout in millis.

Returns:

client configuration.

getNumChannelsPerBookie

public int getNumChannelsPerBookie()

Get num channels per bookie.

Returns:

num channels per bookie.

setNumChannelsPerBookie

public ClientConfiguration setNumChannelsPerBookie(int numChannelsPerBookie)

Set num channels per bookie.

Parameters:

numChannelsPerBookie - num channels per bookie.

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

getAddEntryQuorumTimeout

public int getAddEntryQuorumTimeout()

Get the timeout for top-level add request. That is, the amount of time we should spend waiting for ack quorum.

Returns:

add entry ack quorum timeout.

setAddEntryQuorumTimeout

public ClientConfiguration setAddEntryQuorumTimeout(int timeout)

Set timeout for top-level add entry request.

Parameters:

timeout - The new add entry ack quorum timeout in seconds.

Returns:

client configuration.

See Also:

getAddEntryQuorumTimeout()

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

@Deprecated
public long getTimeoutTaskIntervalMillis()

Deprecated.

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:

the interval at which request timeouts will be checked

setTimeoutTaskIntervalMillis

@Deprecated
public ClientConfiguration setTimeoutTaskIntervalMillis(long timeoutMillis)

Deprecated.

getPCBCTimeoutTimerTickDurationMs

public long getPCBCTimeoutTimerTickDurationMs()

Get the tick duration in milliseconds that used for the HashedWheelTimer that used by PCBC to timeout requests.

Returns:

tick duration in milliseconds

See Also:

HashedWheelTimer

setPCBCTimeoutTimerTickDurationMs

public ClientConfiguration setPCBCTimeoutTimerTickDurationMs(long tickDuration)

Set the tick duration in milliseconds that used for HashedWheelTimer that used by PCBC to timeout requests. Be aware of HashedWheelTimer if you are going to modify this setting.

Parameters:

tickDuration - tick duration in milliseconds.

Returns:

client configuration.

See Also:

getPCBCTimeoutTimerTickDurationMs()

getPCBCTimeoutTimerNumTicks

public int getPCBCTimeoutTimerNumTicks()

Get number of ticks that used for HashedWheelTimer that used by PCBC to timeout requests.

Returns:

number of ticks that used for timeout timer.

See Also:

HashedWheelTimer

setPCBCTimeoutTimerNumTicks

public ClientConfiguration setPCBCTimeoutTimerNumTicks(int numTicks)

Set number of ticks that used for HashedWheelTimer that used by PCBC to timeout request. Be aware of HashedWheelTimer if you are going to modify this setting.

Parameters:

numTicks - number of ticks that used for timeout timer.

Returns:

client configuration.

See Also:

getPCBCTimeoutTimerNumTicks()

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

getEnsemblePlacementPolicy

public Class<? extends EnsemblePlacementPolicy> getEnsemblePlacementPolicy()
                                                                    throws org.apache.commons.configuration.ConfigurationException

Get Ensemble Placement Policy Class.

Returns:

ensemble placement policy class.

Throws:

org.apache.commons.configuration.ConfigurationException

setEnsemblePlacementPolicy

public ClientConfiguration setEnsemblePlacementPolicy(Class<? extends EnsemblePlacementPolicy> policyClass)

Set Ensemble Placement Policy Class.

Parameters:

policyClass - Ensemble Placement Policy Class.

getEnableTaskExecutionStats

public boolean getEnableTaskExecutionStats()

Whether to enable recording task execution stats.

Returns:

flag to enable/disable recording task execution stats.

setEnableTaskExecutionStats

public ClientConfiguration setEnableTaskExecutionStats(boolean enabled)

Enable/Disable recording task execution stats.

Parameters:

enabled - flag to enable/disable recording task execution stats.

Returns:

client configuration.

getTaskExecutionWarnTimeMicros

public long getTaskExecutionWarnTimeMicros()

Get task execution duration which triggers a warning.

Returns:

time in microseconds which triggers a warning.

setTaskExecutionWarnTimeMicros

public ClientConfiguration setTaskExecutionWarnTimeMicros(long warnTime)

Set task execution duration which triggers a warning.

Parameters:

warnTime - time in microseconds which triggers a warning.

Returns:

client configuration.

isBookieHealthCheckEnabled

public boolean isBookieHealthCheckEnabled()

Check if bookie health check is enabled.

Returns:

enableBookieHealthCheck

public ClientConfiguration enableBookieHealthCheck()

Enables the bookie health check.

If the number of read/write errors for a bookie exceeds getBookieErrorThresholdPerInterval() per interval, that bookie is quarantined for getBookieQuarantineTimeSeconds() seconds. During this quarantined period, the client will try not to use this bookie when creating new ensembles.

By default, the bookie health check is disabled.

Returns:

client configuration

getBookieHealthCheckIntervalSeconds

public int getBookieHealthCheckIntervalSeconds()

Get the bookie health check interval in seconds.

Returns:

setBookieHealthCheckInterval

public ClientConfiguration setBookieHealthCheckInterval(int interval,
                                               TimeUnit unit)

Set the bookie health check interval. Default is 60 seconds.

Note: Please enableBookieHealthCheck() to use this configuration.

Parameters:

interval -

unit -

Returns:

client configuration

getBookieErrorThresholdPerInterval

public long getBookieErrorThresholdPerInterval()

Get the error threshold for a bookie to be quarantined.

Returns:

setBookieErrorThresholdPerInterval

public ClientConfiguration setBookieErrorThresholdPerInterval(long thresholdPerInterval)

Set the error threshold per interval (getBookieHealthCheckIntervalSeconds()) for a bookie before it is quarantined. Default is 100 errors per minute.

Note: Please enableBookieHealthCheck() to use this configuration.

Parameters:

threshold -

unit -

Returns:

client configuration

getBookieQuarantineTimeSeconds

public int getBookieQuarantineTimeSeconds()

Get the time for which a bookie will be quarantined.

Returns:

setBookieQuarantineTime

public ClientConfiguration setBookieQuarantineTime(int quarantineTime,
                                          TimeUnit unit)

Set the time for which a bookie will be quarantined. Default is 30 minutes.

Note: Please enableBookieHealthCheck() to use this configuration.

Parameters:

quarantineTime -

unit -

Returns:

client configuration

setClientAuthProviderFactoryClass

public ClientConfiguration setClientAuthProviderFactoryClass(String factoryClass)

Set the client authentication provider factory class name. If this is not set, no authentication will be used

Parameters:

factoryClass - the client authentication provider factory class name

Returns:

client configuration

getClientAuthProviderFactoryClass

public String getClientAuthProviderFactoryClass()

Get the client authentication provider factory class name. If this returns null, no authentication will take place.

Returns:

the client authentication provider factory class name or null.