Package com.networknt.schema.walk

Interface JsonSchemaWalker

All Known Subinterfaces:
JsonValidator
All Known Implementing Classes:
AbstractJsonValidator, AdditionalPropertiesValidator, AllOfValidator, AnyOfValidator, BaseFormatJsonValidator, BaseJsonValidator, ConstValidator, ContainsValidator, ContentEncodingValidator, ContentMediaTypeValidator, DependenciesValidator, DependentRequired, DependentSchemas, DiscriminatorValidator, DynamicRefValidator, EnumValidator, ExclusiveMaximumValidator, ExclusiveMinimumValidator, FalseValidator, FormatValidator, IfValidator, ItemsValidator, ItemsValidator202012, JsonSchema, MaximumValidator, MaxItemsValidator, MaxLengthValidator, MaxPropertiesValidator, MinimumValidator, MinItemsValidator, MinLengthValidator, MinMaxContainsValidator, MinPropertiesValidator, MultipleOfValidator, NotAllowedValidator, NotValidator, OneOfValidator, PatternPropertiesValidator, PatternValidator, PrefixItemsValidator, PropertiesValidator, PropertyNamesValidator, ReadOnlyValidator, RecursiveRefValidator, RefValidator, RequiredValidator, TrueValidator, TypeValidator, UnevaluatedItemsValidator, UnevaluatedPropertiesValidator, UnionTypeValidator, UniqueItemsValidator, WriteOnlyValidator
public interface JsonSchemaWalker

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<ValidationMessage>
    walk(ExecutionContext executionContext, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation, boolean shouldValidateSchema)
    This method gives the capability to walk through the given JsonNode, allowing functionality beyond validation like collecting information,handling cross-cutting concerns like logging or instrumentation.

  • Method Details

    • walk

      Set<ValidationMessage> walk(ExecutionContext executionContext, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode rootNode, JsonNodePath instanceLocation, boolean shouldValidateSchema)
      This method gives the capability to walk through the given JsonNode, allowing functionality beyond validation like collecting information,handling cross-cutting concerns like logging or instrumentation. This method also performs the validation if shouldValidateSchema is set to true.

      JsonValidator.walk(ExecutionContext, JsonNode, JsonNode, JsonNodePath, boolean) provides a default implementation of this method. However, validators that parse sub-schemas should override this method to call walk method on those sub-schemas.
      Parameters:
      executionContext - ExecutionContext
      node - JsonNode
      rootNode - JsonNode
      instanceLocation - JsonNodePath
      shouldValidateSchema - boolean
      Returns:
      a set of validation messages if shouldValidateSchema is true.