Package org.apache.kafka.common.config

Interface ConfigDef.Recommender

  • Enclosing class:
    ConfigDef
    public static interface ConfigDef.Recommender
    This is used by the ConfigDef.validate(Map) to get valid values for a configuration given the current configuration values in order to perform full configuration validation and visibility modification. In case that there are dependencies between configurations, the valid values and visibility for a configuration may change given the values of other configurations.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.Object> validValues​(java.lang.String name, java.util.Map<java.lang.String,​java.lang.Object> parsedConfig)
      The valid values for the configuration given the current configuration values.
      boolean visible​(java.lang.String name, java.util.Map<java.lang.String,​java.lang.Object> parsedConfig)
      Set the visibility of the configuration given the current configuration values.

    • Method Detail

      • validValues

        java.util.List<java.lang.Object> validValues​(java.lang.String name,
                                             java.util.Map<java.lang.String,​java.lang.Object> parsedConfig)
        The valid values for the configuration given the current configuration values.
        Parameters:
        name - The name of the configuration
        parsedConfig - The parsed configuration values
        Returns:
        The list of valid values. To function properly, the returned objects should have the type defined for the configuration using the recommender.

      • visible

        boolean visible​(java.lang.String name,
                java.util.Map<java.lang.String,​java.lang.Object> parsedConfig)
        Set the visibility of the configuration given the current configuration values.
        Parameters:
        name - The name of the configuration
        parsedConfig - The parsed configuration values
        Returns:
        The visibility of the configuration