Uses of Class
org.apache.bookkeeper.conf.ClientConfiguration

Packages that use ClientConfiguration

Package	Description
org.apache.bookkeeper.auth	Classes used to handle authentication in bookies and clients.
org.apache.bookkeeper.bookie	Provides a Bookie server that stores entries for clients.
org.apache.bookkeeper.client	BookKeeper Client.
org.apache.bookkeeper.client.api	BookKeeper Client Public API.
org.apache.bookkeeper.client.impl	BookKeeper Client implementation package.
org.apache.bookkeeper.conf	Configurations used by bookkeeper.
org.apache.bookkeeper.meta	Classes for interacting with bookkeeper ledgers and ledger metadata.
org.apache.bookkeeper.meta.zk	ZooKeeper based metadata implementation.
org.apache.bookkeeper.proto	Classes related to the Bookkeeper protocol.
org.apache.bookkeeper.sasl	SASL and JAAS Authentication classes.
org.apache.bookkeeper.tools.cli.helpers	This classes provides some helper mixins for easily to add commands to bookie shell.
org.apache.bookkeeper.util	Bookkeeper utilities.

Uses of ClientConfiguration in org.apache.bookkeeper.auth

Methods in org.apache.bookkeeper.auth with parameters of type ClientConfiguration

Modifier and Type	Method	Description
void	ClientAuthProvider.Factory.init(ClientConfiguration conf)	Initialize the factory with the client configuration and protobuf message registry.
static ClientAuthProvider.Factory	AuthProviderFactoryFactory.newClientAuthProviderFactory(ClientConfiguration conf)

Uses of ClientConfiguration in org.apache.bookkeeper.bookie

Methods in org.apache.bookkeeper.bookie with parameters of type ClientConfiguration

Modifier and Type	Method	Description
EnsemblePlacementPolicy	LocalBookieEnsemblePlacementPolicy.initialize(ClientConfiguration conf, Optional<DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer hashedWheelTimer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)

Uses of ClientConfiguration in org.apache.bookkeeper.client

Fields in org.apache.bookkeeper.client declared as ClientConfiguration

Modifier and Type	Field	Description
(package private) final ClientConfiguration	BookKeeper.Builder.conf
(package private) final ClientConfiguration	BookKeeper.conf

Methods in org.apache.bookkeeper.client that return ClientConfiguration

Modifier and Type	Method	Description
protected ClientConfiguration	BookKeeper.getConf()
ClientConfiguration	BookKeeperAdmin.getConf()

Methods in org.apache.bookkeeper.client with parameters of type ClientConfiguration

Modifier and Type	Method	Description
static BookKeeper.Builder	BookKeeper.forConfig(ClientConfiguration conf)
(package private) static ClientInternalConf	ClientInternalConf.fromConfig(ClientConfiguration conf)
(package private) static ClientInternalConf	ClientInternalConf.fromConfigAndFeatureProvider(ClientConfiguration conf, FeatureProvider featureProvider)
EnsemblePlacementPolicy	DefaultEnsemblePlacementPolicy.initialize(ClientConfiguration conf, Optional<DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer hashedWheelTimer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)
EnsemblePlacementPolicy	EnsemblePlacementPolicy.initialize(ClientConfiguration conf, Optional<DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer hashedWheelTimer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)	Initialize the policy.
RackawareEnsemblePlacementPolicyImpl	RackawareEnsemblePlacementPolicyImpl.initialize(ClientConfiguration conf, Optional<DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer timer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)
RegionAwareEnsemblePlacementPolicy	RegionAwareEnsemblePlacementPolicy.initialize(ClientConfiguration conf, Optional<DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer timer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)
EnsemblePlacementPolicy	ZoneawareEnsemblePlacementPolicy.initialize(ClientConfiguration conf, Optional<DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer timer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)
EnsemblePlacementPolicy	ZoneawareEnsemblePlacementPolicyImpl.initialize(ClientConfiguration conf, Optional<DNSToSwitchMapping> optionalDnsResolver, io.netty.util.HashedWheelTimer timer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)
protected EnsemblePlacementPolicy	BookKeeper.initializeEnsemblePlacementPolicy(ClientConfiguration conf, DNSToSwitchMapping dnsResolver, io.netty.util.HashedWheelTimer timer, FeatureProvider featureProvider, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)
static BookKeeperAdmin	BookKeeperAdmin.newBookKeeperAdmin(ClientConfiguration conf)
(package private) void	BookKeeper.scheduleBookieHealthCheckIfEnabled(ClientConfiguration conf)

Constructors in org.apache.bookkeeper.client with parameters of type ClientConfiguration

Modifier	Constructor	Description
(package private)	BookieInfoReader(BookKeeper bk, ClientConfiguration conf, ScheduledExecutorService scheduler)
	BookieWatcherImpl(ClientConfiguration conf, EnsemblePlacementPolicy placementPolicy, RegistrationClient registrationClient, BookieAddressResolver bookieAddressResolver, StatsLogger statsLogger)
	BookKeeper(ClientConfiguration conf)	Create a bookkeeper client using a configuration object.
	BookKeeper(ClientConfiguration conf, org.apache.zookeeper.ZooKeeper zk)	Create a bookkeeper client but use the passed in zookeeper client instead of instantiating one.
	BookKeeper(ClientConfiguration conf, org.apache.zookeeper.ZooKeeper zk, io.netty.channel.EventLoopGroup eventLoopGroup)	Create a bookkeeper client but use the passed in zookeeper client and client event loop group instead of instantiating those.
(package private)	BookKeeper(ClientConfiguration conf, org.apache.zookeeper.ZooKeeper zkc, io.netty.channel.EventLoopGroup eventLoopGroup, io.netty.buffer.ByteBufAllocator byteBufAllocator, StatsLogger rootStatsLogger, DNSToSwitchMapping dnsResolver, io.netty.util.HashedWheelTimer requestTimer, FeatureProvider featureProvider)	Constructor for use with the builder.
	BookKeeperAdmin(BookKeeper bkc, ClientConfiguration conf)
	BookKeeperAdmin(BookKeeper bkc, StatsLogger statsLogger, ClientConfiguration conf)	Constructor that takes in a BookKeeper instance .
	BookKeeperAdmin(ClientConfiguration conf)	Constructor that takes in a configuration object so we know how to connect to ZooKeeper to retrieve information about the BookKeeper cluster.
(package private)	Builder(ClientConfiguration conf)
	LedgerFragmentReplicator(BookKeeper bkc, ClientConfiguration conf)
	LedgerFragmentReplicator(BookKeeper bkc, StatsLogger statsLogger, ClientConfiguration conf)

Uses of ClientConfiguration in org.apache.bookkeeper.client.api

Methods in org.apache.bookkeeper.client.api with parameters of type ClientConfiguration

Modifier and Type	Method	Description
static BookKeeperBuilder	BookKeeper.newBuilder(ClientConfiguration clientConfiguration)	Create a new builder which can be used to boot a new BookKeeper client.

Uses of ClientConfiguration in org.apache.bookkeeper.client.impl

Constructors in org.apache.bookkeeper.client.impl with parameters of type ClientConfiguration

Modifier	Constructor	Description
	BookKeeperBuilderImpl(ClientConfiguration conf)

Uses of ClientConfiguration in org.apache.bookkeeper.conf

Methods in org.apache.bookkeeper.conf that return ClientConfiguration

Modifier and Type	Method	Description
ClientConfiguration	ClientConfiguration.enableBookieHealthCheck()	Enables the bookie health check.
protected ClientConfiguration	ClientConfiguration.getThis()
ClientConfiguration	ClientConfiguration.setAddEntryQuorumTimeout(int timeout)	Set timeout for top-level add entry request.
ClientConfiguration	ClientConfiguration.setAddEntryTimeout(int timeout)	Set timeout for add entry request.
ClientConfiguration	ClientConfiguration.setBatchReadEnabled(boolean enable)
ClientConfiguration	ClientConfiguration.setBookieAddressResolverEnabled(boolean enabled)	Enable/Disable BookieAddressResolver.
ClientConfiguration	ClientConfiguration.setBookieErrorThresholdPerInterval(long thresholdPerInterval)	Set the error threshold per interval (getBookieHealthCheckIntervalSeconds()) for a bookie before it is quarantined.
ClientConfiguration	ClientConfiguration.setBookieFailureHistoryExpirationMSec(int expirationMSec)	Set the bookie failure tracking expiration timeout.
ClientConfiguration	ClientConfiguration.setBookieHealthCheckInterval(int interval, TimeUnit unit)	Set the bookie health check interval.
ClientConfiguration	ClientConfiguration.setBookieMaxWeightMultipleForWeightBasedPlacement(int multiple)	Set the max multiple to use for nodes with very high weight.
ClientConfiguration	ClientConfiguration.setBookieQuarantineRatio(double ratio)	set the bookie quarantine ratio.
ClientConfiguration	ClientConfiguration.setBookieQuarantineTime(int quarantineTime, TimeUnit unit)	Set the time for which a bookie will be quarantined.
ClientConfiguration	ClientConfiguration.setBookieRecoveryDigestType(BookKeeper.DigestType digestType)	Set digest type used in bookkeeper admin.
ClientConfiguration	ClientConfiguration.setBookieRecoveryPasswd(byte[] passwd)	Set passwd used in bookkeeper admin.
ClientConfiguration	ClientConfiguration.setClientConnectBookieUnavailableLogThrottling(int throttleValue, TimeUnit unit)	Set the log frequency when a bookie is unavailable, in order to limit log filesize.
ClientConfiguration	ClientConfiguration.setClientConnectTimeoutMillis(int connectTimeoutMillis)	Set client netty connect timeout in millis.
ClientConfiguration	ClientConfiguration.setClientReceiveBufferSize(int bufferSize)	Set client netty channel receive buffer size.
ClientConfiguration	ClientConfiguration.setClientRole(String role)	Set the client role.
ClientConfiguration	ClientConfiguration.setClientSendBufferSize(int bufferSize)	Set client netty channel send buffer size.
ClientConfiguration	ClientConfiguration.setClientSockKeepalive(boolean keepalive)	Set socket keepalive setting.
ClientConfiguration	ClientConfiguration.setClientTcpNoDelay(boolean noDelay)	Set socket nodelay setting.
ClientConfiguration	ClientConfiguration.setClientWriteBufferHighWaterMark(int waterMark)	Set client netty channel write buffer high water mark.
ClientConfiguration	ClientConfiguration.setClientWriteBufferLowWaterMark(int waterMark)	Set client netty channel write buffer low water mark.
ClientConfiguration	ClientConfiguration.setDelayEnsembleChange(boolean enabled)	Enable/Disable delaying ensemble change.
ClientConfiguration	ClientConfiguration.setDisableEnsembleChangeFeatureName(String disableEnsembleChangeFeatureName)	Set the name of the dynamic feature that disables ensemble change.
ClientConfiguration	ClientConfiguration.setDiskWeightBasedPlacementEnabled(boolean isEnabled)	Set whether or not disk weight based placement is enabled.
ClientConfiguration	ClientConfiguration.setEnableBookieAddressTracking(boolean value)	Enable/Disable bookie address changes tracking.
ClientConfiguration	ClientConfiguration.setEnableBookieFailureTracking(boolean enabled)	Enable/Disable bookie failure tracking.
ClientConfiguration	ClientConfiguration.setEnableDigestTypeAutodetection(boolean enable)	Enable autodetection of digest type.
ClientConfiguration	ClientConfiguration.setEnableParallelRecoveryRead(boolean enabled)	Enable/Disable parallel reading in recovery read.
ClientConfiguration	ClientConfiguration.setEnableTaskExecutionStats(boolean enabled)	Enable/Disable recording task execution stats.
ClientConfiguration	ClientConfiguration.setEnsemblePlacementPolicy(Class<? extends EnsemblePlacementPolicy> policyClass)	Set Ensemble Placement Policy Class.
ClientConfiguration	ClientConfiguration.setExplictLacInterval(int interval)	Set the interval to check the need for sending an explicit LAC.
ClientConfiguration	ClientConfiguration.setFirstSpeculativeReadLACTimeout(int timeout)	Set the period of time after which the first speculative read last add confirmed and entry should be triggered.
ClientConfiguration	ClientConfiguration.setFirstSpeculativeReadTimeout(int timeout)	Set the first speculative read timeout.
ClientConfiguration	ClientConfiguration.setGetBookieInfoIntervalSeconds(int pollInterval, TimeUnit unit)	Set the time interval between successive polls for bookie get info.
ClientConfiguration	ClientConfiguration.setGetBookieInfoRetryIntervalSeconds(int interval, TimeUnit unit)	Set the time interval between retries on unsuccessful GetInfo requests.
ClientConfiguration	ClientConfiguration.setGetBookieInfoTimeout(int timeoutSecs)	Set the timeout value in secs for the GET_BOOKIE_INFO request.
ClientConfiguration	ClientConfiguration.setHostnameVerificationEnabled(boolean enabled)	Enable/Disable hostname verification for tls connection.
ClientConfiguration	ClientConfiguration.setMaxAllowedEnsembleChanges(int num)	Set the max allowed ensemble change number.
ClientConfiguration	ClientConfiguration.setMaxSpeculativeReadLACTimeout(int timeout)	Set the maximum interval between successive speculative read last add confirmed and entry requests.
ClientConfiguration	ClientConfiguration.setMaxSpeculativeReadTimeout(int timeout)	Set the max speculative read timeout.
ClientConfiguration	ClientConfiguration.setNettyMaxFrameSizeBytes(int maxSize)	Set the max number of bytes a single message can be that is read by the bookie.
ClientConfiguration	ClientConfiguration.setNettyUsePooledBuffers(boolean enabled)	Deprecated. see BookKeeperBuilder.allocator(io.netty.buffer.ByteBufAllocator)
ClientConfiguration	ClientConfiguration.setNetworkTopologyStabilizePeriodSeconds(int seconds)	Set the network topology stabilize period in seconds.
ClientConfiguration	ClientConfiguration.setNumChannelsPerBookie(int numChannelsPerBookie)	Set num channels per bookie.
ClientConfiguration	ClientConfiguration.setNumIOThreads(int numThreads)	Set the number of IO threads.
ClientConfiguration	ClientConfiguration.setNumWorkerThreads(int numThreads)	Set the number of worker threads.
ClientConfiguration	ClientConfiguration.setOpportunisticStriping(boolean enabled)	Enable/Disable opportunistic striping.
ClientConfiguration	ClientConfiguration.setPCBCTimeoutTimerNumTicks(int numTicks)	Deprecated.
ClientConfiguration	ClientConfiguration.setPCBCTimeoutTimerTickDurationMs(long tickDuration)	Deprecated.
ClientConfiguration	ClientConfiguration.setReadEntryTimeout(int timeout)	Set the timeout for read entry request.
ClientConfiguration	ClientConfiguration.setReadTimeout(int timeout)	Deprecated. use setReadEntryTimeout(int) or setAddEntryTimeout(int) instead
ClientConfiguration	ClientConfiguration.setRecoveryBatchReadEnabled(boolean enabled)	Enable/disable recovery batch read.
ClientConfiguration	ClientConfiguration.setRecoveryReadBatchSize(int batchSize)	Set Recovery Read Batch Size.
ClientConfiguration	ClientConfiguration.setRegistrationClientClass(Class<? extends RegistrationClient> regClientClass)	Deprecated. since 4.7.0
ClientConfiguration	ClientConfiguration.setReorderReadSequenceEnabled(boolean enabled)	Enable/disable reordering read sequence on reading entries.
ClientConfiguration	ClientConfiguration.setReorderThresholdPendingRequests(int threshold)	Set the threshold for the number of pending requests beyond which to reorder reads.
ClientConfiguration	ClientConfiguration.setSpeculativeReadLACTimeoutBackoffMultiplier(float speculativeReadLACTimeoutBackoffMultiplier)	Set the multiplier to use when determining time between successive speculative read LAC requests.
ClientConfiguration	ClientConfiguration.setSpeculativeReadTimeout(int timeout)	Set the speculative read timeout.
ClientConfiguration	ClientConfiguration.setSpeculativeReadTimeoutBackoffMultiplier(float speculativeReadTimeoutBackoffMultiplier)	Set the multiplier to use when determining time between successive speculative read requests.
ClientConfiguration	ClientConfiguration.setStartTLSTimeout(int timeoutSecs)	Set the timeout value in secs for the START_TLS request.
ClientConfiguration	ClientConfiguration.setStickyReadsEnabled(boolean enabled)	Enable/disable having read operations for a ledger to be sticky to a single bookie.
ClientConfiguration	ClientConfiguration.setStoreSystemtimeAsLedgerCreationTime(boolean enabled)	Enable the client to use system time as the ledger creation time.
ClientConfiguration	ClientConfiguration.setTaskExecutionWarnTimeMicros(long warnTime)	Set task execution duration which triggers a warning.
ClientConfiguration	ClientConfiguration.setTcpKeepCnt(int keepCnt)	Set TCP_KEEPCNT value for SO_KEEPALIVE.
ClientConfiguration	ClientConfiguration.setTcpKeepIdle(int keepIdle)	Set TCP_KEEPIDLE value for SO_KEEPALIVE.
ClientConfiguration	ClientConfiguration.setTcpKeepIntvl(int keepIntvl)	Set TCP_KEEPINTVL value for SO_KEEPALIVE.
ClientConfiguration	ClientConfiguration.setTcpUserTimeoutMillis(int tcpUserTimeoutMillis)	Set client netty TCP user timeout in millis (only for Epoll channels).
ClientConfiguration	ClientConfiguration.setThrottleValue(int throttle)	Set throttle value.
ClientConfiguration	ClientConfiguration.setTimeoutMonitorIntervalSec(long timeoutInterval)	Set the interval between successive executions of the operation timeout monitor.
ClientConfiguration	ClientConfiguration.setTimeoutTaskIntervalMillis(long timeoutMillis)	Deprecated.
ClientConfiguration	ClientConfiguration.setTimeoutTimerNumTicks(int numTicks)	Set number of ticks that used for timeout timer.
ClientConfiguration	ClientConfiguration.setTimeoutTimerTickDurationMs(long tickDuration)	Set the tick duration in milliseconds that used for timeout timer.
ClientConfiguration	ClientConfiguration.setTLSCertificatePath(String arg)	Set the path to file containing TLS Certificate.
ClientConfiguration	ClientConfiguration.setTLSKeyStore(String arg)	Set the keystore path for the client.
ClientConfiguration	ClientConfiguration.setTLSKeyStorePasswordPath(String arg)	Set the path to file containing keystore password, if the client keystore is password protected.
ClientConfiguration	ClientConfiguration.setTLSKeyStoreType(String arg)	Set the keystore type for client.
ClientConfiguration	ClientConfiguration.setTLSTrustStore(String arg)	Set the truststore path for the client.
ClientConfiguration	ClientConfiguration.setTLSTrustStorePasswordPath(String arg)	Set the path to file containing truststore password, if the client truststore is password protected.
ClientConfiguration	ClientConfiguration.setTLSTrustStoreType(String arg)	Set the truststore type for client.
ClientConfiguration	ClientConfiguration.setUseV2WireProtocol(boolean useV2WireProtocol)	Set whether or not to use older Bookkeeper wire protocol (no protobuf).
ClientConfiguration	ClientConfiguration.setWaitTimeoutOnBackpressureMillis(long value)	Timeout controlling wait on request send in case of unresponsive bookie(s) (i.e.

Uses of ClientConfiguration in org.apache.bookkeeper.meta

Methods in org.apache.bookkeeper.meta with parameters of type ClientConfiguration

Modifier and Type	Method	Description
MetadataClientDriver	MetadataClientDriver.initialize(ClientConfiguration conf, ScheduledExecutorService scheduler, StatsLogger statsLogger, Optional<Object> ctx)	Initialize the metadata driver.
static <T> T	MetadataDrivers.runFunctionWithMetadataClientDriver(ClientConfiguration conf, Function<MetadataClientDriver,T> function, ScheduledExecutorService executorService)	Process the provided function with metadata client driver resolved from the metadata service uri returned by AbstractConfiguration.getMetadataServiceUri().

Uses of ClientConfiguration in org.apache.bookkeeper.meta.zk

Fields in org.apache.bookkeeper.meta.zk declared as ClientConfiguration

Modifier and Type	Field	Description
(package private) ClientConfiguration	ZKMetadataClientDriver.clientConf

Methods in org.apache.bookkeeper.meta.zk with parameters of type ClientConfiguration

Modifier and Type	Method	Description
MetadataClientDriver	ZKMetadataClientDriver.initialize(ClientConfiguration conf, ScheduledExecutorService scheduler, StatsLogger statsLogger, Optional<Object> optionalCtx)

Uses of ClientConfiguration in org.apache.bookkeeper.proto

Fields in org.apache.bookkeeper.proto declared as ClientConfiguration

Modifier and Type	Field	Description
(package private) final ClientConfiguration	DefaultPerChannelBookieClientPool.conf
protected final ClientConfiguration	PerChannelBookieClient.conf

Constructors in org.apache.bookkeeper.proto with parameters of type ClientConfiguration

Modifier	Constructor	Description
	BookieClientImpl(ClientConfiguration conf, io.netty.channel.EventLoopGroup eventLoopGroup, io.netty.buffer.ByteBufAllocator allocator, OrderedExecutor executor, ScheduledExecutorService scheduler, StatsLogger statsLogger, BookieAddressResolver bookieAddressResolver)
(package private)	DefaultPerChannelBookieClientPool(ClientConfiguration conf, PerChannelBookieClientFactory factory, BookieId address, int coreSize)
	PerChannelBookieClient(ClientConfiguration conf, OrderedExecutor executor, io.netty.channel.EventLoopGroup eventLoopGroup, io.netty.buffer.ByteBufAllocator allocator, BookieId bookieId, StatsLogger parentStatsLogger, ClientAuthProvider.Factory authProviderFactory, com.google.protobuf.ExtensionRegistry extRegistry, PerChannelBookieClientPool pcbcPool, SecurityHandlerFactory shFactory, BookieAddressResolver bookieAddressResolver)
	PerChannelBookieClient(ClientConfiguration conf, OrderedExecutor executor, io.netty.channel.EventLoopGroup eventLoopGroup, BookieId bookieId, StatsLogger parentStatsLogger, ClientAuthProvider.Factory authProviderFactory, com.google.protobuf.ExtensionRegistry extRegistry, PerChannelBookieClientPool pcbcPool, BookieAddressResolver bookieAddressResolver)

Uses of ClientConfiguration in org.apache.bookkeeper.sasl

Methods in org.apache.bookkeeper.sasl with parameters of type ClientConfiguration

Modifier and Type	Method	Description
void	SASLClientProviderFactory.init(ClientConfiguration conf)

Uses of ClientConfiguration in org.apache.bookkeeper.tools.cli.helpers

Methods in org.apache.bookkeeper.tools.cli.helpers with parameters of type ClientConfiguration

Modifier and Type	Method	Description
protected boolean	ClientCommand.apply(ClientConfiguration conf, ClientFlagsT cmdFlags)
protected boolean	DiscoveryCommand.apply(ClientConfiguration clientConf, DiscoveryFlagsT cmdFlags)

Uses of ClientConfiguration in org.apache.bookkeeper.util

Methods in org.apache.bookkeeper.util with parameters of type ClientConfiguration

Modifier and Type	Method	Description
static io.netty.channel.EventLoopGroup	EventLoopUtil.getClientEventLoopGroup(ClientConfiguration conf, ThreadFactory threadFactory)