com.microsoft.azure.schemaregistry.kafka.avro

Class KafkaAvroSerializer<T>

java.lang.Object

com.microsoft.azure.schemaregistry.kafka.avro.KafkaAvroSerializer<T>

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.kafka.common.serialization.Serializer<T>

public class KafkaAvroSerializer<T>
extends Object
implements org.apache.kafka.common.serialization.Serializer<T>

Serializer implementation for Kafka producer, implementing the Kafka Serializer interface. Objects are converted to byte arrays containing an Avro-encoded payload and is prefixed with a GUID pointing to the matching Avro schema in Azure Schema Registry. Currently, sending Avro GenericRecords and SpecificRecords is supported. Avro reflection has been disabled.

See Also:

See deserializer class for downstream deserializer implementation

Constructor Summary

Constructors

Constructor and Description
KafkaAvroSerializer() Empty constructor for Kafka producer

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(Map<String,?> props, boolean isKey) Configures serializer instance.
byte[]	serialize(String topic, org.apache.kafka.common.header.Headers headers, T record) Serializes GenericRecord or SpecificRecord into a byte array, containing a GUID reference to schema and the encoded payload.
byte[]	serialize(String topic, T record) Serializes GenericRecord or SpecificRecord into a byte array, containing a GUID reference to schema and the encoded payload.

Methods inherited from class java.lang.Object

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

Constructor Detail

KafkaAvroSerializer

public KafkaAvroSerializer()

Empty constructor for Kafka producer

Method Detail

configure

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

Configures serializer instance.

Specified by:

configure in interface org.apache.kafka.common.serialization.Serializer<T>

Parameters:

props - Map of properties used to configure instance.

isKey - Indicates if serializing record key or value. Required by Kafka serializer interface, no specific functionality implemented for key use.

See Also:

Serializer will use configs found in KafkaAvroSerializerConfig.

serialize

public byte[] serialize(String topic,
                        T record)

Serializes GenericRecord or SpecificRecord into a byte array, containing a GUID reference to schema and the encoded payload. Null behavior matches Kafka treatment of null values.

Specified by:

serialize in interface org.apache.kafka.common.serialization.Serializer<T>

Parameters:

topic - Topic destination for record. Required by Kafka serializer interface, currently not used.

record - Object to be serialized, may be null

Returns:

byte[] payload for sending to EH Kafka service, may be null

Throws:

org.apache.kafka.common.errors.SerializationException - Exception catchable by core Kafka producer code

serialize

public byte[] serialize(String topic,
                        org.apache.kafka.common.header.Headers headers,
                        T record)

Serializes GenericRecord or SpecificRecord into a byte array, containing a GUID reference to schema and the encoded payload. Null behavior matches Kafka treatment of null values.

Specified by:

serialize in interface org.apache.kafka.common.serialization.Serializer<T>

Parameters:

topic - Topic destination for record. Required by Kafka serializer interface, currently not used.

record - Object to be serialized, may be null

headers - Record headers, may be null

Returns:

byte[] payload for sending to EH Kafka service, may be null

Throws:

org.apache.kafka.common.errors.SerializationException - Exception catchable by core Kafka producer code

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.kafka.common.serialization.Serializer<T>