Package io.confluent.kafka.serializers

Class AbstractKafkaSchemaSerDe

java.lang.Object

io.confluent.kafka.serializers.AbstractKafkaSchemaSerDe

All Implemented Interfaces:

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

public abstract class AbstractKafkaSchemaSerDe
extends Object
implements org.apache.kafka.common.ClusterResourceListener, Closeable, org.apache.kafka.common.metrics.Monitorable

Common fields and helper methods for both the serializer and the deserializer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractKafkaSchemaSerDe.ExtendedSchema
protected static class	AbstractKafkaSchemaSerDe.Migration
protected static class	AbstractKafkaSchemaSerDe.SubjectSchema

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractKafkaSchemaSerDeConfig	config
protected Map<String,Object>	configOriginals
protected ContextNameStrategy	contextNameStrategy
protected static final int	DEFAULT_CACHE_CAPACITY
protected boolean	enableRuleServiceLoader
protected ExecutionEnvironment	executionEnv
protected boolean	isKey
protected SchemaIdDeserializer	keySchemaIdDeserializer
protected SchemaIdSerializer	keySchemaIdSerializer
protected SubjectNameStrategy	keySubjectNameStrategy
protected com.google.common.cache.Cache<AbstractKafkaSchemaSerDe.SubjectSchema,AbstractKafkaSchemaSerDe.ExtendedSchema>	latestVersions
protected com.google.common.cache.Cache<String,AbstractKafkaSchemaSerDe.ExtendedSchema>	latestWithMetadata
protected Map<String,String>	metadata
protected Map<String,Map<String,RuleBase>>	ruleActions
protected Map<String,Map<String,RuleBase>>	ruleExecutors
protected SchemaRegistryClient	schemaRegistry
protected com.google.common.base.Ticker	ticker
protected boolean	useLatestVersion
protected boolean	useSchemaReflection
protected SchemaIdDeserializer	valueSchemaIdDeserializer
protected SchemaIdSerializer	valueSchemaIdSerializer
protected SubjectNameStrategy	valueSubjectNameStrategy

Constructor Summary

Constructors

Constructor	Description
AbstractKafkaSchemaSerDe()

Method Summary

Modifier and Type	Method	Description
static void	clearKey()
void	close()
protected void	configureClientProperties(AbstractKafkaSchemaSerDeConfig config, SchemaProvider provider)
protected Object	executeMigrations(List<AbstractKafkaSchemaSerDe.Migration> migrations, String subject, String topic, org.apache.kafka.common.header.Headers headers, Object message)
protected Object	executeRules(String subject, String topic, org.apache.kafka.common.header.Headers headers, RuleMode ruleMode, ParsedSchema source, ParsedSchema target, Object message)
protected Object	executeRules(String subject, String topic, org.apache.kafka.common.header.Headers headers, Object original, RuleMode ruleMode, ParsedSchema source, ParsedSchema target, Object message)
protected Object	executeRules(String subject, String topic, org.apache.kafka.common.header.Headers headers, Object original, RulePhase rulePhase, RuleMode ruleMode, ParsedSchema source, ParsedSchema target, Object message)
protected Object	executeRules(String subject, String topic, org.apache.kafka.common.header.Headers headers, Object original, RulePhase rulePhase, RuleMode ruleMode, ParsedSchema source, ParsedSchema target, Object message, List<RuleResult> ruleResults)
protected Object	executeValidationRules(String subject, String topic, org.apache.kafka.common.header.Headers headers, ParsedSchema schema, Object message)
org.apache.avro.Schema	getById(int id)	Deprecated.
org.apache.avro.Schema	getBySubjectAndId(String subject, int id)	Deprecated.
protected String	getContextName(String topic)
protected String	getContextName(String topic, String subject)
protected AbstractKafkaSchemaSerDe.ExtendedSchema	getLatestWithMetadata(String subject)
protected List<AbstractKafkaSchemaSerDe.Migration>	getMigrations(String subject, ParsedSchema writerSchema, ParsedSchema readerSchema)
protected String	getOldSubjectName(Object value)	Get the subject name used by the old Encoder interface, which relies only on the value type rather than the topic.
Map<String,Map<String,RuleBase>>	getRuleActions()
Map<String,Map<String,RuleBase>>	getRuleExecutors()
ParsedSchema	getSchemaById(int id)
protected ParsedSchema	getSchemaBySchemaId(String subject, SchemaId schemaId)
ParsedSchema	getSchemaBySubjectAndId(String subject, int id)
Schema	getSchemaEntityBySubjectAndId(String subject, int id)
SchemaRegistryClient	getSchemaRegistryClient()
protected String	getSubjectName(String topic, boolean isKey, Object value, ParsedSchema schema)	Get the subject name for the given topic and value type.
protected void	initValidationRuleExecutor()	Eagerly load and cache the validation rule executor — call from a format-specific configure() when validation.rules.execution is not DISABLED so that a missing dependency surfaces at serializer construction time rather than at the first record.
boolean	isKey()
static Object	key()
protected Map<AbstractKafkaSchemaSerDe.SubjectSchema,AbstractKafkaSchemaSerDe.ExtendedSchema>	latestVersionsCache()
protected Map<String,AbstractKafkaSchemaSerDe.ExtendedSchema>	latestWithMetadataCache()
protected static AbstractKafkaSchemaSerDe.ExtendedSchema	lookupLatestVersion(SchemaRegistryClient schemaRegistry, String subject, ParsedSchema schema, Map<AbstractKafkaSchemaSerDe.SubjectSchema,AbstractKafkaSchemaSerDe.ExtendedSchema> cache, boolean latestCompatStrict)
protected AbstractKafkaSchemaSerDe.ExtendedSchema	lookupLatestVersion(String subject, ParsedSchema schema, boolean latestCompatStrict)
protected ParsedSchema	lookupSchemaByGuid(String guid, ParsedSchema schema, boolean idCompatStrict)
protected ParsedSchema	lookupSchemaBySubjectAndId(String subject, int id, ParsedSchema schema, boolean idCompatStrict)	Deprecated.
protected Schema	lookupSchemaEntityBySubjectAndId(String subject, int id, ParsedSchema schema, boolean idCompatStrict)
void	onUpdate(org.apache.kafka.common.ClusterResource clusterResource)
protected void	postOp(Object payload)
int	register(String subject, ParsedSchema schema)
int	register(String subject, ParsedSchema schema, boolean normalize)
int	register(String subject, org.apache.avro.Schema schema)	Deprecated.
protected Schema	registerWithResponse(String subject, ParsedSchema schema, boolean normalize, boolean propagateSchemaTags)
protected SchemaIdDeserializer	schemaIdDeserializer(boolean isKey)
protected SchemaIdSerializer	schemaIdSerializer(boolean isKey)
static void	setKey(Object obj)
protected boolean	strategyUsesSchema(boolean isKey)
protected com.google.common.base.Ticker	ticker(SchemaRegistryClient client)
protected static org.apache.kafka.common.KafkaException	toKafkaException(RestClientException e, String errorMessage)
void	withPluginMetrics(org.apache.kafka.common.metrics.PluginMetrics metrics)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CACHE_CAPACITY

protected static final int DEFAULT_CACHE_CAPACITY

See Also:

• Constant Field Values

config

protected AbstractKafkaSchemaSerDeConfig config

configOriginals

protected Map<String,Object> configOriginals

schemaRegistry

protected SchemaRegistryClient schemaRegistry

ticker

protected com.google.common.base.Ticker ticker

contextNameStrategy

protected ContextNameStrategy contextNameStrategy

keySubjectNameStrategy

protected SubjectNameStrategy keySubjectNameStrategy

keySchemaIdSerializer

protected SchemaIdSerializer keySchemaIdSerializer

keySchemaIdDeserializer

protected SchemaIdDeserializer keySchemaIdDeserializer

valueSubjectNameStrategy

protected SubjectNameStrategy valueSubjectNameStrategy

valueSchemaIdSerializer

protected SchemaIdSerializer valueSchemaIdSerializer

valueSchemaIdDeserializer

protected SchemaIdDeserializer valueSchemaIdDeserializer

latestVersions

protected com.google.common.cache.Cache<AbstractKafkaSchemaSerDe.SubjectSchema,AbstractKafkaSchemaSerDe.ExtendedSchema> latestVersions

latestWithMetadata

protected com.google.common.cache.Cache<String,AbstractKafkaSchemaSerDe.ExtendedSchema> latestWithMetadata

useSchemaReflection

protected boolean useSchemaReflection

useLatestVersion

protected boolean useLatestVersion

metadata

protected Map<String,String> metadata

executionEnv

protected ExecutionEnvironment executionEnv

enableRuleServiceLoader

protected boolean enableRuleServiceLoader

ruleExecutors

protected Map<String,Map<String,RuleBase>> ruleExecutors

ruleActions

protected Map<String,Map<String,RuleBase>> ruleActions

isKey

protected boolean isKey

Constructor Details

AbstractKafkaSchemaSerDe

public AbstractKafkaSchemaSerDe()

Method Details

key

public static Object key()

setKey

public static void setKey(Object obj)

clearKey

public static void clearKey()

ticker

protected com.google.common.base.Ticker ticker(SchemaRegistryClient client)

configureClientProperties

protected void configureClientProperties(AbstractKafkaSchemaSerDeConfig config,
 SchemaProvider provider)

withPluginMetrics

public void withPluginMetrics(org.apache.kafka.common.metrics.PluginMetrics metrics)

Specified by:

withPluginMetrics in interface org.apache.kafka.common.metrics.Monitorable

postOp

protected void postOp(Object payload)

getSchemaRegistryClient

public SchemaRegistryClient getSchemaRegistryClient()

getRuleExecutors

public Map<String,Map<String,RuleBase>> getRuleExecutors()

getRuleActions

public Map<String,Map<String,RuleBase>> getRuleActions()

isKey

public boolean isKey()

latestVersionsCache

protected Map<AbstractKafkaSchemaSerDe.SubjectSchema,AbstractKafkaSchemaSerDe.ExtendedSchema> latestVersionsCache()

latestWithMetadataCache

protected Map<String,AbstractKafkaSchemaSerDe.ExtendedSchema> latestWithMetadataCache()

getLatestWithMetadata

protected AbstractKafkaSchemaSerDe.ExtendedSchema getLatestWithMetadata(String subject)
                                                                 throws IOException,
RestClientException

Throws:

IOException

RestClientException

getMigrations

protected List<AbstractKafkaSchemaSerDe.Migration> getMigrations(String subject,
 ParsedSchema writerSchema,
 ParsedSchema readerSchema)
                                                          throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSubjectName

protected String getSubjectName(String topic,
 boolean isKey,
 Object value,
 ParsedSchema schema)

Get the subject name for the given topic and value type.

getContextName

protected String getContextName(String topic)

getContextName

protected String getContextName(String topic,
 String subject)

strategyUsesSchema

protected boolean strategyUsesSchema(boolean isKey)

schemaIdSerializer

protected SchemaIdSerializer schemaIdSerializer(boolean isKey)

schemaIdDeserializer

protected SchemaIdDeserializer schemaIdDeserializer(boolean isKey)

getOldSubjectName

protected String getOldSubjectName(Object value)

Get the subject name used by the old Encoder interface, which relies only on the value type rather than the topic.

register

@Deprecated
public int register(String subject,
 org.apache.avro.Schema schema)
             throws IOException,
RestClientException

Deprecated.

Throws:

IOException

RestClientException

register

public int register(String subject,
 ParsedSchema schema)
             throws IOException,
RestClientException

Throws:

IOException

RestClientException

register

public int register(String subject,
 ParsedSchema schema,
 boolean normalize)
             throws IOException,
RestClientException

Throws:

IOException

RestClientException

registerWithResponse

protected Schema registerWithResponse(String subject,
 ParsedSchema schema,
 boolean normalize,
 boolean propagateSchemaTags)
                               throws IOException,
RestClientException

Throws:

IOException

RestClientException

getById

@Deprecated
public org.apache.avro.Schema getById(int id)
                               throws IOException,
RestClientException

Deprecated.

Throws:

IOException

RestClientException

getSchemaById

public ParsedSchema getSchemaById(int id)
                           throws IOException,
RestClientException

Throws:

IOException

RestClientException

getBySubjectAndId

@Deprecated
public org.apache.avro.Schema getBySubjectAndId(String subject,
 int id)
                                         throws IOException,
RestClientException

Deprecated.

Throws:

IOException

RestClientException

getSchemaBySubjectAndId

public ParsedSchema getSchemaBySubjectAndId(String subject,
 int id)
                                     throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaEntityBySubjectAndId

public Schema getSchemaEntityBySubjectAndId(String subject,
 int id)
                                     throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaBySchemaId

protected ParsedSchema getSchemaBySchemaId(String subject,
 SchemaId schemaId)
                                    throws IOException,
RestClientException

Throws:

IOException

RestClientException

lookupSchemaBySubjectAndId

@Deprecated
protected ParsedSchema lookupSchemaBySubjectAndId(String subject,
 int id,
 ParsedSchema schema,
 boolean idCompatStrict)
                                           throws IOException,
RestClientException

Deprecated.

Throws:

IOException

RestClientException

lookupSchemaEntityBySubjectAndId

protected Schema lookupSchemaEntityBySubjectAndId(String subject,
 int id,
 ParsedSchema schema,
 boolean idCompatStrict)
                                           throws IOException,
RestClientException

Throws:

IOException

RestClientException

lookupSchemaByGuid

protected ParsedSchema lookupSchemaByGuid(String guid,
 ParsedSchema schema,
 boolean idCompatStrict)
                                   throws IOException,
RestClientException

Throws:

IOException

RestClientException

lookupLatestVersion

protected AbstractKafkaSchemaSerDe.ExtendedSchema lookupLatestVersion(String subject,
 ParsedSchema schema,
 boolean latestCompatStrict)
                                                               throws IOException,
RestClientException

Throws:

IOException

RestClientException

lookupLatestVersion

protected static AbstractKafkaSchemaSerDe.ExtendedSchema lookupLatestVersion(SchemaRegistryClient schemaRegistry,
 String subject,
 ParsedSchema schema,
 Map<AbstractKafkaSchemaSerDe.SubjectSchema,AbstractKafkaSchemaSerDe.ExtendedSchema> cache,
 boolean latestCompatStrict)
                                                                      throws IOException,
RestClientException

Throws:

IOException

RestClientException

executeMigrations

protected Object executeMigrations(List<AbstractKafkaSchemaSerDe.Migration> migrations,
 String subject,
 String topic,
 org.apache.kafka.common.header.Headers headers,
 Object message)
                            throws IOException

Throws:

IOException

executeRules

protected Object executeRules(String subject,
 String topic,
 org.apache.kafka.common.header.Headers headers,
 RuleMode ruleMode,
 ParsedSchema source,
 ParsedSchema target,
 Object message)

executeRules

protected Object executeRules(String subject,
 String topic,
 org.apache.kafka.common.header.Headers headers,
 Object original,
 RuleMode ruleMode,
 ParsedSchema source,
 ParsedSchema target,
 Object message)

executeRules

protected Object executeRules(String subject,
 String topic,
 org.apache.kafka.common.header.Headers headers,
 Object original,
 RulePhase rulePhase,
 RuleMode ruleMode,
 ParsedSchema source,
 ParsedSchema target,
 Object message)

executeRules

protected Object executeRules(String subject,
 String topic,
 org.apache.kafka.common.header.Headers headers,
 Object original,
 RulePhase rulePhase,
 RuleMode ruleMode,
 ParsedSchema source,
 ParsedSchema target,
 Object message,
 List<RuleResult> ruleResults)

executeValidationRules

protected Object executeValidationRules(String subject,
 String topic,
 org.apache.kafka.common.header.Headers headers,
 ParsedSchema schema,
 Object message)

initValidationRuleExecutor

protected void initValidationRuleExecutor()

Eagerly load and cache the validation rule executor — call from a format-specific configure() when validation.rules.execution is not DISABLED so that a missing dependency surfaces at serializer construction time rather than at the first record. Idempotent.

onUpdate

public void onUpdate(org.apache.kafka.common.ClusterResource clusterResource)

Specified by:

onUpdate in interface org.apache.kafka.common.ClusterResourceListener

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

toKafkaException

protected static org.apache.kafka.common.KafkaException toKafkaException(RestClientException e,
 String errorMessage)