ServerConfiguration (bookkeeper 4.2.3 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_PORT`
`protected static String`	`COMPACTION_MAX_OUTSTANDING_REQUESTS`
`protected static String`	`COMPACTION_RATE`
`protected static String`	`DEATH_WATCH_INTERVAL`
`protected static String`	`DISK_CHECK_INTERVAL`
`protected static String`	`DISK_USAGE_THRESHOLD`
`protected static String`	`ENABLE_STATISTICS`
`protected static String`	`ENTRY_LOG_SIZE_LIMIT`
`protected static String`	`FLUSH_INTERVAL`
`protected static String`	`GC_WAIT_TIME`
`protected static String`	`JOURNAL_DIR`
`protected static String`	`LEDGER_DIRS`
`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`	`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_ONLY_MODE_ENABLED`
`protected static String`	`SERVER_TCP_NODELAY`
`protected static String`	`ZK_SERVERS`
`protected static String`	`ZK_TIMEOUT`

Fields inherited from class org.apache.bookkeeper.conf.AbstractConfiguration
AVAILABLE_NODE, LEDGER_MANAGER_FACTORY_CLASS, LEDGER_MANAGER_TYPE, METASTORE_IMPL_CLASS, METASTORE_MAX_ENTRIES_PER_SCAN, REREPLICATION_ENTRY_BATCH_SIZE, ZK_LEDGERS_ROOT_PATH

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN

Constructor Summary

Constructors
Constructor and Description
`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.
`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()` 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.
`long`	`getEntryLogSizeLimit()` Get entry logger size limitation
`int`	`getFlushInterval()` Get flush interval
`long`	`getGcWaitTime()` Get Garbage collection wait time
`File`	`getJournalDir()` Get dir to store journal files
`String`	`getJournalDirName()` Get dir name to store journal files
`String[]`	`getLedgerDirNames()` Get dir names to store ledger data
`File[]`	`getLedgerDirs()` Get dirs that stores ledger data
`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`	`getMaxJournalSize()` Max journal file size
`long`	`getMinorCompactionInterval()` Get interval to run minor compaction, in seconds.
`double`	`getMinorCompactionThreshold()` Get threshold of minor compaction.
`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
`boolean`	`getServerTcpNoDelay()` Is tcp connection no delay.
`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`	`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
`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`	`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`	`setEntryLogSizeLimit(long logSizeLimit)` Set entry logger size limitation
`ServerConfiguration`	`setFlushInterval(int flushInterval)` Set flush interval
`ServerConfiguration`	`setGcWaitTime(long gcWaitTime)` Set garbage collection wait time
`ServerConfiguration`	`setJournalDirName(String journalDir)` Set dir name to store journal files
`ServerConfiguration`	`setLedgerDirNames(String[] ledgerDirs)` Set dir names to store ledger data
`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`	`setMaxJournalSize(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`	`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`	`setReadOnlyModeEnabled(boolean enabled)` Set whether the bookie is able to go into read-only mode.
`ServerConfiguration`	`setServerTcpNoDelay(boolean noDelay)` Set socket nodelay setting
`ServerConfiguration`	`setStatisticsEnabled(boolean enabled)` Turn on/off statistics
`ServerConfiguration`	`setZkServers(String zkServers)` Set zookeeper servers to connect
`ServerConfiguration`	`setZkTimeout(int zkTimeout)` Set zookeeper timeout

Methods inherited from class org.apache.bookkeeper.conf.AbstractConfiguration
getLedgerManagerFactoryClass, getLedgerManagerType, getMetastoreImplClass, getMetastoreMaxEntriesPerScan, getRereplicationEntryBatchSize, getZkAvailableBookiesPath, getZkLedgersRootPath, loadConf, loadConf, loadConf, setLedgerManagerFactoryClass, setLedgerManagerFactoryClassName, setLedgerManagerType, setMetastoreImplClass, setMetastoreMaxEntriesPerScan, setRereplicationEntryBatchSize, setZkLedgersRootPath

Methods inherited from class org.apache.commons.configuration.CompositeConfiguration
addConfiguration, addPropertyDirect, clear, clearPropertyDirect, clone, containsKey, getConfiguration, getInMemoryConfiguration, getKeys, getKeys, getList, getNumberOfConfigurations, getProperty, getSource, getStringArray, isEmpty, removeConfiguration, setDelimiterParsingDisabled, setListDelimiter

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration
addErrorLogListener, addProperty, append, clearProperty, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getSubstitutor, interpolate, interpolate, interpolatedConfiguration, interpolateHelper, isDelimiterParsingDisabled, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setLogger, setProperty, setThrowExceptionOnMissing, subset

Methods inherited from class org.apache.commons.configuration.event.EventSource
addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, fireEvent, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENTRY_LOG_SIZE_LIMIT
```
protected static final String ENTRY_LOG_SIZE_LIMIT
```
    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
  - 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
  - GC_WAIT_TIME
```
protected static final String GC_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
  - 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
  - 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
  - ENABLE_STATISTICS
```
protected static final String ENABLE_STATISTICS
```
    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
  - DISK_USAGE_THRESHOLD
```
protected static final String DISK_USAGE_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
- 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
  - getGcWaitTime
```
public long getGcWaitTime()
```
    Get Garbage collection wait time
    
    Returns:
    gc wait time
  - setGcWaitTime
```
public ServerConfiguration setGcWaitTime(long gcWaitTime)
```
    Set garbage collection wait time
    
    Parameters:
    gcWaitTime - gc wait time
    
    Returns:
    server configuration
  - getFlushInterval
```
public int getFlushInterval()
```
    Get flush interval
    
    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
    
    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()
  - getMaxJournalSize
```
public long getMaxJournalSize()
```
    Max journal file size
    
    Returns:
    max journal file size
  - setMaxJournalSize
```
public ServerConfiguration setMaxJournalSize(long maxJournalSize)
```
    Set new max journal file size
    
    Parameters:
    maxJournalSize - new max journal file size
    
    Returns:
    server configuration
  - 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
  - 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
  - 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
  - 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()
  - 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 start replicating the ledger fragment. If the writer writes nothing during the grace period, the rereplication worker assumes that it has crashed and 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
  - 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 false.
    
    Returns:
    boolean
  - 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:
    float
  - 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.
  - 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
```
public int getCompactionRate()
```
    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 per second)
    
    Returns:
    ServerConfiguration

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

MINOR_COMPACTION_INTERVAL

MINOR_COMPACTION_THRESHOLD

MAJOR_COMPACTION_INTERVAL

MAJOR_COMPACTION_THRESHOLD

COMPACTION_MAX_OUTSTANDING_REQUESTS

COMPACTION_RATE

GC_WAIT_TIME

FLUSH_INTERVAL

DEATH_WATCH_INTERVAL

OPEN_FILE_LIMIT

PAGE_LIMIT

PAGE_SIZE

MAX_JOURNAL_SIZE

MAX_BACKUP_JOURNALS

BOOKIE_PORT

LISTENING_INTERFACE

ALLOW_LOOPBACK

JOURNAL_DIR

LEDGER_DIRS

SERVER_TCP_NODELAY

ZK_TIMEOUT

ZK_SERVERS

ENABLE_STATISTICS

OPEN_LEDGER_REREPLICATION_GRACE_PERIOD

READ_ONLY_MODE_ENABLED

DISK_USAGE_THRESHOLD

DISK_CHECK_INTERVAL

AUDITOR_PERIODIC_CHECK_INTERVAL

AUDITOR_PERIODIC_BOOKIE_CHECK_INTERVAL

AUTO_RECOVERY_DAEMON_ENABLED

Constructor Detail

ServerConfiguration

ServerConfiguration

Method Detail

getEntryLogSizeLimit

setEntryLogSizeLimit

getGcWaitTime

setGcWaitTime

getFlushInterval

setFlushInterval

getDeathWatchInterval

getOpenFileLimit

setOpenFileLimit

getPageLimit

setPageLimit

getPageSize

setPageSize

getMaxJournalSize

setMaxJournalSize

getMaxBackupJournals

setMaxBackupJournals

getBookiePort

setBookiePort

getListeningInterface

setListeningInterface

getAllowLoopback

setAllowLoopback

getJournalDirName

setJournalDirName

getJournalDir

getLedgerDirNames

setLedgerDirNames

getLedgerDirs

getServerTcpNoDelay

setServerTcpNoDelay

getZkServers

setZkServers