org.apache.kafka.common.config.provider.EnvVarConfigProvider

All Implemented Interfaces:: Closeable, AutoCloseable, ConfigProvider, Configurable

public class EnvVarConfigProviderextends Object implements ConfigProvider

An implementation of ConfigProvider based on environment variables. Keys correspond to the names of the environment variables, paths are currently not being used. Using an allowlist pattern ALLOWLIST_PATTERN_CONFIG that supports regular expressions, it is possible to limit access to specific environment variables. Default allowlist pattern is ".*".

Field Summary
Fields
Modifier and Type
Field
Description
static final String
ALLOWLIST_PATTERN_CONFIG

static final String
ALLOWLIST_PATTERN_CONFIG_DOC
Constructor Summary
Constructors
Constructor
Description
EnvVarConfigProvider()

EnvVarConfigProvider(Map<String,String> envVarsAsArgument)
Method Summary
Modifier and Type
Method
Description
void
close()

void
configure(Map<String,?> configs)
Configure this class with the given key-value pairs
ConfigData
get(String path)
Retrieves the data at the given path.
ConfigData
get(String path, Set<String> keys)
Retrieves the data with the given keys at the given path.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.kafka.common.config.provider.ConfigProvider
subscribe, unsubscribe, unsubscribeAll

Field Details
- ALLOWLIST_PATTERN_CONFIG
  public static final String ALLOWLIST_PATTERN_CONFIG
  See Also:
  Constant Field Values
- ALLOWLIST_PATTERN_CONFIG_DOC
  public static final String ALLOWLIST_PATTERN_CONFIG_DOC
  See Also:
  Constant Field Values
Constructor Details
- EnvVarConfigProvider
  public EnvVarConfigProvider()
- EnvVarConfigProvider
  public EnvVarConfigProvider(Map<String,String> envVarsAsArgument)
Method Details
- 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
- close
  public void close() throws IOException
  Specified by:
  close in interface AutoCloseable
  Specified by:
  close in interface Closeable
  Throws:
  IOException
- get
  public ConfigData get(String path)
  Description copied from interface: ConfigProvider
  Retrieves the data at the given path.
  Specified by:
  get in interface ConfigProvider
  Parameters:
  path - unused
  Returns:
  returns environment variables as configuration
- get
  public ConfigData get(String path, Set<String> keys)
  Description copied from interface: ConfigProvider
  Retrieves the data with the given keys at the given path.
  Specified by:
  get in interface ConfigProvider
  Parameters:
  path - path, not used for environment variables
  keys - the keys whose values will be retrieved.
  Returns:
  the configuration data.

Class EnvVarConfigProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.kafka.common.config.provider.ConfigProvider

Field Details

ALLOWLIST_PATTERN_CONFIG

ALLOWLIST_PATTERN_CONFIG_DOC

Constructor Details

EnvVarConfigProvider

EnvVarConfigProvider

Method Details

configure

close

get

get