Rename JsonSchemaFactory to SchemaRegistry

Author: justin-tay

src/main/java/com/networknt/schema/Schema.java

@@ -40,7 +40,7 @@
 
 /**
  * Used for creating a schema with validators for validating inputs. This is
- * created using {@link JsonSchemaFactory#getInstance(Version, Consumer)}
+ * created using {@link SchemaRegistry#getInstance(Version, Consumer)}
  * and should be cached for performance.
  * <p>
  * This is the core of json constraint implementation. It parses json constraint
@@ -1405,7 +1405,7 @@ public List<KeywordValidator> getValidators() {
      * For avoiding issues with concurrency, in 1.0.49 the {@link com.networknt.schema.Schema} instances affiliated with
      * validators were modified to no more preload the schema and lazy loading is used instead.
      * <p>This comes with the issue that this way you cannot rely on validating important schema features, in particular
-     * <code>$ref</code> resolution at instantiation from {@link com.networknt.schema.JsonSchemaFactory}.</p>
+     * <code>$ref</code> resolution at instantiation from {@link com.networknt.schema.SchemaRegistry}.</p>
      * <p>By calling <code>initializeValidators</code> you can enforce preloading of the {@link com.networknt.schema.Schema}
      * instances of the validators.</p>
      */

src/main/java/com/networknt/schema/JsonSchemaFactory.java renamed to src/main/java/com/networknt/schema/SchemaRegistry.java

@@ -54,8 +54,8 @@
  * JsonSchemaFactory instances are thread-safe provided its configuration is not
  * modified.
  */
-public class JsonSchemaFactory {
-    private static final Logger logger = LoggerFactory.getLogger(JsonSchemaFactory.class);
+public class SchemaRegistry {
+    private static final Logger logger = LoggerFactory.getLogger(SchemaRegistry.class);
 
     public static class Builder {
         private ObjectMapper jsonMapper = null;
@@ -173,8 +173,8 @@ public Builder addMetaSchemas(final Collection<? extends Dialect> jsonMetaSchema
             return metaSchemas(jsonMetaSchemas);
         }
 
-        public JsonSchemaFactory build() {
-            return new JsonSchemaFactory(
+        public SchemaRegistry build() {
+            return new SchemaRegistry(
                     jsonMapper,
                     yamlMapper,
                     jsonNodeReader,
@@ -203,7 +203,7 @@ public JsonSchemaFactory build() {
     private static final List<SchemaLoader> DEFAULT_SCHEMA_LOADERS = SchemaLoaders.builder().build();
     private static final List<SchemaMapper> DEFAULT_SCHEMA_MAPPERS = SchemaMappers.builder().build();
 
-    private JsonSchemaFactory(
+    private SchemaRegistry(
             ObjectMapper jsonMapper,
             ObjectMapper yamlMapper,
             JsonNodeReader jsonNodeReader,
@@ -241,7 +241,7 @@ public SchemaLoader getSchemaLoader() {
     /**
      * Builder without keywords or formats.
      *
-     * Typically {@link #builder(JsonSchemaFactory)} is what is required.
+     * Typically {@link #builder(SchemaRegistry)} is what is required.
      *
      * @return a builder instance without any keywords or formats - usually not what one needs.
      */
@@ -256,7 +256,7 @@ public static Builder builder() {
      * @param versionFlag the default dialect
      * @return the factory
      */
-    public static JsonSchemaFactory getInstance(Specification.Version versionFlag) {
+    public static SchemaRegistry getInstance(Specification.Version versionFlag) {
         return getInstance(versionFlag, null);
     }
 
@@ -268,10 +268,10 @@ public static JsonSchemaFactory getInstance(Specification.Version versionFlag) {
      * @param customizer to customize the factory
      * @return the factory
      */
-    public static JsonSchemaFactory getInstance(Specification.Version versionFlag,
-            Consumer<JsonSchemaFactory.Builder> customizer) {
+    public static SchemaRegistry getInstance(Specification.Version versionFlag,
+            Consumer<SchemaRegistry.Builder> customizer) {
         Dialect dialect = checkVersion(versionFlag);
-        JsonSchemaFactory.Builder builder = builder().defaultMetaSchemaIri(dialect.getIri())
+        SchemaRegistry.Builder builder = builder().defaultMetaSchemaIri(dialect.getIri())
                 .metaSchema(dialect);
         if (customizer != null) {
             customizer.accept(builder);
@@ -300,7 +300,7 @@ public static Dialect checkVersion(Specification.Version version){
     }
 
     /**
-     * Builder from an existing {@link JsonSchemaFactory}.
+     * Builder from an existing {@link SchemaRegistry}.
      * <p>
      * <code>
      * JsonSchemaFactory.builder(JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V201909));
@@ -309,7 +309,7 @@ public static Dialect checkVersion(Specification.Version version){
      * @param blueprint the existing factory
      * @return the builder
      */
-    public static Builder builder(final JsonSchemaFactory blueprint) {
+    public static Builder builder(final SchemaRegistry blueprint) {
         Builder builder = builder()
                 .metaSchemas(blueprint.metaSchemas.values())
                 .defaultMetaSchemaIri(blueprint.defaultMetaSchemaIri)

src/main/java/com/networknt/schema/SpecificationVersionDetector.java

@@ -75,7 +75,7 @@ public static Optional<Version> detectOptionalVersion(JsonNode jsonNode, boolean
         return Optional.ofNullable(jsonNode.get(SCHEMA_TAG)).map(schemaTag -> {
 
             String schemaTagValue = schemaTag.asText();
-            String schemaUri = JsonSchemaFactory.normalizeMetaSchemaUri(schemaTagValue);
+            String schemaUri = SchemaRegistry.normalizeMetaSchemaUri(schemaTagValue);
 
             if (throwIfUnsupported) {
                 return Version.fromDialectId(schemaUri)

src/main/java/com/networknt/schema/ValidationContext.java

@@ -27,18 +27,18 @@
 
 public class ValidationContext {
     private final Dialect dialect;
-    private final JsonSchemaFactory jsonSchemaFactory;
+    private final SchemaRegistry jsonSchemaFactory;
     private final SchemaValidatorsConfig config;
     private final ConcurrentMap<String, Schema> schemaReferences;
     private final ConcurrentMap<String, Schema> schemaResources;
     private final ConcurrentMap<String, Schema> dynamicAnchors;
 
     public ValidationContext(Dialect dialect,
-                             JsonSchemaFactory jsonSchemaFactory, SchemaValidatorsConfig config) {
+                             SchemaRegistry jsonSchemaFactory, SchemaValidatorsConfig config) {
         this(dialect, jsonSchemaFactory, config, new ConcurrentHashMap<>(), new ConcurrentHashMap<>(), new ConcurrentHashMap<>());
     }
 
-    public ValidationContext(Dialect dialect, JsonSchemaFactory jsonSchemaFactory,
+    public ValidationContext(Dialect dialect, SchemaRegistry jsonSchemaFactory,
             SchemaValidatorsConfig config, ConcurrentMap<String, Schema> schemaReferences,
             ConcurrentMap<String, Schema> schemaResources, ConcurrentMap<String, Schema> dynamicAnchors) {
         if (dialect == null) {
@@ -69,7 +69,7 @@ public String resolveSchemaId(JsonNode schemaNode) {
         return this.dialect.readId(schemaNode);
     }
 
-    public JsonSchemaFactory getJsonSchemaFactory() {
+    public SchemaRegistry getJsonSchemaFactory() {
         return this.jsonSchemaFactory;
     }
 

src/main/java/com/networknt/schema/dialect/DefaultDialectRegistry.java

@@ -22,7 +22,7 @@
 import com.networknt.schema.Error;
 import com.networknt.schema.InvalidSchemaException;
 import com.networknt.schema.Schema;
-import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SchemaRegistry;
 import com.networknt.schema.SchemaLocation;
 import com.networknt.schema.SchemaValidatorsConfig;
 import com.networknt.schema.Specification;
@@ -33,15 +33,15 @@
  */
 public class DefaultDialectRegistry implements DialectRegistry {
     @Override
-    public Dialect getDialect(String dialectId, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
+    public Dialect getDialect(String dialectId, SchemaRegistry schemaFactory, SchemaValidatorsConfig config) {
         // Is it a well-known dialect?
-        return Specification.Version.fromDialectId(dialectId).map(JsonSchemaFactory::checkVersion).orElseGet(() -> {
+        return Specification.Version.fromDialectId(dialectId).map(SchemaRegistry::checkVersion).orElseGet(() -> {
             // Custom dialect
             return loadDialect(dialectId, schemaFactory, config);
         });
     }
 
-    protected Dialect loadDialect(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
+    protected Dialect loadDialect(String iri, SchemaRegistry schemaFactory, SchemaValidatorsConfig config) {
         try {
             Dialect result = loadDialectBuilder(iri, schemaFactory, config).build();
             return result;
@@ -53,7 +53,7 @@ protected Dialect loadDialect(String iri, JsonSchemaFactory schemaFactory, Schem
         }
     }
 
-    protected Dialect.Builder loadDialectBuilder(String iri, JsonSchemaFactory schemaFactory,
+    protected Dialect.Builder loadDialectBuilder(String iri, SchemaRegistry schemaFactory,
             SchemaValidatorsConfig config) {
         Schema schema = schemaFactory.getSchema(SchemaLocation.of(iri), config);
         Dialect.Builder builder = Dialect.builder(iri, schema.getValidationContext().getMetaSchema());

src/main/java/com/networknt/schema/dialect/DialectRegistry.java

@@ -15,7 +15,7 @@
  */
 package com.networknt.schema.dialect;
 
-import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SchemaRegistry;
 import com.networknt.schema.SchemaValidatorsConfig;
 
 /**
@@ -36,5 +36,5 @@ public interface DialectRegistry {
      * @param config        the config
      * @return the dialect
      */
-    Dialect getDialect(String dialectId, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config);
+    Dialect getDialect(String dialectId, SchemaRegistry schemaFactory, SchemaValidatorsConfig config);
 }

src/main/java/com/networknt/schema/dialect/DisallowUnknownDialectFactory.java

@@ -17,16 +17,16 @@
 
 import com.networknt.schema.Error;
 import com.networknt.schema.InvalidSchemaException;
-import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SchemaRegistry;
 import com.networknt.schema.SchemaValidatorsConfig;
 
 /**
  * A {@link DialectRegistry} that does not meta-schemas that aren't
- * explicitly configured in the {@link JsonSchemaFactory}.
+ * explicitly configured in the {@link SchemaRegistry}.
  */
 public class DisallowUnknownDialectFactory implements DialectRegistry {
     @Override
-    public Dialect getDialect(String dialectId, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
+    public Dialect getDialect(String dialectId, SchemaRegistry schemaFactory, SchemaValidatorsConfig config) {
         throw new InvalidSchemaException(Error.builder()
                 .message("Unknown dialect ''{0}''. Only dialects that are explicitly configured can be used.")
                 .arguments(dialectId).build());

src/test/java/com/networknt/schema/AbstractJsonSchemaTest.java

@@ -59,7 +59,7 @@ private JsonNode getJsonNodeFromPath(String dataPath) {
     }
 
     private Schema getJsonSchema(JsonNode schemaNode) {
-        return JsonSchemaFactory
+        return SchemaRegistry
                 .getInstance(SpecificationVersionDetector.detectOptionalVersion(schemaNode, false).orElse(DEFAULT_VERSION_FLAG))
                 .getSchema(schemaNode);
     }

src/test/java/com/networknt/schema/AbstractJsonSchemaTestSuite.java

@@ -168,7 +168,7 @@ private Stream<DynamicNode> buildContainer(Version defaultVersion, TestSource te
 
     private DynamicNode buildContainer(Version defaultVersion, TestCase testCase) {
         try {
-            JsonSchemaFactory validatorFactory = buildValidatorFactory(defaultVersion, testCase);
+            SchemaRegistry validatorFactory = buildValidatorFactory(defaultVersion, testCase);
 
             return dynamicContainer(testCase.getDisplayName(), testCase.getTests().stream().map(testSpec -> {
                 return buildTest(validatorFactory, testSpec);
@@ -182,7 +182,7 @@ private DynamicNode buildContainer(Version defaultVersion, TestCase testCase) {
         }
     }
 
-    private JsonSchemaFactory buildValidatorFactory(Version defaultVersion, TestCase testCase) {
+    private SchemaRegistry buildValidatorFactory(Version defaultVersion, TestCase testCase) {
         if (testCase.isDisabled()) return null;
         SchemaLoader schemaLoader = new SchemaLoader() {
             @Override
@@ -202,8 +202,8 @@ public InputStreamSource getSchema(AbsoluteIri absoluteIri) {
             }
         };
         Version specVersion = detectVersion(testCase.getSchema(), testCase.getSpecification(), defaultVersion, false);
-        JsonSchemaFactory base = JsonSchemaFactory.getInstance(specVersion);
-        return JsonSchemaFactory
+        SchemaRegistry base = SchemaRegistry.getInstance(specVersion);
+        return SchemaRegistry
                 .builder(base)
                 .schemaMappers(schemaMappers -> schemaMappers
                         .mapPrefix("https://", "http://")
@@ -212,7 +212,7 @@ public InputStreamSource getSchema(AbsoluteIri absoluteIri) {
                 .build();
     }
 
-    private DynamicNode buildTest(JsonSchemaFactory validatorFactory, TestSpec testSpec) {
+    private DynamicNode buildTest(SchemaRegistry validatorFactory, TestSpec testSpec) {
         if (testSpec.isDisabled()) {
             return dynamicTest(testSpec.getDescription(), () -> abortAndReset(testSpec.getReason()));
         }

src/test/java/com/networknt/schema/AdditionalPropertiesValidatorTest.java

@@ -45,7 +45,7 @@ void messageFalse() {
                 + "  },\r\n"
                 + "  \"additionalProperties\": false\r\n"
                 + "}";
-        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(Version.DRAFT_2020_12);
+        SchemaRegistry factory = SchemaRegistry.getInstance(Version.DRAFT_2020_12);
         SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();
         Schema schema = factory.getSchema(schemaData, config);
         String inputData = "{\r\n"
@@ -80,7 +80,7 @@ void messageSchema() {
                 + "  },\r\n"
                 + "  \"additionalProperties\": { \"type\": \"number\" }\r\n"
                 + "}";
-        JsonSchemaFactory factory = JsonSchemaFactory.getInstance(Version.DRAFT_2020_12);
+        SchemaRegistry factory = SchemaRegistry.getInstance(Version.DRAFT_2020_12);
         SchemaValidatorsConfig config = SchemaValidatorsConfig.builder().build();
         Schema schema = factory.getSchema(schemaData, config);
         String inputData = "{\r\n"