Package org.apache.kafka.common

Class DelegatingReconfigurable

java.lang.Object

org.apache.kafka.common.DelegatingReconfigurable

All Implemented Interfaces:

Configurable, Reconfigurable

public final class DelegatingReconfigurable
extends Object
implements Reconfigurable

Constructor Summary

Constructors

Constructor	Description
DelegatingReconfigurable(Supplier<?> supplier)

Method Summary

Modifier and Type	Method	Description
void	configure(Map<String,?> configs)	Configure this class with the given key-value pairs
Set<String>	reconfigurableConfigs()	Returns the names of configs that may be reconfigured.
void	reconfigure(Map<String,?> configs)	Reconfigures this instance with the given key-value pairs.
void	validateReconfiguration(Map<String,?> configs)	Validates the provided configuration.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DelegatingReconfigurable

public DelegatingReconfigurable(Supplier<?> supplier)

Method Details

reconfigurableConfigs

public Set<String> reconfigurableConfigs()

Description copied from interface: Reconfigurable

Returns the names of configs that may be reconfigured.

Specified by:

reconfigurableConfigs in interface Reconfigurable

validateReconfiguration

public void validateReconfiguration(Map<String,?> configs)
                             throws ConfigException

Description copied from interface: Reconfigurable

Validates the provided configuration. The provided map contains all configs including any reconfigurable configs that may be different from the initial configuration. Reconfiguration will be not performed if this method throws any exception.

Specified by:

validateReconfiguration in interface Reconfigurable

Throws:

ConfigException - if the provided configs are not valid. The exception message from ConfigException will be returned to the client in the AlterConfigs response.

reconfigure

public void reconfigure(Map<String,?> configs)

Description copied from interface: Reconfigurable

Reconfigures this instance with the given key-value pairs. The provided map contains all configs including any reconfigurable configs that may have changed since the object was initially configured using Configurable.configure(Map). This method will only be invoked if the configs have passed validation using Reconfigurable.validateReconfiguration(Map).

Specified by:

reconfigure in interface Reconfigurable

configure

public void configure(Map<String,?> configs)

Description copied from interface: Configurable

Configure this class with the given key-value pairs

Specified by:

configure in interface Configurable