org.apache.bookkeeper.conf

Class AbstractConfiguration

java.lang.Object

org.apache.commons.configuration.event.EventSource

org.apache.commons.configuration.AbstractConfiguration

org.apache.commons.configuration.CompositeConfiguration

org.apache.bookkeeper.conf.AbstractConfiguration

All Implemented Interfaces:

Cloneable, org.apache.commons.configuration.Configuration

Direct Known Subclasses:

ClientConfiguration, ServerConfiguration

public abstract class AbstractConfiguration
extends org.apache.commons.configuration.CompositeConfiguration

Abstract configuration

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AVAILABLE_NODE
protected static int	DEFAULT_NETTY_MAX_FRAME_SIZE
protected static ClassLoader	defaultLoader
protected static String	LEDGER_MANAGER_FACTORY_CLASS
static String	LEDGER_MANAGER_FACTORY_DISABLE_CLASS_CHECK
protected static String	LEDGER_MANAGER_TYPE
(package private) static org.slf4j.Logger	LOG
protected static String	METASTORE_IMPL_CLASS
protected static String	METASTORE_MAX_ENTRIES_PER_SCAN
protected static String	NETTY_MAX_FRAME_SIZE
static String	READ_SYSTEM_PROPERTIES_PROPERTY
protected static String	REREPLICATION_ENTRY_BATCH_SIZE
protected static String	TLS_CLIENT_AUTHENTICATION
protected static String	TLS_ENABLED_CIPHER_SUITES This list will be passed to SSLEngine.setEnabledCipherSuites(java.lang.String[]).
protected static String	TLS_ENABLED_PROTOCOLS This list will be passed to SSLEngine.setEnabledProtocols(java.lang.String[]).
protected static String	TLS_PROVIDER
protected static String	TLS_PROVIDER_FACTORY_CLASS
protected static String	ZK_ENABLE_SECURITY
protected static String	ZK_LEDGERS_ROOT_PATH
protected static String	ZK_REQUEST_RATE_LIMIT

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

Modifier	Constructor and Description
protected	AbstractConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getClientAuthProviderFactoryClass() Get the client authentication provider factory class name.
Feature	getFeature(String configProperty, Feature defaultValue)
Class<? extends org.apache.bookkeeper.meta.LedgerManagerFactory>	getLedgerManagerFactoryClass() Get ledger manager factory class.
String	getLedgerManagerType() Deprecated. replaced by getLedgerManagerFactoryClass()
String	getMetastoreImplClass() Get metastore implementation class.
int	getMetastoreMaxEntriesPerScan() Get max entries per scan in metastore.
int	getNettyMaxFrameSizeBytes() Get the maximum netty frame size in bytes.
long	getRereplicationEntryBatchSize() Get the re-replication entry batch size
boolean	getTLSClientAuthentication() Whether the client will send an TLS certificate on TLS-handshake
String	getTLSEnabledCipherSuites() Get the list of enabled TLS cipher suites
String	getTLSEnabledProtocols() Get the list of enabled TLS protocols
String	getTLSProvider() Get TLS Provider (JDK or OpenSSL)
String	getTLSProviderFactoryClass() Get the security provider factory class name.
String	getZkAvailableBookiesPath() Get the node under which available bookies are stored
String	getZkLedgersRootPath() Get Zk Ledgers Root Path.
double	getZkRequestRateLimit() Get zookeeper access request rate limit.
boolean	isZkEnableSecurity() Are z-node created with strict ACLs
void	loadConf(AbstractConfiguration baseConf) You can load configuration from other configuration
void	loadConf(org.apache.commons.configuration.Configuration otherConf) Load configuration from other configuration object
void	loadConf(URL confURL) You can load configurations in precedence order.
AbstractConfiguration	setClientAuthProviderFactoryClass(String factoryClass) Set the client authentication provider factory class name.
void	setFeature(String configProperty, Feature feature)
void	setLedgerManagerFactoryClass(Class<? extends org.apache.bookkeeper.meta.LedgerManagerFactory> factoryClass) Set Ledger Manager Factory Class.
void	setLedgerManagerFactoryClassName(String factoryClassName) Set Ledger Manager Factory Class Name.
void	setLedgerManagerType(String lmType) Deprecated. replaced by setLedgerManagerFactoryClass(java.lang.Class<? extends org.apache.bookkeeper.meta.LedgerManagerFactory>)
void	setMetastoreImplClass(String metastoreImplClass) Set metastore implementation class.
void	setMetastoreMaxEntriesPerScan(int maxEntries) Set max entries per scan in metastore.
AbstractConfiguration	setNettyMaxFrameSizeBytes(int maxSize) Set the max number of bytes a single message can be that is read by the bookie.
void	setRereplicationEntryBatchSize(long rereplicationEntryBatchSize) Set the max entries to keep in fragment for re-replication.
AbstractConfiguration	setTLSClientAuthentication(boolean enabled) Specify whether the client will send an TLS certificate on TLS-handshake
AbstractConfiguration	setTLSEnabledCipherSuites(String list) Set the list of enabled TLS cipher suites.
AbstractConfiguration	setTLSEnabledProtocols(String list) Set the list of enabled TLS protocols.
AbstractConfiguration	setTLSProvider(String provider) Set TLS Provider (JDK or OpenSSL)
AbstractConfiguration	setTLSProviderFactoryClass(String factoryClass) Set the client security provider factory class name.
void	setZkEnableSecurity(boolean zkEnableSecurity) Set the usage of ACLs of new z-nodes
void	setZkLedgersRootPath(String zkLedgersPath) Set Zk Ledgers Root Path.
void	setZkRequestRateLimit(double rateLimit) Set zookeeper access request rate limit.

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

LOG

static final org.slf4j.Logger LOG

READ_SYSTEM_PROPERTIES_PROPERTY

public static final String READ_SYSTEM_PROPERTIES_PROPERTY

See Also:

Constant Field Values

defaultLoader

protected static final ClassLoader defaultLoader

LEDGER_MANAGER_TYPE

protected static final String LEDGER_MANAGER_TYPE

See Also:

Constant Field Values

LEDGER_MANAGER_FACTORY_CLASS

protected static final String LEDGER_MANAGER_FACTORY_CLASS

See Also:

Constant Field Values

ZK_LEDGERS_ROOT_PATH

protected static final String ZK_LEDGERS_ROOT_PATH

See Also:

Constant Field Values

ZK_REQUEST_RATE_LIMIT

protected static final String ZK_REQUEST_RATE_LIMIT

See Also:

Constant Field Values

AVAILABLE_NODE

protected static final String AVAILABLE_NODE

See Also:

Constant Field Values

REREPLICATION_ENTRY_BATCH_SIZE

protected static final String REREPLICATION_ENTRY_BATCH_SIZE

See Also:

Constant Field Values

METASTORE_IMPL_CLASS

protected static final String METASTORE_IMPL_CLASS

See Also:

Constant Field Values

METASTORE_MAX_ENTRIES_PER_SCAN

protected static final String METASTORE_MAX_ENTRIES_PER_SCAN

See Also:

Constant Field Values

TLS_PROVIDER

protected static final String TLS_PROVIDER

See Also:

Constant Field Values

TLS_PROVIDER_FACTORY_CLASS

protected static final String TLS_PROVIDER_FACTORY_CLASS

See Also:

Constant Field Values

TLS_CLIENT_AUTHENTICATION

protected static final String TLS_CLIENT_AUTHENTICATION

See Also:

Constant Field Values

TLS_ENABLED_CIPHER_SUITES

protected static final String TLS_ENABLED_CIPHER_SUITES

This list will be passed to SSLEngine.setEnabledCipherSuites(java.lang.String[]). Please refer to official JDK JavaDocs

See Also:

Constant Field Values

TLS_ENABLED_PROTOCOLS

protected static final String TLS_ENABLED_PROTOCOLS

This list will be passed to SSLEngine.setEnabledProtocols(java.lang.String[]). Please refer to official JDK JavaDocs

See Also:

Constant Field Values

NETTY_MAX_FRAME_SIZE

protected static final String NETTY_MAX_FRAME_SIZE

See Also:

Constant Field Values

DEFAULT_NETTY_MAX_FRAME_SIZE

protected static final int DEFAULT_NETTY_MAX_FRAME_SIZE

See Also:

Constant Field Values

ZK_ENABLE_SECURITY

protected static final String ZK_ENABLE_SECURITY

See Also:

Constant Field Values

LEDGER_MANAGER_FACTORY_DISABLE_CLASS_CHECK

public static final String LEDGER_MANAGER_FACTORY_DISABLE_CLASS_CHECK

See Also:

Constant Field Values

Constructor Detail

AbstractConfiguration

protected AbstractConfiguration()

Method Detail

loadConf

public void loadConf(URL confURL)
              throws org.apache.commons.configuration.ConfigurationException

You can load configurations in precedence order. The first one takes precedence over any loaded later.

Parameters:

confURL - Configuration URL

Throws:

org.apache.commons.configuration.ConfigurationException

loadConf

public void loadConf(AbstractConfiguration baseConf)

You can load configuration from other configuration

Parameters:

baseConf - Other Configuration

loadConf

public void loadConf(org.apache.commons.configuration.Configuration otherConf)

Load configuration from other configuration object

Parameters:

otherConf - Other configuration object

setLedgerManagerType

@Deprecated
public void setLedgerManagerType(String lmType)

Deprecated. replaced by setLedgerManagerFactoryClass(java.lang.Class<? extends org.apache.bookkeeper.meta.LedgerManagerFactory>)

Set Ledger Manager Type.

Parameters:

lmType - Ledger Manager Type

getLedgerManagerType

@Deprecated
public String getLedgerManagerType()

Deprecated. replaced by getLedgerManagerFactoryClass()

Get Ledger Manager Type.

Returns:

ledger manager type

Throws:

org.apache.commons.configuration.ConfigurationException

setLedgerManagerFactoryClassName

public void setLedgerManagerFactoryClassName(String factoryClassName)

Set Ledger Manager Factory Class Name.

Parameters:

factoryClassName - Ledger Manager Factory Class Name

setLedgerManagerFactoryClass

public void setLedgerManagerFactoryClass(Class<? extends org.apache.bookkeeper.meta.LedgerManagerFactory> factoryClass)

Set Ledger Manager Factory Class.

Parameters:

factoryClass - Ledger Manager Factory Class

getLedgerManagerFactoryClass

public Class<? extends org.apache.bookkeeper.meta.LedgerManagerFactory> getLedgerManagerFactoryClass()
                                                                                              throws org.apache.commons.configuration.ConfigurationException

Get ledger manager factory class.

Returns:

ledger manager factory class

Throws:

org.apache.commons.configuration.ConfigurationException

setZkLedgersRootPath

public void setZkLedgersRootPath(String zkLedgersPath)

Set Zk Ledgers Root Path.

Parameters:

zkLedgersPath - zk ledgers root path

getZkLedgersRootPath

public String getZkLedgersRootPath()

Get Zk Ledgers Root Path.

Returns:

zk ledgers root path

getZkRequestRateLimit

public double getZkRequestRateLimit()

Get zookeeper access request rate limit.

Returns:

zookeeper access request rate limit.

setZkRequestRateLimit

public void setZkRequestRateLimit(double rateLimit)

Set zookeeper access request rate limit.

Parameters:

rateLimit - zookeeper access request rate limit.

isZkEnableSecurity

public boolean isZkEnableSecurity()

Are z-node created with strict ACLs

Returns:

usage of secure ZooKeeper ACLs

setZkEnableSecurity

public void setZkEnableSecurity(boolean zkEnableSecurity)

Set the usage of ACLs of new z-nodes

Parameters:

zkEnableSecurity -

getZkAvailableBookiesPath

public String getZkAvailableBookiesPath()

Get the node under which available bookies are stored

Returns:

Node under which available bookies are stored.

setRereplicationEntryBatchSize

public void setRereplicationEntryBatchSize(long rereplicationEntryBatchSize)

Set the max entries to keep in fragment for re-replication. If fragment has more entries than this count, then the original fragment will be split into multiple small logical fragments by keeping max entries count to rereplicationEntryBatchSize. So, re-replication will happen in batches wise.

getRereplicationEntryBatchSize

public long getRereplicationEntryBatchSize()

Get the re-replication entry batch size

getMetastoreImplClass

public String getMetastoreImplClass()

Get metastore implementation class.

Returns:

metastore implementation class name.

setMetastoreImplClass

public void setMetastoreImplClass(String metastoreImplClass)

Set metastore implementation class.

Parameters:

metastoreImplClass - Metastore implementation Class name.

getMetastoreMaxEntriesPerScan

public int getMetastoreMaxEntriesPerScan()

Get max entries per scan in metastore.

Returns:

max entries per scan in metastore.

setMetastoreMaxEntriesPerScan

public void setMetastoreMaxEntriesPerScan(int maxEntries)

Set max entries per scan in metastore.

Parameters:

maxEntries - Max entries per scan in metastore.

setFeature

public void setFeature(String configProperty,
                       Feature feature)

getFeature

public Feature getFeature(String configProperty,
                          Feature defaultValue)

setClientAuthProviderFactoryClass

public AbstractConfiguration setClientAuthProviderFactoryClass(String factoryClass)

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

Parameters:

factoryClass - the client authentication provider factory class name

Returns:

client configuration

getClientAuthProviderFactoryClass

public String getClientAuthProviderFactoryClass()

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

Returns:

the client authentication provider factory class name or null.

getNettyMaxFrameSizeBytes

public int getNettyMaxFrameSizeBytes()

Get the maximum netty frame size in bytes. Any message received larger that this will be rejected.

Returns:

the maximum netty frame size in bytes.

setNettyMaxFrameSizeBytes

public AbstractConfiguration setNettyMaxFrameSizeBytes(int maxSize)

Set the max number of bytes a single message can be that is read by the bookie. Any message larger than that size will be rejected.

Parameters:

maxSize - the max size in bytes

Returns:

server configuration

getTLSProviderFactoryClass

public String getTLSProviderFactoryClass()

Get the security provider factory class name. If this returns null, no security will be enforced on the channel.

Returns:

the security provider factory class name or null.

setTLSProviderFactoryClass

public AbstractConfiguration setTLSProviderFactoryClass(String factoryClass)

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

Parameters:

factoryClass - the client security provider factory class name

Returns:

client configuration

getTLSProvider

public String getTLSProvider()

Get TLS Provider (JDK or OpenSSL)

Returns:

the TLS provider to use in creating TLS Context

setTLSProvider

public AbstractConfiguration setTLSProvider(String provider)

Set TLS Provider (JDK or OpenSSL)

Parameters:

provider - TLS Provider type

Returns:

Client Configuration

getTLSClientAuthentication

public boolean getTLSClientAuthentication()

Whether the client will send an TLS certificate on TLS-handshake

Returns:

whether TLS is enabled on the bookie or not.

See Also:

#setTLSAuthentication(boolean)

setTLSClientAuthentication

public AbstractConfiguration setTLSClientAuthentication(boolean enabled)

Specify whether the client will send an TLS certificate on TLS-handshake

Parameters:

enabled - Whether to send a certificate or not

Returns:

client configuration

setTLSEnabledCipherSuites

public AbstractConfiguration setTLSEnabledCipherSuites(String list)

Set the list of enabled TLS cipher suites. Leave null not to override default JDK list. This list will be passed to SSLEngine.setEnabledCipherSuites(java.lang.String[]). Please refer to official JDK JavaDocs

Parameters:

list - comma separated list of enabled TLS cipher suites

Returns:

current configuration

getTLSEnabledCipherSuites

public String getTLSEnabledCipherSuites()

Get the list of enabled TLS cipher suites

Returns:

this list of enabled TLS cipher suites

See Also:

setTLSEnabledCipherSuites(java.lang.String)

setTLSEnabledProtocols

public AbstractConfiguration setTLSEnabledProtocols(String list)

Set the list of enabled TLS protocols. Leave null not to override default JDK list. This list will be passed to SSLEngine.setEnabledProtocols(java.lang.String[]). Please refer to official JDK JavaDocs

Parameters:

list - comma separated list of enabled TLS cipher suites

Returns:

current configuration

getTLSEnabledProtocols

public String getTLSEnabledProtocols()

Get the list of enabled TLS protocols

Returns:

the list of enabled TLS protocols.

See Also:

setTLSEnabledProtocols(java.lang.String)