Class SimpleHeaderConverter

java.lang.Object
org.apache.kafka.connect.storage.SimpleHeaderConverter
All Implemented Interfaces:
Closeable, AutoCloseable, Configurable, ConnectPlugin, Versioned, HeaderConverter
public class SimpleHeaderConverter extends Object implements HeaderConverter
A HeaderConverter that serializes header values as strings and that deserializes header values to the most appropriate numeric, boolean, array, or map representation. Schemas are not serialized, but are inferred upon deserialization when possible.

  • Constructor Details

    • SimpleHeaderConverter

      public SimpleHeaderConverter()

  • Method Details

    • version

      public String version()
      Description copied from interface: HeaderConverter
      Get the version of this component.
      Specified by:
      version in interface HeaderConverter
      Specified by:
      version in interface Versioned
      Returns:
      the version, formatted as a String. The version may not be null or empty.

    • config

      public ConfigDef config()
      Description copied from interface: ConnectPlugin
      Returns the configuration specification for this component.

      The returned ConfigDef object describes all configuration properties that this component accepts, including their types, default values, validators, importance levels, and documentation strings.

      Specified by:
      config in interface ConnectPlugin
      Returns:
      the configuration definition for this component; never null

    • configure

      public void configure(Map<String,?> configs)
      Description copied from interface: Configurable
      Configure this class with the given key-value pairs
      Specified by:
      configure in interface Configurable

    • toConnectHeader

      public SchemaAndValue toConnectHeader(String topic, String headerKey, byte[] value)
      Description copied from interface: HeaderConverter
      Convert the header name and byte array value into a Header object.
      Specified by:
      toConnectHeader in interface HeaderConverter
      Parameters:
      topic - the name of the topic for the record containing the header
      headerKey - the header's key; may not be null
      value - the header's raw value; may be null
      Returns:
      the SchemaAndValue; may not be null

    • fromConnectHeader

      public byte[] fromConnectHeader(String topic, String headerKey, Schema schema, Object value)
      Description copied from interface: HeaderConverter
      Convert the Header's value into its byte array representation.
      Specified by:
      fromConnectHeader in interface HeaderConverter
      Parameters:
      topic - the name of the topic for the record containing the header
      headerKey - the header's key; may not be null
      schema - the schema for the header's value; may be null
      value - the header's value to convert; may be null
      Returns:
      the byte array form of the Header's value; may be null if the value is null

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException