org.oracle.okafka.common.config

Class AbstractConfig

java.lang.Object

org.oracle.okafka.common.config.AbstractConfig

Direct Known Subclasses:

AdminClientConfig, ConsumerConfig, ProducerConfig

public class AbstractConfig
extends java.lang.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, java.util.Map<?,?> originals)
AbstractConfig(ConfigDef definition, java.util.Map<?,?> originals, boolean doLog)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Object	get(java.lang.String key)
java.lang.Boolean	getBoolean(java.lang.String key)
java.lang.Class<?>	getClass(java.lang.String key)
<T> T	getConfiguredInstance(java.lang.String key, java.lang.Class<T> t) Get a configured instance of the give class specified by the given configuration key.
<T> java.util.List<T>	getConfiguredInstances(java.util.List<java.lang.String> classNames, java.lang.Class<T> t, java.util.Map<java.lang.String,java.lang.Object> configOverrides) Get a list of configured instances of the given class specified by the given configuration key.
<T> java.util.List<T>	getConfiguredInstances(java.lang.String key, java.lang.Class<T> t) Get a list of configured instances of the given class specified by the given configuration key.
<T> java.util.List<T>	getConfiguredInstances(java.lang.String key, java.lang.Class<T> t, java.util.Map<java.lang.String,java.lang.Object> configOverrides) Get a list of configured instances of the given class specified by the given configuration key.
java.lang.Integer	getInt(java.lang.String key)
java.util.List<java.lang.String>	getList(java.lang.String key)
java.lang.Long	getLong(java.lang.String key)
java.lang.Short	getShort(java.lang.String key)
java.lang.String	getString(java.lang.String key)
int	hashCode()
void	ignore(java.lang.String key)
void	logUnused() Log warnings for any unused configurations
java.util.Map<java.lang.String,java.lang.Object>	originals()
protected java.util.Map<java.lang.String,java.lang.Object>	postProcessParsedConfig(java.util.Map<java.lang.String,java.lang.Object> parsedValues)
java.util.Set<java.lang.String>	unused()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConfig

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

AbstractConfig

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

Method Detail

get

public java.lang.Object get(java.lang.String key)

getInt

public java.lang.Integer getInt(java.lang.String key)

getLong

public java.lang.Long getLong(java.lang.String key)

getShort

public java.lang.Short getShort(java.lang.String key)

getString

public java.lang.String getString(java.lang.String key)

getClass

public java.lang.Class<?> getClass(java.lang.String key)

getList

public java.util.List<java.lang.String> getList(java.lang.String key)

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

ignore

public void ignore(java.lang.String key)

originals

public java.util.Map<java.lang.String,java.lang.Object> originals()

postProcessParsedConfig

protected java.util.Map<java.lang.String,java.lang.Object> postProcessParsedConfig(java.util.Map<java.lang.String,java.lang.Object> parsedValues)

logUnused

public void logUnused()

Log warnings for any unused configurations

unused

public java.util.Set<java.lang.String> unused()

getConfiguredInstance

public <T> T getConfiguredInstance(java.lang.String key,
                                   java.lang.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> java.util.List<T> getConfiguredInstances(java.lang.String key,
                                                    java.lang.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> java.util.List<T> getConfiguredInstances(java.lang.String key,
                                                    java.lang.Class<T> t,
                                                    java.util.Map<java.lang.String,java.lang.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

getConfiguredInstances

public <T> java.util.List<T> getConfiguredInstances(java.util.List<java.lang.String> classNames,
                                                    java.lang.Class<T> t,
                                                    java.util.Map<java.lang.String,java.lang.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:

classNames - The list of class names of the instances to create

t - The interface the class should implement

configOverrides - Configuration overrides to use.

Returns:

The list of configured instances

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object