Package io.confluent.kafka.schemaregistry.json

Class JsonSchema

java.lang.Object

io.confluent.kafka.schemaregistry.json.JsonSchema

All Implemented Interfaces:

ParsedSchema

public class JsonSchema
extends Object
implements ParsedSchema

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BASE_URI
static final String	TAGS
static final String	TYPE

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

RESERVED

Constructor Summary

Constructors

Constructor	Description
JsonSchema(com.fasterxml.jackson.databind.JsonNode jsonNode)
JsonSchema(com.fasterxml.jackson.databind.JsonNode jsonNode, List<SchemaReference> references, Map<String,String> resolvedReferences, Metadata metadata, RuleSet ruleSet, Integer version)
JsonSchema(com.fasterxml.jackson.databind.JsonNode jsonNode, List<SchemaReference> references, Map<String,String> resolvedReferences, Integer version)
JsonSchema(String schemaString)
JsonSchema(String schemaString, List<SchemaReference> references, Map<String,String> resolvedReferences, Metadata metadata, RuleSet ruleSet, Integer version)
JsonSchema(String schemaString, List<SchemaReference> references, Map<String,String> resolvedReferences, Metadata metadata, RuleSet ruleSet, Integer version, boolean blockRemoteRefs)
JsonSchema(String schemaString, List<SchemaReference> references, Map<String,String> resolvedReferences, Integer version)
JsonSchema(org.everit.json.schema.Schema schemaObj)
JsonSchema(org.everit.json.schema.Schema schemaObj, Integer version)

Method Summary

Modifier and Type	Method	Description
String	canonicalString()
JsonSchema	copy()
JsonSchema	copy(Metadata metadata, RuleSet ruleSet)
JsonSchema	copy(Integer version)
ParsedSchema	copy(Map<SchemaEntity,Set<String>> tagsToAdd, Map<SchemaEntity,Set<String>> tagsToRemove)
ParsedSchema	copy(Map<SchemaEntity,Set<String>> tagsToAdd, Map<SchemaEntity,Set<String>> tagsToRemove, boolean addBeforeRemove)
JsonSchema	copyIgnoringModernDialects()
Object	copyMessage(Object message)
boolean	equals(Object o)
String	formattedString(String format)
Object	fromJson(com.fasterxml.jackson.databind.JsonNode json)
protected Map<URI,String>	getPrepopulatedMappings()
String	getString(String key)
boolean	has(String key)
int	hashCode()
boolean	hasTopLevelField(String field)
Map<SchemaEntity,Set<String>>	inlineTaggedEntities()
Set<String>	inlineTags()
List<String>	isBackwardCompatible(CompatibilityPolicy policy, ParsedSchema previousSchema)
List<String>	isBackwardCompatible(ParsedSchema previousSchema)
boolean	isIgnoreModernDialects()
Metadata	metadata()
String	name()
JsonSchema	normalize()
org.everit.json.schema.Schema	rawSchema()
List<SchemaReference>	references()
Map<String,String>	resolvedReferences()
RuleSet	ruleSet()
String	schemaType()
com.fasterxml.jackson.databind.JsonNode	toJson(Object message)
com.fasterxml.jackson.databind.JsonNode	toJsonNode()
String	toString()
Object	transformMessage(RuleContext ctx, FieldTransform transform, Object message)
void	validate(boolean strict)
com.fasterxml.jackson.databind.JsonNode	validate(com.fasterxml.jackson.databind.JsonNode value)
static com.fasterxml.jackson.databind.JsonNode	validate(com.github.erosb.jsonsKema.Schema schema, com.fasterxml.jackson.databind.JsonNode value)
static com.fasterxml.jackson.databind.JsonNode	validate(org.everit.json.schema.Schema schema, Object value)
List<ValidationRuleError>	validateMessage(ValidationRuleExecutor executor, Object message)	Walk message against this schema and evaluate every inline confluent:rules CHECK constraint encountered, collecting all failures into the returned list.
List<ValidationRuleError>	validateMessage(ValidationRuleExecutor executor, Object message, boolean failFast)
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, isCompatible, isCompatible, tags, validate

Field Details

DEFAULT_BASE_URI

public static final String DEFAULT_BASE_URI

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

TAGS

public static final String TAGS

See Also:

• Constant Field Values

Constructor Details

JsonSchema

public JsonSchema(com.fasterxml.jackson.databind.JsonNode jsonNode)

JsonSchema

public JsonSchema(String schemaString)

JsonSchema

public JsonSchema(com.fasterxml.jackson.databind.JsonNode jsonNode,
 List<SchemaReference> references,
 Map<String,String> resolvedReferences,
 Integer version)

JsonSchema

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

JsonSchema

public JsonSchema(com.fasterxml.jackson.databind.JsonNode jsonNode,
 List<SchemaReference> references,
 Map<String,String> resolvedReferences,
 Metadata metadata,
 RuleSet ruleSet,
 Integer version)

JsonSchema

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

JsonSchema

public JsonSchema(String schemaString,
 List<SchemaReference> references,
 Map<String,String> resolvedReferences,
 Metadata metadata,
 RuleSet ruleSet,
 Integer version,
 boolean blockRemoteRefs)

JsonSchema

public JsonSchema(org.everit.json.schema.Schema schemaObj)

JsonSchema

public JsonSchema(org.everit.json.schema.Schema schemaObj,
 Integer version)

Method Details

copy

public JsonSchema copy()

Specified by:

copy in interface ParsedSchema

copy

public JsonSchema copy(Integer version)

Specified by:

copy in interface ParsedSchema

copy

public JsonSchema 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

copy

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

Specified by:

copy in interface ParsedSchema

copyIgnoringModernDialects

public JsonSchema copyIgnoringModernDialects()

toJsonNode

public com.fasterxml.jackson.databind.JsonNode toJsonNode()

rawSchema

public org.everit.json.schema.Schema rawSchema()

Specified by:

rawSchema in interface ParsedSchema

getPrepopulatedMappings

protected Map<URI,String> getPrepopulatedMappings()

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

has

public boolean has(String key)

getString

public String getString(String key)

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()

metadata

public Metadata metadata()

Specified by:

metadata in interface ParsedSchema

ruleSet

public RuleSet ruleSet()

Specified by:

ruleSet in interface ParsedSchema

isIgnoreModernDialects

public boolean isIgnoreModernDialects()

normalize

public JsonSchema normalize()

Specified by:

normalize in interface ParsedSchema

validate

public void validate(boolean strict)

Specified by:

validate in interface ParsedSchema

validate

public com.fasterxml.jackson.databind.JsonNode validate(com.fasterxml.jackson.databind.JsonNode value)
                                                 throws com.fasterxml.jackson.core.JsonProcessingException,
org.everit.json.schema.ValidationException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

org.everit.json.schema.ValidationException

validate

public static com.fasterxml.jackson.databind.JsonNode validate(com.github.erosb.jsonsKema.Schema schema,
 com.fasterxml.jackson.databind.JsonNode value)
                                                        throws com.fasterxml.jackson.core.JsonProcessingException,
org.everit.json.schema.ValidationException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

org.everit.json.schema.ValidationException

validate

public static com.fasterxml.jackson.databind.JsonNode validate(org.everit.json.schema.Schema schema,
 Object value)
                                                        throws com.fasterxml.jackson.core.JsonProcessingException,
org.everit.json.schema.ValidationException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

org.everit.json.schema.ValidationException

isBackwardCompatible

public List<String> isBackwardCompatible(CompatibilityPolicy policy,
 ParsedSchema previousSchema)

Specified by:

isBackwardCompatible 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

fromJson

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

Specified by:

fromJson in interface ParsedSchema

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)
                   throws IOException

Specified by:

copyMessage in interface ParsedSchema

Throws:

IOException

transformMessage

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

Specified by:

transformMessage in interface ParsedSchema

Throws:

RuleException

validateMessage

public List<ValidationRuleError> validateMessage(ValidationRuleExecutor executor,
 Object message)

Walk message against this schema and evaluate every inline confluent:rules CHECK constraint encountered, collecting all failures into the returned list. Read-only — does not modify the message.

Two kinds of rules are evaluated:

• Object-level (confluent:rules on an ObjectSchema) — this = the object value.
• Property-level (confluent:rules on a property's schema) — this = the property value. Honors the column-level skip-on-null contract: when the property value is null (or the property is absent), property-level rules are skipped.

Failures are appended to the returned list with their dotted-path location (e.g. $.addr.zip, $.tags[3]). The walk continues after each failure so callers see the full set rather than only the first.

Specified by:

validateMessage in interface ParsedSchema

validateMessage

public List<ValidationRuleError> validateMessage(ValidationRuleExecutor executor,
 Object message,
 boolean failFast)

Specified by:

validateMessage in interface ParsedSchema

inlineTags

public Set<String> inlineTags()

Specified by:

inlineTags in interface ParsedSchema

inlineTaggedEntities

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

Specified by:

inlineTaggedEntities in interface ParsedSchema