Package dev.harrel.jsonschema

Class ValidatorFactory

java.lang.Object

dev.harrel.jsonschema.ValidatorFactory

public final class ValidatorFactory
extends Object

Configurable factory for Validator class. Provides methods for ad-hoc validation, which parse schema each time they are invoked.

See Also:

• Validator

Constructor Summary

Constructors

Constructor	Description
ValidatorFactory()

Method Summary

Modifier and Type	Method	Description
Validator	createValidator()	Creates new instance of Validator using current configuration.
Validator.Result	validate(JsonNode schemaNode, JsonNode instanceNode)	Validates JSON instance against schema.
Validator.Result	validate(JsonNode schemaNode, Object instanceProviderNode)	Validates JSON instance against schema.
Validator.Result	validate(JsonNode schemaNode, String rawInstance)	Validates JSON instance against schema.
Validator.Result	validate(Object schemaProviderNode, JsonNode instanceNode)	Validates JSON instance against schema.
Validator.Result	validate(Object schemaProviderNode, Object instanceProviderNode)	Validates JSON instance against schema.
Validator.Result	validate(Object schemaProviderNode, String rawInstance)	Validates JSON instance against schema.
Validator.Result	validate(String rawSchema, JsonNode instanceNode)	Validates JSON instance against schema.
Validator.Result	validate(String rawSchema, Object instanceProviderNode)	Validates JSON instance against schema.
Validator.Result	validate(String rawSchema, String rawInstance)	Validates JSON instance against schema.
ValidatorFactory	withDefaultDialect(Dialect dialect)	Sets default Dialect which will be used when $schema keyword is absent.
ValidatorFactory	withDialect(Dialect dialect)	Registers a Dialect using Dialect.getMetaSchema() value.
ValidatorFactory	withDisabledSchemaValidation(boolean disabledSchemaValidation)	Disables schema validation against meta-schemas.
ValidatorFactory	withEvaluatorFactory(EvaluatorFactory evaluatorFactory)	Sets additional EvaluatorFactory to be used alongside with the core EvaluatorFactory provided by Dialect.
ValidatorFactory	withJsonNodeFactories(JsonNodeFactory schemaNodeFactory, JsonNodeFactory instanceNodeFactory)	Sets one JsonNodeFactory for schema parsing and one for data parsing.
ValidatorFactory	withJsonNodeFactory(JsonNodeFactory jsonNodeFactory)	Sets JsonNodeFactory to be used for both schema and data parsing.
ValidatorFactory	withSchemaResolver(SchemaResolver schemaResolver)	Composes SchemaResolver with default schema resolver.

Methods inherited from class java.lang.Object

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

Constructor Details

ValidatorFactory

public ValidatorFactory()

Method Details

createValidator

public Validator createValidator()

Creates new instance of Validator using current configuration.

Returns:

new Validator instance

withDialect

public ValidatorFactory withDialect(Dialect dialect)

Registers a Dialect using Dialect.getMetaSchema() value. If Dialect.getMetaSchema() returns null, the dialect will not be registered. This method can be called multiple times to register multiple dialects. Keep in mind that overriding an official dialect is also possible if you provide the same meta-schema. Generally, this method should be used only when:

• You need your meta-schema to be recursive (same value in $schema and $id).
• You want to validate vocabularies integrity based on your dialect's required and supported vocabularies.
• You use withDisabledSchemaValidation() and want to define active vocabularies for your meta-schema.

Parameters:

dialect - Dialect to be registered

Returns:

self

withDefaultDialect

public ValidatorFactory withDefaultDialect(Dialect dialect)

Sets default Dialect which will be used when $schema keyword is absent. Provided default is Dialects.Draft2020Dialect.

Parameters:

dialect - Dialect to be used as default

Returns:

self

withEvaluatorFactory

public ValidatorFactory withEvaluatorFactory(EvaluatorFactory evaluatorFactory)

Sets additional EvaluatorFactory to be used alongside with the core EvaluatorFactory provided by Dialect. This is the best way to provide custom keyword support.

Parameters:

evaluatorFactory - EvaluatorFactory to be used

Returns:

self

withJsonNodeFactory

public ValidatorFactory withJsonNodeFactory(JsonNodeFactory jsonNodeFactory)

Sets JsonNodeFactory to be used for both schema and data parsing. If you require different factories for schemas and data, please use withJsonNodeFactories(dev.harrel.jsonschema.JsonNodeFactory, dev.harrel.jsonschema.JsonNodeFactory) Provided default is JacksonNode.Factory.

Parameters:

jsonNodeFactory - JsonNodeFactory to be used

Returns:

self

withJsonNodeFactories

public ValidatorFactory withJsonNodeFactories(JsonNodeFactory schemaNodeFactory,
 JsonNodeFactory instanceNodeFactory)

Sets one JsonNodeFactory for schema parsing and one for data parsing. Might be useful when you expect schemas to be in a different format than data (JSON/YAML). In most cases having two different factories is not required, so please just use withJsonNodeFactory(dev.harrel.jsonschema.JsonNodeFactory) whenever possible. Provided default is JacksonNode.Factory.

Parameters:

schemaNodeFactory - JsonNodeFactory to be used for parsing schemas

instanceNodeFactory - JsonNodeFactory to be used for parsing data

Returns:

self

withSchemaResolver

public ValidatorFactory withSchemaResolver(SchemaResolver schemaResolver)

Composes SchemaResolver with default schema resolver. The default schema resolver resolves only official specification meta-schemas. Meta-schemas are loaded from classpath.

Parameters:

schemaResolver - SchemaResolver to be used

Returns:

self

See Also:

• SpecificationVersion

withDisabledSchemaValidation

public ValidatorFactory withDisabledSchemaValidation(boolean disabledSchemaValidation)

Disables schema validation against meta-schemas.

Parameters:

disabledSchemaValidation - if schema validation should be disabled

Returns:

self

validate

public Validator.Result validate(String rawSchema,
 String rawInstance)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

rawSchema - string representation of schema JSON

rawInstance - string representation of instance JSON

Returns:

validation result

validate

public Validator.Result validate(Object schemaProviderNode,
 String rawInstance)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaProviderNode - object representing schema JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

rawInstance - string representation of instance JSON

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(JsonNode schemaNode,
 String rawInstance)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaNode - JsonNode schema JSON, which could be created via JsonNodeFactory

rawInstance - string representation of instance JSON

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(String rawSchema,
 Object instanceProviderNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

rawSchema - string representation of schema JSON

instanceProviderNode - object representing instance JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(Object schemaProviderNode,
 Object instanceProviderNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaProviderNode - object representing schema JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

instanceProviderNode - object representing instance JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(JsonNode schemaNode,
 Object instanceProviderNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaNode - JsonNode schema JSON, which could be created via JsonNodeFactory

instanceProviderNode - object representing instance JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(String rawSchema,
 JsonNode instanceNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

rawSchema - string representation of schema JSON

instanceNode - JsonNode instance JSON, which could be created via JsonNodeFactory

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(Object schemaProviderNode,
 JsonNode instanceNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaProviderNode - object representing schema JSON for currently set JsonNodeFactory. E.g. com.fasterxml.jackson.databind.JsonNode for default JsonNodeFactory (JacksonNode.Factory)

instanceNode - JsonNode instance JSON, which could be created via JsonNodeFactory

Returns:

validation result

See Also:

• validate(String, String)

validate

public Validator.Result validate(JsonNode schemaNode,
 JsonNode instanceNode)

Validates JSON instance against schema. Each invocation creates temporary Validator which parses schema from scratch. If you want to validate multiple JSON instances against same schema - please use createValidator() and use Validator class directly.

Parameters:

schemaNode - JsonNode schema JSON, which could be created via JsonNodeFactory

instanceNode - JsonNode instance JSON, which could be created via JsonNodeFactory

Returns:

validation result

See Also:

• validate(String, String)