Package io.aiven.kafka.connect.common.config

Class ConfigFragment

java.lang.Object
io.aiven.kafka.connect.common.config.ConfigFragment
Direct Known Subclasses:
BackoffPolicyConfig, CompressionFragment, FileNameFragment, OutputFormatFragment, SourceConfigFragment, TransformerFragment
public class ConfigFragment extends Object
Config fragments encapsulate logical fragments of configuration that may be used across multiple Connectors or across the source/sink of a connector pair. All implementing classes should be final. All configuration keys should be specified as static final String within the fragment. They should be package private so that test code can use them. All implementing classes must implement a public static ConfigDef update(final ConfigDef configDef) method, though more arguments are allowed. The method must add the defintions for the configuration options the fragment supports to the configDef parameter and return it. Access to the configuraiton within the fragment is via the cfg property. All access to configuration values should be through methods. For example if the string value of the "foo" config options should be returned then the method { @code public String getFoo() } should be created. All complex access to configuration values should be encapsulated within methods. For example if the Baz object requires the "foo" and "bar" values then something like public Baz getBaz() { return new Baz(getFoo(), cfg.getString("bar")); } should be created. Any fragment depends on another fragment may create it inline and use it. The validate() method may call the validate methods on the dependant fragments during validation.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.apache.kafka.common.config.AbstractConfig
    cfg
    The configuration that this fragment is associated with

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    ConfigFragment(org.apache.kafka.common.config.AbstractConfig cfg)
    Construct the ConfigFragment..

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    has(String key)
    Determines if a key has been set.
    void
    validate()
    Validate that the data in the configuration matches any restrictions.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • cfg

      protected final org.apache.kafka.common.config.AbstractConfig cfg
      The configuration that this fragment is associated with

  • Constructor Details

    • ConfigFragment

      protected ConfigFragment(org.apache.kafka.common.config.AbstractConfig cfg)
      Construct the ConfigFragment..
      Parameters:
      cfg - the configuration that this fragment is associated with.

  • Method Details

    • validate

      public void validate()
      Validate that the data in the configuration matches any restrictions. Default implementation does nothing.

    • has

      public final boolean has(String key)
      Determines if a key has been set.
      Parameters:
      key - The key to check.
      Returns:
      true if the key was set, false if the key was not set or does not exist in the config.