io.apicurio.registry.serde.jsonschema.JsonSchemaKafkaSerializer Maven / Gradle / Ivy

Go to download
package io.apicurio.registry.serde.jsonschema;

import com.networknt.schema.JsonSchema;
import io.apicurio.registry.resolver.ParsedSchema;
import io.apicurio.registry.resolver.SchemaResolver;
import io.apicurio.registry.resolver.strategy.ArtifactReferenceResolverStrategy;
import io.apicurio.registry.rest.client.RegistryClient;
import io.apicurio.registry.serde.KafkaSerializer;
import io.apicurio.registry.serde.headers.MessageTypeSerdeHeaders;
import org.apache.kafka.common.header.Headers;

import java.io.IOException;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;

/**
 * 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.
 */
public class JsonSchemaKafkaSerializer extends KafkaSerializer {

    private MessageTypeSerdeHeaders serdeHeaders;

    public JsonSchemaKafkaSerializer() {
        super(new JsonSchemaSerializer<>());
    }

    public JsonSchemaKafkaSerializer(RegistryClient client) {
        super(new JsonSchemaSerializer<>(client));
    }

    public JsonSchemaKafkaSerializer(SchemaResolver schemaResolver) {
        super(new JsonSchemaSerializer<>(schemaResolver));
    }

    public JsonSchemaKafkaSerializer(RegistryClient client, SchemaResolver schemaResolver) {
        super(new JsonSchemaSerializer<>(client, schemaResolver));
    }

    public JsonSchemaKafkaSerializer(RegistryClient client,
            ArtifactReferenceResolverStrategy strategy,
            SchemaResolver schemaResolver) {
        super(new JsonSchemaSerializer<>(client, strategy, schemaResolver));
    }

    /**
     * @see KafkaSerializer#configure(java.util.Map, boolean)
     */
    @Override
    public void configure(Map configs, boolean isKey) {
        super.configure(configs, isKey);
        serdeHeaders = new MessageTypeSerdeHeaders(new HashMap<>(configs), isKey);
    }

    /**
     * @param validationEnabled the validationEnabled to set
     */
    public void setValidationEnabled(Boolean validationEnabled) {
        ((JsonSchemaSerializer) delegatedSerializer).setValidationEnabled(validationEnabled);
    }

    /**
     * @see KafkaSerializer#serializeData(org.apache.kafka.common.header.Headers,
     *      io.apicurio.registry.resolver.ParsedSchema, java.lang.Object, java.io.OutputStream)
     */
    @Override
    protected void serializeData(Headers headers, ParsedSchema schema, T data, OutputStream out)
            throws IOException {

        if (headers != null) {
            serdeHeaders.addMessageTypeHeader(headers, data.getClass().getName());
        }

        delegatedSerializer.serializeData(schema, data, out);
    }
}