Rename JsonMetaSchemaFactory to DialectRegistry

justin-tay · justin-tay · commit bf5f620e19e4 · 2025-09-23T18:59:42.000+08:00
diff --git a/src/main/java/com/networknt/schema/DisallowUnknownJsonMetaSchemaFactory.java b/src/main/java/com/networknt/schema/DisallowUnknownJsonMetaSchemaFactory.java
diff --git a/src/main/java/com/networknt/schema/JsonMetaSchemaFactory.java b/src/main/java/com/networknt/schema/JsonMetaSchemaFactory.java
diff --git a/src/main/java/com/networknt/schema/JsonSchemaFactory.java b/src/main/java/com/networknt/schema/JsonSchemaFactory.java
@@ -19,8 +19,10 @@
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.networknt.schema.Specification.Version;
+import com.networknt.schema.dialect.DefaultDialectRegistry;
 import com.networknt.schema.dialect.Dialect;
 import com.networknt.schema.dialect.DialectId;
+import com.networknt.schema.dialect.DialectRegistry;
 import com.networknt.schema.dialect.Dialects;
 import com.networknt.schema.resource.DefaultSchemaLoader;
 import com.networknt.schema.resource.SchemaLoader;
@@ -64,7 +66,7 @@ public static class Builder {
         private SchemaLoaders.Builder schemaLoadersBuilder = null;
         private SchemaMappers.Builder schemaMappersBuilder = null;
         private boolean enableSchemaCache = true;
-        private JsonMetaSchemaFactory metaSchemaFactory = null;
+        private DialectRegistry metaSchemaFactory = null;
 
         /**
          * Sets the json node reader to read the data.
@@ -118,7 +120,7 @@ public Builder defaultMetaSchemaIri(final String defaultMetaSchemaIri) {
             return this;
         }
 
-        public Builder metaSchemaFactory(final JsonMetaSchemaFactory jsonMetaSchemaFactory) {
+        public Builder metaSchemaFactory(final DialectRegistry jsonMetaSchemaFactory) {
             this.metaSchemaFactory = jsonMetaSchemaFactory;
             return this;
         }
@@ -196,7 +198,7 @@ public JsonSchemaFactory build() {
     private final ConcurrentMap<String, Dialect> metaSchemas;
     private final ConcurrentMap<SchemaLocation, JsonSchema> schemaCache = new ConcurrentHashMap<>();
     private final boolean enableSchemaCache;
-    private final JsonMetaSchemaFactory metaSchemaFactory;
+    private final DialectRegistry metaSchemaFactory;
     
     private static final List<SchemaLoader> DEFAULT_SCHEMA_LOADERS = SchemaLoaders.builder().build();
     private static final List<SchemaMapper> DEFAULT_SCHEMA_MAPPERS = SchemaMappers.builder().build();
@@ -210,7 +212,7 @@ private JsonSchemaFactory(
             SchemaMappers.Builder schemaMappersBuilder,
             ConcurrentMap<String, Dialect> metaSchemas,
             boolean enableSchemaCache,
-            JsonMetaSchemaFactory metaSchemaFactory) {
+            DialectRegistry metaSchemaFactory) {
         this.metaSchemas = metaSchemas;
         if (defaultMetaSchemaIri == null || defaultMetaSchemaIri.trim().isEmpty()) {
             throw new IllegalArgumentException("defaultMetaSchemaIri must not be null or empty");
@@ -468,8 +470,8 @@ public Dialect getMetaSchema(String iri, SchemaValidatorsConfig config) {
      * @return the meta-schema
      */
     protected Dialect loadMetaSchema(String iri, SchemaValidatorsConfig config) {
-        return this.metaSchemaFactory != null ? this.metaSchemaFactory.getMetaSchema(iri, this, config)
-                : DefaultJsonMetaSchemaFactory.getInstance().getMetaSchema(iri, this, config);
+        return this.metaSchemaFactory != null ? this.metaSchemaFactory.getDialect(iri, this, config)
+                : DefaultDialectRegistry.getInstance().getDialect(iri, this, config);
     }
 
     JsonNode readTree(String content, InputFormat inputFormat) throws IOException {
diff --git a/src/main/java/com/networknt/schema/dialect/DefaultDialectRegistry.java b/src/main/java/com/networknt/schema/dialect/DefaultDialectRegistry.java
@@ -13,45 +13,47 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.networknt.schema;
+package com.networknt.schema.dialect;
 
 import java.util.Map;
 import java.util.Map.Entry;
 
 import com.fasterxml.jackson.databind.JsonNode;
+import com.networknt.schema.Error;
+import com.networknt.schema.InvalidSchemaException;
+import com.networknt.schema.JsonSchema;
+import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SchemaLocation;
+import com.networknt.schema.SchemaValidatorsConfig;
+import com.networknt.schema.Specification;
 import com.networknt.schema.Specification.Version;
-import com.networknt.schema.dialect.Dialect;
 
 /**
- * Default {@link JsonMetaSchemaFactory}.
+ * Default {@link DialectRegistry}.
  */
-public class DefaultJsonMetaSchemaFactory implements JsonMetaSchemaFactory {
+public class DefaultDialectRegistry implements DialectRegistry {
     @Override
-    public Dialect getMetaSchema(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
+    public Dialect getDialect(String dialectId, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
         // Is it a well-known dialect?
-        return Specification.Version.fromDialectId(iri)
-                .map(JsonSchemaFactory::checkVersion)
-                .orElseGet(() -> {
-                    // Custom meta schema
-                    return loadMetaSchema(iri, schemaFactory, config);
-                });
+        return Specification.Version.fromDialectId(dialectId).map(JsonSchemaFactory::checkVersion).orElseGet(() -> {
+            // Custom dialect
+            return loadDialect(dialectId, schemaFactory, config);
+        });
     }
 
-    protected Dialect loadMetaSchema(String iri, JsonSchemaFactory schemaFactory,
-            SchemaValidatorsConfig config) {
+    protected Dialect loadDialect(String iri, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
         try {
-            Dialect result = loadMetaSchemaBuilder(iri, schemaFactory, config).build();
+            Dialect result = loadDialectBuilder(iri, schemaFactory, config).build();
             return result;
         } catch (InvalidSchemaException e) {
             throw e;
         } catch (Exception e) {
-            Error error = Error.builder()
-                    .message("Failed to load meta-schema ''{0}''").arguments(iri).build();
+            Error error = Error.builder().message("Failed to load dialect ''{0}''").arguments(iri).build();
             throw new InvalidSchemaException(error, e);
         }
     }
 
-    protected Dialect.Builder loadMetaSchemaBuilder(String iri, JsonSchemaFactory schemaFactory,
+    protected Dialect.Builder loadDialectBuilder(String iri, JsonSchemaFactory schemaFactory,
             SchemaValidatorsConfig config) {
         JsonSchema schema = schemaFactory.getSchema(SchemaLocation.of(iri), config);
         Dialect.Builder builder = Dialect.builder(iri, schema.getValidationContext().getMetaSchema());
@@ -72,10 +74,10 @@ protected Dialect.Builder loadMetaSchemaBuilder(String iri, JsonSchemaFactory sc
     }
 
     private static class Holder {
-        private static final DefaultJsonMetaSchemaFactory INSTANCE = new DefaultJsonMetaSchemaFactory();
+        private static final DefaultDialectRegistry INSTANCE = new DefaultDialectRegistry();
     }
 
-    public static DefaultJsonMetaSchemaFactory getInstance() {
+    public static DefaultDialectRegistry getInstance() {
         return Holder.INSTANCE;
     }
 }
diff --git a/src/main/java/com/networknt/schema/dialect/DialectRegistry.java b/src/main/java/com/networknt/schema/dialect/DialectRegistry.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.networknt.schema.dialect;
+
+import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SchemaValidatorsConfig;
+
+/**
+ * Registry for {@link Dialect} that can be retrieved using the dialect id which
+ * is the IRI that indicates the meta-schema that can be used to validate the
+ * schema conforms to the dialect.
+ */
+@FunctionalInterface
+public interface DialectRegistry {
+    /**
+     * Gets the dialect given the dialect id which is the IRI that indicates the
+     * meta-schema that can be used to validate the schema conforms to the dialect.
+     * 
+     * @param dialectId     the dialect id of the dialect which IRI that indicates
+     *                      the meta-schema that can be used to validate the schema
+     *                      conforms to the dialect
+     * @param schemaFactory the schema factory
+     * @param config        the config
+     * @return the dialect
+     */
+    Dialect getDialect(String dialectId, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config);
+}
diff --git a/src/main/java/com/networknt/schema/dialect/DisallowUnknownDialectFactory.java b/src/main/java/com/networknt/schema/dialect/DisallowUnknownDialectFactory.java
@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2024 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.networknt.schema.dialect;
+
+import com.networknt.schema.Error;
+import com.networknt.schema.InvalidSchemaException;
+import com.networknt.schema.JsonSchemaFactory;
+import com.networknt.schema.SchemaValidatorsConfig;
+
+/**
+ * A {@link DialectRegistry} that does not meta-schemas that aren't
+ * explicitly configured in the {@link JsonSchemaFactory}.
+ */
+public class DisallowUnknownDialectFactory implements DialectRegistry {
+    @Override
+    public Dialect getDialect(String dialectId, JsonSchemaFactory schemaFactory, SchemaValidatorsConfig config) {
+        throw new InvalidSchemaException(Error.builder()
+                .message("Unknown dialect ''{0}''. Only dialects that are explicitly configured can be used.")
+                .arguments(dialectId).build());
+    }
+
+    private static class Holder {
+        private static final DisallowUnknownDialectFactory INSTANCE = new DisallowUnknownDialectFactory();
+    }
+
+    /**
+     * Gets the instance of {@link DisallowUnknownDialectFactory}.
+     * 
+     * @return the json meta schema factory
+     */
+    public static DisallowUnknownDialectFactory getInstance() {
+        return Holder.INSTANCE;
+    }
+}
diff --git a/src/test/java/com/networknt/schema/DisallowUnknownDialectFactoryTest.java b/src/test/java/com/networknt/schema/DisallowUnknownDialectFactoryTest.java
@@ -21,11 +21,12 @@
 import org.junit.jupiter.api.Test;
 
 import com.networknt.schema.Specification.Version;
+import com.networknt.schema.dialect.DisallowUnknownDialectFactory;
 
 /**
  * Tests for DisallowUnknownJsonMetaSchemaFactory. 
  */
-class DisallowUnknownJsonMetaSchemaFactoryTest {
+class DisallowUnknownDialectFactoryTest {
     private static final String DRAFT_202012_SCHEMA = "{\r\n"
             + "  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\r\n"
             + "  \"type\": \"object\"\r\n"
@@ -45,15 +46,15 @@ void defaultHandling() {
     @Test
     void draft202012() {
         JsonSchemaFactory factory = JsonSchemaFactory.getInstance(Version.DRAFT_2020_12,
-                builder -> builder.metaSchemaFactory(DisallowUnknownJsonMetaSchemaFactory.getInstance()));
+                builder -> builder.metaSchemaFactory(DisallowUnknownDialectFactory.getInstance()));
         assertDoesNotThrow(() -> factory.getSchema(DRAFT_202012_SCHEMA));
         assertThrows(InvalidSchemaException.class, () -> factory.getSchema(DRAFT_7_SCHEMA));
     }
 
     @Test
     void draft7() {
         JsonSchemaFactory factory = JsonSchemaFactory.getInstance(Version.DRAFT_7,
-                builder -> builder.metaSchemaFactory(DisallowUnknownJsonMetaSchemaFactory.getInstance()));
+                builder -> builder.metaSchemaFactory(DisallowUnknownDialectFactory.getInstance()));
         assertDoesNotThrow(() -> factory.getSchema(DRAFT_7_SCHEMA));
         assertThrows(InvalidSchemaException.class, () -> factory.getSchema(DRAFT_202012_SCHEMA));
     }
diff --git a/src/test/java/com/networknt/schema/oas/OpenApi30Test.java b/src/test/java/com/networknt/schema/oas/OpenApi30Test.java
@@ -24,7 +24,6 @@
 
 import org.junit.jupiter.api.Test;
 
-import com.networknt.schema.DisallowUnknownJsonMetaSchemaFactory;
 import com.networknt.schema.InputFormat;
 import com.networknt.schema.JsonSchema;
 import com.networknt.schema.JsonSchemaFactory;
@@ -33,6 +32,7 @@
 import com.networknt.schema.SchemaLocation;
 import com.networknt.schema.SchemaValidatorsConfig;
 import com.networknt.schema.Specification.Version;
+import com.networknt.schema.dialect.DisallowUnknownDialectFactory;
 import com.networknt.schema.dialect.OpenApi30;
 import com.networknt.schema.Error;
 
@@ -48,7 +48,7 @@ void validateMetaSchema() {
         JsonSchemaFactory factory = JsonSchemaFactory.getInstance(Version.DRAFT_7,
                 builder -> builder.metaSchema(OpenApi30.getInstance())
                         .defaultMetaSchemaIri(OpenApi30.getInstance().getIri())
-                        .metaSchemaFactory(DisallowUnknownJsonMetaSchemaFactory.getInstance()));
+                        .metaSchemaFactory(DisallowUnknownDialectFactory.getInstance()));
         JsonSchema schema = factory.getSchema(SchemaLocation.of(
                 "classpath:schema/oas/3.0/petstore.yaml#/paths/~1pet/post/requestBody/content/application~1json/schema"));
         String input = "{\r\n"
diff --git a/src/test/java/com/networknt/schema/oas/OpenApi31Test.java b/src/test/java/com/networknt/schema/oas/OpenApi31Test.java
