100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Asset model update: Added ASSET_TYPE Value descriptor with mechanism for populating AllowedValues constraint at runtime
Rich Turnera4e03f466759
diff --git a/agent/src/main/java/org/openremote/agent/protocol/AgentModelProvider.java b/agent/src/main/java/org/openremote/agent/protocol/AgentModelProvider.javaindex dd108480f..ca5d6ca19 100644--- a/agent/src/main/java/org/openremote/agent/protocol/AgentModelProvider.java+++ b/agent/src/main/java/org/openremote/agent/protocol/AgentModelProvider.java@@ -57,4 +57,8 @@ public class AgentModelProvider implements AssetModelProvider {public Map<Class<? extends Asset<?>>, List<ValueDescriptor<?>>> getValueDescriptors() {return null;}++ @Override+ public void onAssetModelFinished() {+ }}diff --git a/model/src/main/java/org/openremote/model/AssetModelProvider.java b/model/src/main/java/org/openremote/model/AssetModelProvider.javaindex de1908284..3f742761f 100644--- a/model/src/main/java/org/openremote/model/AssetModelProvider.java+++ b/model/src/main/java/org/openremote/model/AssetModelProvider.java@@ -87,4 +87,10 @@ public interface AssetModelProvider {* scanning.*/Map<Class<? extends Asset<?>>, List<ValueDescriptor<?>>> getValueDescriptors();++ /**+ * Called when the full Asset model has been initialised which gives {@link AssetModelProvider}s the chance to do+ * additional work (e.g. add constraints such as allowed values based on available asset types).+ */+ void onAssetModelFinished();}diff --git a/model/src/main/java/org/openremote/model/StandardModelProvider.java b/model/src/main/java/org/openremote/model/StandardModelProvider.javaindex 20953014c..f0329cb2c 100644--- a/model/src/main/java/org/openremote/model/StandardModelProvider.java+++ b/model/src/main/java/org/openremote/model/StandardModelProvider.java@@ -21,13 +21,13 @@ package org.openremote.model;import org.openremote.model.asset.Asset;import org.openremote.model.asset.AssetDescriptor;+import org.openremote.model.asset.impl.GroupAsset;import org.openremote.model.syslog.SyslogCategory;+import org.openremote.model.util.AssetModelUtil;import org.openremote.model.util.TsIgnore;import org.openremote.model.value.*;-import java.util.List;-import java.util.Map;-import java.util.Set;+import java.util.*;import java.util.logging.Logger;import static org.openremote.model.syslog.SyslogCategory.MODEL_AND_VALUES;@@ -42,7 +42,6 @@ import static org.openremote.model.syslog.SyslogCategory.MODEL_AND_VALUES;public class StandardModelProvider implements AssetModelProvider {protected static Logger LOG = SyslogCategory.getLogger(MODEL_AND_VALUES, StandardModelProvider.class);- protected Set<Class<? extends Asset<?>>> assetClasses;@Overridepublic AssetDescriptor<?>[] getAssetDescriptors() {@@ -68,4 +67,12 @@ public class StandardModelProvider implements AssetModelProvider {public Map<Class<? extends Asset<?>>, List<ValueDescriptor<?>>> getValueDescriptors() {return null;}++ @Override+ public void onAssetModelFinished() {+ // Inject allowed asset types into GroupAsset+ List<ValueConstraint> constraints = ValueType.ASSET_TYPE.getConstraints() != null ? new ArrayList<>(Arrays.asList(ValueType.ASSET_TYPE.getConstraints())): new ArrayList<>();+ constraints.add(new ValueConstraint.AllowedValues(Arrays.stream(AssetModelUtil.getAssetClasses(null)).map(Class::getSimpleName).toArray()));+ ValueType.ASSET_TYPE.updateConstraints(constraints.toArray(new ValueConstraint[0]));+ }}diff --git a/model/src/main/java/org/openremote/model/asset/impl/GroupAsset.java b/model/src/main/java/org/openremote/model/asset/impl/GroupAsset.javaindex 8235b8412..bbc4dfe53 100644--- a/model/src/main/java/org/openremote/model/asset/impl/GroupAsset.java+++ b/model/src/main/java/org/openremote/model/asset/impl/GroupAsset.java@@ -23,12 +23,11 @@ import org.openremote.model.asset.Asset;import org.openremote.model.asset.AssetDescriptor;import org.openremote.model.attribute.Attribute;import org.openremote.model.attribute.MetaItem;-import org.openremote.model.value.AttributeDescriptor;-import org.openremote.model.value.MetaItemType;-import org.openremote.model.value.ValueConstraint;-import org.openremote.model.value.ValueType;+import org.openremote.model.attribute.MetaMap;+import org.openremote.model.value.*;import javax.persistence.Entity;+import java.util.Collection;import java.util.Optional;/**@@ -38,14 +37,9 @@ import java.util.Optional;@Entitypublic class GroupAsset extends Asset<GroupAsset> {- public static final AttributeDescriptor<String> CHILD_ASSET_TYPE = new AttributeDescriptor<>("childAssetType", ValueType.TEXT);+ public static final AttributeDescriptor<String> CHILD_ASSET_TYPE = new AttributeDescriptor<>("childAssetType", ValueType.ASSET_TYPE);public static final AssetDescriptor<GroupAsset> DESCRIPTOR = new AssetDescriptor<>("folder", "B3B3B3", GroupAsset.class);-// static {-// // How to get all asset types-// CHILD_ASSET_TYPE.withConstraints(new ValueConstraint.AllowedValues())-// }-/*** For use by hydrators (i.e. JPA/Jackson)*/diff --git a/model/src/main/java/org/openremote/model/util/AssetModelUtil.java b/model/src/main/java/org/openremote/model/util/AssetModelUtil.javaindex d049d1338..64df2e09b 100644--- a/model/src/main/java/org/openremote/model/util/AssetModelUtil.java+++ b/model/src/main/java/org/openremote/model/util/AssetModelUtil.java@@ -446,6 +446,9 @@ public final class AssetModelUtil {String vds = nonSerializableValueDescriptors.stream().map(ValueDescriptor::toString).collect(Collectors.joining(",\n"));throw new IllegalStateException("One or more value types do not implement java.io.Serializable: " + vds);}++ // Call on finished on each provider+ assetModelProviders.forEach(AssetModelProvider::onAssetModelFinished);}/**diff --git a/model/src/main/java/org/openremote/model/value/AttributeDescriptor.java b/model/src/main/java/org/openremote/model/value/AttributeDescriptor.javaindex b0dd03ac5..94d84ad6e 100644--- a/model/src/main/java/org/openremote/model/value/AttributeDescriptor.java+++ b/model/src/main/java/org/openremote/model/value/AttributeDescriptor.java@@ -117,6 +117,10 @@ public class AttributeDescriptor<T> extends AbstractNameValueDescriptorHolder<T>return newDescriptor;}+ public void updateConstraints(ValueConstraint...valueConstraints) {+ constraints = valueConstraints;+ }+@Overridepublic String toString() {return AttributeDescriptor.class.getSimpleName() + "{" +diff --git a/model/src/main/java/org/openremote/model/value/ValueConstraint.java b/model/src/main/java/org/openremote/model/value/ValueConstraint.javaindex 617e1a599..67f9af94f 100644--- a/model/src/main/java/org/openremote/model/value/ValueConstraint.java+++ b/model/src/main/java/org/openremote/model/value/ValueConstraint.java@@ -41,7 +41,7 @@ import java.util.Optional;@JsonSubTypes.Type(ValueConstraint.FutureOrPresent.class),@JsonSubTypes.Type(ValueConstraint.NotEmpty.class),@JsonSubTypes.Type(ValueConstraint.NotBlank.class),- @JsonSubTypes.Type(ValueConstraint.NotNull.class),+ @JsonSubTypes.Type(ValueConstraint.NotNull.class)})public abstract class ValueConstraint implements Serializable {diff --git a/model/src/main/java/org/openremote/model/value/ValueDescriptor.java b/model/src/main/java/org/openremote/model/value/ValueDescriptor.javaindex 4de75babf..68a4d69be 100644--- a/model/src/main/java/org/openremote/model/value/ValueDescriptor.java+++ b/model/src/main/java/org/openremote/model/value/ValueDescriptor.java@@ -234,6 +234,10 @@ public class ValueDescriptor<T> implements NameHolder, Serializable {return new ValueDescriptor<>(name, type, constraints, format, units, arrayDimensions);}+ public void updateConstraints(ValueConstraint...valueConstraints) {+ constraints = valueConstraints;+ }+public Integer getArrayDimensions() {return arrayDimensions;}diff --git a/model/src/main/java/org/openremote/model/value/ValueType.java b/model/src/main/java/org/openremote/model/value/ValueType.javaindex d4d8de495..91a025775 100644--- a/model/src/main/java/org/openremote/model/value/ValueType.java+++ b/model/src/main/java/org/openremote/model/value/ValueType.java@@ -135,6 +135,11 @@ public final class ValueType {new ValueConstraint.Pattern(Constants.ASSET_ID_REGEXP));+ /**+ * Allowed values constraint is added at runtime based on {@link org.openremote.model.util.AssetModelUtil}+ */+ public static final ValueDescriptor<String> ASSET_TYPE = new ValueDescriptor<>("assetType", String.class);+public static final ValueDescriptor<Integer> DIRECTION = new ValueDescriptor<>("direction", Integer.class,new ValueConstraint.Min(0),new ValueConstraint.Max(259)diff --git a/test/src/main/java/org/openremote/test/model/TestAssetModelProvider.java b/test/src/main/java/org/openremote/test/model/TestAssetModelProvider.javaindex 5cabf5a96..0c82338d9 100644--- a/test/src/main/java/org/openremote/test/model/TestAssetModelProvider.java+++ b/test/src/main/java/org/openremote/test/model/TestAssetModelProvider.java@@ -54,4 +54,9 @@ public class TestAssetModelProvider implements AssetModelProvider {public Map<Class<? extends Asset<?>>, List<ValueDescriptor<?>>> getValueDescriptors() {return null;}++ @Override+ public void onAssetModelFinished() {++ }}diff --git a/test/src/test/groovy/org/openremote/test/model/AssetModelTest.groovy b/test/src/test/groovy/org/openremote/test/model/AssetModelTest.groovyindex 6c68bbd9f..1805bff2d 100644--- a/test/src/test/groovy/org/openremote/test/model/AssetModelTest.groovy+++ b/test/src/test/groovy/org/openremote/test/model/AssetModelTest.groovy@@ -8,6 +8,7 @@ import org.openremote.manager.asset.AssetModelServiceimport org.openremote.model.asset.Assetimport org.openremote.model.asset.AssetModelResourceimport org.openremote.model.asset.agent.AgentLink+import org.openremote.model.asset.impl.GroupAssetimport org.openremote.model.asset.impl.LightAssetimport org.openremote.model.asset.impl.ThingAssetimport org.openremote.model.attribute.Attribute@@ -17,6 +18,7 @@ import org.openremote.model.asset.AssetTypeInfoimport org.openremote.model.util.AssetModelUtilimport org.openremote.model.value.MetaItemTypeimport org.openremote.model.value.SubStringValueFilter+import org.openremote.model.value.ValueConstraintimport org.openremote.model.value.ValueFilterimport org.openremote.model.value.ValueTypeimport org.openremote.model.value.Values@@ -60,6 +62,16 @@ class AssetModelTest extends Specification implements ManagerContainerTrait {!thingAssetInfo2.get().attributeDescriptors.find { (it == Asset.LOCATION) }.optionalthingAssetInfo2.get().attributeDescriptors.find { (it == Asset.LOCATION) }.type == ValueType.GEO_JSON_POINT+ when: "the asset type value descriptor is retrieved"+ def assetValueType = AssetModelUtil.getValueDescriptor(ValueType.ASSET_TYPE.getName())++ then: "it should contain an allowed values constraint with all asset types listed"+ assetValueType.isPresent()+ assetValueType.get().constraints != null+ assetValueType.get().constraints.find {it instanceof ValueConstraint.AllowedValues} as ValueConstraint.AllowedValues != null+ (assetValueType.get().constraints.find {it instanceof ValueConstraint.AllowedValues} as ValueConstraint.AllowedValues).allowedValues.length == AssetModelUtil.getAssetInfos().length+ (assetValueType.get().constraints.find {it instanceof ValueConstraint.AllowedValues} as ValueConstraint.AllowedValues).allowedValues.any { (it == GroupAsset.class.getSimpleName()) }+when: "All asset model infos are retrieved"def assetInfos = assetModelResource.getAssetInfos(null, null, null);