~ clean up type hierarchy and codecs

Author: kevinherron

milo-examples/client-examples/src/main/java/org/eclipse/milo/examples/client/UnifiedAutomationReadCustomDataTypeExample1.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 the Eclipse Milo Authors
+ * Copyright (c) 2025 the Eclipse Milo Authors
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -18,9 +18,10 @@
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 import org.eclipse.milo.opcua.sdk.client.OpcUaClient;
-import org.eclipse.milo.opcua.sdk.core.types.DynamicEnum;
-import org.eclipse.milo.opcua.sdk.core.types.DynamicOptionSet;
-import org.eclipse.milo.opcua.sdk.core.types.DynamicStruct;
+import org.eclipse.milo.opcua.sdk.core.types.DynamicEnumType;
+import org.eclipse.milo.opcua.sdk.core.types.DynamicOptionSetType;
+import org.eclipse.milo.opcua.sdk.core.types.DynamicStructType;
+import org.eclipse.milo.opcua.sdk.core.types.DynamicType;
 import org.eclipse.milo.opcua.stack.core.encoding.EncodingContext;
 import org.eclipse.milo.opcua.stack.core.security.SecurityPolicy;
 import org.eclipse.milo.opcua.stack.core.types.builtin.ByteString;
@@ -64,40 +65,40 @@ public void run(OpcUaClient client, CompletableFuture<OpcUaClient> future) throw
   private void readWriteReadPerson(OpcUaClient client) throws Exception {
     NodeId nodeId = NodeId.parse("ns=3;s=Person1");
 
-    DynamicStruct value = readScalarValue(client, nodeId);
+    DynamicStructType value = (DynamicStructType) readScalarValue(client, nodeId);
     logger.info("Person1: {}", value);
 
     Random r = new Random();
-    DynamicEnum gender = (DynamicEnum) value.getMembers().get("Gender");
+    DynamicEnumType gender = (DynamicEnumType) value.getMembers().get("Gender");
     value.getMembers().put("Name", "Fat Boy" + r.nextInt(100));
-    value.getMembers().put("Gender", new DynamicEnum(gender.getDataType(), r.nextInt(2)));
+    value.getMembers().put("Gender", new DynamicEnumType(gender.getDataType(), r.nextInt(2)));
 
     StatusCode status = writeValue(client, nodeId, value);
     System.out.println("write status: " + status);
 
-    value = readScalarValue(client, nodeId);
+    value = (DynamicStructType) readScalarValue(client, nodeId);
     logger.info("Person1': {}", value);
   }
 
   private void readWriteReadWorkOrder(OpcUaClient client) throws Exception {
     NodeId nodeId = NodeId.parse("ns=3;s=Demo.Static.Scalar.WorkOrder");
 
-    DynamicStruct value = readScalarValue(client, nodeId);
+    DynamicStructType value = (DynamicStructType) readScalarValue(client, nodeId);
     logger.info("WorkOrder: {}", value);
 
     value.getMembers().put("ID", UUID.randomUUID());
 
     StatusCode status = writeValue(client, nodeId, value);
     System.out.println("write status: " + status);
 
-    value = readScalarValue(client, nodeId);
+    value = (DynamicStructType) readScalarValue(client, nodeId);
     logger.info("WorkOrder': {}", value);
   }
 
   private void readWriteCarExtras(OpcUaClient client) throws Exception {
     NodeId nodeId = NodeId.parse("ns=3;s=Demo.Static.Scalar.CarExtras");
 
-    DynamicOptionSet value = (DynamicOptionSet) readScalarValue(client, nodeId);
+    DynamicOptionSetType value = (DynamicOptionSetType) readScalarValue(client, nodeId);
     logger.info("CarExtras: {}", value);
 
     byte b = requireNonNull(value.getValue().bytes())[0];
@@ -106,33 +107,32 @@ private void readWriteCarExtras(OpcUaClient client) throws Exception {
     StatusCode status = writeValue(client, nodeId, value);
     System.out.println("write status: " + status);
 
-    value = (DynamicOptionSet) readScalarValue(client, nodeId);
+    value = (DynamicOptionSetType) readScalarValue(client, nodeId);
     logger.info("CarExtras': {}", value);
   }
 
   private void readWorkOrderArray(OpcUaClient client) throws Exception {
     NodeId nodeId = NodeId.parse("ns=3;s=Demo.Static.Arrays.WorkOrder");
 
-    DynamicStruct[] value = readArrayValue(client, nodeId);
+    DynamicType[] value = readArrayValue(client, nodeId);
 
     logger.info("WorkOrderArray:");
     for (int i = 0; i < value.length; i++) {
       logger.info("  WorkOrder[{}]: {}", i, value[i]);
     }
   }
 
-  private static DynamicStruct readScalarValue(OpcUaClient client, NodeId nodeId) throws Exception {
+  private static DynamicType readScalarValue(OpcUaClient client, NodeId nodeId) throws Exception {
     DataValue dataValue =
         client.readValues(0.0, TimestampsToReturn.Neither, List.of(nodeId)).get(0);
 
     ExtensionObject xo = (ExtensionObject) dataValue.getValue().getValue();
     assert xo != null;
 
-    return (DynamicStruct) xo.decode(client.getDynamicEncodingContext());
+    return (DynamicType) xo.decode(client.getDynamicEncodingContext());
   }
 
-  private static DynamicStruct[] readArrayValue(OpcUaClient client, NodeId nodeId)
-      throws Exception {
+  private static DynamicType[] readArrayValue(OpcUaClient client, NodeId nodeId) throws Exception {
     DataValue dataValue =
         client.readValues(0.0, TimestampsToReturn.Neither, List.of(nodeId)).get(0);
 
@@ -141,13 +141,12 @@ private static DynamicStruct[] readArrayValue(OpcUaClient client, NodeId nodeId)
 
     EncodingContext ctx = client.getDynamicEncodingContext();
 
-    return Arrays.stream(xos)
-        .map(xo -> (DynamicStruct) xo.decode(ctx))
-        .toArray(DynamicStruct[]::new);
+    return Arrays.stream(xos).map(xo -> (DynamicType) xo.decode(ctx)).toArray(DynamicType[]::new);
   }
 
-  private static StatusCode writeValue(OpcUaClient client, NodeId nodeId, DynamicStruct value)
+  private static StatusCode writeValue(OpcUaClient client, NodeId nodeId, DynamicType value)
       throws Exception {
+
     ExtensionObject xo =
         ExtensionObject.encodeDefaultBinary(
             client.getDynamicEncodingContext(), value, value.getDataType().getBinaryEncodingId());
@@ -160,7 +159,7 @@ private static StatusCode writeValue(OpcUaClient client, NodeId nodeId, DynamicS
   @Override
   public String getEndpointUrl() {
     // Change this if UaCPPServer is running somewhere other than localhost.
-    return "opc.tcp://localhost:48010";
+    return "opc.tcp://192.168.1.66:48010";
   }
 
   @Override

opc-ua-sdk/integration-tests/src/test/java/org/eclipse/milo/opcua/sdk/client/DynamicMatrixTestTypeTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 the Eclipse Milo Authors
+ * Copyright (c) 2025 the Eclipse Milo Authors
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -14,7 +14,7 @@
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 import org.eclipse.milo.opcua.sdk.client.nodes.UaVariableNode;
-import org.eclipse.milo.opcua.sdk.core.types.DynamicStruct;
+import org.eclipse.milo.opcua.sdk.core.types.DynamicStructType;
 import org.eclipse.milo.opcua.sdk.test.AbstractClientServerTest;
 import org.eclipse.milo.opcua.sdk.test.MatrixTestType;
 import org.eclipse.milo.opcua.stack.core.UaException;
@@ -38,7 +38,7 @@ public void read() throws UaException {
     ExtensionObject xo = (ExtensionObject) value.getValue().getValue();
     assert xo != null;
 
-    DynamicStruct decoded = (DynamicStruct) xo.decode(client.getDynamicEncodingContext());
+    DynamicStructType decoded = (DynamicStructType) xo.decode(client.getDynamicEncodingContext());
     assertEquals(
         MatrixTestType.TYPE_ID,
         decoded.getTypeId().absolute(client.getNamespaceTable()).orElseThrow());

opc-ua-sdk/sdk-client/src/main/java/org/eclipse/milo/opcua/sdk/client/OpcUaClient.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 the Eclipse Milo Authors
+ * Copyright (c) 2025 the Eclipse Milo Authors
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -39,7 +39,7 @@
 import org.eclipse.milo.opcua.sdk.client.subscriptions.OpcUaSubscription;
 import org.eclipse.milo.opcua.sdk.client.subscriptions.PublishingManager;
 import org.eclipse.milo.opcua.sdk.client.typetree.DataTypeTreeBuilder;
-import org.eclipse.milo.opcua.sdk.core.types.DynamicCodecFactory;
+import org.eclipse.milo.opcua.sdk.core.types.codec.DynamicCodecFactory;
 import org.eclipse.milo.opcua.sdk.core.typetree.DataType;
 import org.eclipse.milo.opcua.sdk.core.typetree.DataTypeTree;
 import org.eclipse.milo.opcua.stack.core.AttributeId;

opc-ua-sdk/sdk-core/src/main/java/org/eclipse/milo/opcua/sdk/core/types/DynamicEnum.java renamed to opc-ua-sdk/sdk-core/src/main/java/org/eclipse/milo/opcua/sdk/core/types/DynamicEnumType.java

@@ -23,15 +23,15 @@
 import org.eclipse.milo.opcua.stack.core.types.structured.EnumField;
 import org.jspecify.annotations.Nullable;
 
-public class DynamicEnum implements UaEnumeratedType {
+public final class DynamicEnumType extends DynamicType implements UaEnumeratedType {
 
   private final DataType dataType;
   private final String name;
   private final int value;
   private final LocalizedText displayName;
   private final LocalizedText description;
 
-  public DynamicEnum(DataType dataType, int value) {
+  public DynamicEnumType(DataType dataType, int value) {
     this.dataType = dataType;
 
     EnumDefinition definition = (EnumDefinition) dataType.getDataTypeDefinition();
@@ -53,7 +53,7 @@ public DynamicEnum(DataType dataType, int value) {
     throw new IllegalArgumentException("value: " + value);
   }
 
-  public DynamicEnum(
+  public DynamicEnumType(
       DataType dataType,
       String name,
       int value,
@@ -76,6 +76,7 @@ public int getValue() {
     return value;
   }
 
+  @Override
   public DataType getDataType() {
     return dataType;
   }
@@ -95,7 +96,7 @@ public LocalizedText getDescription() {
   @Override
   public boolean equals(Object o) {
     if (o == null || getClass() != o.getClass()) return false;
-    DynamicEnum that = (DynamicEnum) o;
+    DynamicEnumType that = (DynamicEnumType) o;
     return value == that.value
         && Objects.equals(dataType.getNodeId(), that.dataType.getNodeId())
         && Objects.equals(name, that.name);
@@ -108,17 +109,17 @@ public int hashCode() {
 
   @Override
   public String toString() {
-    return new StringJoiner(", ", DynamicEnum.class.getSimpleName() + "[", "]")
+    return new StringJoiner(", ", DynamicEnumType.class.getSimpleName() + "[", "]")
         .add("name='" + name + "'")
         .add("value=" + value)
         .toString();
   }
 
-  public static DynamicEnum newInstance(DataType dataType, int value) {
-    return new DynamicEnum(dataType, value);
+  public static DynamicEnumType newInstance(DataType dataType, int value) {
+    return new DynamicEnumType(dataType, value);
   }
 
-  public static Function<Integer, DynamicEnum> newInstanceFactory(DataType dataType) {
-    return value -> new DynamicEnum(dataType, value);
+  public static Function<Integer, DynamicEnumType> newInstanceFactory(DataType dataType) {
+    return value -> new DynamicEnumType(dataType, value);
   }
 }

opc-ua-sdk/sdk-core/src/main/java/org/eclipse/milo/opcua/sdk/core/types/DynamicOptionSet.java renamed to opc-ua-sdk/sdk-core/src/main/java/org/eclipse/milo/opcua/sdk/core/types/DynamicOptionSetType.java

@@ -18,23 +18,43 @@
 import java.util.Map;
 import java.util.StringJoiner;
 import org.eclipse.milo.opcua.sdk.core.typetree.DataType;
+import org.eclipse.milo.opcua.stack.core.types.UaStructuredType;
 import org.eclipse.milo.opcua.stack.core.types.builtin.ByteString;
+import org.eclipse.milo.opcua.stack.core.types.builtin.ExpandedNodeId;
 import org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText;
 import org.eclipse.milo.opcua.stack.core.types.structured.EnumDefinition;
 import org.eclipse.milo.opcua.stack.core.types.structured.EnumField;
 import org.eclipse.milo.opcua.stack.core.util.Lazy;
 import org.jspecify.annotations.Nullable;
 
-public class DynamicOptionSet extends DynamicStruct {
+public final class DynamicOptionSetType extends DynamicType implements UaStructuredType {
 
   private final Lazy<Map<Integer, EnumField>> lazyFieldMap = new Lazy<>();
 
-  public DynamicOptionSet(DataType dataType) {
+  private final DataType dataType;
+  private final LinkedHashMap<String, Object> members;
+
+  public DynamicOptionSetType(DataType dataType) {
     this(dataType, new LinkedHashMap<>());
   }
 
-  public DynamicOptionSet(DataType dataType, LinkedHashMap<String, Object> members) {
-    super(dataType, members);
+  public DynamicOptionSetType(DataType dataType, LinkedHashMap<String, Object> members) {
+    this.dataType = dataType;
+    this.members = members;
+  }
+
+  @Override
+  public ExpandedNodeId getTypeId() {
+    return dataType.getNodeId().expanded();
+  }
+
+  @Override
+  public DataType getDataType() {
+    return dataType;
+  }
+
+  public LinkedHashMap<String, Object> getMembers() {
+    return members;
   }
 
   public ByteString getValue() {
@@ -76,7 +96,7 @@ private Map<Integer, EnumField> getFieldMap() {
         () -> {
           Map<Integer, EnumField> fieldMap = Collections.synchronizedMap(new HashMap<>());
 
-          EnumDefinition definition = (EnumDefinition) getDataType().getDataTypeDefinition();
+          EnumDefinition definition = (EnumDefinition) dataType.getDataTypeDefinition();
           assert definition != null;
 
           EnumField[] fields = requireNonNullElse(definition.getFields(), new EnumField[0]);
@@ -91,7 +111,7 @@ private Map<Integer, EnumField> getFieldMap() {
 
   @Override
   public String toString() {
-    return new StringJoiner(", ", DynamicOptionSet.class.getSimpleName() + "[", "]")
+    return new StringJoiner(", ", DynamicOptionSetType.class.getSimpleName() + "[", "]")
         .add("value=" + toBitString(getValue()))
         .add("validBits=" + toBitString(getValidBits()))
         .toString();