com.networknt.schema

Class JsonSchema

java.lang.Object

com.networknt.schema.BaseJsonValidator

com.networknt.schema.JsonSchema

All Implemented Interfaces:

JsonValidator, JsonSchemaWalker

public class JsonSchema
extends BaseJsonValidator

This is the core of json constraint implementation. It parses json constraint file and generates JsonValidators. The class is thread safe, once it is constructed, it can be used to validate multiple json data concurrently.

Field Summary

Fields inherited from class com.networknt.schema.BaseJsonValidator

applyDefaultsStrategy, failFast, parentSchema, schemaNode, schemaPath

Fields inherited from interface com.networknt.schema.JsonValidator

AT_ROOT

Constructor Summary

Constructors

Constructor and Description
JsonSchema(ValidationContext validationContext, String schemaPath, URI currentUri, com.fasterxml.jackson.databind.JsonNode schemaNode, JsonSchema parent)
JsonSchema(ValidationContext validationContext, URI baseUri, com.fasterxml.jackson.databind.JsonNode schemaNode)
JsonSchema(ValidationContext validationContext, URI baseUri, com.fasterxml.jackson.databind.JsonNode schemaNode, boolean suppressSubSchemaRetrieval)

Method Summary

Modifier and Type	Method and Description
JsonSchema	findAncestor()
CollectorContext	getCollectorContext()
URI	getCurrentUri()
com.fasterxml.jackson.databind.JsonNode	getRefSchemaNode(String ref) Find the schema node for $ref attribute.
JsonValidator	getRequiredValidator()
Map<String,JsonValidator>	getValidators()
boolean	hasRequiredValidator()
void	initializeValidators() Initializes the validators' JsonSchema instances.
String	toString()
Set<ValidationMessage>	validate(com.fasterxml.jackson.databind.JsonNode jsonNode, com.fasterxml.jackson.databind.JsonNode rootNode, String at) START OF VALIDATE METHODS
ValidationResult	validateAndCollect(com.fasterxml.jackson.databind.JsonNode node)
protected ValidationResult	validateAndCollect(com.fasterxml.jackson.databind.JsonNode jsonNode, com.fasterxml.jackson.databind.JsonNode rootNode, String at) This method both validates and collects the data in a CollectorContext.
ValidationResult	walk(com.fasterxml.jackson.databind.JsonNode node, boolean shouldValidateSchema) Walk the JSON node
Set<ValidationMessage>	walk(com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, String at, boolean shouldValidateSchema) This is default implementation of walk method.

Methods inherited from class com.networknt.schema.BaseJsonValidator

buildValidationMessage, checkDiscriminatorMatch, debug, equals, fetchSubSchemaNode, getNodeFieldType, getParentSchema, getSchemaNode, getSchemaPath, getValidatorType, greaterThan, isPartOfOneOfMultipleType, lessThan, parseErrorCode, preloadJsonSchemas, registerAndMergeDiscriminator, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.networknt.schema.JsonValidator

preloadJsonSchema

Constructor Detail

JsonSchema

public JsonSchema(ValidationContext validationContext,
                  URI baseUri,
                  com.fasterxml.jackson.databind.JsonNode schemaNode)

JsonSchema

public JsonSchema(ValidationContext validationContext,
                  String schemaPath,
                  URI currentUri,
                  com.fasterxml.jackson.databind.JsonNode schemaNode,
                  JsonSchema parent)

JsonSchema

public JsonSchema(ValidationContext validationContext,
                  URI baseUri,
                  com.fasterxml.jackson.databind.JsonNode schemaNode,
                  boolean suppressSubSchemaRetrieval)

Method Detail

getCurrentUri

public URI getCurrentUri()

getRefSchemaNode

public com.fasterxml.jackson.databind.JsonNode getRefSchemaNode(String ref)

Find the schema node for $ref attribute.

Parameters:

ref - String

Returns:

JsonNode

findAncestor

public JsonSchema findAncestor()

validate

public Set<ValidationMessage> validate(com.fasterxml.jackson.databind.JsonNode jsonNode,
                                       com.fasterxml.jackson.databind.JsonNode rootNode,
                                       String at)

START OF VALIDATE METHODS

Parameters:

jsonNode - JsonNode

rootNode - JsonNode

at - String

Returns:

A list of ValidationMessage if there is any validation error, or an empty list if there is no error.

validateAndCollect

public ValidationResult validateAndCollect(com.fasterxml.jackson.databind.JsonNode node)

validateAndCollect

protected ValidationResult validateAndCollect(com.fasterxml.jackson.databind.JsonNode jsonNode,
                                              com.fasterxml.jackson.databind.JsonNode rootNode,
                                              String at)

This method both validates and collects the data in a CollectorContext. Unlike others this methods cleans and removes everything from collector context before returning.

Parameters:

jsonNode - JsonNode

rootNode - JsonNode

at - String path

Returns:

ValidationResult

walk

public ValidationResult walk(com.fasterxml.jackson.databind.JsonNode node,
                             boolean shouldValidateSchema)

Walk the JSON node

Parameters:

node - JsonNode

shouldValidateSchema - indicator on validation

Returns:

result of ValidationResult

walk

public Set<ValidationMessage> walk(com.fasterxml.jackson.databind.JsonNode node,
                                   com.fasterxml.jackson.databind.JsonNode rootNode,
                                   String at,
                                   boolean shouldValidateSchema)

Description copied from class: BaseJsonValidator

This is default implementation of walk method. Its job is to call the validate method if shouldValidateSchema is enabled.

Specified by:

walk in interface JsonSchemaWalker

Overrides:

walk in class BaseJsonValidator

Parameters:

node - JsonNode

rootNode - JsonNode

at - String

shouldValidateSchema - boolean

Returns:

a set of validation messages if shouldValidateSchema is true.

getCollectorContext

public CollectorContext getCollectorContext()

toString

public String toString()

Overrides:

toString in class Object

hasRequiredValidator

public boolean hasRequiredValidator()

getRequiredValidator

public JsonValidator getRequiredValidator()

getValidators

public Map<String,JsonValidator> getValidators()

initializeValidators

public void initializeValidators()

Initializes the validators' JsonSchema instances. For avoiding issues with concurrency, in 1.0.49 the JsonSchema instances affiliated with validators were modified to no more preload the schema and lazy loading is used instead.

This comes with the issue that this way you cannot rely on validating important schema features, in particular $ref resolution at instantiation from JsonSchemaFactory.

By calling initializeValidators you can enforce preloading of the JsonSchema instances of the validators.