org.apache.kafka.common.config

Class AbstractConfig

java.lang.Object

org.apache.kafka.common.config.AbstractConfig

Direct Known Subclasses:

AdminClientConfig, ConsumerConfig, ProducerConfig, StreamsConfig

public class AbstractConfig
extends Object

A convenient base class for configurations to extend.

This class holds both the original configuration that was provided as well as the parsed

Constructor Summary

Constructors

Constructor and Description
AbstractConfig(ConfigDef definition, Map<?,?> originals)
AbstractConfig(ConfigDef definition, Map<?,?> originals, boolean doLog)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
protected Object	get(String key)
Boolean	getBoolean(String key)
Class<?>	getClass(String key)
<T> T	getConfiguredInstance(String key, Class<T> t) Get a configured instance of the give class specified by the given configuration key.
<T> List<T>	getConfiguredInstances(String key, Class<T> t) Get a list of configured instances of the given class specified by the given configuration key.
<T> List<T>	getConfiguredInstances(String key, Class<T> t, Map<String,Object> configOverrides) Get a list of configured instances of the given class specified by the given configuration key.
Double	getDouble(String key)
Integer	getInt(String key)
List<String>	getList(String key)
Long	getLong(String key)
org.apache.kafka.common.config.types.Password	getPassword(String key)
Short	getShort(String key)
String	getString(String key)
int	hashCode()
void	ignore(String key)
void	logUnused() Log warnings for any unused configurations
Map<String,Object>	originals()
Map<String,String>	originalsStrings() Get all the original settings, ensuring that all values are of type String.
Map<String,Object>	originalsWithPrefix(String prefix) Gets all original settings with the given prefix, stripping the prefix before adding it to the output.
protected Map<String,Object>	postProcessParsedConfig(Map<String,Object> parsedValues) Called directly after user configs got parsed (and thus default values got set).
ConfigDef.Type	typeOf(String key)
Set<String>	unused()
Map<String,?>	values()
Map<String,Object>	valuesWithPrefixOverride(String prefix) Put all keys that do not start with prefix and their parsed values in the result map and then put all the remaining keys with the prefix stripped and their parsed values in the result map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractConfig

public AbstractConfig(ConfigDef definition,
                      Map<?,?> originals,
                      boolean doLog)

AbstractConfig

public AbstractConfig(ConfigDef definition,
                      Map<?,?> originals)

Method Detail

postProcessParsedConfig

protected Map<String,Object> postProcessParsedConfig(Map<String,Object> parsedValues)

Called directly after user configs got parsed (and thus default values got set). This allows to change default values for "secondary defaults" if required.

Parameters:

parsedValues - unmodifiable map of current configuration

Returns:

a map of updates that should be applied to the configuration (will be validated to prevent bad updates)

get

protected Object get(String key)

ignore

public void ignore(String key)

getShort

public Short getShort(String key)

getInt

public Integer getInt(String key)

getLong

public Long getLong(String key)

getDouble

public Double getDouble(String key)

getList

public List<String> getList(String key)

getBoolean

public Boolean getBoolean(String key)

getString

public String getString(String key)

typeOf

public ConfigDef.Type typeOf(String key)

getPassword

public org.apache.kafka.common.config.types.Password getPassword(String key)

getClass

public Class<?> getClass(String key)

unused

public Set<String> unused()

originals

public Map<String,Object> originals()

originalsStrings

public Map<String,String> originalsStrings()

Get all the original settings, ensuring that all values are of type String.

Returns:

the original settings

Throws:

ClassCastException - if any of the values are not strings

originalsWithPrefix

public Map<String,Object> originalsWithPrefix(String prefix)

Gets all original settings with the given prefix, stripping the prefix before adding it to the output.

Parameters:

prefix - the prefix to use as a filter

Returns:

a Map containing the settings with the prefix

valuesWithPrefixOverride

public Map<String,Object> valuesWithPrefixOverride(String prefix)

Put all keys that do not start with prefix and their parsed values in the result map and then put all the remaining keys with the prefix stripped and their parsed values in the result map. This is useful if one wants to allow prefixed configs to override default ones.

values

public Map<String,?> values()

logUnused

public void logUnused()

Log warnings for any unused configurations

getConfiguredInstance

public <T> T getConfiguredInstance(String key,
                                   Class<T> t)

Get a configured instance of the give class specified by the given configuration key. If the object implements Configurable configure it using the configuration.

Parameters:

key - The configuration key for the class

t - The interface the class should implement

Returns:

A configured instance of the class

getConfiguredInstances

public <T> List<T> getConfiguredInstances(String key,
                                          Class<T> t)

Get a list of configured instances of the given class specified by the given configuration key. The configuration may specify either null or an empty string to indicate no configured instances. In both cases, this method returns an empty list to indicate no configured instances.

Parameters:

key - The configuration key for the class

t - The interface the class should implement

Returns:

The list of configured instances

getConfiguredInstances

public <T> List<T> getConfiguredInstances(String key,
                                          Class<T> t,
                                          Map<String,Object> configOverrides)

Get a list of configured instances of the given class specified by the given configuration key. The configuration may specify either null or an empty string to indicate no configured instances. In both cases, this method returns an empty list to indicate no configured instances.

Parameters:

key - The configuration key for the class

t - The interface the class should implement

configOverrides - Configuration overrides to use.

Returns:

The list of configured instances

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object