Package io.confluent.kafka.serializers.json

Class AbstractKafkaJsonSchemaDeserializer<T>

java.lang.Object

io.confluent.kafka.serializers.AbstractKafkaSchemaSerDe

io.confluent.kafka.serializers.json.AbstractKafkaJsonSchemaDeserializer<T>

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.kafka.common.ClusterResourceListener

Direct Known Subclasses:

KafkaJsonSchemaDeserializer

public abstract class AbstractKafkaJsonSchemaDeserializer<T>
extends AbstractKafkaSchemaSerDe

Nested Class Summary

Nested classes/interfaces inherited from class io.confluent.kafka.serializers.AbstractKafkaSchemaSerDe

AbstractKafkaSchemaSerDe.ExtendedSchema, AbstractKafkaSchemaSerDe.Migration, AbstractKafkaSchemaSerDe.SubjectSchema

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	allowedTypePackages
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected Class<T>	type
protected String	typeProperty
protected boolean	validate
protected boolean	validateBeforeDomainRules

Fields inherited from class io.confluent.kafka.serializers.AbstractKafkaSchemaSerDe

config, configOriginals, contextNameStrategy, DEFAULT_CACHE_CAPACITY, enableRuleServiceLoader, executionEnv, isKey, keySchemaIdDeserializer, keySchemaIdSerializer, keySubjectNameStrategy, latestVersions, latestWithMetadata, metadata, ruleActions, ruleExecutors, schemaRegistry, ticker, useLatestVersion, useSchemaReflection, valueSchemaIdDeserializer, valueSchemaIdSerializer, valueSubjectNameStrategy

Constructor Summary

Constructors

Constructor	Description
AbstractKafkaJsonSchemaDeserializer()

Method Summary

Modifier and Type	Method	Description
protected void	configure(KafkaJsonSchemaDeserializerConfig config, Class<T> type)	Sets properties for this deserializer without overriding the schema registry client itself.
protected Object	deserialize(boolean includeSchemaAndVersion, String topic, Boolean isKey, byte[] payload)
protected Object	deserialize(boolean includeSchemaAndVersion, String topic, Boolean isKey, org.apache.kafka.common.header.Headers headers, byte[] payload)
protected Object	deserialize(boolean includeSchemaAndVersion, String topic, Boolean key, org.apache.kafka.common.header.Headers headers, byte[] payload, Function<ParsedSchema,ParsedSchema> writerToReaderSchemaFunc)
protected T	deserialize(byte[] payload)	Deserializes the payload without including schema information for primitive types, maps, and arrays.
protected KafkaJsonSchemaDeserializerConfig	deserializerConfig(Map<String,?> props)
protected KafkaJsonSchemaDeserializerConfig	deserializerConfig(Properties props)
protected JsonSchemaAndValue	deserializeWithSchemaAndVersion(String topic, boolean isKey, org.apache.kafka.common.header.Headers headers, byte[] payload)
protected JsonSchemaAndValue	deserializeWithSchemaAndVersion(String topic, boolean isKey, org.apache.kafka.common.header.Headers headers, byte[] payload, Function<ParsedSchema,ParsedSchema> writerToReaderSchemaFunc)
com.fasterxml.jackson.databind.ObjectMapper	objectMapper()
protected com.fasterxml.jackson.databind.JsonNode	validateJson(com.fasterxml.jackson.databind.JsonNode jsonNode, ByteBuffer buffer, int start, int length, JsonSchema schema)

Methods inherited from class io.confluent.kafka.serializers.AbstractKafkaSchemaSerDe

clearKey, close, configureClientProperties, executeMigrations, executeRules, executeRules, executeRules, executeValidationRules, getById, getBySubjectAndId, getContextName, getContextName, getLatestWithMetadata, getMigrations, getOldSubjectName, getRuleActions, getRuleExecutors, getSchemaById, getSchemaBySchemaId, getSchemaBySubjectAndId, getSchemaEntityBySubjectAndId, getSchemaRegistryClient, getSubjectName, initValidationRuleExecutor, isKey, key, latestVersionsCache, latestWithMetadataCache, lookupLatestVersion, lookupLatestVersion, lookupSchemaByGuid, lookupSchemaBySubjectAndId, lookupSchemaEntityBySubjectAndId, onUpdate, postOp, register, register, register, registerWithResponse, schemaIdDeserializer, schemaIdSerializer, setKey, strategyUsesSchema, ticker, toKafkaException

Methods inherited from class java.lang.Object

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

Field Details

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

type

protected Class<T> type

typeProperty

protected String typeProperty

allowedTypePackages

protected List<String> allowedTypePackages

validate

protected boolean validate

validateBeforeDomainRules

protected boolean validateBeforeDomainRules

Constructor Details

AbstractKafkaJsonSchemaDeserializer

public AbstractKafkaJsonSchemaDeserializer()

Method Details

configure

protected void configure(KafkaJsonSchemaDeserializerConfig config,
 Class<T> type)

Sets properties for this deserializer without overriding the schema registry client itself. Useful for testing, where a mock client is injected.

deserializerConfig

protected KafkaJsonSchemaDeserializerConfig deserializerConfig(Map<String,?> props)

deserializerConfig

protected KafkaJsonSchemaDeserializerConfig deserializerConfig(Properties props)

objectMapper

public com.fasterxml.jackson.databind.ObjectMapper objectMapper()

deserialize

protected T deserialize(byte[] payload)
                 throws org.apache.kafka.common.errors.SerializationException,
org.apache.kafka.common.errors.InvalidConfigurationException

Deserializes the payload without including schema information for primitive types, maps, and arrays. Just the resulting deserialized object is returned.

This behavior is the norm for Decoders/Deserializers.

Parameters:

payload - serialized data

Returns:

the deserialized object

Throws:

org.apache.kafka.common.errors.SerializationException

org.apache.kafka.common.errors.InvalidConfigurationException

deserialize

protected Object deserialize(boolean includeSchemaAndVersion,
 String topic,
 Boolean isKey,
 byte[] payload)
                      throws org.apache.kafka.common.errors.SerializationException,
org.apache.kafka.common.errors.InvalidConfigurationException

Throws:

org.apache.kafka.common.errors.SerializationException

org.apache.kafka.common.errors.InvalidConfigurationException

deserialize

protected Object deserialize(boolean includeSchemaAndVersion,
 String topic,
 Boolean isKey,
 org.apache.kafka.common.header.Headers headers,
 byte[] payload)
                      throws org.apache.kafka.common.errors.SerializationException,
org.apache.kafka.common.errors.InvalidConfigurationException

Throws:

org.apache.kafka.common.errors.SerializationException

org.apache.kafka.common.errors.InvalidConfigurationException

deserialize

protected Object deserialize(boolean includeSchemaAndVersion,
 String topic,
 Boolean key,
 org.apache.kafka.common.header.Headers headers,
 byte[] payload,
 Function<ParsedSchema,ParsedSchema> writerToReaderSchemaFunc)
                      throws org.apache.kafka.common.errors.SerializationException,
org.apache.kafka.common.errors.InvalidConfigurationException

Throws:

org.apache.kafka.common.errors.SerializationException

org.apache.kafka.common.errors.InvalidConfigurationException

deserializeWithSchemaAndVersion

protected JsonSchemaAndValue deserializeWithSchemaAndVersion(String topic,
 boolean isKey,
 org.apache.kafka.common.header.Headers headers,
 byte[] payload)
                                                      throws org.apache.kafka.common.errors.SerializationException

Throws:

org.apache.kafka.common.errors.SerializationException

deserializeWithSchemaAndVersion

protected JsonSchemaAndValue deserializeWithSchemaAndVersion(String topic,
 boolean isKey,
 org.apache.kafka.common.header.Headers headers,
 byte[] payload,
 Function<ParsedSchema,ParsedSchema> writerToReaderSchemaFunc)
                                                      throws org.apache.kafka.common.errors.SerializationException

Throws:

org.apache.kafka.common.errors.SerializationException

validateJson

protected com.fasterxml.jackson.databind.JsonNode validateJson(com.fasterxml.jackson.databind.JsonNode jsonNode,
 ByteBuffer buffer,
 int start,
 int length,
 JsonSchema schema)
                                                        throws IOException

Throws:

IOException