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

Class CommonConfig

java.lang.Object
org.apache.kafka.common.config.AbstractConfig
io.aiven.commons.kafka.config.CommonConfig
public class CommonConfig extends org.apache.kafka.common.config.AbstractConfig
The base configuration or all connectors.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CommonConfig.ChangeTrackingMap
    A map of values that allows overrides.

  • Field Summary

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

    AUTOMATIC_CONFIG_PROVIDERS_PROPERTY, CONFIG_PROVIDERS_CONFIG

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommonConfig(CommonConfigDef definition, Map<String,String> originals)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final void
    finalize()
    Avoid Finalizer attack
    protected void
    fragmentPostProcess(CommonConfig.ChangeTrackingMap map)
    Allows implementations to modify the values of the map from the fragments.
    Long
    getKafkaRetryBackoffMs()
    Gets the Kafka retry backoff time in MS.
    int
    getMaxTasks()
    Get the maximum number of tasks that should be run by this connector configuration Max Tasks is set within the Kafka Connect framework and so is retrieved slightly differently in ConnectorConfig.java
    int
    getTaskId()
    Get the task id for this configuration
    protected final Map<String,Object>
    postProcessParsedConfig(Map<String,Object> parsedValues)
     

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

    documentationOf, equals, get, getBoolean, getClass, getConfiguredInstance, getConfiguredInstance, getConfiguredInstances, getConfiguredInstances, getConfiguredInstances, getDouble, getInt, getList, getLong, getPassword, getShort, getString, hashCode, ignore, logUnused, nonInternalValues, originals, originals, originalsStrings, originalsWithPrefix, originalsWithPrefix, typeOf, unused, values, valuesWithPrefixAllOrNothing, valuesWithPrefixOverride

    Methods inherited from class java.lang.Object

    clone, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CommonConfig

      public CommonConfig(CommonConfigDef definition, Map<String,String> originals)
      Constructor.
      Parameters:
      definition - CommonConfigDef based definition to use.
      originals - the original property name to value map.

  • Method Details

    • finalize

      protected final void finalize()
      Avoid Finalizer attack
      Overrides:
      finalize in class Object

    • postProcessParsedConfig

      protected final Map<String,Object> postProcessParsedConfig(Map<String,Object> parsedValues)
      Overrides:
      postProcessParsedConfig in class org.apache.kafka.common.config.AbstractConfig

    • fragmentPostProcess

      protected void fragmentPostProcess(CommonConfig.ChangeTrackingMap map)
      Allows implementations to modify the values of the map from the fragments. Default implementation does nothing.
      Parameters:
      map - the map to make changes in.

    • getKafkaRetryBackoffMs

      public Long getKafkaRetryBackoffMs()
      Gets the Kafka retry backoff time in MS.
      Returns:
      The Kafka retry backoff time in MS.

    • getMaxTasks

      public int getMaxTasks()
      Get the maximum number of tasks that should be run by this connector configuration Max Tasks is set within the Kafka Connect framework and so is retrieved slightly differently in ConnectorConfig.java
      Returns:
      The maximum number of tasks that should be run by this connector configuration

    • getTaskId

      public int getTaskId()
      Get the task id for this configuration
      Returns:
      The task id for this configuration