Allow initialisation of Validators with Settings

Author: hylkevds

FROST-Server.Core.Model/pom.xml

@@ -38,6 +38,10 @@
             <groupId>de.fraunhofer.iosb.ilt</groupId>
             <artifactId>Configurable</artifactId>
         </dependency>
+        <dependency>
+            <groupId>de.fraunhofer.iosb.ilt</groupId>
+            <artifactId>Settings</artifactId>
+        </dependency>
         <dependency>
             <groupId>de.grundid.opendatalab</groupId>
             <artifactId>geojson-jackson</artifactId>

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/core/EntityValidator.java

@@ -19,13 +19,18 @@
 
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import de.fraunhofer.iosb.ilt.frostserver.util.exception.IncompleteEntityException;
+import de.fraunhofer.iosb.ilt.settings.Settings;
 
 /**
  * A validator that checks if an Entity has no missing properties.
  */
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
 public interface EntityValidator {
 
+    public default void init(Settings settings) {
+        // Does nothing by default.
+    }
+
     /**
      * Check if all required properties are non-null on the given Entity.
      *

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/loader/DefEntityType.java

@@ -33,6 +33,7 @@
 import de.fraunhofer.iosb.ilt.frostserver.query.OrderBy;
 import de.fraunhofer.iosb.ilt.frostserver.query.expression.Path;
 import de.fraunhofer.iosb.ilt.frostserver.util.StringHelper;
+import de.fraunhofer.iosb.ilt.settings.Settings;
 import java.util.ArrayList;
 import java.util.List;
 import org.slf4j.Logger;
@@ -157,6 +158,13 @@ public void init() {
     }
 
     public EntityType getEntityType(ModelRegistry modelRegistry) {
+        if (entityType == null) {
+            throw new IllegalStateException("EntityType " + name + " not initialised!");
+        }
+        return entityType;
+    }
+
+    public EntityType getEntityType(ModelRegistry modelRegistry, Settings settings) {
         if (entityType == null) {
             entityType = modelRegistry.getEntityTypeForName(name, true);
             if (entityType == null) {
@@ -165,7 +173,7 @@ public EntityType getEntityType(ModelRegistry modelRegistry) {
                 entityType.setAdminOnly(adminOnly);
             }
             if (validators != null) {
-                validators.createValidators(modelRegistry, entityType);
+                validators.createValidators(modelRegistry, entityType, settings.getSubSettings(name + '.'));
             }
             entityType.addAnnotations(annotations);
         }

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/loader/DefModel.java

@@ -24,6 +24,7 @@
 import de.fraunhofer.iosb.ilt.configurable.editor.EditorList;
 import de.fraunhofer.iosb.ilt.configurable.editor.EditorString;
 import de.fraunhofer.iosb.ilt.frostserver.model.ModelRegistry;
+import de.fraunhofer.iosb.ilt.settings.Settings;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -66,9 +67,9 @@ public void registerPropertyTypes(ModelRegistry modelRegistry) {
         }
     }
 
-    public void registerEntityTypes(ModelRegistry modelRegistry) {
+    public void registerEntityTypes(ModelRegistry modelRegistry, Settings settings) {
         for (DefEntityType defType : entityTypes) {
-            modelRegistry.registerEntityType(defType.getEntityType(modelRegistry));
+            modelRegistry.registerEntityType(defType.getEntityType(modelRegistry, settings));
         }
     }
 

FROST-Server.Core.Model/src/main/java/de/fraunhofer/iosb/ilt/frostserver/model/loader/DefValidator.java

@@ -26,6 +26,7 @@
 import de.fraunhofer.iosb.ilt.frostserver.model.EntityType;
 import de.fraunhofer.iosb.ilt.frostserver.model.ModelRegistry;
 import de.fraunhofer.iosb.ilt.frostserver.model.core.EntityValidator;
+import de.fraunhofer.iosb.ilt.settings.Settings;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -53,13 +54,17 @@ public class DefValidator {
      *
      * @param modelRegistry The model to modify.
      * @param entityType The entity type to create the validator for.
+     * @param settings The settings object used to load settings for the
+     * validators.
      */
-    public void createValidators(ModelRegistry modelRegistry, EntityType entityType) {
+    public void createValidators(ModelRegistry modelRegistry, EntityType entityType, Settings settings) {
         for (var namedValidator : getCreateValidators()) {
             entityType.addCreateValidator(namedValidator.name, namedValidator.validator);
+            namedValidator.validator.init(settings.getSubSettings(namedValidator.name + '.'));
         }
         for (var namedValidator : getUpdateValidators()) {
             entityType.addUpdateValidator(namedValidator.name, namedValidator.validator);
+            namedValidator.validator.init(settings.getSubSettings(namedValidator.name + '.'));
         }
     }
 

Plugins/CoreModelV2/pom.xml

@@ -44,6 +44,10 @@
             <artifactId>FROST-Server.Util</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>de.fraunhofer.iosb.ilt</groupId>
+            <artifactId>Settings</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>

Plugins/ModelLoader/src/main/java/de/fraunhofer/iosb/ilt/frostserver/plugin/modelloader/PluginModelLoader.java

@@ -67,6 +67,7 @@
  */
 public class PluginModelLoader implements PluginRootDocument, PluginModel, LiquibaseUser {
 
+    public static final String PREFIX_DATA_MODEL = "dataModel.";
     private static final Logger LOGGER = LoggerFactory.getLogger(PluginModelLoader.class.getName());
 
     private CoreSettings settings;
@@ -329,7 +330,8 @@ public void registerEntityTypes() {
 
         ModelRegistry modelRegistry = settings.getModelRegistry();
         for (DefModel modelDefinition : modelDefinitions) {
-            modelDefinition.registerEntityTypes(modelRegistry);
+            final Settings dmSettings = settings.getSettings().getSubSettings(PREFIX_DATA_MODEL);
+            modelDefinition.registerEntityTypes(modelRegistry, dmSettings);
         }
     }
 

pom.xml

@@ -133,7 +133,7 @@
         <version.postgis>2025.1.1</version.postgis>
         <version.postgres>42.7.8</version.postgres>
         <version.prometheus>1.4.3</version.prometheus>
-        <version.settings>1.1</version.settings>
+        <version.settings>1.2</version.settings>
         <version.slf4j-api>2.0.17</version.slf4j-api>
         <version.testcontainers>2.0.3</version.testcontainers>
         <version.testcontainers-keycloak>4.1.0</version.testcontainers-keycloak>