io.confluent.kafka.serializers.subject

Class RecordNameStrategy

java.lang.Object

io.confluent.kafka.serializers.subject.RecordNameStrategy

All Implemented Interfaces:

SubjectNameStrategy, org.apache.kafka.common.Configurable

Direct Known Subclasses:

TopicRecordNameStrategy

public class RecordNameStrategy
extends Object
implements SubjectNameStrategy, SubjectNameStrategy

For any record type that is published to Kafka, registers the schema in the registry under the fully-qualified record name (regardless of the topic). This strategy allows a topic to contain a mixture of different record types, since no intra-topic compatibility checking is performed. Instead, checks compatibility of any occurrences of the same record name across all topics.

Constructor Summary

Constructors

Constructor and Description
RecordNameStrategy()

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,?> config)
protected String	getRecordName(ParsedSchema schema, boolean isKey) If the schema is a record type, returns its fully-qualified name.
String	getSubjectName(String topic, boolean isKey, Object value) Deprecated.
String	subjectName(String topic, boolean isKey, ParsedSchema schema) For a given topic and message, returns the subject name under which the schema should be registered in the schema registry.
boolean	usesSchema() Whether the strategy depends on the schema.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordNameStrategy

public RecordNameStrategy()

Method Detail

configure

public void configure(Map<String,?> config)

Specified by:

configure in interface org.apache.kafka.common.Configurable

usesSchema

public boolean usesSchema()

Description copied from interface: SubjectNameStrategy

Whether the strategy depends on the schema.

Returns:

Whether the strategy depends on the schema.

subjectName

public String subjectName(String topic,
                          boolean isKey,
                          ParsedSchema schema)

Description copied from interface: SubjectNameStrategy

For a given topic and message, returns the subject name under which the schema should be registered in the schema registry.

Parameters:

topic - The Kafka topic name to which the message is being published.

isKey - True when encoding a message key, false for a message value.

schema - the schema of the record being serialized/deserialized

Returns:

The subject name under which the schema should be registered.

getRecordName

protected String getRecordName(ParsedSchema schema,
                               boolean isKey)

If the schema is a record type, returns its fully-qualified name. Otherwise throws an error.

getSubjectName

@Deprecated
public String getSubjectName(String topic,
                                         boolean isKey,
                                         Object value)

Deprecated.

Description copied from interface: SubjectNameStrategy

For a given topic and message, returns the subject name under which the schema should be registered in the schema registry.

Specified by:

getSubjectName in interface SubjectNameStrategy

Parameters:

topic - The Kafka topic name to which the message is being published.

isKey - True when encoding a message key, false for a message value.

value - The value to be published in the message.

Returns:

The subject name under which the schema should be registered.