Package io.confluent.kafka.schemaregistry.protobuf

Class ProtobufSchema

java.lang.Object

io.confluent.kafka.schemaregistry.protobuf.ProtobufSchema

All Implemented Interfaces:

ParsedSchema

public class ProtobufSchema
extends Object
implements ParsedSchema

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProtobufSchema.Format
static class	ProtobufSchema.ProtobufMeta

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY_LOCATION
static final String	API_LOCATION
static final String	CALENDAR_PERIOD_LOCATION
static final String	CFLT_DECIMAL_LOCATION
static final String	CFLT_META_LOCATION
static final String	COLOR_LOCATION
static final String	CONFLUENT_ENUM_META
static final String	CONFLUENT_ENUM_VALUE_META
static final String	CONFLUENT_FIELD_META
static final String	CONFLUENT_FILE_META
static final String	CONFLUENT_MESSAGE_META
static final String	CONFLUENT_PREFIX
static final String	DATE_LOCATION
static final String	DATETIME_LOCATION
static final String	DAY_OF_WEEK_LOCATION
static final String	DECIMAL_LOCATION
static final com.squareup.wire.schema.Location	DEFAULT_LOCATION
static final String	DEFAULT_NAME
static final String	DESCRIPTOR_LOCATION
static final String	DOC_FIELD
static final String	DURATION_LOCATION
static final String	EMPTY_LOCATION
static final String	EXPR_LOCATION
static final com.google.protobuf.ExtensionRegistry	EXTENSION_REGISTRY
static final String	FIELD_MASK_LOCATION
static final String	FRACTION_LOCATION
static final String	INTERVAL_LOCATION
static final String	KEY_FIELD
static final String	LATLNG_LOCATION
static final String	MAP_ENTRY_SUFFIX
static final String	MONEY_LOCATION
static final String	MONTH_LOCATION
static final String	PARAMS_FIELD
static final String	PHONE_NUMBER_LOCATION
static final String	POSTAL_ADDRESS_LOCATION
static final String	PRECISION_KEY
static final String	PROTO2
static final String	PROTO3
static final String	QUATERNION_LOCATION
static final String	SCALE_KEY
static final String	SOURCE_CONTEXT_LOCATION
static final String	STRUCT_LOCATION
static final String	TAGS_FIELD
static final String	TIME_OF_DAY_LOCATION
static final String	TIMESTAMP_LOCATION
static final String	TYPE
static final String	TYPE_LOCATION
static final String	VALUE_FIELD
static final String	WRAPPER_LOCATION

Constructor Summary

Constructors

Constructor	Description
ProtobufSchema(com.google.protobuf.Descriptors.Descriptor descriptor)
ProtobufSchema(com.google.protobuf.Descriptors.Descriptor descriptor, List<SchemaReference> references)
ProtobufSchema(com.google.protobuf.Descriptors.EnumDescriptor enumDescriptor)
ProtobufSchema(com.google.protobuf.Descriptors.EnumDescriptor enumDescriptor, List<SchemaReference> references)
ProtobufSchema(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor)
ProtobufSchema(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor, List<SchemaReference> references)
ProtobufSchema(com.squareup.wire.schema.internal.parser.ProtoFileElement protoFileElement, List<SchemaReference> references, Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement> dependencies)
ProtobufSchema(String schemaString)
ProtobufSchema(String schemaString, List<SchemaReference> references, Map<String,String> resolvedReferences, Metadata metadata, RuleSet ruleSet, Integer version, String name)
ProtobufSchema(String schemaString, List<SchemaReference> references, Map<String,String> resolvedReferences, Integer version, String name)

Method Summary

Modifier and Type	Method	Description
String	canonicalString()
ProtobufSchema	copy()
ProtobufSchema	copy(Metadata metadata, RuleSet ruleSet)
ProtobufSchema	copy(Integer version)
ProtobufSchema	copy(String name)
ProtobufSchema	copy(List<SchemaReference> references)
ProtobufSchema	copy(List<SchemaReference> references, Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement> dependencies)
ParsedSchema	copy(Map<SchemaEntity,Set<String>> tagsToAdd, Map<SchemaEntity,Set<String>> tagsToRemove)
Object	copyMessage(Object message)
ProtobufSchema	copyWithSchema(String schema)
Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement>	dependencies()
Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement>	dependenciesWithLogicalTypes()
boolean	equals(Object o)
static String	findDoc(Optional<com.squareup.wire.schema.internal.parser.OptionElement> meta)
static ProtobufSchema.ProtobufMeta	findMeta(String name, List<com.squareup.wire.schema.internal.parser.OptionElement> options)
static ProtobufSchema.ProtobufMeta	findMeta(String name, Map<String,com.squareup.wire.schema.internal.parser.OptionElement> options)
static Optional<com.squareup.wire.schema.internal.parser.OptionElement>	findOption(String name, List<com.squareup.wire.schema.internal.parser.OptionElement> options)
static Optional<com.squareup.wire.schema.internal.parser.OptionElement>	findOption(String name, Map<String,com.squareup.wire.schema.internal.parser.OptionElement> options)
static Map<String,String>	findParams(Optional<com.squareup.wire.schema.internal.parser.OptionElement> meta)
static List<String>	findTags(Optional<com.squareup.wire.schema.internal.parser.OptionElement> meta)
String	formattedString(String format)
Object	fromJson(com.fasterxml.jackson.databind.JsonNode json)
String	fullName()
String	fullName(String originalPath)
com.google.protobuf.Descriptors.EnumDescriptor	getEnumDescriptor(String enumTypeName)
com.google.protobuf.Descriptors.EnumValueDescriptor	getEnumValue(String enumTypeName, int enumNumber)
int	hashCode()
boolean	hasTopLevelField(String field)
Map<SchemaEntity,Set<String>>	inlineTaggedEntities()
Set<String>	inlineTags()
List<String>	isBackwardCompatible(ParsedSchema previousSchema)
static Set<String>	knownTypes()
protected static com.squareup.wire.schema.internal.parser.OptionElement	merge(com.squareup.wire.schema.internal.parser.OptionElement existing, com.squareup.wire.schema.internal.parser.OptionElement replacement)
Metadata	metadata()
String	name()
com.google.protobuf.DynamicMessage.Builder	newMessageBuilder()
com.google.protobuf.DynamicMessage.Builder	newMessageBuilder(String name)
ProtobufSchema	normalize()
com.squareup.wire.schema.internal.parser.ProtoFileElement	rawSchema()
List<SchemaReference>	references()
Map<String,String>	resolvedReferences()
RuleSet	ruleSet()
String	schemaType()
static com.google.protobuf.DescriptorProtos.ExtensionRangeOptions.Declaration	toDeclaration(com.squareup.wire.schema.internal.parser.OptionElement option)
com.google.protobuf.Descriptors.Descriptor	toDescriptor()
com.google.protobuf.Descriptors.Descriptor	toDescriptor(String name)
static FieldDefinition	toDynamicField(Context ctx, com.squareup.wire.schema.internal.parser.FieldElement fieldElement, String label, boolean isProto3Optional, Integer oneofIndex, String extendee)
static FieldDefinition	toDynamicField(Context ctx, com.squareup.wire.schema.internal.parser.FieldElement fieldElement, String type, String label, boolean isProto3Optional, Integer oneofIndex, String extendee)
DynamicSchema	toDynamicSchema()
DynamicSchema	toDynamicSchema(String name)
static com.google.protobuf.DescriptorProtos.FieldOptions.EditionDefault	toEditionDefault(com.squareup.wire.schema.internal.parser.OptionElement option)
static com.google.protobuf.DescriptorProtos.FeatureSet	toFeatures(com.squareup.wire.schema.internal.parser.OptionElement option)
static com.google.protobuf.DescriptorProtos.FieldOptions.FeatureSupport	toFeatureSupport(com.squareup.wire.schema.internal.parser.OptionElement option)
com.fasterxml.jackson.databind.JsonNode	toJson(Object message)
static String	toMapEntry(String s)
static String	toMapField(String s)
MessageIndexes	toMessageIndexes(String name)
MessageIndexes	toMessageIndexes(String name, boolean normalize)
String	toMessageName(MessageIndexes indexes)
static Object	toPrimitiveValue(Object value)
com.google.protobuf.Descriptors.GenericDescriptor	toSpecificDescriptor(String originalPath)
String	toString()
protected static com.squareup.wire.schema.internal.parser.OptionElement	transform(com.squareup.wire.schema.internal.parser.OptionElement option)
Object	transformMessage(RuleContext ctx, FieldTransform transform, Object message)
static String	underscoresToCamelCase(String input, boolean capitalizeNextLetter)
void	validate(boolean strict)
Integer	version()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.confluent.kafka.schemaregistry.ParsedSchema

canLookup, deepEquals, equivalent, getReservedFields, isBackwardCompatible, isCompatible, isCompatible, tags, validate

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

PROTO2

public static final String PROTO2

See Also:

• Constant Field Values

PROTO3

public static final String PROTO3

See Also:

• Constant Field Values

DOC_FIELD

public static final String DOC_FIELD

See Also:

• Constant Field Values

PARAMS_FIELD

public static final String PARAMS_FIELD

See Also:

• Constant Field Values

TAGS_FIELD

public static final String TAGS_FIELD

See Also:

• Constant Field Values

PRECISION_KEY

public static final String PRECISION_KEY

See Also:

• Constant Field Values

SCALE_KEY

public static final String SCALE_KEY

See Also:

• Constant Field Values

DEFAULT_NAME

public static final String DEFAULT_NAME

See Also:

• Constant Field Values

MAP_ENTRY_SUFFIX

public static final String MAP_ENTRY_SUFFIX

See Also:

• Constant Field Values

KEY_FIELD

public static final String KEY_FIELD

See Also:

• Constant Field Values

VALUE_FIELD

public static final String VALUE_FIELD

See Also:

• Constant Field Values

CONFLUENT_PREFIX

public static final String CONFLUENT_PREFIX

See Also:

• Constant Field Values

CONFLUENT_FILE_META

public static final String CONFLUENT_FILE_META

See Also:

• Constant Field Values

CONFLUENT_MESSAGE_META

public static final String CONFLUENT_MESSAGE_META

See Also:

• Constant Field Values

CONFLUENT_FIELD_META

public static final String CONFLUENT_FIELD_META

See Also:

• Constant Field Values

CONFLUENT_ENUM_META

public static final String CONFLUENT_ENUM_META

See Also:

• Constant Field Values

CONFLUENT_ENUM_VALUE_META

public static final String CONFLUENT_ENUM_VALUE_META

See Also:

• Constant Field Values

DEFAULT_LOCATION

public static final com.squareup.wire.schema.Location DEFAULT_LOCATION

CFLT_META_LOCATION

public static final String CFLT_META_LOCATION

See Also:

• Constant Field Values

CFLT_DECIMAL_LOCATION

public static final String CFLT_DECIMAL_LOCATION

See Also:

• Constant Field Values

CALENDAR_PERIOD_LOCATION

public static final String CALENDAR_PERIOD_LOCATION

See Also:

• Constant Field Values

COLOR_LOCATION

public static final String COLOR_LOCATION

See Also:

• Constant Field Values

DATE_LOCATION

public static final String DATE_LOCATION

See Also:

• Constant Field Values

DATETIME_LOCATION

public static final String DATETIME_LOCATION

See Also:

• Constant Field Values

DAY_OF_WEEK_LOCATION

public static final String DAY_OF_WEEK_LOCATION

See Also:

• Constant Field Values

DECIMAL_LOCATION

public static final String DECIMAL_LOCATION

See Also:

• Constant Field Values

EXPR_LOCATION

public static final String EXPR_LOCATION

See Also:

• Constant Field Values

FRACTION_LOCATION

public static final String FRACTION_LOCATION

See Also:

• Constant Field Values

INTERVAL_LOCATION

public static final String INTERVAL_LOCATION

See Also:

• Constant Field Values

LATLNG_LOCATION

public static final String LATLNG_LOCATION

See Also:

• Constant Field Values

MONEY_LOCATION

public static final String MONEY_LOCATION

See Also:

• Constant Field Values

MONTH_LOCATION

public static final String MONTH_LOCATION

See Also:

• Constant Field Values

PHONE_NUMBER_LOCATION

public static final String PHONE_NUMBER_LOCATION

See Also:

• Constant Field Values

POSTAL_ADDRESS_LOCATION

public static final String POSTAL_ADDRESS_LOCATION

See Also:

• Constant Field Values

QUATERNION_LOCATION

public static final String QUATERNION_LOCATION

See Also:

• Constant Field Values

TIME_OF_DAY_LOCATION

public static final String TIME_OF_DAY_LOCATION

See Also:

• Constant Field Values

ANY_LOCATION

public static final String ANY_LOCATION

See Also:

• Constant Field Values

API_LOCATION

public static final String API_LOCATION

See Also:

• Constant Field Values

DESCRIPTOR_LOCATION

public static final String DESCRIPTOR_LOCATION

See Also:

• Constant Field Values

DURATION_LOCATION

public static final String DURATION_LOCATION

See Also:

• Constant Field Values

EMPTY_LOCATION

public static final String EMPTY_LOCATION

See Also:

• Constant Field Values

FIELD_MASK_LOCATION

public static final String FIELD_MASK_LOCATION

See Also:

• Constant Field Values

SOURCE_CONTEXT_LOCATION

public static final String SOURCE_CONTEXT_LOCATION

See Also:

• Constant Field Values

STRUCT_LOCATION

public static final String STRUCT_LOCATION

See Also:

• Constant Field Values

TIMESTAMP_LOCATION

public static final String TIMESTAMP_LOCATION

See Also:

• Constant Field Values

TYPE_LOCATION

public static final String TYPE_LOCATION

See Also:

• Constant Field Values

WRAPPER_LOCATION

public static final String WRAPPER_LOCATION

See Also:

• Constant Field Values

EXTENSION_REGISTRY

public static final com.google.protobuf.ExtensionRegistry EXTENSION_REGISTRY

Constructor Details

ProtobufSchema

public ProtobufSchema(String schemaString)

ProtobufSchema

public ProtobufSchema(String schemaString,
 List<SchemaReference> references,
 Map<String,String> resolvedReferences,
 Integer version,
 String name)

ProtobufSchema

public ProtobufSchema(String schemaString,
 List<SchemaReference> references,
 Map<String,String> resolvedReferences,
 Metadata metadata,
 RuleSet ruleSet,
 Integer version,
 String name)

ProtobufSchema

public ProtobufSchema(com.squareup.wire.schema.internal.parser.ProtoFileElement protoFileElement,
 List<SchemaReference> references,
 Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement> dependencies)

ProtobufSchema

public ProtobufSchema(com.google.protobuf.Descriptors.Descriptor descriptor)

ProtobufSchema

public ProtobufSchema(com.google.protobuf.Descriptors.Descriptor descriptor,
 List<SchemaReference> references)

ProtobufSchema

public ProtobufSchema(com.google.protobuf.Descriptors.EnumDescriptor enumDescriptor)

ProtobufSchema

public ProtobufSchema(com.google.protobuf.Descriptors.EnumDescriptor enumDescriptor,
 List<SchemaReference> references)

ProtobufSchema

public ProtobufSchema(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor)

ProtobufSchema

public ProtobufSchema(com.google.protobuf.Descriptors.FileDescriptor fileDescriptor,
 List<SchemaReference> references)

Method Details

knownTypes

public static Set<String> knownTypes()

copy

public ProtobufSchema copy()

Specified by:

copy in interface ParsedSchema

copy

public ProtobufSchema copy(Integer version)

Specified by:

copy in interface ParsedSchema

copy

public ProtobufSchema copy(String name)

copy

public ProtobufSchema copy(List<SchemaReference> references)

copy

public ProtobufSchema copy(List<SchemaReference> references,
 Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement> dependencies)

copy

public ProtobufSchema copy(Metadata metadata,
 RuleSet ruleSet)

Specified by:

copy in interface ParsedSchema

copy

public ParsedSchema copy(Map<SchemaEntity,Set<String>> tagsToAdd,
 Map<SchemaEntity,Set<String>> tagsToRemove)

Specified by:

copy in interface ParsedSchema

copyWithSchema

public ProtobufSchema copyWithSchema(String schema)

toDescriptor

public com.google.protobuf.Descriptors.Descriptor toDescriptor()

toDescriptor

public com.google.protobuf.Descriptors.Descriptor toDescriptor(String name)

newMessageBuilder

public com.google.protobuf.DynamicMessage.Builder newMessageBuilder()

newMessageBuilder

public com.google.protobuf.DynamicMessage.Builder newMessageBuilder(String name)

getEnumDescriptor

public com.google.protobuf.Descriptors.EnumDescriptor getEnumDescriptor(String enumTypeName)

getEnumValue

public com.google.protobuf.Descriptors.EnumValueDescriptor getEnumValue(String enumTypeName,
 int enumNumber)

toDynamicSchema

public DynamicSchema toDynamicSchema()

toDynamicSchema

public DynamicSchema toDynamicSchema(String name)

merge

protected static com.squareup.wire.schema.internal.parser.OptionElement merge(com.squareup.wire.schema.internal.parser.OptionElement existing,
 com.squareup.wire.schema.internal.parser.OptionElement replacement)

transform

protected static com.squareup.wire.schema.internal.parser.OptionElement transform(com.squareup.wire.schema.internal.parser.OptionElement option)

toDeclaration

public static com.google.protobuf.DescriptorProtos.ExtensionRangeOptions.Declaration toDeclaration(com.squareup.wire.schema.internal.parser.OptionElement option)

toFeatures

public static com.google.protobuf.DescriptorProtos.FeatureSet toFeatures(com.squareup.wire.schema.internal.parser.OptionElement option)

toFeatureSupport

public static com.google.protobuf.DescriptorProtos.FieldOptions.FeatureSupport toFeatureSupport(com.squareup.wire.schema.internal.parser.OptionElement option)

toEditionDefault

public static com.google.protobuf.DescriptorProtos.FieldOptions.EditionDefault toEditionDefault(com.squareup.wire.schema.internal.parser.OptionElement option)

toPrimitiveValue

public static Object toPrimitiveValue(Object value)

toDynamicField

public static FieldDefinition toDynamicField(Context ctx,
 com.squareup.wire.schema.internal.parser.FieldElement fieldElement,
 String label,
 boolean isProto3Optional,
 Integer oneofIndex,
 String extendee)

toDynamicField

public static FieldDefinition toDynamicField(Context ctx,
 com.squareup.wire.schema.internal.parser.FieldElement fieldElement,
 String type,
 String label,
 boolean isProto3Optional,
 Integer oneofIndex,
 String extendee)

findOption

public static Optional<com.squareup.wire.schema.internal.parser.OptionElement> findOption(String name,
 List<com.squareup.wire.schema.internal.parser.OptionElement> options)

findOption

public static Optional<com.squareup.wire.schema.internal.parser.OptionElement> findOption(String name,
 Map<String,com.squareup.wire.schema.internal.parser.OptionElement> options)

findMeta

public static ProtobufSchema.ProtobufMeta findMeta(String name,
 List<com.squareup.wire.schema.internal.parser.OptionElement> options)

findMeta

public static ProtobufSchema.ProtobufMeta findMeta(String name,
 Map<String,com.squareup.wire.schema.internal.parser.OptionElement> options)

findDoc

public static String findDoc(Optional<com.squareup.wire.schema.internal.parser.OptionElement> meta)

findParams

public static Map<String,String> findParams(Optional<com.squareup.wire.schema.internal.parser.OptionElement> meta)

findTags

public static List<String> findTags(Optional<com.squareup.wire.schema.internal.parser.OptionElement> meta)

rawSchema

public com.squareup.wire.schema.internal.parser.ProtoFileElement rawSchema()

Specified by:

rawSchema in interface ParsedSchema

hasTopLevelField

public boolean hasTopLevelField(String field)

Specified by:

hasTopLevelField in interface ParsedSchema

schemaType

public String schemaType()

Specified by:

schemaType in interface ParsedSchema

name

public String name()

Specified by:

name in interface ParsedSchema

canonicalString

public String canonicalString()

Specified by:

canonicalString in interface ParsedSchema

formattedString

public String formattedString(String format)

Specified by:

formattedString in interface ParsedSchema

version

public Integer version()

Specified by:

version in interface ParsedSchema

references

public List<SchemaReference> references()

Specified by:

references in interface ParsedSchema

resolvedReferences

public Map<String,String> resolvedReferences()

dependencies

public Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement> dependencies()

dependenciesWithLogicalTypes

public Map<String,com.squareup.wire.schema.internal.parser.ProtoFileElement> dependenciesWithLogicalTypes()

metadata

public Metadata metadata()

Specified by:

metadata in interface ParsedSchema

ruleSet

public RuleSet ruleSet()

Specified by:

ruleSet in interface ParsedSchema

normalize

public ProtobufSchema normalize()

Specified by:

normalize in interface ParsedSchema

validate

public void validate(boolean strict)

Specified by:

validate in interface ParsedSchema

isBackwardCompatible

public List<String> isBackwardCompatible(ParsedSchema previousSchema)

Specified by:

isBackwardCompatible in interface ParsedSchema

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toSpecificDescriptor

public com.google.protobuf.Descriptors.GenericDescriptor toSpecificDescriptor(String originalPath)

fullName

public String fullName()

fullName

public String fullName(String originalPath)

toMessageIndexes

public MessageIndexes toMessageIndexes(String name)

toMessageIndexes

public MessageIndexes toMessageIndexes(String name,
 boolean normalize)

toMessageName

public String toMessageName(MessageIndexes indexes)

toMapEntry

public static String toMapEntry(String s)

toMapField

public static String toMapField(String s)

fromJson

public Object fromJson(com.fasterxml.jackson.databind.JsonNode json)
                throws IOException

Specified by:

fromJson in interface ParsedSchema

Throws:

IOException

toJson

public com.fasterxml.jackson.databind.JsonNode toJson(Object message)
                                               throws IOException

Specified by:

toJson in interface ParsedSchema

Throws:

IOException

copyMessage

public Object copyMessage(Object message)

Specified by:

copyMessage in interface ParsedSchema

transformMessage

public Object transformMessage(RuleContext ctx,
 FieldTransform transform,
 Object message)
                        throws RuleException

Specified by:

transformMessage in interface ParsedSchema

Throws:

RuleException

inlineTags

public Set<String> inlineTags()

Specified by:

inlineTags in interface ParsedSchema

inlineTaggedEntities

public Map<SchemaEntity,Set<String>> inlineTaggedEntities()

Specified by:

inlineTaggedEntities in interface ParsedSchema

underscoresToCamelCase

public static String underscoresToCamelCase(String input,
 boolean capitalizeNextLetter)