io.apicurio.registry.utils.serde

Class JsonSchemaKafkaSerializer<T>

java.lang.Object

io.apicurio.registry.utils.serde.AbstractKafkaSerDe<S>

io.apicurio.registry.utils.serde.AbstractKafkaStrategyAwareSerDe<com.worldturner.medeia.schema.validation.SchemaValidator,S>

io.apicurio.registry.utils.serde.JsonSchemaKafkaSerDe<JsonSchemaKafkaSerializer<T>>

io.apicurio.registry.utils.serde.JsonSchemaKafkaSerializer<T>

All Implemented Interfaces:

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

public class JsonSchemaKafkaSerializer<T>
extends JsonSchemaKafkaSerDe<JsonSchemaKafkaSerializer<T>>
implements org.apache.kafka.common.serialization.Serializer<T>

An implementation of the Kafka Serializer for JSON Schema use-cases. This serializer assumes that the user's application needs to serialize a Java Bean to JSON data using Jackson. In addition to standard serialization of the bean, this implementation can also optionally validate it against a JSON schema.

Author:

eric.wittmann@gmail.com, Ales Justin

Field Summary

Fields inherited from class io.apicurio.registry.utils.serde.JsonSchemaKafkaSerDe

api, mapper

Fields inherited from class io.apicurio.registry.utils.serde.AbstractKafkaStrategyAwareSerDe

REGISTRY_ARTIFACT_ID_STRATEGY_CONFIG_PARAM, REGISTRY_GLOBAL_ID_STRATEGY_CONFIG_PARAM

Fields inherited from class io.apicurio.registry.utils.serde.AbstractKafkaSerDe

headerUtils, key, log, MAGIC_BYTE, REGISTRY_CACHED_CONFIG_PARAM, REGISTRY_CONFLUENT_ID_HANDLER_CONFIG_PARAM, REGISTRY_ID_HANDLER_CONFIG_PARAM, REGISTRY_REQUEST_HEADERS_PREFIX, REGISTRY_REQUEST_KEY_PASSWORD, REGISTRY_REQUEST_KEYSTORE_LOCATION, REGISTRY_REQUEST_KEYSTORE_PASSWORD, REGISTRY_REQUEST_KEYSTORE_TYPE, REGISTRY_REQUEST_TRUSTSTORE_LOCATION, REGISTRY_REQUEST_TRUSTSTORE_PASSWORD, REGISTRY_REQUEST_TRUSTSTORE_TYPE, REGISTRY_URL_CONFIG_PARAM, USE_HEADERS

Constructor Summary

Constructors

Constructor and Description
JsonSchemaKafkaSerializer() Constructor.
JsonSchemaKafkaSerializer(RegistryService client, Boolean validationEnabled) Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	addSchemaHeaders(org.apache.kafka.common.header.Headers headers, String artifactId, long globalId) Adds appropriate information to the Headers so that the deserializer can function properly.
protected void	addTypeHeaders(org.apache.kafka.common.header.Headers headers, T data) Adds appropriate information to the Headers so that the deserializer can function properly.
protected String	getArtifactId(String topic, T data) Figure out the artifact ID from the topic name and data.
protected long	getGlobalId(String artifactId, String topic, T data) Gets the global id of the schema to use for validation.
byte[]	serialize(String topic, org.apache.kafka.common.header.Headers headers, T data)
byte[]	serialize(String topic, T data)

Methods inherited from class io.apicurio.registry.utils.serde.JsonSchemaKafkaSerDe

configure, getSchemaCache, isValidationEnabled, setValidationEnabled

Methods inherited from class io.apicurio.registry.utils.serde.AbstractKafkaStrategyAwareSerDe

getArtifactIdStrategy, getGlobalIdStrategy, setArtifactIdStrategy, setGlobalIdStrategy

Methods inherited from class io.apicurio.registry.utils.serde.AbstractKafkaSerDe

asLegacyId, close, getByteBuffer, getClient, getIdHandler, instantiate, instantiate, isKey, loadClass, reset, self, setIdHandler, setKey, toGlobalId

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, configure

Constructor Detail

JsonSchemaKafkaSerializer

public JsonSchemaKafkaSerializer()

Constructor.

JsonSchemaKafkaSerializer

public JsonSchemaKafkaSerializer(RegistryService client,
                                 Boolean validationEnabled)

Constructor.

Parameters:

client - the client

validationEnabled - the validation enabled flag

Method Detail

serialize

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

Specified by:

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

See Also:

Serializer.serialize(java.lang.String, java.lang.Object)

serialize

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

Specified by:

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

See Also:

Serializer.serialize(java.lang.String, org.apache.kafka.common.header.Headers, java.lang.Object)

getArtifactId

protected String getArtifactId(String topic,
                               T data)

Figure out the artifact ID from the topic name and data.

Parameters:

topic - the Kafka topic

data - msg data

getGlobalId

protected long getGlobalId(String artifactId,
                           String topic,
                           T data)

Gets the global id of the schema to use for validation.

Parameters:

artifactId - artifact id

topic - the topic

data - the msg data

addSchemaHeaders

protected void addSchemaHeaders(org.apache.kafka.common.header.Headers headers,
                                String artifactId,
                                long globalId)

Adds appropriate information to the Headers so that the deserializer can function properly.

Parameters:

headers - msg headers

artifactId - artifact id

globalId - global id

addTypeHeaders

protected void addTypeHeaders(org.apache.kafka.common.header.Headers headers,
                              T data)

Adds appropriate information to the Headers so that the deserializer can function properly.

Parameters:

headers - the headers

data - the msg data