Package org.apache.kafka.common

Interface Reconfigurable

All Superinterfaces:

Configurable

public interface Reconfigurable
extends Configurable

Interface for reconfigurable classes that support dynamic configuration.

Method Summary

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

Methods inherited from interface org.apache.kafka.common.Configurable

configure

Method Detail

reconfigurableConfigs

java.util.Set<java.lang.String> reconfigurableConfigs()

Returns the names of configs that may be reconfigured.

validateReconfiguration

void validateReconfiguration(java.util.Map<java.lang.String,?> configs)
                      throws ConfigException

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.

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

void reconfigure(java.util.Map<java.lang.String,?> configs)

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 validateReconfiguration(Map).