Package io.aiven.commons.kafka.connector.common.config

Class ConnectorCommonConfigFragment

java.lang.Object
io.aiven.commons.kafka.config.fragment.ConfigFragment
io.aiven.commons.kafka.connector.common.config.ConnectorCommonConfigFragment
All Implemented Interfaces:
io.aiven.commons.kafka.config.fragment.FragmentDataAccess
public class ConnectorCommonConfigFragment extends io.aiven.commons.kafka.config.fragment.ConfigFragment
The common connector fragment.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ConnectorCommonConfigFragment.Setter
    Gets the setter for this fragment.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    RELAX_SCHEMES
    name of java property that if set allows http to be used in URLs

    Fields inherited from class io.aiven.commons.kafka.config.fragment.ConfigFragment

    dataAccess

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConnectorCommonConfigFragment(io.aiven.commons.kafka.config.fragment.FragmentDataAccess dataAccess)
    Construct the ConfigFragment.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.aiven.commons.util.io.compression.CompressionType
    getCompressionType()
    Gets the compression type expected for I/O to storage.
    String
    getKeyConverterSchemaRegistryUrl()
    Gets the key converter schema registry URL.
    String
    getSchemaRegistryUrl()
    Gets the schema registry URL.
    String
    getValueConverterSchemaRegistryUrl()
    Gets the value converter schema registry URL.
    boolean
    isKeyConverterRegistryEnabled()
    Gets the key converter schema registry enabled flag.
    boolean
    isSchemaRegistryEnabled()
    Gets the schema registry enabled flag.
    boolean
    isValueConverterRegistryEnabled()
    Gets the value converter schema registry enabled flag.
    static void
    postProcess(io.aiven.commons.kafka.config.CommonConfig.ChangeTrackingMap configMap)
    Ensure that the various URLs and enablements are set correctly.
    static ConnectorCommonConfigFragment.Setter
    setter(Map<String,String> data)
    Creates a Setter for this fragment.
    static org.apache.kafka.common.config.ConfigDef
    update(org.apache.kafka.common.config.ConfigDef configDef)
    Update the configuration definition with the properties for this fragment.
    void
    validate(Map<String,org.apache.kafka.common.config.ConfigValue> configMap)
     

    Methods inherited from class io.aiven.commons.kafka.config.fragment.ConfigFragment

    getBoolean, getConfiguredInstance, getInt, getList, getLong, getPassword, getString, has, logDeprecated, logDeprecated, logDeprecated, registerIssue, validate, validationMessage, values

    Methods inherited from class java.lang.Object

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

  • Field Details

    • RELAX_SCHEMES

      public static final String RELAX_SCHEMES
      name of java property that if set allows http to be used in URLs
      See Also:

  • Constructor Details

    • ConnectorCommonConfigFragment

      public ConnectorCommonConfigFragment(io.aiven.commons.kafka.config.fragment.FragmentDataAccess dataAccess)
      Construct the ConfigFragment.
      Parameters:
      dataAccess - the FragmentDataAccess that this fragment is associated with.

  • Method Details

    • setter

      public static ConnectorCommonConfigFragment.Setter setter(Map<String,String> data)
      Creates a Setter for this fragment.
      Parameters:
      data - the data map to modify.
      Returns:
      the Setter

    • update

      public static org.apache.kafka.common.config.ConfigDef update(org.apache.kafka.common.config.ConfigDef configDef)
      Update the configuration definition with the properties for this fragment.
      Parameters:
      configDef - the configuration definition to update.
      Returns:
      the updated configuration definition.

    • postProcess

      public static void postProcess(io.aiven.commons.kafka.config.CommonConfig.ChangeTrackingMap configMap)
      Ensure that the various URLs and enablements are set correctly.
      Parameters:
      configMap - the change tracking map to process.

    • validate

      public void validate(Map<String,org.apache.kafka.common.config.ConfigValue> configMap)
      Overrides:
      validate in class io.aiven.commons.kafka.config.fragment.ConfigFragment

    • getCompressionType

      public io.aiven.commons.util.io.compression.CompressionType getCompressionType()
      Gets the compression type expected for I/O to storage.
      Returns:
      the compression type expected for I/O to storage.

    • getSchemaRegistryUrl

      public String getSchemaRegistryUrl()
      Gets the schema registry URL.
      Returns:
      the schema registry URL. May be null

    • isSchemaRegistryEnabled

      public boolean isSchemaRegistryEnabled()
      Gets the schema registry enabled flag. If true the system should utilize the schema registry.
      Returns:
      the schema registry enabled flag.

    • getValueConverterSchemaRegistryUrl

      public String getValueConverterSchemaRegistryUrl()
      Gets the value converter schema registry URL. May be null if not set and getSchemaRegistryUrl() returns null.
      Returns:
      the value converter schema registry URL.

    • isValueConverterRegistryEnabled

      public boolean isValueConverterRegistryEnabled()
      Gets the value converter schema registry enabled flag. If true the system should utilize the value converter schema registry.
      Returns:
      the value converter schema registry enabled flag.

    • getKeyConverterSchemaRegistryUrl

      public String getKeyConverterSchemaRegistryUrl()
      Gets the key converter schema registry URL. May be null if not set and getSchemaRegistryUrl() returns null.
      Returns:
      the key converter schema registry URL.

    • isKeyConverterRegistryEnabled

      public boolean isKeyConverterRegistryEnabled()
      Gets the key converter schema registry enabled flag. If true the system should utilize the key converter schema registry.
      Returns:
      the key converter schema registry enabled flag.