io.cloudevents.kafka

Class CloudEventSerializer

java.lang.Object

io.cloudevents.kafka.CloudEventSerializer

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.kafka.common.serialization.Serializer<io.cloudevents.CloudEvent>

public class CloudEventSerializer
extends Object
implements org.apache.kafka.common.serialization.Serializer<io.cloudevents.CloudEvent>

Kafka Serializer for CloudEvent.

To configure the encoding to use when serializing the event, you can use the ENCODING_CONFIG configuration key, which accepts both a String or a variant of the enum Encoding. If you configure the Encoding as Encoding.STRUCTURED, you MUST configure the EventFormat to use with EVENT_FORMAT_CONFIG, specifying a String corresponding to the content type of the event format or specifying an instance of EventFormat.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODING_CONFIG The configuration key for the Encoding to use when serializing the event.
static String	EVENT_FORMAT_CONFIG The configuration key for the EventFormat to use when serializing the event in structured mode.

Constructor Summary

Constructors

Constructor and Description
CloudEventSerializer()

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,?> configs, boolean isKey)
byte[]	serialize(String topic, io.cloudevents.CloudEvent data)
byte[]	serialize(String topic, org.apache.kafka.common.header.Headers headers, io.cloudevents.CloudEvent data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.common.serialization.Serializer

close

Field Detail

ENCODING_CONFIG

public static final String ENCODING_CONFIG

The configuration key for the Encoding to use when serializing the event.

See Also:

Constant Field Values

EVENT_FORMAT_CONFIG

public static final String EVENT_FORMAT_CONFIG

The configuration key for the EventFormat to use when serializing the event in structured mode.

See Also:

Constant Field Values

Constructor Detail

CloudEventSerializer

public CloudEventSerializer()

Method Detail

configure

public void configure(Map<String,?> configs,
                      boolean isKey)

Specified by:

configure in interface org.apache.kafka.common.serialization.Serializer<io.cloudevents.CloudEvent>

serialize

public byte[] serialize(String topic,
                        io.cloudevents.CloudEvent data)

Specified by:

serialize in interface org.apache.kafka.common.serialization.Serializer<io.cloudevents.CloudEvent>

serialize

public byte[] serialize(String topic,
                        org.apache.kafka.common.header.Headers headers,
                        io.cloudevents.CloudEvent data)

Specified by:

serialize in interface org.apache.kafka.common.serialization.Serializer<io.cloudevents.CloudEvent>