Class PropertiesValidator

java.lang.Object

com.networknt.schema.ValidationMessageHandler

com.networknt.schema.BaseJsonValidator

com.networknt.schema.PropertiesValidator

All Implemented Interfaces:

JsonValidator, JsonSchemaWalker

public class PropertiesValidator
extends BaseJsonValidator

JsonValidator for properties.

Nested Class Summary

Nested classes/interfaces inherited from class BaseJsonValidator

BaseJsonValidator.JsonNodePathJsonPath, BaseJsonValidator.JsonNodePathJsonPointer, BaseJsonValidator.JsonNodePathLegacy

Field Summary

Fields

Modifier and Type	Field	Description
private Boolean	hasUnevaluatedPropertiesValidator
private static final org.slf4j.Logger	logger
static final String	PROPERTY
private final Map<String, JsonSchema>	schemas

Fields inherited from class BaseJsonValidator

schemaNode, suppressSubSchemaRetrieval, validationContext

Fields inherited from class ValidationMessageHandler

errorMessage, errorMessageKeyword, errorMessageType, evaluationParentSchema, evaluationPath, keyword, messageSource, parentSchema, schemaLocation

Constructor Summary

Constructors

Constructor	Description
PropertiesValidator(SchemaLocation schemaLocation, JsonNodePath evaluationPath, com.fasterxml.jackson.databind.JsonNode schemaNode, JsonSchema parentSchema, ValidationContext validationContext)

Method Summary

Modifier and Type	Method	Description
private void	applyPropertyDefaults(com.fasterxml.jackson.databind.node.ObjectNode node)
private boolean	collectAnnotations()
private static com.fasterxml.jackson.databind.JsonNode	getDefaultNode(JsonSchema schema)
Map<String, JsonSchema>	getSchemas()
private boolean	hasUnevaluatedPropertiesValidator()
void	preloadJsonSchema()	In case the JsonValidator has a related JsonSchema or several ones, calling preloadJsonSchema will actually load the schema document(s) eagerly.
Set<ValidationMessage>	validate(ExecutionContext executionContext, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation)	Validate the given JsonNode, the given node is the child node of the root node at given data path.
protected Set<ValidationMessage>	validate(ExecutionContext executionContext, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation, boolean walk)
Set<ValidationMessage>	walk(ExecutionContext executionContext, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation, boolean shouldValidateSchema)	This is default implementation of walk method.
private void	walkSchema(ExecutionContext executionContext, Map.Entry<String, JsonSchema> entry, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation, boolean shouldValidateSchema, SetView<ValidationMessage> validationMessages, WalkListenerRunner propertyWalkListenerRunner)

Methods inherited from class BaseJsonValidator

atRoot, checkDiscriminatorMatch, collectAnnotations, collectAnnotations, debug, equals, fetchSubSchemaNode, getEvaluationParentSchema, getEvaluationPath, getKeyword, getNodeFieldType, getParentSchema, getSchemaLocation, getSchemaNode, hasAdjacentKeywordInEvaluationPath, message, preloadJsonSchemas, putAnnotation, registerAndMergeDiscriminator, toString, validate

Methods inherited from class ValidationMessageHandler

getErrorMessage, getErrorMessageType, getMessageNode

Methods inherited from class Object

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

Field Details

PROPERTY

public static final String PROPERTY

See Also:

• Constant Field Values

logger

private static final org.slf4j.Logger logger

schemas

private final Map<String, JsonSchema> schemas

hasUnevaluatedPropertiesValidator

private Boolean hasUnevaluatedPropertiesValidator

Constructor Details

PropertiesValidator

public PropertiesValidator(SchemaLocation schemaLocation,
 JsonNodePath evaluationPath,
 com.fasterxml.jackson.databind.JsonNode schemaNode,
 JsonSchema parentSchema,
 ValidationContext validationContext)

Method Details

validate

public Set<ValidationMessage> validate(ExecutionContext executionContext,
 com.fasterxml.jackson.databind.JsonNode node,
 com.fasterxml.jackson.databind.JsonNode rootNode,
 JsonNodePath instanceLocation)

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:

executionContext - ExecutionContext

node - JsonNode

rootNode - JsonNode

instanceLocation - JsonNodePath

Returns:

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

validate

protected Set<ValidationMessage> validate(ExecutionContext executionContext,
 com.fasterxml.jackson.databind.JsonNode node,
 com.fasterxml.jackson.databind.JsonNode rootNode,
 JsonNodePath instanceLocation,
 boolean walk)

walk

public Set<ValidationMessage> walk(ExecutionContext executionContext,
 com.fasterxml.jackson.databind.JsonNode node,
 com.fasterxml.jackson.databind.JsonNode rootNode,
 JsonNodePath instanceLocation,
 boolean shouldValidateSchema)

Description copied from interface: JsonValidator

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

Parameters:

executionContext - ExecutionContext

node - JsonNode

rootNode - JsonNode

instanceLocation - JsonNodePath

shouldValidateSchema - boolean

Returns:

a set of validation messages if shouldValidateSchema is true.

collectAnnotations

private boolean collectAnnotations()

hasUnevaluatedPropertiesValidator

private boolean hasUnevaluatedPropertiesValidator()

applyPropertyDefaults

private void applyPropertyDefaults(com.fasterxml.jackson.databind.node.ObjectNode node)

getDefaultNode

private static com.fasterxml.jackson.databind.JsonNode getDefaultNode(JsonSchema schema)

walkSchema

private void walkSchema(ExecutionContext executionContext,
 Map.Entry<String, JsonSchema> entry,
 com.fasterxml.jackson.databind.JsonNode node,
 com.fasterxml.jackson.databind.JsonNode rootNode,
 JsonNodePath instanceLocation,
 boolean shouldValidateSchema,
 SetView<ValidationMessage> validationMessages,
 WalkListenerRunner propertyWalkListenerRunner)

getSchemas

public Map<String, JsonSchema> getSchemas()

preloadJsonSchema

public void preloadJsonSchema()

Description copied from interface: JsonValidator

In case the JsonValidator has a related JsonSchema or several ones, calling preloadJsonSchema will actually load the schema document(s) eagerly.