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

Packages that use ServerConfiguration

Package	Description
org.apache.bookkeeper.client	BookKeeper Client.
org.apache.bookkeeper.conf	Configurations used by bookkeeper.

Uses of ServerConfiguration in org.apache.bookkeeper.client

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

Modifier and Type	Method and Description
static boolean	BookKeeperAdmin.format(ServerConfiguration conf, boolean isInteractive, boolean force) Format the BookKeeper metadata in zookeeper.
static boolean	BookKeeperAdmin.initBookie(ServerConfiguration conf) Initializes bookie, by making sure that the journalDir, ledgerDirs and indexDirs are empty and there is no registered Bookie with this BookieId.
static boolean	BookKeeperAdmin.initNewCluster(ServerConfiguration conf) Intializes new cluster by creating required znodes for the cluster.
static boolean	BookKeeperAdmin.nukeExistingCluster(ServerConfiguration conf, java.lang.String ledgersRootPath, java.lang.String instanceId, boolean force) Nukes existing cluster metadata.

Uses of ServerConfiguration in org.apache.bookkeeper.conf

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

Modifier and Type	Method and Description
protected ServerConfiguration	ServerConfiguration.getThis()
ServerConfiguration	ServerConfiguration.setAdvertisedAddress(java.lang.String advertisedAddress) Configure the bookie to advertise a specific address.
ServerConfiguration	ServerConfiguration.setAllowEphemeralPorts(boolean allow) Configure the bookie to allow using an ephemeral port.
ServerConfiguration	ServerConfiguration.setAllowLoopback(boolean allow) Configure the bookie to allow loopback interfaces to be used as the primary bookie interface.
ServerConfiguration	ServerConfiguration.setAllowMultipleDirsUnderSameDiskPartition(boolean allow) Configure the Bookie to allow/disallow multiple ledger/index/journal directories in the same filesystem diskpartition.
ServerConfiguration	ServerConfiguration.setAllowStorageExpansion(boolean val) Change the setting of whether or not we should allow ledger/index dirs to be added to the current set of dirs.
ServerConfiguration	ServerConfiguration.setAuditorLedgerVerificationPercentage(long auditorLedgerVerificationPercentage) Set what percentage of a ledger (fragment)'s entries will be verified.
ServerConfiguration	ServerConfiguration.setAuthorizedRoles(java.lang.String roles) Set authorized roles.
ServerConfiguration	ServerConfiguration.setAutoRecoveryDaemonEnabled(boolean enabled) Sets that whether the auto-recovery service can start along with Bookie server itself or not.
ServerConfiguration	ServerConfiguration.setBookieId(java.lang.String bookieId) Configure the bookie to advertise a specific BookieId.
ServerConfiguration	ServerConfiguration.setBookiePort(int port) Set new bookie port that bookie server listen on.
ServerConfiguration	ServerConfiguration.setCloseChannelOnResponseTimeout(boolean value) Configures action in case if server timed out sending response to the client.
ServerConfiguration	ServerConfiguration.setCompactionMaxOutstandingRequests(int maxOutstandingRequests) Set the maximum number of entries which can be compacted without flushing.
ServerConfiguration	ServerConfiguration.setCompactionRate(int rate) Set the rate of compaction adds.
ServerConfiguration	ServerConfiguration.setCompactionRateByBytes(int rate) Set the rate of compaction adds.
ServerConfiguration	ServerConfiguration.setCompactionRateByEntries(int rate) Set the rate of compaction adds.
ServerConfiguration	ServerConfiguration.setDisableServerSocketBind(boolean disableServerSocketBind) Configure the bookie to disable bind on network interfaces, this bookie will be available only to BookKeeper clients executed on the local JVM.
ServerConfiguration	ServerConfiguration.setDiskCheckInterval(int interval) Set the disk checker interval to monitor ledger disk space.
ServerConfiguration	ServerConfiguration.setDiskLowWaterMarkUsageThreshold(float threshold) Set the disk free space low water mark threshold.
ServerConfiguration	ServerConfiguration.setDiskUsageThreshold(float threshold) Set the Disk free space threshold as a fraction of the total after which disk will be considered as full during disk check.
ServerConfiguration	ServerConfiguration.setDiskUsageWarnThreshold(float threshold) Set the warning threshold for disk usage.
ServerConfiguration	ServerConfiguration.setEnableLocalTransport(boolean enableLocalTransport) Configure the bookie to listen for BookKeeper clients executed on the local JVM.
ServerConfiguration	ServerConfiguration.setEnableTaskExecutionStats(boolean enabled) Enable/Disable recording task execution stats.
ServerConfiguration	ServerConfiguration.setEntryLogFilePreAllocationEnabled(boolean enabled) Enable/disable entry log file preallocation.
ServerConfiguration	ServerConfiguration.setEntrylogMapAccessExpiryTimeInSeconds(int entrylogMapAccessExpiryTimeInSeconds)
ServerConfiguration	ServerConfiguration.setEntryLogPerLedgerCounterLimitsMultFactor(int entryLogPerLedgerCounterLimitsMultFactor)
ServerConfiguration	ServerConfiguration.setEntryLogPerLedgerEnabled(boolean entryLogPerLedgerEnabled)
ServerConfiguration	ServerConfiguration.setEntryLogSizeLimit(long logSizeLimit) Set entry logger size limitation.
ServerConfiguration	ServerConfiguration.setExtraServerComponents(java.lang.String[] componentClasses) Set the extra list of server lifecycle components to enable on a bookie server.
ServerConfiguration	ServerConfiguration.setFileInfoCacheInitialCapacity(int initialCapacity) Set the minimum total size for the internal file info cache tables for initialization.
ServerConfiguration	ServerConfiguration.setFileInfoFormatVersionToWrite(int version) Set fileinfo format version to write.
ServerConfiguration	ServerConfiguration.setFileInfoMaxIdleTime(long idleTime) Set the max idle time allowed for a open file info existed in file info cache.
ServerConfiguration	ServerConfiguration.setFlushInterval(int flushInterval) Set flush interval.
ServerConfiguration	ServerConfiguration.setFlushIntervalInBytes(long flushInterval) Set entry log flush interval in bytes.
ServerConfiguration	ServerConfiguration.setForceAllowCompaction(boolean enable) Allow manually force compact the entry log or not.
ServerConfiguration	ServerConfiguration.setForceReadOnlyBookie(boolean enabled) Sets that whether force start a bookie in readonly mode.
ServerConfiguration	ServerConfiguration.setGcOverreplicatedLedgerWaitTime(long gcWaitTime, java.util.concurrent.TimeUnit unit) Set wait time for garbage collection of overreplicated ledgers.
ServerConfiguration	ServerConfiguration.setGcWaitTime(long gcWaitTime) Set garbage collection wait time.
ServerConfiguration	ServerConfiguration.setHttpServerEnabled(boolean enabled) Set whether to start the http server or not.
ServerConfiguration	ServerConfiguration.setHttpServerPort(int port) Set Http server port listening on.
ServerConfiguration	ServerConfiguration.setIgnoreExtraServerComponentsStartupFailures(boolean enabled) Set the flag whether to ignore startup failures on loading server components specified at getExtraServerComponents().
ServerConfiguration	ServerConfiguration.setIndexDirName(java.lang.String[] indexDirs) Set dir name to store index files.
ServerConfiguration	ServerConfiguration.setIsForceGCAllowWhenNoSpace(boolean force) Set whether force GC is allowed when disk full or almost full.
ServerConfiguration	ServerConfiguration.setIsThrottleByBytes(boolean byBytes) Set whether use bytes to throttle garbage collector compaction or not.
ServerConfiguration	ServerConfiguration.setJournalAdaptiveGroupWrites(boolean enabled) Enable/disable group journal force writes.
ServerConfiguration	ServerConfiguration.setJournalAlignmentSize(int size) Set journal alignment size.
ServerConfiguration	ServerConfiguration.setJournalBufferedEntriesThreshold(int maxEntries) Set maximum entries to buffer to impose on a journal write to achieve grouping.
ServerConfiguration	ServerConfiguration.setJournalBufferedWritesThreshold(long maxBytes) Set maximum bytes to buffer to impose on a journal write to achieve grouping.
ServerConfiguration	ServerConfiguration.setJournalDirName(java.lang.String journalDir) Set dir name to store journal files.
ServerConfiguration	ServerConfiguration.setJournalDirsName(java.lang.String[] journalDirs) Set dir names to store journal files.
ServerConfiguration	ServerConfiguration.setJournalFlushWhenQueueEmpty(boolean enabled) Set if we should flush the journal when queue is empty.
ServerConfiguration	ServerConfiguration.setJournalFormatVersionToWrite(int version) Set journal format version to write.
ServerConfiguration	ServerConfiguration.setJournalMaxGroupWaitMSec(long journalMaxGroupWaitMSec) Sets the maximum latency to impose on a journal write to achieve grouping.
ServerConfiguration	ServerConfiguration.setJournalMaxMemorySizeMb(long journalMaxMemorySizeMb) Set the max amount of memory that can be used by the journal.
ServerConfiguration	ServerConfiguration.setJournalPageCacheFlushIntervalMSec(long journalPageCacheFlushIntervalMSec) Set PageCache flush interval in second.
ServerConfiguration	ServerConfiguration.setJournalQueueSize(int journalQueueSize) Set the size of the journal queue.
ServerConfiguration	ServerConfiguration.setJournalRemovePagesFromCache(boolean enabled) Sets that whether should we remove pages from page cache after force write.
ServerConfiguration	ServerConfiguration.setJournalSyncData(boolean syncData) Enable or disable journal syncs.
ServerConfiguration	ServerConfiguration.setJournalWriteBufferSizeKB(int bufferSizeKB) Set the size of the write buffers used for the journal.
ServerConfiguration	ServerConfiguration.setJournalWriteData(boolean journalWriteData) Should the data be written to journal before acknowledgment.
ServerConfiguration	ServerConfiguration.setLedgerDirNames(java.lang.String[] ledgerDirs) Set dir names to store ledger data.
ServerConfiguration	ServerConfiguration.setLedgerStorageClass(java.lang.String ledgerStorageClass) Set the LedgerStorage implementation class name.
ServerConfiguration	ServerConfiguration.setListeningInterface(java.lang.String iface) Set the network interface that the bookie should listen on.
ServerConfiguration	ServerConfiguration.setMajorCompactionInterval(long interval) Set interval to run major compaction.
ServerConfiguration	ServerConfiguration.setMajorCompactionMaxTimeMillis(long majorCompactionMaxTimeMillis) Set the maximum milliseconds to run major compaction.
ServerConfiguration	ServerConfiguration.setMajorCompactionThreshold(double threshold) Set threshold of major compaction.
ServerConfiguration	ServerConfiguration.setMaxAddsInProgressLimit(int value) Set max number of adds in progress.
ServerConfiguration	ServerConfiguration.setMaxBackupJournals(int maxBackupJournals) Set max number of older journal files to kept.
ServerConfiguration	ServerConfiguration.setMaximumNumberOfActiveEntryLogs(int maximumNumberOfActiveEntryLogs)
ServerConfiguration	ServerConfiguration.setMaxJournalSizeMB(long maxJournalSize) Set new max journal file size.
ServerConfiguration	ServerConfiguration.setMaxPendingAddRequestPerThread(int maxPendingAddRequestsPerThread) Set the max number of pending add requests for each add worker thread.
ServerConfiguration	ServerConfiguration.setMaxPendingReadRequestPerThread(int maxPendingReadRequestsPerThread) Set the max number of pending read requests for each read worker thread.
ServerConfiguration	ServerConfiguration.setMaxReadsInProgressLimit(int value) Set max number of reads in progress.
ServerConfiguration	ServerConfiguration.setMinorCompactionInterval(long interval) Set interval to run minor compaction.
ServerConfiguration	ServerConfiguration.setMinorCompactionMaxTimeMillis(long minorCompactionMaxTimeMillis) Set the maximum milliseconds to run minor compaction.
ServerConfiguration	ServerConfiguration.setMinorCompactionThreshold(double threshold) Set threshold of minor compaction.
ServerConfiguration	ServerConfiguration.setMinUsableSizeForEntryLogCreation(long minUsableSizeForEntryLogCreation) Sets the minimum safe usable size to be available in ledger directory for Bookie to create entry log files.
ServerConfiguration	ServerConfiguration.setMinUsableSizeForHighPriorityWrites(long minUsableSizeForHighPriorityWrites) Sets the minimum safe usable size to be available in ledger directory for Bookie to accept high priority writes.
ServerConfiguration	ServerConfiguration.setMinUsableSizeForIndexFileCreation(long minUsableSizeForIndexFileCreation) Sets the minimum safe Usable size to be available in index directory for Bookie to create Index File while replaying journal at the time of Bookie Start in Readonly Mode (in bytes).
ServerConfiguration	ServerConfiguration.setNettyMaxFrameSizeBytes(int maxSize) Set the max number of bytes a single message can be that is read by the bookie.
ServerConfiguration	ServerConfiguration.setNumAddWorkerThreads(int numThreads) Set the number of threads that would handle write requests.
ServerConfiguration	ServerConfiguration.setNumHighPriorityWorkerThreads(int numThreads) Set the number of threads that should be used for high priority requests (i.e.
ServerConfiguration	ServerConfiguration.setNumJournalCallbackThreads(int numThreads) Set the number of threads that would handle journal callbacks.
ServerConfiguration	ServerConfiguration.setNumLongPollWorkerThreads(int numThreads) Set the number of threads that should handle long poll requests.
ServerConfiguration	ServerConfiguration.setNumOfMemtableFlushThreads(int numOfMemtableFlushThreads)
ServerConfiguration	ServerConfiguration.setNumReadWorkerThreads(int numThreads) Set the number of threads that would handle read requests.
ServerConfiguration	ServerConfiguration.setOpenFileLimit(int fileLimit) Set limitation of number of open files.
ServerConfiguration	ServerConfiguration.setOperationMaxNumbersInSingleRocksDBWriteBatch(int maxNumbersInSingleRocksDBBatch) Set the max operation numbers in a single rocksdb write batch.
ServerConfiguration	ServerConfiguration.setPageLimit(int pageLimit) Set limitation number of index pages in ledger cache.
ServerConfiguration	ServerConfiguration.setPageSize(int pageSize) Set page size.
ServerConfiguration	ServerConfiguration.setPersistBookieStatusEnabled(boolean enabled) Whether to persist the bookie status so that when bookie server restarts, it will continue using the previous status.
ServerConfiguration	ServerConfiguration.setReadBufferBytes(int readBufferSize) Set the number of bytes we should use as capacity for org.apache.bookkeeper.bookie.BufferedReadChannel.
ServerConfiguration	ServerConfiguration.setReadOnlyModeEnabled(boolean enabled) Set whether the bookie is able to go into read-only mode.
ServerConfiguration	ServerConfiguration.setReadWorkerThreadsThrottlingEnabled(boolean throttle) Use auto-throttling of the read-worker threads.
ServerConfiguration	ServerConfiguration.setRequestTimerNumTicks(int tickCount) Set the number of ticks per wheel for the request timer.
ServerConfiguration	ServerConfiguration.setRequestTimerTickDurationMs(int tickDuration) Set the tick duration in milliseconds.
ServerConfiguration	ServerConfiguration.setRocksDBDeleteEntriesBatchSize(int rocksDBDeleteEntriesBatchSize) Set entry log location index delete entries batch size from RocksDB.
ServerConfiguration	ServerConfiguration.setServerNumIOThreads(int numThreads) Set the number of IO threads.
ServerConfiguration	ServerConfiguration.setServerSockKeepalive(boolean keepalive) Set socket keepalive setting.
ServerConfiguration	ServerConfiguration.setServerSockLinger(int linger) Set socket linger timeout on close.
ServerConfiguration	ServerConfiguration.setServerTcpNoDelay(boolean noDelay) Set socket nodelay setting.
ServerConfiguration	ServerConfiguration.setServerWriteBufferHighWaterMark(int waterMark) Set server netty channel write buffer high water mark.
ServerConfiguration	ServerConfiguration.setServerWriteBufferLowWaterMark(int waterMark) Set server netty channel write buffer low water mark.
ServerConfiguration	ServerConfiguration.setSkipListArenaChunkSize(int size) Set the number of bytes we used as chunk allocation for org.apache.bookkeeper.bookie.SkipListArena.
ServerConfiguration	ServerConfiguration.setSkipListArenaMaxAllocSize(int size) Set the max size we should allocate from the skiplist arena.
ServerConfiguration	ServerConfiguration.setSkipListSizeLimit(int size) Set skip list size limit.
ServerConfiguration	ServerConfiguration.setSkipReplayJournalInvalidRecord(boolean skipReplayJournalInvalidRecord) When this config is set to true,if we replay journal failed, we will skip.
ServerConfiguration	ServerConfiguration.setSortedLedgerStorageEnabled(boolean enabled) Deprecated. Use setLedgerStorageClass(String) to configure the implementation class
ServerConfiguration	ServerConfiguration.setStatisticsEnabled(boolean enabled) Turn on/off statistics.
ServerConfiguration	ServerConfiguration.setStatsProviderClass(java.lang.Class<? extends org.apache.bookkeeper.stats.StatsProvider> providerClass) Set the stats provider used by bookie.
ServerConfiguration	ServerConfiguration.setTLSCertificatePath(java.lang.String arg) Set the path to file containing TLS Certificate.
ServerConfiguration	ServerConfiguration.setTLSKeyStore(java.lang.String arg) Set the keystore path for the client.
ServerConfiguration	ServerConfiguration.setTLSKeyStorePasswordPath(java.lang.String arg) Set the path to file containing keystore password, if the client keystore is password protected.
ServerConfiguration	ServerConfiguration.setTLSKeyStoreType(java.lang.String arg) Set the keystore type for client.
ServerConfiguration	ServerConfiguration.setTLSTrustStore(java.lang.String arg) Set the truststore path for the client.
ServerConfiguration	ServerConfiguration.setTLSTrustStorePasswordPath(java.lang.String arg) Set the path to file containing truststore password, if the client truststore is password protected.
ServerConfiguration	ServerConfiguration.setTLSTrustStoreType(java.lang.String arg) Set the truststore type for client.
ServerConfiguration	ServerConfiguration.setUseHostNameAsBookieID(boolean useHostName) Configure the bookie to use its hostname to register with the co-ordination service(eg: zookeeper) and in ledger metadata.
ServerConfiguration	ServerConfiguration.setUseShortHostName(boolean useShortHostName) Configure the bookie to use its short hostname or FQDN hostname to register with the co-ordination service(eg: zookeeper) and in ledger metadata.
ServerConfiguration	ServerConfiguration.setUseTargetEntryLogSizeForGc(boolean useTargetEntryLogSizeForGc)
ServerConfiguration	ServerConfiguration.setUseTransactionalCompaction(boolean useTransactionalCompaction) Set whether to use transactional compaction and using a separate log for compaction or not.
ServerConfiguration	ServerConfiguration.setVerifyMetadataOnGc(boolean verifyMetadataOnGC) Set whether the bookie is configured to double check prior to gc.
ServerConfiguration	ServerConfiguration.setWaitTimeoutOnResponseBackpressureMillis(long value) Timeout controlling wait on response send in case of unresponsive client (i.e.
ServerConfiguration	ServerConfiguration.setWriteBufferBytes(int writeBufferBytes) Set the number of bytes used as capacity for the write buffer.
ServerConfiguration	ServerConfiguration.setZkRetryBackoffMaxMs(int retryMs) Set zookeeper client backoff retry max time in millis.
ServerConfiguration	ServerConfiguration.setZkRetryBackoffStartMs(int retryMs) Set zookeeper client backoff retry start time in millis.