From 9bba5178cb50eeb691331ec2b977c69a1e8a5df4 Mon Sep 17 00:00:00 2001 From: ramuramaiah Date: Tue, 19 Jun 2018 19:21:29 +0530 Subject: [PATCH] Replaced the org.json JSON parser with jackson JSON parser Replaced the org.json JSON parser with jackson JSON parser --- .gitignore | 10 - .travis.yml | 15 - CONTRIBUTING.md | 86 --- README.md | 415 +--------- core/org.everit.json.schema.iml | 36 + core/pom.xml | 41 +- .../org/everit/json/schema/ArraySchema.java | 4 +- .../schema/ArraySchemaValidatingVisitor.java | 8 +- .../org/everit/json/schema/BooleanSchema.java | 4 +- .../schema/CollectingFailureReporter.java | 4 +- .../everit/json/schema/CombinedSchema.java | 46 +- .../org/everit/json/schema/ConstSchema.java | 4 +- .../schema/EarlyFailingFailureReporter.java | 4 +- .../org/everit/json/schema/EnumSchema.java | 20 +- .../org/everit/json/schema/FalseSchema.java | 13 +- .../org/everit/json/schema/JsonException.java | 37 + .../org/everit/json/schema/JsonPointer.java | 162 ++++ .../json/schema/JsonPointerException.java | 13 + .../everit/json/schema/JsonSchemaUtil.java | 132 ++++ .../org/everit/json/schema/NotSchema.java | 4 +- .../org/everit/json/schema/NullSchema.java | 4 +- .../org/everit/json/schema/NumberSchema.java | 20 +- .../everit/json/schema/ObjectComparator.java | 40 +- .../org/everit/json/schema/ObjectSchema.java | 62 +- .../schema/ObjectSchemaValidatingVisitor.java | 36 +- .../org/everit/json/schema/Procedure.java | 6 + .../everit/json/schema/ReferenceSchema.java | 4 +- .../java/org/everit/json/schema/Schema.java | 13 +- .../org/everit/json/schema/StringSchema.java | 8 +- .../org/everit/json/schema/TrueSchema.java | 11 +- .../everit/json/schema/ValidatingVisitor.java | 8 +- .../json/schema/ValidationException.java | 36 +- .../schema/ValidationFailureReporter.java | 4 +- .../java/org/everit/json/schema/Visitor.java | 5 +- .../json/schema/internal/JSONPrinter.java | 112 ++- .../internal/JsonPointerFormatValidator.java | 4 +- .../RelativeJsonPointerFormatValidator.java | 7 +- .../loader/AdjacentSchemaExtractionState.java | 39 - .../schema/loader/CombinedSchemaLoader.java | 60 +- .../everit/json/schema/loader/JsonArray.java | 33 +- .../everit/json/schema/loader/JsonObject.java | 86 ++- .../schema/loader/JsonPointerEvaluator.java | 23 +- .../everit/json/schema/loader/JsonValue.java | 76 +- .../json/schema/loader/LoadingState.java | 18 +- .../json/schema/loader/NullJsonObject.java | 30 + .../schema/loader/ObjectSchemaLoader.java | 21 +- .../schema/loader/ProjectedJsonObject.java | 121 --- .../json/schema/loader/ReferenceLookup.java | 23 +- .../json/schema/loader/SchemaExtractor.java | 284 ------- .../json/schema/loader/SchemaLoader.java | 304 +++++--- .../schema/loader/internal/JSONPointer.java | 180 ----- .../loader/internal/ReferenceResolver.java | 2 +- .../ResolutionScopeChangeListener.java | 19 - .../loader/internal/TypeBasedMultiplexer.java | 252 ------- .../json/schema/regexp/RE2JRegexpFactory.java | 30 - .../everit/json/schema/ArraySchemaTest.java | 43 +- .../schema/CollectingFailureReporterTest.java | 10 +- .../json/schema/CombinedSchemaTest.java | 37 +- .../everit/json/schema/ConstSchemaTest.java | 22 +- .../everit/json/schema/EmptySchemaTest.java | 26 +- .../everit/json/schema/EnumSchemaTest.java | 44 +- .../everit/json/schema/NullSchemaTest.java | 7 +- .../json/schema/NullableValidationTest.java | 4 +- .../everit/json/schema/NumberSchemaTest.java | 35 +- .../json/schema/ObjectComparatorTest.java | 18 +- .../everit/json/schema/ObjectSchemaTest.java | 76 +- .../json/schema/PointerBubblingTest.java | 12 +- .../json/schema/ReferenceSchemaTest.java | 11 +- .../everit/json/schema/ResourceLoader.java | 24 +- .../json/schema/SchemaExceptionTest.java | 7 +- .../everit/json/schema/StringSchemaTest.java | 50 +- .../org/everit/json/schema/TestSupport.java | 5 +- .../json/schema/ValidatingVisitorTest.java | 22 +- .../json/schema/ValidationExceptionTest.java | 18 +- .../org/everit/json/schema/ValidatorTest.java | 9 +- .../internal/DefaultFormatValidatorTest.java | 309 -------- .../json/schema/internal/JSONPrinterTest.java | 137 ---- .../JsonPointerFormatValidatorTest.java | 56 -- ...elativeJsonPointerFormatValidatorTest.java | 97 --- .../URIReferenceFormatValidatorTest.java | 32 - .../internal/URITemplateFormatTest.java | 22 - .../internal/URIV4FormatValidatorTest.java | 24 - .../schema/internal/ValidatorTestSupport.java | 27 - .../AdjacentSchemaExtractionStateTest.java | 28 - .../schema/loader/ArraySchemaLoaderTest.java | 91 --- .../loader/CombinedSchemaLoaderTest.java | 80 -- .../loader/CustomFormatValidatorTest.java | 95 --- .../schema/loader/DefinesPropertyTest.java | 123 --- .../everit/json/schema/loader/ExtendTest.java | 78 -- .../json/schema/loader/JsonArrayTest.java | 25 - .../json/schema/loader/JsonObjectTest.java | 170 ----- .../loader/JsonPointerEvaluatorTest.java | 90 --- .../json/schema/loader/JsonValueTest.java | 294 -------- .../json/schema/loader/LoadingStateTest.java | 105 --- .../loader/NumberSchemaLoadingTest.java | 69 -- .../schema/loader/ObjectSchemaLoaderTest.java | 111 --- .../loader/ProjectedJsonObjectTest.java | 174 ----- .../loader/ReadWriteContextLoadingTest.java | 40 - .../schema/loader/ReferenceLookupTest.java | 87 --- .../schema/loader/ResolutionScopeTest.java | 45 -- .../json/schema/loader/SchemaLoaderTest.java | 707 ------------------ .../loader/SpecificationVersionTest.java | 54 -- .../internal/ReferenceResolverTest.java | 104 --- .../internal/TypeBasedMultiplexerTest.java | 172 ----- .../schema/regexp/JavaUtilRegexpTest.java | 33 - .../json/schema/regexp/RE2JRegexpTest.java | 33 - .../jsonvalidator/combinedtestschemas.json | 27 +- .../nestedSchema-tests-input.json | 11 + .../jsonvalidator/nestedSchema-tests.json | 43 ++ .../jsonvalidator/ref-lookup-tests.json | 3 - .../org/everit/jsonvalidator/testschemas.json | 17 +- .../jsonvalidator/v4-referred-subschema.json | 9 - jetbrains-logo.png | Bin 4835 -> 0 bytes org.everit.json.schema.parent.iml | 12 + pom.xml | 2 +- tests/org.everit.json.schema.tests.iml | 42 ++ tests/pom.xml | 4 +- .../org/everit/json/schema/AllofTest.java | 25 + .../everit/json/schema/EmptyObjectTest.java | 10 +- .../json/schema/EvenCharNumValidator.java | 20 - .../json/schema/InvalidObjectInArrayTest.java | 28 - .../org/everit/json/schema/IssueTest.java | 292 -------- .../everit/json/schema/MetaSchemaTest.java | 8 +- .../everit/json/schema/RelativeURITest.java | 6 +- .../java/org/everit/json/schema/TestCase.java | 61 +- .../issues/issue164/remotes/v4-schema.json | 9 - .../json/schema/issues/issue164/schema.json | 11 - .../schema/issues/issue164/subject-valid.json | 9 - .../issues/issue174/expectedException.json | 36 - .../json/schema/issues/issue174/schema.json | 36 - .../issues/issue174/subject-invalid.json | 3 - .../issues/issue182/remotes/schemaA.json | 12 - .../issues/issue182/remotes/schemaB.json | 13 - .../issues/issue182/remotes/schemaC.json | 13 - .../json/schema/issues/issue182/schema.json | 18 - .../schema/issues/issue182/subject-valid.json | 5 - .../json/schema/issues/issue36/remotes/geo | 10 - .../json/schema/issues/issue36/schema.json | 2 +- .../json/schema/wm/allof/allOfSchema.json | 18 + .../schema/wm/allof/allOfSchema_subject.json | 4 + 140 files changed, 1586 insertions(+), 6264 deletions(-) delete mode 100644 .gitignore delete mode 100644 .travis.yml delete mode 100644 CONTRIBUTING.md create mode 100644 core/org.everit.json.schema.iml create mode 100644 core/src/main/java/org/everit/json/schema/JsonException.java create mode 100644 core/src/main/java/org/everit/json/schema/JsonPointer.java create mode 100644 core/src/main/java/org/everit/json/schema/JsonPointerException.java create mode 100644 core/src/main/java/org/everit/json/schema/JsonSchemaUtil.java create mode 100644 core/src/main/java/org/everit/json/schema/Procedure.java delete mode 100644 core/src/main/java/org/everit/json/schema/loader/AdjacentSchemaExtractionState.java create mode 100644 core/src/main/java/org/everit/json/schema/loader/NullJsonObject.java delete mode 100644 core/src/main/java/org/everit/json/schema/loader/ProjectedJsonObject.java delete mode 100644 core/src/main/java/org/everit/json/schema/loader/SchemaExtractor.java delete mode 100644 core/src/main/java/org/everit/json/schema/loader/internal/JSONPointer.java delete mode 100644 core/src/main/java/org/everit/json/schema/loader/internal/ResolutionScopeChangeListener.java delete mode 100644 core/src/main/java/org/everit/json/schema/loader/internal/TypeBasedMultiplexer.java delete mode 100644 core/src/main/java/org/everit/json/schema/regexp/RE2JRegexpFactory.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/DefaultFormatValidatorTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/JSONPrinterTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/JsonPointerFormatValidatorTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/RelativeJsonPointerFormatValidatorTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/URIReferenceFormatValidatorTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/URITemplateFormatTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/URIV4FormatValidatorTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/internal/ValidatorTestSupport.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/AdjacentSchemaExtractionStateTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/ArraySchemaLoaderTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/CombinedSchemaLoaderTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/CustomFormatValidatorTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/DefinesPropertyTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/ExtendTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/JsonArrayTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/JsonObjectTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/JsonPointerEvaluatorTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/JsonValueTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/LoadingStateTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/NumberSchemaLoadingTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/ObjectSchemaLoaderTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/ProjectedJsonObjectTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/ReadWriteContextLoadingTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/ReferenceLookupTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/ResolutionScopeTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/SchemaLoaderTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/SpecificationVersionTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/internal/ReferenceResolverTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/loader/internal/TypeBasedMultiplexerTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/regexp/JavaUtilRegexpTest.java delete mode 100644 core/src/test/java/org/everit/json/schema/regexp/RE2JRegexpTest.java create mode 100644 core/src/test/resources/org/everit/jsonvalidator/nestedSchema-tests-input.json create mode 100644 core/src/test/resources/org/everit/jsonvalidator/nestedSchema-tests.json delete mode 100644 core/src/test/resources/org/everit/jsonvalidator/v4-referred-subschema.json delete mode 100644 jetbrains-logo.png create mode 100644 org.everit.json.schema.parent.iml create mode 100644 tests/org.everit.json.schema.tests.iml create mode 100644 tests/src/test/java/org/everit/json/schema/AllofTest.java delete mode 100644 tests/src/test/java/org/everit/json/schema/EvenCharNumValidator.java delete mode 100644 tests/src/test/java/org/everit/json/schema/InvalidObjectInArrayTest.java delete mode 100644 tests/src/test/java/org/everit/json/schema/IssueTest.java delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue164/remotes/v4-schema.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue164/schema.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue164/subject-valid.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue174/expectedException.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue174/schema.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue174/subject-invalid.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue182/remotes/schemaA.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue182/remotes/schemaB.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue182/remotes/schemaC.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue182/schema.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue182/subject-valid.json delete mode 100644 tests/src/test/resources/org/everit/json/schema/issues/issue36/remotes/geo create mode 100644 tests/src/test/resources/org/everit/json/schema/wm/allof/allOfSchema.json create mode 100644 tests/src/test/resources/org/everit/json/schema/wm/allof/allOfSchema_subject.json diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 07c324505..000000000 --- a/.gitignore +++ /dev/null @@ -1,10 +0,0 @@ -.project -.settings -.classpath -target -.checkstyle -.fbExcludeFilterFile -.pmd -.pmdruleset.xml -.idea -*.iml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 45dfa565a..000000000 --- a/.travis.yml +++ /dev/null @@ -1,15 +0,0 @@ -language: java -jdk: - - oraclejdk8 -script: mvn verify -after_success: - - mvn -f core/pom.xml jacoco:report coveralls:report -install: true -sudo: false -cache: - directories: - - $HOME/.m2 -addons: - apt: - packages: - - oracle-java8-installer diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 8db2b0d10..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,86 +0,0 @@ -# Contributing guidelines - - -## Submitting bugreports - - -Though any kind of feedback, feature request and bugreport is appreciated, I would more prefer if you would send a proper -pull request with a failing test in case you find a bug in the library. - -Currently there is a simple mechanism in the integration tests to make it easy to add new tests. Using this is especially -preferred if your bugreport is related to a complex schema or multiple schemas. There is no need to dig into the java code, -you only have to create a few new files in the repo (but you will have to run the tests - see the build instructions below). - -### Steps: - * create an issue, just to get an issue number - * fork the repository - * in your fork, create a directory under the `tests/src/test/resources/org/everit/json/schema/issues/` directory (for example `issue42` ) - * in this directory create a `schema.json` file with your JSON Schema document that is not handled correctly - * in the same directory create a `subject-valid.json` file, which is a JSON document, and you expect that document to pass -the validation, but due to a bug it fails with a `ValidationException` - * if you have a JSON document that you expect to be invalid, but it passes the validation, then you should name this file `subject-invalid.json`. -It will mean that for the test suite that an expected `ValidationException` is not thrown. - * you can create both the `subject-valid.json` and `subject-invalid.json` test files if you find it needed - - -### Remote schema loading: -If your testcase has anything to do with remote schemas, then - * you can put those schemas under the `yourIssueDir/remotes/` directory - * the `yourIssueDir/remotes/` directory will act as the document root of a HTTP server during test execution - * this HTTP server will listen at address `http://localhost:1234` so please change your schemas (`id` and `$ref` properties) -to fetch the remote schemas relative from this address - -You can find a good example for all of these in the `tests/src/test/resources/org/everit/json/schema/issues/issue17` testcase. - -If you successfully created your testcase, then it will fail with an `AssertionError` with a message like -"validation failed with: org.everit.json.schema.ValidationException:..." or "did not throw ValidationException for invalid subject", -and then you are ready to send a pull request. - -### Defining expected failures in integration tests - -In some cases the error you want to report is not about "if a given json is valid against a schema", but instead an inproper validation failure report to be tested. In such case you can create a testcase which contains: -* a `schema.json` -* a `subject-invalid.json` -* an `expectedException.json` - -The last one should contain a JSON description of the expected exception. Such an exception description has at most 2 keys: -* `message`: (required) the value is the expected exception message -* `causingExceptions` : (optional) the value is an array of causing exceptions (which are returned by the `ġetCausingExceptions()` method of the expected `ValidationException`). Each item of this entry should also be an exception description, so these are objects with a required `message` and an optional `causingExceptions` key. Example `expectedException.json`: - -```js -{ - "message": "#: 4 schema violations found", - "causingExceptions": [ - { - "message": "#/0: 2 schema violations found", - "causingExceptions": [ - { - "message": "#/0/name: expected type: String, found: JSONArray" - }, - { - "message": "#/0/dimensions/width: expected type: Number, found: String" - } - ] - }, - { - "message": "#/1: required key [price] not found" - }, - { - "message": "#/2/id: expected type: Number, found: String" - } - ] -} -``` - -## Building the project locally - -Prerequisities: the following tools have to be installed: -* jdk1.8.0_45 (earlier versions of javac cannot compile the project due to a type inference issue) -* maven 3.x - - -Steps for building the project: -* clone the repository: `git clone https://github.com/everit-org/json-schema.git && cd json-schema/` -* build it with maven: `mvn clean install` - -(or just `mvn clean test` if you are only interested in running the tests) diff --git a/README.md b/README.md index e18775bc1..b02c54b2d 100644 --- a/README.md +++ b/README.md @@ -1,417 +1,12 @@ -# JSON Schema Validator +# JSON Schema Validator (Modified Everit JSON Schema parser with jackson as the JSON parser) [![Apache 2.0 License][ASL 2.0 badge]][ASL 2.0] [![Build Status][Travis badge master]][Travis] [![Coverage Status][Coveralls.io badge master]][Coveralls.io] -* [When to use this library?](#when-to-use-this-library) -* [Maven installation](#maven-installation) - * [Java7 version](#java7-version) -* [Quickstart](#quickstart) -* [Draft 4 or Draft 6 or Draft 7?](#draft-4-or-draft-6-or-draft-7) -* [Investigating failures](#investigating-failures) - * [JSON report of the failures](#json-report-of-the-failures) -* [Eary failure mode](#early-failure-mode) -* [Default values](#default-values) -* [RegExp implementations](#regexp-implementations) -* [readOnly and writeOnly context](#readonly-and-writeonly-context) -* [Format validators](#format-validators) - * [Example](#example) -* [Resolution scopes](#resolution-scopes) - - Supported by JetBrains. +* [The original JSON Schema validator](#the-original-json-schema-validator) This project is an implementation of the JSON Schema [Draft v4][draft-zyp-json-schema-04], [Draft v6](https://tools.ietf.org/html/draft-wright-json-schema-01) and [Draft v7](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00) specifications. -It uses the [org.json API](http://stleary.github.io/JSON-java/) (created by Douglas Crockford) for representing JSON data. - -# When to use this library? - -Lets assume that you already know what JSON Schema is, and you want to utilize it in a Java application to validate JSON data. -But - as you may have already discovered - there is also an [other Java implementation][java-json-tools/json-schema-validator] -of the JSON Schema specification. So here are some advices about which one to use: - * if you use Jackson to handle JSON in Java code, then [java-json-tools/json-schema-validator] is obviously a better choice, since it uses Jackson - * if you want to use the [org.json API](http://stleary.github.io/JSON-java/) then this library is the better choice - * if you need JSON Schema Draft 6 / 7 support, then you need this library. - * if you want to use anything else for handling JSON (like GSON or javax.json), then you are in a little trouble, since -currently there is no schema validation library backed by these libraries. It means that you will have to parse the JSON -twice: once for the schema validator, and once for your own processing. In a case like that, this library is probably still -a better choice, since it seems to be [twice faster](https://github.com/erosb/json-schema-perftest) than the Jackson-based [java-json-tools][java-json-tools/json-schema-validator] library. - - -## Maven installation - -Add the JitPack repository and the dependency to your `pom.xml` as follows: - -```xml - - com.github.everit-org.json-schema - org.everit.json.schema - 1.9.1 - -... - - - jitpack.io - https://jitpack.io - - -``` - -_Note_: from version `1.6.0`, the library is primarily distributed through JitPack. Previous versions are also available through maven central. - -### Java7 version - -If you are looking for a version which works on Java7, then you can use this artifact, kindly backported by [Doctusoft](https://doctusoft.com/): - -```xml - - com.doctusoft - json-schema-java7 - 1.4.1 - -``` - -## Quickstart - - -```java -import org.everit.json.schema.Schema; -import org.everit.json.schema.loader.SchemaLoader; -import org.json.JSONObject; -import org.json.JSONTokener; -// ... -try (InputStream inputStream = getClass().getResourceAsStream("/path/to/your/schema.json")) { - JSONObject rawSchema = new JSONObject(new JSONTokener(inputStream)); - Schema schema = SchemaLoader.load(rawSchema); - schema.validate(new JSONObject("{\"hello\" : \"world\"}")); // throws a ValidationException if this object is invalid -} -``` - -## Draft 4, Draft 6 or Draft 7? - -JSON Schema has currently 4 major releases, Draft 3, Draft 4, Draft 6 and Draft 7. This library implements the 3 newer ones, you can have a quick look at the differences [here](https://github.com/json-schema-org/json-schema-spec/wiki/FAQ:-draft-wright-json-schema%5B-validation%5D-01#changes) and [here](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#appendix-B). -Since the two versions have a number of differences - and draft 6 is not backwards-compatible with draft 4 - it is good to know which version will you use. - -The best way to denote the JSON Schema version you want to use is to include its meta-schema URL in the document root with the `"$schema"` key. This is a common notation, facilitated by the library to determine which version should be used. - -Quick reference: - * if there is `"$schema": "http://json-schema.org/draft-04/schema"` in the schema root, then Draft 4 will be used - * if there is `"$schema": "http://json-schema.org/draft-06/schema"` in the schema root, then Draft 6 will be used - * if there is `"$schema": "http://json-schema.org/draft-07/schema"` in the schema root, then Draft 7 will be used - * if none of these is found then Draft 4 will be assumed as default - -If you want to specify the meta-schema version explicitly then you can change the default from Draft 4 to Draft 6 / 7 by configuring the loader this way: - -```java -SchemaLoader loader = SchemaLoader.builder() - .schemaJson(yourSchemaJSON) - .draftV6Support() // or draftV7Support() - .build(); -Schema schema = loader.load().build(); -``` - -## Investigating failures - - -Starting from version `1.1.0` the validator collects every schema violations (instead of failing immediately on the first -one). Each failure is denoted by a JSON pointer, pointing from the root of the document to the violating part. If more -than one schema violations have been detected, then a `ValidationException` will be thrown at the most common parent -elements of the violations, and each separate violations can be obtained using the `ValidationException#getCausingExceptions()` -method. - -To demonstrate the above concepts, lets see an example. Lets consider the following schema: - -```json -{ - "type" : "object", - "properties" : { - "rectangle" : {"$ref" : "#/definitions/Rectangle" } - }, - "definitions" : { - "size" : { - "type" : "number", - "minimum" : 0 - }, - "Rectangle" : { - "type" : "object", - "properties" : { - "a" : {"$ref" : "#/definitions/size"}, - "b" : {"$ref" : "#/definitions/size"} - } - } - } -} -``` - -The following JSON document has only one violation against the schema (since "a" cannot be negative): - -```json -{ - "rectangle" : { - "a" : -5, - "b" : 5 - } -} -``` - -In this case the thrown `ValidationException` will point to `#/rectangle/a` and it won't contain sub-exceptions: - -```java -try { - schema.validate(rectangleSingleFailure); -} catch (ValidationException e) { - // prints #/rectangle/a: -5.0 is not higher or equal to 0 - System.out.println(e.getMessage()); -} -``` - - -Now - to illustrate the way how multiple violations are handled - lets consider the following JSON document, where both -the "a" and "b" properties violate the above schema: - -```json -{ - "rectangle" : { - "a" : -5, - "b" : "asd" - } -} -``` - -In this case the thrown `ValidationException` will point to `#/rectangle`, and it has 2 sub-exceptions, pointing to -`#/rectangle/a` and `#/rectangle/b` : - -```java -try { - schema.validate(rectangleMultipleFailures); -} catch (ValidationException e) { - System.out.println(e.getMessage()); - e.getCausingExceptions().stream() - .map(ValidationException::getMessage) - .forEach(System.out::println); -} -``` - -This will print the following output: -``` -#/rectangle: 2 schema violations found -#/rectangle/a: -5.0 is not higher or equal to 0 -#/rectangle/b: expected type: Number, found: String -``` - -### JSON report of the failures - -Since version `1.4.0` it is possible to print the `ValidationException` instances as -JSON-formatted failure reports. The `ValidationException#toJSON()` method returns a `JSONObject` instance with the -following keys: - - * `"message"`: the programmer-friendly exception message (desription of the validation failure) - * `"keyword"`: the JSON Schema keyword which was violated - * `"pointerToViolation"`: a JSON Pointer denoting the path from the input document root to its fragment which caused - the validation failure - * `"schemaLocation"`: a JSON Pointer denoting the path from the schema JSON root to the violated keyword - * `"causingExceptions"`: a (possibly empty) array of sub-exceptions. Each sub-exception is represented as a JSON object, - with the same structure as described in this listing. See more above about causing exceptions. - -Please take into account that the complete failure report is a *hierarchical tree structure*: sub-causes of a cause can -be obtained using `#getCausingExceptions()` . - -## Early failure mode - -By default the validation error reporting in collecting mode (see the "Investigating failures" chapter). That is convenient for having a -detailed error report, but under some circumstances it is more appropriate to stop the validation when a failure is found without -checking the rest of the JSON document. To toggle this fast-failing validation mode - * you have to explicitly build a `Validator` instance for your schema instead of calling `Schema#validate(input)` - * you have to call the `failEarly()` method of `ValidatorBuilder` - -Example: - -```java -import org.everit.json.schema.Validator; -... -Validator validator = Validator.builder() - .failEarly() - .build(); -validator.performValidation(schema, input); -``` - -_Note: the `Validator` class is immutable and thread-safe, so you don't have to create a new one for each validation, it is enough -to configure it only once._ - - -## Default values - -The JSON Schema specification defines the "default" keyword for denoting default values, though it doesn't explicitly state how it should -affect the validation process. By default this library doesn't set the default values, but if you need this feature, you can turn it on -by the `SchemaLoaderBuilder#useDefaults(boolean)` method, before loading the schema: - -```json -{ - "properties": { - "prop": { - "type": "number", - "default": 1 - } - } -} -``` - - -```java -JSONObject input = new JSONObject("{}"); -System.out.println(input.get("prop")); // prints null -Schema schema = SchemaLoader.builder() - .useDefaults(true) - .schemaJson(rawSchema) - .build() - .load().build(); -schema.validate(input); -System.out.println(input.get("prop")); // prints 1 -``` - -If there are some properties missing from `input` which have `"default"` values in the schema, then they will be set by the validator -during validation. - -## RegExp Implementations - -For supporting the `"regex"` keyword of JSON Schema the library offers two possible implementations: - * the default is based on the `java.util.regex` package - * the other one is based on the [RE2J](https://github.com/google/re2j) library - -While the RE2J library provides significantly better performance than `java.util.regex`, it is not completely compatible with -the syntax supported by `java.util` or ECMA 262. So RE2J is recommended if you are concerned about performance and its limitations are acceptable. - -The RE2J implementation can be activated with the `SchemaLoaderBuilder#regexpFactory()` call: - -```java -SchemaLoader loader = SchemaLoader.builder() - .regexpFactory(new RE2JRegexpFactory()) - // ... - .build(); -``` -Notes: - - if you don't need the RE2J implementation, it is recommended to exclude it in your `pom.xml` so it doesn't increase your artifact's size unnecessarily - - version history: in versions 1.0.0 ... 1.7.0 the `java.util` implementation was used, in 1.8.0 the RE2J implementation was used, and in 1.9.0 we made it -configurable, due to some reported regressions. - - -## readOnly and writeOnly context - -The library supports the `readOnly` and `writeOnly` keywords which first appeared in Draft 7. If you want to utilize this feature, then before validation you need to tell the vaildator if the -validation happens in read or write context. Example: - -schema.json: - -```json -{ - "properties": { - "id": { - "type": "number", - "readOnly": true - } - } -} -``` - -Validation code snippet: -```java - -Validator validator = Validator.builder() - .readWriteContext(ReadWriteContext.WRITE) - .build(); - -validator.performValidation(schema, new JSONObject("{\"id\":42}")); -``` - -In this case we told the validator that the validation happens in `WRITE` context, and in the input JSON object the `"id"` property appears, which is marked as `"readOnly"` in the schema, therefore this call will throw a `ValidationException`. - -## Format validators - - -Starting from version `1.2.0` the library supports the [`"format"` keyword][draft-fge-json-schema-validation-00 format] -(which is an optional part of the specification). - -The supported formats vary depending on the schema spec version you use (since the standard formats were introduced in different versions on the validation specification). - -Here is a compatibility table of te supported standard formats: - -| | Draft 4 | Draft 6 | Draft 7 | -|----------------------|--------------------|--------------------|--------------------| -| date-time | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| email | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| hostname | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| ipv4 | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| ipv6 | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| uri | :white_check_mark: | :white_check_mark: | :white_check_mark: | -| uri-reference | | :white_check_mark: | :white_check_mark: | -| uri-template | | :white_check_mark: | :white_check_mark: | -| json-pointer | | :white_check_mark: | :white_check_mark: | -| date | | | :white_check_mark: | -| time | | | :white_check_mark: | -| regex | | | :white_check_mark: | -| relative-json-pointer| | | :white_check_mark: | - - -The library also supports adding custom format validators. To use a custom validator basically you have to - - * create your own validation in a class implementing the `org.everit.json.schema.FormatValidator` interface - * bind your validator to a name in a `org.everit.json.schema.loader.SchemaLoader.SchemaLoaderBuilder` instance before loading the actual schema - -### Example - - - -Lets assume the task is to create a custom validator which accepts strings with an even number of characters. - -The custom `FormatValidator` will look something like this: - -```java -public class EvenCharNumValidator implements FormatValidator { - - @Override - public Optional validate(final String subject) { - if (subject.length() % 2 == 0) { - return Optional.empty(); - } else { - return Optional.of(String.format("the length of string [%s] is odd", subject)); - } - } - -} -``` - -To bind the `EvenCharNumValidator` to a `"format"` value (for example `"evenlength"`) you have to bind a validator instance -to the keyword in the schema loader configuration: - -```java -JSONObject rawSchema = new JSONObject(new JSONTokener(inputStream)); -SchemaLoader schemaLoader = SchemaLoader.builder() - .schemaJson(rawSchema) // rawSchema is the JSON representation of the schema utilizing the "evenlength" non-standard format - .addFormatValidator("evenlength", new EvenCharNumValidator()) // the EvenCharNumValidator gets bound to the "evenlength" keyword - .build(); -Schema schema = schemaLoader.load().build(); // the schema is created using the above created configuration -schema.validate(jsonDcoument); // the document validation happens here -``` - - -## Resolution scopes - -In a JSON Schema document it is possible to use relative URIs to refer previously defined -types. Such references are expressed using the `"$ref"` and `"id"` keywords. While the specification describes resolution scope alteration and dereferencing in detail, it doesn't explain the expected behavior when the first occuring `"$ref"` or `"id"` is a relative URI. - -In the case of this implementation it is possible to explicitly define an absolute URI serving as the base URI (resolution scope) using the appropriate builder method: +It uses the [jackson API](https://github.com/FasterXML/jackson) as the underlying JSON parser. -```java -SchemaLoader schemaLoader = SchemaLoader.builder() - .schemaJson(jsonSchema) - .resolutionScope("http://example.org/") // setting the default resolution scope - .build(); -``` +# The original JSON Schema validator -[ASL 2.0 badge]: https://img.shields.io/:license-Apache%202.0-blue.svg -[ASL 2.0]: https://www.apache.org/licenses/LICENSE-2.0 -[Travis badge master]: https://travis-ci.org/everit-org/json-schema.svg?branch=master -[Travis]: https://travis-ci.org/everit-org/json-schema -[Coveralls.io badge master]: https://coveralls.io/repos/github/everit-org/json-schema/badge.svg?branch=master -[Coveralls.io]: https://coveralls.io/github/everit-org/json-schema?branch=master -[java-json-tools/json-schema-validator]: https://github.com/java-json-tools/json-schema-validator -[draft-zyp-json-schema-04]: https://tools.ietf.org/html/draft-zyp-json-schema-04 -[draft-fge-json-schema-validation-00 format]: https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-7 +https://github.com/everit-org/json-schema \ No newline at end of file diff --git a/core/org.everit.json.schema.iml b/core/org.everit.json.schema.iml new file mode 100644 index 000000000..8f529321d --- /dev/null +++ b/core/org.everit.json.schema.iml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/core/pom.xml b/core/pom.xml index 24723d4fe..14884a6fc 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -1,8 +1,6 @@