com.networknt.schema

Class JsonSchema

java.lang.Object

com.networknt.schema.BaseJsonValidator

com.networknt.schema.JsonSchema

All Implemented Interfaces:

JsonValidator

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

Modifier and Type	Field and Description
protected Map<String,JsonValidator>	validators

Fields inherited from class com.networknt.schema.BaseJsonValidator

config, failFast, validatorState

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()
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()
String	toString()
Set<ValidationMessage>	validate(com.fasterxml.jackson.databind.JsonNode jsonNode, com.fasterxml.jackson.databind.JsonNode rootNode, String at) Validate the given JsonNode, the given node is the child node of the root node at given data path.
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 CollectionContext.

Methods inherited from class com.networknt.schema.BaseJsonValidator

buildValidationMessage, debug, equals, fetchSubSchemaNode, getNodeFieldType, getParentSchema, getSchemaNode, getSchemaPath, getValidatorType, greaterThan, lessThan, parseErrorCode, validate

Methods inherited from class java.lang.Object

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

Field Detail

validators

protected Map<String,JsonValidator> validators

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)

Description copied from interface: JsonValidator

Validate the given JsonNode, the given node is the child node of the root node at given data path.

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 CollectionContext.

Parameters:

jsonNode - JsonNode

rootNode - JsonNode

at - String path

Returns:

ValidationResult

toString

public String toString()

Overrides:

toString in class Object

hasRequiredValidator

public boolean hasRequiredValidator()

getRequiredValidator

public JsonValidator getRequiredValidator()

getValidators

public Map<String,JsonValidator> getValidators()