org.apache.kafka.connect.storage

Class SimpleHeaderConverter

java.lang.Object

org.apache.kafka.connect.storage.SimpleHeaderConverter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Configurable, HeaderConverter

public class SimpleHeaderConverter
extends java.lang.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 Summary

Constructors

Constructor and Description
SimpleHeaderConverter()

Method Summary

Modifier and Type	Method and Description
void	close()
ConfigDef	config() Configuration specification for this set of header converters.
void	configure(java.util.Map<java.lang.String,?> configs) Configure this class with the given key-value pairs
byte[]	fromConnectHeader(java.lang.String topic, java.lang.String headerKey, Schema schema, java.lang.Object value) Convert the Header's value into its byte array representation.
SchemaAndValue	toConnectHeader(java.lang.String topic, java.lang.String headerKey, byte[] value) Convert the header name and byte array value into a Header object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleHeaderConverter

public SimpleHeaderConverter()

Method Detail

config

public ConfigDef config()

Description copied from interface: HeaderConverter

Configuration specification for this set of header converters.

Specified by:

config in interface HeaderConverter

Returns:

the configuration specification; may not be null

configure

public void configure(java.util.Map<java.lang.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(java.lang.String topic,
                                      java.lang.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(java.lang.String topic,
                                java.lang.String headerKey,
                                Schema schema,
                                java.lang.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 java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException