ServerConfiguration (bookkeeper 4.4.0 API)

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.ServerConfiguration

All Implemented Interfaces:

Cloneable, org.apache.commons.configuration.Configuration
```
public class ServerConfiguration
extends AbstractConfiguration
```
Configuration manages server-side settings

Field Summary

Fields
Modifier and Type	Field and Description
`protected static String`	`ALLOW_LOOPBACK`
`protected static String`	`AUDITOR_PERIODIC_BOOKIE_CHECK_INTERVAL`
`protected static String`	`AUDITOR_PERIODIC_CHECK_INTERVAL`
`protected static String`	`AUTO_RECOVERY_DAEMON_ENABLED`
`protected static String`	`BOOKIE_AUTH_PROVIDER_FACTORY_CLASS`
`protected static String`	`BOOKIE_PORT`
`protected static String`	`COMPACTION_MAX_OUTSTANDING_REQUESTS`
`protected static String`	`COMPACTION_RATE`
`protected static String`	`COMPACTION_RATE_BY_BYTES`
`protected static String`	`COMPACTION_RATE_BY_ENTRIES`
`protected static String`	`DEATH_WATCH_INTERVAL`
`protected static String`	`DISK_CHECK_INTERVAL`
`protected static String`	`DISK_USAGE_THRESHOLD`
`protected static String`	`DISK_USAGE_WARN_THRESHOLD`
`protected static String`	`ENABLE_LOCAL_TRANSPORT`
`protected static String`	`ENABLE_STATISTICS`
`protected static String`	`ENTRY_LOG_FILE_PREALLOCATION_ENABLED`
`protected static String`	`ENTRY_LOG_SIZE_LIMIT`
`protected static String`	`FLUSH_INTERVAL`
`protected static String`	`FORCE_READ_ONLY_BOOKIE`
`protected static String`	`GC_OVERREPLICATED_LEDGER_WAIT_TIME`
`protected static String`	`GC_WAIT_TIME`
`protected static String`	`INDEX_DIRS`
`protected static String`	`IS_FORCE_GC_ALLOW_WHEN_NO_SPACE`
`protected static String`	`IS_THROTTLE_BY_BYTES`
`protected static String`	`JOURNAL_ADAPTIVE_GROUP_WRITES`
`protected static String`	`JOURNAL_ALIGNMENT_SIZE`
`protected static String`	`JOURNAL_BUFFERED_ENTRIES_THRESHOLD`
`protected static String`	`JOURNAL_BUFFERED_WRITES_THRESHOLD`
`protected static String`	`JOURNAL_DIR`
`protected static String`	`JOURNAL_FLUSH_WHEN_QUEUE_EMPTY`
`protected static String`	`JOURNAL_FORMAT_VERSION_TO_WRITE`
`protected static String`	`JOURNAL_MAX_GROUP_WAIT_MSEC`
`protected static String`	`JOURNAL_PRE_ALLOC_SIZE`
`protected static String`	`JOURNAL_REMOVE_FROM_PAGE_CACHE`
`protected static String`	`JOURNAL_WRITE_BUFFER_SIZE`
`protected static String`	`LEDGER_DIRS`
`protected static String`	`LEDGER_STORAGE_CLASS`
`protected static String`	`LISTENING_INTERFACE`
`protected static String`	`MAJOR_COMPACTION_INTERVAL`
`protected static String`	`MAJOR_COMPACTION_THRESHOLD`
`protected static String`	`MAX_BACKUP_JOURNALS`
`protected static String`	`MAX_JOURNAL_SIZE`
`protected static String`	`MINOR_COMPACTION_INTERVAL`
`protected static String`	`MINOR_COMPACTION_THRESHOLD`
`protected static String`	`NUM_ADD_WORKER_THREADS`
`protected static String`	`NUM_JOURNAL_CALLBACK_THREADS`
`protected static String`	`NUM_READ_WORKER_THREADS`
`protected static String`	`OPEN_FILE_LIMIT`
`protected static String`	`OPEN_LEDGER_REREPLICATION_GRACE_PERIOD`
`protected static String`	`PAGE_LIMIT`
`protected static String`	`PAGE_SIZE`
`protected static String`	`READ_BUFFER_SIZE`
`protected static String`	`READ_ONLY_MODE_ENABLED`
`protected static String`	`SERVER_TCP_NODELAY`
`protected static String`	`SKIP_LIST_CHUNK_SIZE_ENTRY`
`protected static String`	`SKIP_LIST_MAX_ALLOC_ENTRY`
`protected static String`	`SKIP_LIST_SIZE_LIMIT`
`protected static String`	`SORTED_LEDGER_STORAGE_ENABLED`
`protected static String`	`STATS_PROVIDER_CLASS`
`protected static String`	`USE_HOST_NAME_AS_BOOKIE_ID`
`protected static String`	`WRITE_BUFFER_SIZE`
`protected static String`	`ZK_RETRY_BACKOFF_MAX_MS`
`protected static String`	`ZK_RETRY_BACKOFF_START_MS`
`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
`ServerConfiguration()` Construct a default configuration object
`ServerConfiguration(AbstractConfiguration conf)` Construct a configuration based on other configuration

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAllowLoopback()` Is the bookie allowed to use a loopback interface as its primary interface(i.e.
`long`	`getAuditorPeriodicBookieCheckInterval()` Get the interval between auditor bookie check runs.
`long`	`getAuditorPeriodicCheckInterval()` Get the regularity at which the auditor checks all ledgers.
`String`	`getBookieAuthProviderFactoryClass()` Get the bookie authentication provider factory class name.
`int`	`getBookiePort()` Get bookie port that bookie server listen on
`int`	`getCompactionMaxOutstandingRequests()` Get the maximum number of entries which can be compacted without flushing.
`int`	`getCompactionRate()` Deprecated. replaced by `getCompactionRateByEntries()`
`int`	`getCompactionRateByBytes()` Get the rate of compaction adds.
`int`	`getCompactionRateByEntries()` Get the rate of compaction adds.
`int`	`getDeathWatchInterval()` Get bookie death watch interval
`int`	`getDiskCheckInterval()` Get the disk checker interval
`float`	`getDiskUsageThreshold()` Returns disk free space threshold.
`float`	`getDiskUsageWarnThreshold()` Returns the warning threshold for disk usage.
`long`	`getEntryLogSizeLimit()` Get entry logger size limitation
`int`	`getFlushInterval()` Get flush interval.
`long`	`getGcOverreplicatedLedgerWaitTimeMillis()` Get wait time in millis for garbage collection of overreplicated ledgers
`long`	`getGcWaitTime()` Get Garbage collection wait time.
`String[]`	`getIndexDirNames()` Get dir name to store index files.
`File[]`	`getIndexDirs()` Get index dir to store ledger index files.
`boolean`	`getIsForceGCAllowWhenNoSpace()` Get whether force compaction is allowed when disk full or almost full.
`boolean`	`getIsThrottleByBytes()` Get whether use bytes to throttle garbage collector compaction or not
`boolean`	`getJournalAdaptiveGroupWrites()` Should we group journal force writes
`int`	`getJournalAlignmentSize()` All the journal writes and commits should be aligned to given size.
`long`	`getJournalBufferedEntriesThreshold()` Maximum entries to buffer to impose on a journal write to achieve grouping.
`long`	`getJournalBufferedWritesThreshold()` Maximum bytes to buffer to impose on a journal write to achieve grouping
`File`	`getJournalDir()` Get dir to store journal files
`String`	`getJournalDirName()` Get dir name to store journal files
`boolean`	`getJournalFlushWhenQueueEmpty()` Should we flush the journal when queue is empty
`int`	`getJournalFormatVersionToWrite()` Get journal format version to write.
`long`	`getJournalMaxGroupWaitMSec()` Maximum latency to impose on a journal write to achieve grouping.
`int`	`getJournalPreAllocSizeMB()` How much space should we pre-allocate at a time in the journal
`boolean`	`getJournalRemovePagesFromCache()` Should we remove pages from page cache after force write
`int`	`getJournalWriteBufferSizeKB()` Size of the write buffers used for the journal
`String[]`	`getLedgerDirNames()` Get dir names to store ledger data
`File[]`	`getLedgerDirs()` Get dirs that stores ledger data
`String`	`getLedgerStorageClass()`
`String`	`getListeningInterface()` Get the network interface that the bookie should listen for connections on.
`long`	`getMajorCompactionInterval()` Get interval to run major compaction, in seconds.
`double`	`getMajorCompactionThreshold()` Get threshold of major compaction.
`int`	`getMaxBackupJournals()` Max number of older journal files kept
`long`	`getMaxJournalSizeMB()` Max journal file size
`long`	`getMinorCompactionInterval()` Get interval to run minor compaction, in seconds.
`double`	`getMinorCompactionThreshold()` Get threshold of minor compaction.
`int`	`getNumAddWorkerThreads()` Get the number of threads that should handle write requests.
`int`	`getNumJournalCallbackThreads()` Get the number of threads that should handle journal callbacks.
`int`	`getNumReadWorkerThreads()` Get the number of threads that should handle read requests.
`int`	`getOpenFileLimit()` Get open file limit.
`long`	`getOpenLedgerRereplicationGracePeriod()` Get the grace period which the rereplication worker to wait before fencing and rereplicating a ledger fragment which is still being written to, on bookie failure.
`int`	`getPageLimit()` Get limitation number of index pages in ledger cache
`int`	`getPageSize()` Get page size
`int`	`getReadBufferBytes()` Get the number of bytes we should use as capacity for org.apache.bookkeeper.bookie.BufferedReadChannel Default is 512 bytes
`boolean`	`getServerTcpNoDelay()` Is tcp connection no delay.
`int`	`getSkipListArenaChunkSize()` Get the number of bytes we should use as chunk allocation for org.apache.bookkeeper.bookie.SkipListArena Default is 4 MB
`int`	`getSkipListArenaMaxAllocSize()` Get the max size we should allocate from the skiplist arena.
`long`	`getSkipListSizeLimit()` Get skip list data size limitation (default 64MB)
`boolean`	`getSortedLedgerStorageEnabled()` Check if sorted-ledger storage enabled (default true)
`Class<? extends org.apache.bookkeeper.stats.StatsProvider>`	`getStatsProviderClass()` Get the stats provider used by bookie.
`boolean`	`getUseHostNameAsBookieID()` Get whether bookie is using hostname for registration and in ledger metadata.
`int`	`getWriteBufferBytes()` Get the number of bytes used as capacity for the write buffer.
`int`	`getZkRetryBackoffMaxMs()` Get zookeeper client backoff retry max time in millis.
`int`	`getZkRetryBackoffStartMs()` Get zookeeper client backoff retry start time in millis.
`String`	`getZkServers()` Get zookeeper servers to connect
`int`	`getZkTimeout()` Get zookeeper timeout
`boolean`	`isAutoRecoveryDaemonEnabled()` Get whether the Bookie itself can start auto-recovery service also or not
`boolean`	`isEnableLocalTransport()` Get hwhether to use listen for local JVM clients.
`boolean`	`isEntryLogFilePreAllocationEnabled()` Is entry log file preallocation enabled.
`boolean`	`isForceReadOnlyBookie()` Get whether the Bookie is force started in read only mode or not
`boolean`	`isReadOnlyModeEnabled()` Get whether read-only mode is enabled.
`boolean`	`isStatisticsEnabled()` Is statistics enabled
`ServerConfiguration`	`setAllowLoopback(boolean allow)` Configure the bookie to allow loopback interfaces to be used as the primary bookie interface.
`void`	`setAuditorPeriodicBookieCheckInterval(long interval)` Set the interval between auditor bookie checks.
`void`	`setAuditorPeriodicCheckInterval(long interval)` Set the regularity at which the auditor will run a check of all ledgers.
`ServerConfiguration`	`setAutoRecoveryDaemonEnabled(boolean enabled)` Sets that whether the auto-recovery service can start along with Bookie server itself or not
`void`	`setBookieAuthProviderFactoryClass(String factoryClass)`
`ServerConfiguration`	`setBookiePort(int port)` Set new bookie port that bookie server listen on
`ServerConfiguration`	`setCompactionMaxOutstandingRequests(int maxOutstandingRequests)` Set the maximum number of entries which can be compacted without flushing.
`ServerConfiguration`	`setCompactionRate(int rate)` Set the rate of compaction adds.
`ServerConfiguration`	`setCompactionRateByBytes(int rate)` Set the rate of compaction adds.
`ServerConfiguration`	`setCompactionRateByEntries(int rate)` Set the rate of compaction adds.
`ServerConfiguration`	`setDiskCheckInterval(int interval)` Set the disk checker interval to monitor ledger disk space
`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`	`setDiskUsageWarnThreshold(float threshold)` Set the warning threshold for disk usage.
`ServerConfiguration`	`setEnableLocalTransport(boolean enableLocalTransport)` Configure the bookie to listen for BookKeeper clients executed on the local JVM
`ServerConfiguration`	`setEntryLogFilePreAllocationEnabled(boolean enabled)` Enable/disable entry log file preallocation.
`ServerConfiguration`	`setEntryLogSizeLimit(long logSizeLimit)` Set entry logger size limitation
`ServerConfiguration`	`setFlushInterval(int flushInterval)` Set flush interval
`ServerConfiguration`	`setForceReadOnlyBookie(boolean enabled)` Sets that whether force start a bookie in readonly mode
`ServerConfiguration`	`setGcOverreplicatedLedgerWaitTime(long gcWaitTime, TimeUnit unit)` Set wait time for garbage collection of overreplicated ledgers.
`ServerConfiguration`	`setGcWaitTime(long gcWaitTime)` Set garbage collection wait time
`ServerConfiguration`	`setIndexDirName(String[] indexDirs)` Set dir name to store index files.
`ServerConfiguration`	`setIsForceGCAllowWhenNoSpace(boolean force)` Set whether force GC is allowed when disk full or almost full.
`ServerConfiguration`	`setIsThrottleByBytes(boolean byBytes)` Set whether use bytes to throttle garbage collector compaction or not
`ServerConfiguration`	`setJournalAdaptiveGroupWrites(boolean enabled)` Enable/disable group journal force writes
`ServerConfiguration`	`setJournalAlignmentSize(int size)` Set journal alignment size.
`ServerConfiguration`	`setJournalBufferedEntriesThreshold(int maxEntries)` Set maximum entries to buffer to impose on a journal write to achieve grouping.
`ServerConfiguration`	`setJournalDirName(String journalDir)` Set dir name to store journal files
`ServerConfiguration`	`setJournalFlushWhenQueueEmpty(boolean enabled)` Set if we should flush the journal when queue is empty
`ServerConfiguration`	`setJournalFormatVersionToWrite(int version)` Set journal format version to write.
`ServerConfiguration`	`setJournalRemovePagesFromCache(boolean enabled)` Sets that whether should we remove pages from page cache after force write.
`ServerConfiguration`	`setLedgerDirNames(String[] ledgerDirs)` Set dir names to store ledger data
`ServerConfiguration`	`setLedgerStorageClass(String ledgerStorageClass)` Set the `LedgerStorage` implementation class name
`ServerConfiguration`	`setListeningInterface(String iface)` Set the network interface that the bookie should listen on.
`ServerConfiguration`	`setMajorCompactionInterval(long interval)` Set interval to run major compaction.
`ServerConfiguration`	`setMajorCompactionThreshold(double threshold)` Set threshold of major compaction.
`ServerConfiguration`	`setMaxBackupJournals(int maxBackupJournals)` Set max number of older journal files to kept
`ServerConfiguration`	`setMaxJournalSizeMB(long maxJournalSize)` Set new max journal file size
`ServerConfiguration`	`setMinorCompactionInterval(long interval)` Set interval to run minor compaction
`ServerConfiguration`	`setMinorCompactionThreshold(double threshold)` Set threshold of minor compaction
`ServerConfiguration`	`setNumAddWorkerThreads(int numThreads)` Set the number of threads that would handle write requests.
`ServerConfiguration`	`setNumJournalCallbackThreads(int numThreads)` Set the number of threads that would handle journal callbacks.
`ServerConfiguration`	`setNumReadWorkerThreads(int numThreads)` Set the number of threads that would handle read requests.
`ServerConfiguration`	`setOpenFileLimit(int fileLimit)` Set limitation of number of open files.
`void`	`setOpenLedgerRereplicationGracePeriod(String waitTime)` Set the grace period which the rereplication worker will wait before fencing and rereplicating a ledger fragment which is still being written to, on bookie failure.
`ServerConfiguration`	`setPageLimit(int pageLimit)` Set limitation number of index pages in ledger cache.
`ServerConfiguration`	`setPageSize(int pageSize)` Set page size
`ServerConfiguration`	`setReadBufferBytes(int readBufferSize)` Set the number of bytes we should use as capacity for org.apache.bookkeeper.bookie.BufferedReadChannel
`ServerConfiguration`	`setReadOnlyModeEnabled(boolean enabled)` Set whether the bookie is able to go into read-only mode.
`ServerConfiguration`	`setServerTcpNoDelay(boolean noDelay)` Set socket nodelay setting
`ServerConfiguration`	`setSkipListArenaChunkSize(int size)` Set the number of bytes w used as chunk allocation for org.apache.bookkeeper.bookie.SkipListArena
`ServerConfiguration`	`setSkipListSizeLimit(int size)` Set skip list size limit.
`ServerConfiguration`	`setSortedLedgerStorageEnabled(boolean enabled)` Deprecated. Use `setLedgerStorageClass(String)` to configure the implementation class
`ServerConfiguration`	`setStatisticsEnabled(boolean enabled)` Turn on/off statistics
`ServerConfiguration`	`setStatsProviderClass(Class<? extends org.apache.bookkeeper.stats.StatsProvider> providerClass)` Set the stats provider used by bookie.
`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`	`setWriteBufferBytes(int writeBufferBytes)` Set the number of bytes used as capacity for the write buffer.
`ServerConfiguration`	`setZkRetryBackoffMaxMs(int retryMs)` Set zookeeper client backoff retry max time in millis.
`ServerConfiguration`	`setZkRetryBackoffStartMs(int retryMs)` Set zookeeper client backoff retry start time in millis.
`ServerConfiguration`	`setZkServers(String zkServers)` Set zookeeper servers to connect
`ServerConfiguration`	`setZkTimeout(int zkTimeout)` Set zookeeper timeout
`void`	`validate()` Validate the configuration.

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
  - ENTRY_LOG_SIZE_LIMIT
```
protected static final String ENTRY_LOG_SIZE_LIMIT
```
    See Also:
    Constant Field Values
  - ENTRY_LOG_FILE_PREALLOCATION_ENABLED
```
protected static final String ENTRY_LOG_FILE_PREALLOCATION_ENABLED
```
    See Also:
    Constant Field Values
  - MINOR_COMPACTION_INTERVAL
```
protected static final String MINOR_COMPACTION_INTERVAL
```
    See Also:
    Constant Field Values
  - MINOR_COMPACTION_THRESHOLD
```
protected static final String MINOR_COMPACTION_THRESHOLD
```
    See Also:
    Constant Field Values
  - MAJOR_COMPACTION_INTERVAL
```
protected static final String MAJOR_COMPACTION_INTERVAL
```
    See Also:
    Constant Field Values
  - MAJOR_COMPACTION_THRESHOLD
```
protected static final String MAJOR_COMPACTION_THRESHOLD
```
    See Also:
    Constant Field Values
  - IS_THROTTLE_BY_BYTES
```
protected static final String IS_THROTTLE_BY_BYTES
```
    See Also:
    Constant Field Values
  - COMPACTION_MAX_OUTSTANDING_REQUESTS
```
protected static final String COMPACTION_MAX_OUTSTANDING_REQUESTS
```
    See Also:
    Constant Field Values
  - COMPACTION_RATE
```
protected static final String COMPACTION_RATE
```
    See Also:
    Constant Field Values
  - COMPACTION_RATE_BY_ENTRIES
```
protected static final String COMPACTION_RATE_BY_ENTRIES
```
    See Also:
    Constant Field Values
  - COMPACTION_RATE_BY_BYTES
```
protected static final String COMPACTION_RATE_BY_BYTES
```
    See Also:
    Constant Field Values
  - GC_WAIT_TIME
```
protected static final String GC_WAIT_TIME
```
    See Also:
    Constant Field Values
  - IS_FORCE_GC_ALLOW_WHEN_NO_SPACE
```
protected static final String IS_FORCE_GC_ALLOW_WHEN_NO_SPACE
```
    See Also:
    Constant Field Values
  - GC_OVERREPLICATED_LEDGER_WAIT_TIME
```
protected static final String GC_OVERREPLICATED_LEDGER_WAIT_TIME
```
    See Also:
    Constant Field Values
  - FLUSH_INTERVAL
```
protected static final String FLUSH_INTERVAL
```
    See Also:
    Constant Field Values
  - DEATH_WATCH_INTERVAL
```
protected static final String DEATH_WATCH_INTERVAL
```
    See Also:
    Constant Field Values
  - OPEN_FILE_LIMIT
```
protected static final String OPEN_FILE_LIMIT
```
    See Also:
    Constant Field Values
  - PAGE_LIMIT
```
protected static final String PAGE_LIMIT
```
    See Also:
    Constant Field Values
  - PAGE_SIZE
```
protected static final String PAGE_SIZE
```
    See Also:
    Constant Field Values
  - MAX_JOURNAL_SIZE
```
protected static final String MAX_JOURNAL_SIZE
```
    See Also:
    Constant Field Values
  - MAX_BACKUP_JOURNALS
```
protected static final String MAX_BACKUP_JOURNALS
```
    See Also:
    Constant Field Values
  - JOURNAL_ADAPTIVE_GROUP_WRITES
```
protected static final String JOURNAL_ADAPTIVE_GROUP_WRITES
```
    See Also:
    Constant Field Values
  - JOURNAL_MAX_GROUP_WAIT_MSEC
```
protected static final String JOURNAL_MAX_GROUP_WAIT_MSEC
```
    See Also:
    Constant Field Values
  - JOURNAL_BUFFERED_WRITES_THRESHOLD
```
protected static final String JOURNAL_BUFFERED_WRITES_THRESHOLD
```
    See Also:
    Constant Field Values
  - JOURNAL_BUFFERED_ENTRIES_THRESHOLD
```
protected static final String JOURNAL_BUFFERED_ENTRIES_THRESHOLD
```
    See Also:
    Constant Field Values
  - JOURNAL_FLUSH_WHEN_QUEUE_EMPTY
```
protected static final String JOURNAL_FLUSH_WHEN_QUEUE_EMPTY
```
    See Also:
    Constant Field Values
  - JOURNAL_REMOVE_FROM_PAGE_CACHE
```
protected static final String JOURNAL_REMOVE_FROM_PAGE_CACHE
```
    See Also:
    Constant Field Values
  - JOURNAL_PRE_ALLOC_SIZE
```
protected static final String JOURNAL_PRE_ALLOC_SIZE
```
    See Also:
    Constant Field Values
  - JOURNAL_WRITE_BUFFER_SIZE
```
protected static final String JOURNAL_WRITE_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - JOURNAL_ALIGNMENT_SIZE
```
protected static final String JOURNAL_ALIGNMENT_SIZE
```
    See Also:
    Constant Field Values
  - NUM_JOURNAL_CALLBACK_THREADS
```
protected static final String NUM_JOURNAL_CALLBACK_THREADS
```
    See Also:
    Constant Field Values
  - JOURNAL_FORMAT_VERSION_TO_WRITE
```
protected static final String JOURNAL_FORMAT_VERSION_TO_WRITE
```
    See Also:
    Constant Field Values
  - BOOKIE_PORT
```
protected static final String BOOKIE_PORT
```
    See Also:
    Constant Field Values
  - LISTENING_INTERFACE
```
protected static final String LISTENING_INTERFACE
```
    See Also:
    Constant Field Values
  - ALLOW_LOOPBACK
```
protected static final String ALLOW_LOOPBACK
```
    See Also:
    Constant Field Values
  - JOURNAL_DIR
```
protected static final String JOURNAL_DIR
```
    See Also:
    Constant Field Values
  - LEDGER_DIRS
```
protected static final String LEDGER_DIRS
```
    See Also:
    Constant Field Values
  - INDEX_DIRS
```
protected static final String INDEX_DIRS
```
    See Also:
    Constant Field Values
  - SERVER_TCP_NODELAY
```
protected static final String SERVER_TCP_NODELAY
```
    See Also:
    Constant Field Values
  - 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
  - ZK_RETRY_BACKOFF_START_MS
```
protected static final String ZK_RETRY_BACKOFF_START_MS
```
    See Also:
    Constant Field Values
  - ZK_RETRY_BACKOFF_MAX_MS
```
protected static final String ZK_RETRY_BACKOFF_MAX_MS
```
    See Also:
    Constant Field Values
  - OPEN_LEDGER_REREPLICATION_GRACE_PERIOD
```
protected static final String OPEN_LEDGER_REREPLICATION_GRACE_PERIOD
```
    See Also:
    Constant Field Values
  - READ_ONLY_MODE_ENABLED
```
protected static final String READ_ONLY_MODE_ENABLED
```
    See Also:
    Constant Field Values
  - FORCE_READ_ONLY_BOOKIE
```
protected static final String FORCE_READ_ONLY_BOOKIE
```
    See Also:
    Constant Field Values
  - DISK_USAGE_THRESHOLD
```
protected static final String DISK_USAGE_THRESHOLD
```
    See Also:
    Constant Field Values
  - DISK_USAGE_WARN_THRESHOLD
```
protected static final String DISK_USAGE_WARN_THRESHOLD
```
    See Also:
    Constant Field Values
  - DISK_CHECK_INTERVAL
```
protected static final String DISK_CHECK_INTERVAL
```
    See Also:
    Constant Field Values
  - AUDITOR_PERIODIC_CHECK_INTERVAL
```
protected static final String AUDITOR_PERIODIC_CHECK_INTERVAL
```
    See Also:
    Constant Field Values
  - AUDITOR_PERIODIC_BOOKIE_CHECK_INTERVAL
```
protected static final String AUDITOR_PERIODIC_BOOKIE_CHECK_INTERVAL
```
    See Also:
    Constant Field Values
  - AUTO_RECOVERY_DAEMON_ENABLED
```
protected static final String AUTO_RECOVERY_DAEMON_ENABLED
```
    See Also:
    Constant Field Values
  - NUM_ADD_WORKER_THREADS
```
protected static final String NUM_ADD_WORKER_THREADS
```
    See Also:
    Constant Field Values
  - NUM_READ_WORKER_THREADS
```
protected static final String NUM_READ_WORKER_THREADS
```
    See Also:
    Constant Field Values
  - READ_BUFFER_SIZE
```
protected static final String READ_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - WRITE_BUFFER_SIZE
```
protected static final String WRITE_BUFFER_SIZE
```
    See Also:
    Constant Field Values
  - USE_HOST_NAME_AS_BOOKIE_ID
```
protected static final String USE_HOST_NAME_AS_BOOKIE_ID
```
    See Also:
    Constant Field Values
  - ENABLE_LOCAL_TRANSPORT
```
protected static final String ENABLE_LOCAL_TRANSPORT
```
    See Also:
    Constant Field Values
  - SORTED_LEDGER_STORAGE_ENABLED
```
protected static final String SORTED_LEDGER_STORAGE_ENABLED
```
    See Also:
    Constant Field Values
  - SKIP_LIST_SIZE_LIMIT
```
protected static final String SKIP_LIST_SIZE_LIMIT
```
    See Also:
    Constant Field Values
  - SKIP_LIST_CHUNK_SIZE_ENTRY
```
protected static final String SKIP_LIST_CHUNK_SIZE_ENTRY
```
    See Also:
    Constant Field Values
  - SKIP_LIST_MAX_ALLOC_ENTRY
```
protected static final String SKIP_LIST_MAX_ALLOC_ENTRY
```
    See Also:
    Constant Field Values
  - ENABLE_STATISTICS
```
protected static final String ENABLE_STATISTICS
```
    See Also:
    Constant Field Values
  - STATS_PROVIDER_CLASS
```
protected static final String STATS_PROVIDER_CLASS
```
    See Also:
    Constant Field Values
  - LEDGER_STORAGE_CLASS
```
protected static final String LEDGER_STORAGE_CLASS
```
    See Also:
    Constant Field Values
  - BOOKIE_AUTH_PROVIDER_FACTORY_CLASS
```
protected static final String BOOKIE_AUTH_PROVIDER_FACTORY_CLASS
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ServerConfiguration
```
public ServerConfiguration()
```
    Construct a default configuration object
  - ServerConfiguration
```
public ServerConfiguration(AbstractConfiguration conf)
```
    Construct a configuration based on other configuration
    
    Parameters:
    conf - Other configuration
- Method Detail
  - getEntryLogSizeLimit
```
public long getEntryLogSizeLimit()
```
    Get entry logger size limitation
    
    Returns:
    entry logger size limitation
  - setEntryLogSizeLimit
```
public ServerConfiguration setEntryLogSizeLimit(long logSizeLimit)
```
    Set entry logger size limitation
    
    Parameters:
    logSizeLimit - new log size limitation
  - isEntryLogFilePreAllocationEnabled
```
public boolean isEntryLogFilePreAllocationEnabled()
```
    Is entry log file preallocation enabled.
    
    Returns:
    whether entry log file preallocation is enabled or not.
  - setEntryLogFilePreAllocationEnabled
```
public ServerConfiguration setEntryLogFilePreAllocationEnabled(boolean enabled)
```
    Enable/disable entry log file preallocation.
    
    Parameters:
    enabled - enable/disable entry log file preallocation.
    
    Returns:
    server configuration object.
  - getGcWaitTime
```
public long getGcWaitTime()
```
    Get Garbage collection wait time. Default value is 10 minutes. The guideline is not to set a too low value for this, if using zookeeper based ledger manager. And it would be nice to align with the average lifecyle time of ledgers in the system.
    
    Returns:
    gc wait time
  - setGcWaitTime
```
public ServerConfiguration setGcWaitTime(long gcWaitTime)
```
    Set garbage collection wait time
    
    Parameters:
    gcWaitTime - gc wait time
    
    Returns:
    server configuration
  - getGcOverreplicatedLedgerWaitTimeMillis
```
public long getGcOverreplicatedLedgerWaitTimeMillis()
```
    Get wait time in millis for garbage collection of overreplicated ledgers
    
    Returns:
    gc wait time
  - setGcOverreplicatedLedgerWaitTime
```
public ServerConfiguration setGcOverreplicatedLedgerWaitTime(long gcWaitTime,
                                                    TimeUnit unit)
```
    Set wait time for garbage collection of overreplicated ledgers. Default: 1 day A ledger can be overreplicated under the following circumstances: 1. The ledger with few entries has bk1 and bk2 as its ensemble. 2. bk1 crashes. 3. bk3 replicates the ledger from bk2 and updates the ensemble to bk2 and bk3. 4. bk1 comes back up. 5. Now there are 3 copies of the ledger.
    
    Parameters:
    gcWaitTime -
    
    Returns:
    server configuration
  - getFlushInterval
```
public int getFlushInterval()
```
    Get flush interval. Default value is 10 second. It isn't useful to decrease this value, since ledger storage only checkpoints when an entry logger file is rolled.
    
    Returns:
    flush interval
  - setFlushInterval
```
public ServerConfiguration setFlushInterval(int flushInterval)
```
    Set flush interval
    
    Parameters:
    flushInterval - Flush Interval
    
    Returns:
    server configuration
  - getDeathWatchInterval
```
public int getDeathWatchInterval()
```
    Get bookie death watch interval
    
    Returns:
    watch interval
  - getOpenFileLimit
```
public int getOpenFileLimit()
```
    Get open file limit. Default value is 20000.
    
    Returns:
    max number of files to open
  - setOpenFileLimit
```
public ServerConfiguration setOpenFileLimit(int fileLimit)
```
    Set limitation of number of open files.
    
    Parameters:
    fileLimit - Limitation of number of open files.
    
    Returns:
    server configuration
  - getPageLimit
```
public int getPageLimit()
```
    Get limitation number of index pages in ledger cache
    
    Returns:
    max number of index pages in ledger cache
  - setPageLimit
```
public ServerConfiguration setPageLimit(int pageLimit)
```
    Set limitation number of index pages in ledger cache.
    
    Parameters:
    pageLimit - Limitation of number of index pages in ledger cache.
    
    Returns:
    server configuration
  - getPageSize
```
public int getPageSize()
```
    Get page size
    
    Returns:
    page size in ledger cache
  - setPageSize
```
public ServerConfiguration setPageSize(int pageSize)
```
    Set page size
    
    Parameters:
    pageSize - Page Size
    
    Returns:
    Server Configuration
    See Also:
    getPageSize()
  - getMaxJournalSizeMB
```
public long getMaxJournalSizeMB()
```
    Max journal file size
    
    Returns:
    max journal file size
  - setMaxJournalSizeMB
```
public ServerConfiguration setMaxJournalSizeMB(long maxJournalSize)
```
    Set new max journal file size
    
    Parameters:
    maxJournalSize - new max journal file size
    
    Returns:
    server configuration
  - getJournalPreAllocSizeMB
```
public int getJournalPreAllocSizeMB()
```
    How much space should we pre-allocate at a time in the journal
    
    Returns:
    journal pre-allocation size in MB
  - getJournalWriteBufferSizeKB
```
public int getJournalWriteBufferSizeKB()
```
    Size of the write buffers used for the journal
    
    Returns:
    journal write buffer size in KB
  - getMaxBackupJournals
```
public int getMaxBackupJournals()
```
    Max number of older journal files kept
    
    Returns:
    max number of older journal files to kept
  - setMaxBackupJournals
```
public ServerConfiguration setMaxBackupJournals(int maxBackupJournals)
```
    Set max number of older journal files to kept
    
    Parameters:
    maxBackupJournals - Max number of older journal files
    
    Returns:
    server configuration
  - getJournalAlignmentSize
```
public int getJournalAlignmentSize()
```
    All the journal writes and commits should be aligned to given size. If not, zeros will be padded to align to given size.
    
    Returns:
    journal alignment size
  - setJournalAlignmentSize
```
public ServerConfiguration setJournalAlignmentSize(int size)
```
    Set journal alignment size.
    
    Parameters:
    size - journal alignment size.
    
    Returns:
    server configuration.
  - getJournalFormatVersionToWrite
```
public int getJournalFormatVersionToWrite()
```
    Get journal format version to write.
    
    Returns:
    journal format version to write.
  - setJournalFormatVersionToWrite
```
public ServerConfiguration setJournalFormatVersionToWrite(int version)
```
    Set journal format version to write.
    
    Parameters:
    version - journal format version to write.
    
    Returns:
    server configuration.
  - getBookiePort
```
public int getBookiePort()
```
    Get bookie port that bookie server listen on
    
    Returns:
    bookie port
  - setBookiePort
```
public ServerConfiguration setBookiePort(int port)
```
    Set new bookie port that bookie server listen on
    
    Parameters:
    port - Port to listen on
    
    Returns:
    server configuration
  - getListeningInterface
```
public String getListeningInterface()
```
    Get the network interface that the bookie should listen for connections on. If this is null, then the bookie will listen for connections on all interfaces.
    
    Returns:
    the network interface to listen on, e.g. eth0, or null if none is specified
  - setListeningInterface
```
public ServerConfiguration setListeningInterface(String iface)
```
    Set the network interface that the bookie should listen on. If not set, the bookie will listen on all interfaces.
    
    Parameters:
    iface - the interface to listen on
  - getAllowLoopback
```
public boolean getAllowLoopback()
```
    Is the bookie allowed to use a loopback interface as its primary interface(i.e. the interface it uses to establish its identity)? By default, loopback interfaces are not allowed as the primary interface. Using a loopback interface as the primary interface usually indicates a configuration error. For example, its fairly common in some VPS setups to not configure a hostname, or to have the hostname resolve to 127.0.0.1. If this is the case, then all bookies in the cluster will establish their identities as 127.0.0.1:3181, and only one will be able to join the cluster. For VPSs configured like this, you should explicitly set the listening interface.
    
    Returns:
    whether a loopback interface can be used as the primary interface
    See Also:
    setListeningInterface(String)
  - setAllowLoopback
```
public ServerConfiguration setAllowLoopback(boolean allow)
```
    Configure the bookie to allow loopback interfaces to be used as the primary bookie interface.
    
    Parameters:
    allow - whether to allow loopback interfaces
    
    Returns:
    server configuration
    See Also:
    getAllowLoopback()
  - getJournalDirName
```
public String getJournalDirName()
```
    Get dir name to store journal files
    
    Returns:
    journal dir name
  - setJournalDirName
```
public ServerConfiguration setJournalDirName(String journalDir)
```
    Set dir name to store journal files
    
    Parameters:
    journalDir - Dir to store journal files
    
    Returns:
    server configuration
  - getJournalDir
```
public File getJournalDir()
```
    Get dir to store journal files
    
    Returns:
    journal dir, if no journal dir provided return null
  - getLedgerDirNames
```
public String[] getLedgerDirNames()
```
    Get dir names to store ledger data
    
    Returns:
    ledger dir names, if not provided return null
  - setLedgerDirNames
```
public ServerConfiguration setLedgerDirNames(String[] ledgerDirs)
```
    Set dir names to store ledger data
    
    Parameters:
    ledgerDirs - Dir names to store ledger data
    
    Returns:
    server configuration
  - getLedgerDirs
```
public File[] getLedgerDirs()
```
    Get dirs that stores ledger data
    
    Returns:
    ledger dirs
  - getIndexDirNames
```
public String[] getIndexDirNames()
```
    Get dir name to store index files.
    
    Returns:
    ledger index dir name, if no index dirs provided return null
  - setIndexDirName
```
public ServerConfiguration setIndexDirName(String[] indexDirs)
```
    Set dir name to store index files.
    
    Parameters:
    indexDirs - Index dir names
    
    Returns:
    server configuration.
  - getIndexDirs
```
public File[] getIndexDirs()
```
    Get index dir to store ledger index files.
    
    Returns:
    index dirs, if no index dirs provided return null
  - getServerTcpNoDelay
```
public boolean getServerTcpNoDelay()
```
    Is tcp connection no delay.
    
    Returns:
    tcp socket nodelay setting
  - setServerTcpNoDelay
```
public ServerConfiguration setServerTcpNoDelay(boolean noDelay)
```
    Set socket nodelay setting
    
    Parameters:
    noDelay - NoDelay setting
    
    Returns:
    server configuration
  - getZkServers
```
public String getZkServers()
```
    Get zookeeper servers to connect
    
    Returns:
    zookeeper servers
  - setZkServers
```
public ServerConfiguration setZkServers(String zkServers)
```
    Set zookeeper servers to connect
    
    Parameters:
    zkServers - ZooKeeper servers to connect
  - getZkTimeout
```
public int getZkTimeout()
```
    Get zookeeper timeout
    
    Returns:
    zookeeper server timeout
  - setZkTimeout
```
public ServerConfiguration setZkTimeout(int zkTimeout)
```
    Set zookeeper timeout
    
    Parameters:
    zkTimeout - ZooKeeper server timeout
    
    Returns:
    server configuration
  - getZkRetryBackoffStartMs
```
public int getZkRetryBackoffStartMs()
```
    Get zookeeper client backoff retry start time in millis.
    
    Returns:
    zk backoff retry start time in millis.
  - setZkRetryBackoffStartMs
```
public ServerConfiguration setZkRetryBackoffStartMs(int retryMs)
```
    Set zookeeper client backoff retry start time in millis.
    
    Parameters:
    retryMs - backoff retry start time in millis.
    
    Returns:
    server configuration.
  - getZkRetryBackoffMaxMs
```
public int getZkRetryBackoffMaxMs()
```
    Get zookeeper client backoff retry max time in millis.
    
    Returns:
    zk backoff retry max time in millis.
  - setZkRetryBackoffMaxMs
```
public ServerConfiguration setZkRetryBackoffMaxMs(int retryMs)
```
    Set zookeeper client backoff retry max time in millis.
    
    Parameters:
    retryMs - backoff retry max time in millis.
    
    Returns:
    server configuration.
  - isStatisticsEnabled
```
public boolean isStatisticsEnabled()
```
    Is statistics enabled
    
    Returns:
    is statistics enabled
  - setStatisticsEnabled
```
public ServerConfiguration setStatisticsEnabled(boolean enabled)
```
    Turn on/off statistics
    
    Parameters:
    enabled - Whether statistics enabled or not.
    
    Returns:
    server configuration
  - getMinorCompactionThreshold
```
public double getMinorCompactionThreshold()
```
    Get threshold of minor compaction. For those entry log files whose remaining size percentage reaches below this threshold will be compacted in a minor compaction. If it is set to less than zero, the minor compaction is disabled.
    
    Returns:
    threshold of minor compaction
  - setMinorCompactionThreshold
```
public ServerConfiguration setMinorCompactionThreshold(double threshold)
```
    Set threshold of minor compaction
    
    Parameters:
    threshold - Threshold for minor compaction
    
    Returns:
    server configuration
    See Also:
    getMinorCompactionThreshold()
  - getMajorCompactionThreshold
```
public double getMajorCompactionThreshold()
```
    Get threshold of major compaction. For those entry log files whose remaining size percentage reaches below this threshold will be compacted in a major compaction. If it is set to less than zero, the major compaction is disabled.
    
    Returns:
    threshold of major compaction
  - setMajorCompactionThreshold
```
public ServerConfiguration setMajorCompactionThreshold(double threshold)
```
    Set threshold of major compaction.
    
    Parameters:
    threshold - Threshold of major compaction
    
    Returns:
    server configuration
    See Also:
    getMajorCompactionThreshold()
  - getMinorCompactionInterval
```
public long getMinorCompactionInterval()
```
    Get interval to run minor compaction, in seconds. If it is set to less than zero, the minor compaction is disabled.
    
    Returns:
    threshold of minor compaction
  - setMinorCompactionInterval
```
public ServerConfiguration setMinorCompactionInterval(long interval)
```
    Set interval to run minor compaction
    
    Parameters:
    interval - Interval to run minor compaction
    
    Returns:
    server configuration
    See Also:
    getMinorCompactionInterval()
  - getMajorCompactionInterval
```
public long getMajorCompactionInterval()
```
    Get interval to run major compaction, in seconds. If it is set to less than zero, the major compaction is disabled.
    
    Returns:
    high water mark
  - setMajorCompactionInterval
```
public ServerConfiguration setMajorCompactionInterval(long interval)
```
    Set interval to run major compaction.
    
    Parameters:
    interval - Interval to run major compaction
    
    Returns:
    server configuration
    See Also:
    getMajorCompactionInterval()
  - getIsForceGCAllowWhenNoSpace
```
public boolean getIsForceGCAllowWhenNoSpace()
```
    Get whether force compaction is allowed when disk full or almost full. Force GC may get some space back, but may also fill up disk space more quickly. This is because new log files are created before GC, while old garbage log files deleted after GC.
    
    Returns:
    true - do force GC when disk full, false - suspend GC when disk full.
  - setIsForceGCAllowWhenNoSpace
```
public ServerConfiguration setIsForceGCAllowWhenNoSpace(boolean force)
```
    Set whether force GC is allowed when disk full or almost full.
    
    Parameters:
    force - true to allow force GC; false to suspend GC
    
    Returns:
    ServerConfiguration
  - setOpenLedgerRereplicationGracePeriod
```
public void setOpenLedgerRereplicationGracePeriod(String waitTime)
```
    Set the grace period which the rereplication worker will wait before fencing and rereplicating a ledger fragment which is still being written to, on bookie failure. The grace period allows the writer to detect the bookie failure, and and start writing to another ledger fragment. If the writer writes nothing during the grace period, the rereplication worker assumes that it has crashed and therefore fences the ledger, preventing any further writes to that ledger.
    
    Parameters:
    waitTime - time to wait before replicating ledger fragment
    See Also:
    BookKeeper.openLedger(long, org.apache.bookkeeper.client.BookKeeper.DigestType, byte[])
  - getOpenLedgerRereplicationGracePeriod
```
public long getOpenLedgerRereplicationGracePeriod()
```
    Get the grace period which the rereplication worker to wait before fencing and rereplicating a ledger fragment which is still being written to, on bookie failure.
    
    Returns:
    long
  - getReadBufferBytes
```
public int getReadBufferBytes()
```
    Get the number of bytes we should use as capacity for org.apache.bookkeeper.bookie.BufferedReadChannel Default is 512 bytes
    
    Returns:
    read buffer size
  - setReadBufferBytes
```
public ServerConfiguration setReadBufferBytes(int readBufferSize)
```
    Set the number of bytes we should use as capacity for org.apache.bookkeeper.bookie.BufferedReadChannel
    
    Parameters:
    readBufferSize - Read Buffer Size
    
    Returns:
    server configuration
  - setNumAddWorkerThreads
```
public ServerConfiguration setNumAddWorkerThreads(int numThreads)
```
    Set the number of threads that would handle write requests.
    
    Parameters:
    numThreads - number of threads to handle write requests.
    
    Returns:
    server configuration
  - getNumAddWorkerThreads
```
public int getNumAddWorkerThreads()
```
    Get the number of threads that should handle write requests.
    
    Returns:
    the number of threads that handle write requests.
  - setNumReadWorkerThreads
```
public ServerConfiguration setNumReadWorkerThreads(int numThreads)
```
    Set the number of threads that would handle read requests.
    
    Parameters:
    numThreads - Number of threads to handle read requests.
    
    Returns:
    server configuration
  - getNumReadWorkerThreads
```
public int getNumReadWorkerThreads()
```
    Get the number of threads that should handle read requests.
  - getWriteBufferBytes
```
public int getWriteBufferBytes()
```
    Get the number of bytes used as capacity for the write buffer. Default is 64KB. NOTE: Make sure this value is greater than the maximum message size.
    
    Returns:
    the size of the write buffer in bytes
  - setWriteBufferBytes
```
public ServerConfiguration setWriteBufferBytes(int writeBufferBytes)
```
    Set the number of bytes used as capacity for the write buffer.
    
    Parameters:
    writeBufferBytes - Write Buffer Bytes
    
    Returns:
    server configuration
  - setNumJournalCallbackThreads
```
public ServerConfiguration setNumJournalCallbackThreads(int numThreads)
```
    Set the number of threads that would handle journal callbacks.
    
    Parameters:
    numThreads - number of threads to handle journal callbacks.
    
    Returns:
    server configuration
  - getNumJournalCallbackThreads
```
public int getNumJournalCallbackThreads()
```
    Get the number of threads that should handle journal callbacks.
    
    Returns:
    the number of threads that handle journal callbacks.
  - setSortedLedgerStorageEnabled
```
public ServerConfiguration setSortedLedgerStorageEnabled(boolean enabled)
```
    Deprecated. Use setLedgerStorageClass(String) to configure the implementation class
    
    Set sorted-ledger storage enabled or not
    
    Parameters:
    enabled -
  - getSortedLedgerStorageEnabled
```
public boolean getSortedLedgerStorageEnabled()
```
    Check if sorted-ledger storage enabled (default true)
    
    Returns:
    true if sorted ledger storage is enabled, false otherwise
  - getSkipListSizeLimit
```
public long getSkipListSizeLimit()
```
    Get skip list data size limitation (default 64MB)
    
    Returns:
    skip list data size limitation
  - setSkipListSizeLimit
```
public ServerConfiguration setSkipListSizeLimit(int size)
```
    Set skip list size limit.
    
    Parameters:
    size - skip list size limit.
    
    Returns:
    server configuration object.
  - getSkipListArenaChunkSize
```
public int getSkipListArenaChunkSize()
```
    Get the number of bytes we should use as chunk allocation for org.apache.bookkeeper.bookie.SkipListArena Default is 4 MB
    
    Returns:
    the number of bytes to use for each chunk in the skiplist arena
  - setSkipListArenaChunkSize
```
public ServerConfiguration setSkipListArenaChunkSize(int size)
```
    Set the number of bytes w used as chunk allocation for org.apache.bookkeeper.bookie.SkipListArena
    
    Parameters:
    size - chunk size.
    
    Returns:
    server configuration object.
  - getSkipListArenaMaxAllocSize
```
public int getSkipListArenaMaxAllocSize()
```
    Get the max size we should allocate from the skiplist arena. Allocations larger than this should be allocated directly by the VM to avoid fragmentation.
    
    Returns:
    max size allocatable from the skiplist arena (Default is 128 KB)
  - getJournalAdaptiveGroupWrites
```
public boolean getJournalAdaptiveGroupWrites()
```
    Should we group journal force writes
    
    Returns:
    group journal force writes
  - setJournalAdaptiveGroupWrites
```
public ServerConfiguration setJournalAdaptiveGroupWrites(boolean enabled)
```
    Enable/disable group journal force writes
    
    Parameters:
    enabled - flag to enable/disable group journal force writes
  - getJournalMaxGroupWaitMSec
```
public long getJournalMaxGroupWaitMSec()
```
    Maximum latency to impose on a journal write to achieve grouping. Default is 2ms.
    
    Returns:
    max wait for grouping
  - getJournalBufferedWritesThreshold
```
public long getJournalBufferedWritesThreshold()
```
    Maximum bytes to buffer to impose on a journal write to achieve grouping
    
    Returns:
    max bytes to buffer
  - getJournalBufferedEntriesThreshold
```
public long getJournalBufferedEntriesThreshold()
```
    Maximum entries to buffer to impose on a journal write to achieve grouping. Use getJournalBufferedWritesThreshold() if this is set to zero or less than zero.
    
    Returns:
    max entries to buffer.
  - setJournalBufferedEntriesThreshold
```
public ServerConfiguration setJournalBufferedEntriesThreshold(int maxEntries)
```
    Set maximum entries to buffer to impose on a journal write to achieve grouping. Use getJournalBufferedWritesThreshold() set this to zero or less than zero.
    
    Parameters:
    maxEntries - maximum entries to buffer.
    
    Returns:
    server configuration.
  - setJournalFlushWhenQueueEmpty
```
public ServerConfiguration setJournalFlushWhenQueueEmpty(boolean enabled)
```
    Set if we should flush the journal when queue is empty
  - getJournalFlushWhenQueueEmpty
```
public boolean getJournalFlushWhenQueueEmpty()
```
    Should we flush the journal when queue is empty
    
    Returns:
    flush when queue is empty
  - setReadOnlyModeEnabled
```
public ServerConfiguration setReadOnlyModeEnabled(boolean enabled)
```
    Set whether the bookie is able to go into read-only mode. If this is set to false, the bookie will shutdown on encountering an error condition.
    
    Parameters:
    enabled - whether to enable read-only mode.
    
    Returns:
    ServerConfiguration
  - isReadOnlyModeEnabled
```
public boolean isReadOnlyModeEnabled()
```
    Get whether read-only mode is enabled. The default is true.
    
    Returns:
    boolean
  - setDiskUsageWarnThreshold
```
public ServerConfiguration setDiskUsageWarnThreshold(float threshold)
```
    Set the warning threshold for disk usage.
    
    Parameters:
    threshold - warning threshold to force gc.
    
    Returns:
    ServerConfiguration
  - getDiskUsageWarnThreshold
```
public float getDiskUsageWarnThreshold()
```
    Returns the warning threshold for disk usage. If disk usage goes beyond this, a garbage collection cycle will be forced.
    
    Returns:
    the percentage at which a disk usage warning will trigger
  - setDiskUsageThreshold
```
public 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.
    
    Parameters:
    threshold - threshold to declare a disk full
    
    Returns:
    ServerConfiguration
  - getDiskUsageThreshold
```
public float getDiskUsageThreshold()
```
    Returns disk free space threshold. By default it is 0.95.
    
    Returns:
    the percentage at which a disk will be considered full
  - setDiskCheckInterval
```
public ServerConfiguration setDiskCheckInterval(int interval)
```
    Set the disk checker interval to monitor ledger disk space
    
    Parameters:
    interval - interval between disk checks for space.
    
    Returns:
    ServerConfiguration
  - getDiskCheckInterval
```
public int getDiskCheckInterval()
```
    Get the disk checker interval
    
    Returns:
    int
  - setAuditorPeriodicCheckInterval
```
public void setAuditorPeriodicCheckInterval(long interval)
```
    Set the regularity at which the auditor will run a check of all ledgers. This should not be run very often, and at most, once a day. Setting this to 0 will completely disable the periodic check.
    
    Parameters:
    interval - The interval in seconds. e.g. 86400 = 1 day, 604800 = 1 week
  - getAuditorPeriodicCheckInterval
```
public long getAuditorPeriodicCheckInterval()
```
    Get the regularity at which the auditor checks all ledgers.
    
    Returns:
    The interval in seconds. Default is 604800 (1 week).
  - setAuditorPeriodicBookieCheckInterval
```
public void setAuditorPeriodicBookieCheckInterval(long interval)
```
    Set the interval between auditor bookie checks. The auditor bookie check, checks ledger metadata to see which bookies contain entries for each ledger. If a bookie which should contain entries is unavailable, then the ledger containing that entry is marked for recovery. Setting this to 0 disabled the periodic check. Bookie checks will still run when a bookie fails.
    
    Parameters:
    interval - The period in seconds.
  - getAuditorPeriodicBookieCheckInterval
```
public long getAuditorPeriodicBookieCheckInterval()
```
    Get the interval between auditor bookie check runs.
    
    Returns:
    the interval between bookie check runs, in seconds. Default is 86400 (= 1 day)
    See Also:
    setAuditorPeriodicBookieCheckInterval(long)
  - setAutoRecoveryDaemonEnabled
```
public ServerConfiguration setAutoRecoveryDaemonEnabled(boolean enabled)
```
    Sets that whether the auto-recovery service can start along with Bookie server itself or not
    
    Parameters:
    enabled - - true if need to start auto-recovery service. Otherwise false.
    
    Returns:
    ServerConfiguration
  - isAutoRecoveryDaemonEnabled
```
public boolean isAutoRecoveryDaemonEnabled()
```
    Get whether the Bookie itself can start auto-recovery service also or not
    
    Returns:
    true - if Bookie should start auto-recovery service along with it. false otherwise.
  - setForceReadOnlyBookie
```
public ServerConfiguration setForceReadOnlyBookie(boolean enabled)
```
    Sets that whether force start a bookie in readonly mode
    
    Parameters:
    enabled - - true if need to start a bookie in read only mode. Otherwise false.
    
    Returns:
    ServerConfiguration
  - isForceReadOnlyBookie
```
public boolean isForceReadOnlyBookie()
```
    Get whether the Bookie is force started in read only mode or not
    
    Returns:
    true - if need to start a bookie in read only mode. Otherwise false.
  - getIsThrottleByBytes
```
public boolean getIsThrottleByBytes()
```
    Get whether use bytes to throttle garbage collector compaction or not
    
    Returns:
    true - use Bytes, false - use Entries.
  - setIsThrottleByBytes
```
public ServerConfiguration setIsThrottleByBytes(boolean byBytes)
```
    Set whether use bytes to throttle garbage collector compaction or not
    
    Parameters:
    byBytes - true to use by bytes; false to use by entries
    
    Returns:
    ServerConfiguration
  - getCompactionMaxOutstandingRequests
```
public int getCompactionMaxOutstandingRequests()
```
    Get the maximum number of entries which can be compacted without flushing. Default is 100,000.
    
    Returns:
    the maximum number of unflushed entries
  - setCompactionMaxOutstandingRequests
```
public ServerConfiguration setCompactionMaxOutstandingRequests(int maxOutstandingRequests)
```
    Set the maximum number of entries which can be compacted without flushing. When compacting, the entries are written to the entrylog and the new offsets are cached in memory. Once the entrylog is flushed the index is updated with the new offsets. This parameter controls the number of entries added to the entrylog before a flush is forced. A higher value for this parameter means more memory will be used for offsets. Each offset consists of 3 longs. This parameter should _not_ be modified unless you know what you're doing. The default is 100,000.
    
    Parameters:
    maxOutstandingRequests - number of entries to compact before flushing
    
    Returns:
    ServerConfiguration
  - getCompactionRate
```
@Deprecated
public int getCompactionRate()
```
    Deprecated. replaced by getCompactionRateByEntries()
    
    Get the rate of compaction adds. Default is 1,000.
    
    Returns:
    rate of compaction (adds per second)
  - setCompactionRate
```
public ServerConfiguration setCompactionRate(int rate)
```
    Set the rate of compaction adds.
    
    Parameters:
    rate - rate of compaction adds (adds entries per second)
    
    Returns:
    ServerConfiguration
  - getCompactionRateByEntries
```
public int getCompactionRateByEntries()
```
    Get the rate of compaction adds. Default is 1,000.
    
    Returns:
    rate of compaction (adds entries per second)
  - setCompactionRateByEntries
```
public ServerConfiguration setCompactionRateByEntries(int rate)
```
    Set the rate of compaction adds.
    
    Parameters:
    rate - rate of compaction adds (adds entries per second)
    
    Returns:
    ServerConfiguration
  - getCompactionRateByBytes
```
public int getCompactionRateByBytes()
```
    Get the rate of compaction adds. Default is 1,000,000.
    
    Returns:
    rate of compaction (adds bytes per second)
  - setCompactionRateByBytes
```
public ServerConfiguration setCompactionRateByBytes(int rate)
```
    Set the rate of compaction adds.
    
    Parameters:
    rate - rate of compaction adds (adds bytes per second)
    
    Returns:
    ServerConfiguration
  - getJournalRemovePagesFromCache
```
@Beta
public boolean getJournalRemovePagesFromCache()
```
    Should we remove pages from page cache after force write
    
    Returns:
    remove pages from cache
  - setJournalRemovePagesFromCache
```
public ServerConfiguration setJournalRemovePagesFromCache(boolean enabled)
```
    Sets that whether should we remove pages from page cache after force write.
    
    Parameters:
    enabled - - true if we need to remove pages from page cache. otherwise, false
    
    Returns:
    ServerConfiguration
  - getLedgerStorageClass
```
public String getLedgerStorageClass()
```
  - setLedgerStorageClass
```
public ServerConfiguration setLedgerStorageClass(String ledgerStorageClass)
```
    Set the LedgerStorage implementation class name
    
    Parameters:
    ledgerStorageClass - the class name
    
    Returns:
    ServerConfiguration
  - getUseHostNameAsBookieID
```
public boolean getUseHostNameAsBookieID()
```
    Get whether bookie is using hostname for registration and in ledger metadata. Defaults to false.
    
    Returns:
    true, then bookie will be registered with its hostname and hostname will be used in ledger metadata. Otherwise bookie will use its ipaddress
  - setUseHostNameAsBookieID
```
public ServerConfiguration setUseHostNameAsBookieID(boolean useHostName)
```
    Configure the bookie to use its hostname to register with the co-ordination service(eg: zookeeper) and in ledger metadata
    
    Parameters:
    useHostName - whether to use hostname for registration and in ledgermetadata
    
    Returns:
    server configuration
    See Also:
    getUseHostNameAsBookieID()
  - isEnableLocalTransport
```
public boolean isEnableLocalTransport()
```
    Get hwhether to use listen for local JVM clients. Defaults to false.
    
    Returns:
    true, then bookie will be listen for local JVM clients
  - setEnableLocalTransport
```
public ServerConfiguration setEnableLocalTransport(boolean enableLocalTransport)
```
    Configure the bookie to listen for BookKeeper clients executed on the local JVM
    
    Parameters:
    enableLocalTransport - whether to use listen for local JVM clients
    
    Returns:
    server configuration
    See Also:
    #getEnableLocalTransport
  - getStatsProviderClass
```
public Class<? extends org.apache.bookkeeper.stats.StatsProvider> getStatsProviderClass()
                                                                                 throws org.apache.commons.configuration.ConfigurationException
```
    Get the stats provider used by bookie.
    
    Returns:
    stats provider class
    
    Throws:
    
    org.apache.commons.configuration.ConfigurationException
  - setStatsProviderClass
```
public ServerConfiguration setStatsProviderClass(Class<? extends org.apache.bookkeeper.stats.StatsProvider> providerClass)
```
    Set the stats provider used by bookie.
    
    Parameters:
    providerClass - stats provider class
    
    Returns:
    server configuration
  - validate
```
public void validate()
              throws org.apache.commons.configuration.ConfigurationException
```
    Validate the configuration.
    
    Throws:
    
    org.apache.commons.configuration.ConfigurationException
  - setBookieAuthProviderFactoryClass
```
public void setBookieAuthProviderFactoryClass(String factoryClass)
```
  - getBookieAuthProviderFactoryClass
```
public String getBookieAuthProviderFactoryClass()
```
    Get the bookie authentication provider factory class name. If this returns null, no authentication will take place.
    
    Returns:
    the bookie authentication provider factory class name or null.

Class ServerConfiguration

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

ENTRY_LOG_SIZE_LIMIT

ENTRY_LOG_FILE_PREALLOCATION_ENABLED

MINOR_COMPACTION_INTERVAL

MINOR_COMPACTION_THRESHOLD

MAJOR_COMPACTION_INTERVAL

MAJOR_COMPACTION_THRESHOLD

IS_THROTTLE_BY_BYTES

COMPACTION_MAX_OUTSTANDING_REQUESTS

COMPACTION_RATE

COMPACTION_RATE_BY_ENTRIES

COMPACTION_RATE_BY_BYTES

GC_WAIT_TIME

IS_FORCE_GC_ALLOW_WHEN_NO_SPACE

GC_OVERREPLICATED_LEDGER_WAIT_TIME

FLUSH_INTERVAL

DEATH_WATCH_INTERVAL

OPEN_FILE_LIMIT

PAGE_LIMIT

PAGE_SIZE

MAX_JOURNAL_SIZE

MAX_BACKUP_JOURNALS

JOURNAL_ADAPTIVE_GROUP_WRITES

JOURNAL_MAX_GROUP_WAIT_MSEC

JOURNAL_BUFFERED_WRITES_THRESHOLD

JOURNAL_BUFFERED_ENTRIES_THRESHOLD

JOURNAL_FLUSH_WHEN_QUEUE_EMPTY

JOURNAL_REMOVE_FROM_PAGE_CACHE

JOURNAL_PRE_ALLOC_SIZE

JOURNAL_WRITE_BUFFER_SIZE

JOURNAL_ALIGNMENT_SIZE

NUM_JOURNAL_CALLBACK_THREADS

JOURNAL_FORMAT_VERSION_TO_WRITE

BOOKIE_PORT

LISTENING_INTERFACE

ALLOW_LOOPBACK

JOURNAL_DIR

LEDGER_DIRS

INDEX_DIRS

SERVER_TCP_NODELAY

ZK_TIMEOUT

ZK_SERVERS

ZK_RETRY_BACKOFF_START_MS

ZK_RETRY_BACKOFF_MAX_MS

OPEN_LEDGER_REREPLICATION_GRACE_PERIOD

READ_ONLY_MODE_ENABLED

FORCE_READ_ONLY_BOOKIE

DISK_USAGE_THRESHOLD

DISK_USAGE_WARN_THRESHOLD

DISK_CHECK_INTERVAL

AUDITOR_PERIODIC_CHECK_INTERVAL

AUDITOR_PERIODIC_BOOKIE_CHECK_INTERVAL

AUTO_RECOVERY_DAEMON_ENABLED

NUM_ADD_WORKER_THREADS

NUM_READ_WORKER_THREADS

READ_BUFFER_SIZE

WRITE_BUFFER_SIZE

USE_HOST_NAME_AS_BOOKIE_ID

ENABLE_LOCAL_TRANSPORT

SORTED_LEDGER_STORAGE_ENABLED

SKIP_LIST_SIZE_LIMIT

SKIP_LIST_CHUNK_SIZE_ENTRY

SKIP_LIST_MAX_ALLOC_ENTRY

ENABLE_STATISTICS

STATS_PROVIDER_CLASS

LEDGER_STORAGE_CLASS

BOOKIE_AUTH_PROVIDER_FACTORY_CLASS

Constructor Detail

ServerConfiguration