Module io.aiven.commons.kafka.config
Package io.aiven.commons.kafka.config

Class CommonConfigDef

java.lang.Object
org.apache.kafka.common.config.ConfigDef
io.aiven.commons.kafka.config.CommonConfigDef
public class CommonConfigDef extends org.apache.kafka.common.config.ConfigDef
The ConfigDef for the CommonConfig class.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.apache.kafka.common.config.ConfigDef

    org.apache.kafka.common.config.ConfigDef.CaseInsensitiveValidString, org.apache.kafka.common.config.ConfigDef.CompositeValidator, org.apache.kafka.common.config.ConfigDef.ConfigKey, org.apache.kafka.common.config.ConfigDef.Importance, org.apache.kafka.common.config.ConfigDef.LambdaValidator, org.apache.kafka.common.config.ConfigDef.ListSize, org.apache.kafka.common.config.ConfigDef.NonEmptyString, org.apache.kafka.common.config.ConfigDef.NonEmptyStringWithoutControlChars, org.apache.kafka.common.config.ConfigDef.NonNullValidator, org.apache.kafka.common.config.ConfigDef.Range, org.apache.kafka.common.config.ConfigDef.Recommender, org.apache.kafka.common.config.ConfigDef.Type, org.apache.kafka.common.config.ConfigDef.Validator, org.apache.kafka.common.config.ConfigDef.ValidList, org.apache.kafka.common.config.ConfigDef.ValidString, org.apache.kafka.common.config.ConfigDef.Width

  • Field Summary

    Fields inherited from class org.apache.kafka.common.config.ConfigDef

    NO_DEFAULT_VALUE

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommonConfigDef()
    Constructor .

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    hide(String key, boolean state)
    Allows users to toggle certain config on and off in the documentation
    protected Map<String,org.apache.kafka.common.config.ConfigValue>
    multiValidate(Map<String,org.apache.kafka.common.config.ConfigValue> valueMap)
    Gathers in depth, multi argument configuration issues.
    final List<org.apache.kafka.common.config.ConfigValue>
    validate(Map<String,String> props)
     

    Methods inherited from class org.apache.kafka.common.config.ConfigDef

    configKeys, convertToString, convertToStringMapWithPasswordValues, defaultValues, define, define, define, define, define, define, define, define, define, define, define, define, define, define, define, define, define, define, defineInternal, defineInternal, embed, getConfigValue, groups, headers, names, parse, parseType, toEnrichedRst, toHtml, toHtml, toHtml, toHtml, toHtmlTable, toHtmlTable, toRst, validateAll, withClientSaslSupport, withClientSslSupport

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CommonConfigDef

      public CommonConfigDef()
      Constructor .

  • Method Details

    • multiValidate

      protected Map<String,org.apache.kafka.common.config.ConfigValue> multiValidate(Map<String,org.apache.kafka.common.config.ConfigValue> valueMap)
      Gathers in depth, multi argument configuration issues. This method should be overridden when the Fragments added to the config have validation rules that required inspection of multiple properties.

      Overriding methods should call the parent method to update the map and then add error messages to the ConfigValue associated with property name that is in error.

      Parameters:
      valueMap - the map of configuration names to values.
      Returns:
      the updated map.

    • hide

      protected void hide(String key, boolean state)
      Allows users to toggle certain config on and off in the documentation
      Parameters:
      key - The config key that you want to toggle hidden or unhidden in the documentation
      state - true hides the key from documentation false shows the config in the documentation

    • validate

      public final List<org.apache.kafka.common.config.ConfigValue> validate(Map<String,String> props)
      Overrides:
      validate in class org.apache.kafka.common.config.ConfigDef