Simplify CompositeValueCodec instantiation
[mdsal.git] / binding / mdsal-binding-dom-codec / src / main / java / org / opendaylight / mdsal / binding / dom / codec / impl / BindingCodecContext.java
index e410d9549a467a9597e9bda2b20a564d81c77eac..5c03da48c655cba6974272ee4929aa9bf3c530f2 100644 (file)
@@ -23,8 +23,8 @@ import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
+import java.lang.reflect.WildcardType;
 import java.time.Instant;
-import java.util.AbstractMap.SimpleEntry;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
@@ -34,14 +34,12 @@ import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Optional;
 import java.util.ServiceLoader;
-import java.util.concurrent.Callable;
 import java.util.concurrent.ExecutionException;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 import org.kohsuke.MetaInfServices;
-import org.opendaylight.binding.runtime.api.BindingRuntimeContext;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
@@ -52,13 +50,15 @@ import org.opendaylight.mdsal.binding.dom.codec.loader.CodecClassLoader;
 import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer;
 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
-import org.opendaylight.mdsal.binding.model.api.GeneratedType;
+import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
+import org.opendaylight.mdsal.binding.runtime.api.ListRuntimeType;
 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
 import org.opendaylight.yangtools.concepts.Delegator;
 import org.opendaylight.yangtools.concepts.IllegalArgumentCodec;
 import org.opendaylight.yangtools.concepts.Immutable;
 import org.opendaylight.yangtools.util.ClassLoaderUtils;
 import org.opendaylight.yangtools.yang.binding.Action;
+import org.opendaylight.yangtools.yang.binding.BaseNotification;
 import org.opendaylight.yangtools.yang.binding.DataContainer;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.Identifiable;
@@ -83,16 +83,15 @@ import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeS
 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.TypeAware;
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
+import org.opendaylight.yangtools.yang.model.api.stmt.TypeDefinitionAware;
 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
@@ -157,9 +156,9 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     @Inject
     public BindingCodecContext(final BindingRuntimeContext context) {
         this.context = requireNonNull(context, "Binding Runtime Context is required.");
-        this.root = SchemaRootCodecContext.create(this);
-        this.identityCodec = new IdentityCodec(context);
-        this.instanceIdentifierCodec = new InstanceIdentifierCodec(this);
+        root = SchemaRootCodecContext.create(this);
+        identityCodec = new IdentityCodec(context);
+        instanceIdentifierCodec = new InstanceIdentifierCodec(this);
     }
 
     @Override
@@ -202,7 +201,7 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
             final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
         final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
         final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
-        return new SimpleEntry<>(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
+        return Map.entry(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
     }
 
     @Override
@@ -218,7 +217,7 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     }
 
     @Override
-    public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification> notification,
+    public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification<?>> notification,
             final NormalizedNodeStreamWriter domWriter) {
         return root.getNotification(notification).createWriter(domWriter);
     }
@@ -331,12 +330,12 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
         return null;
     }
 
-    NotificationCodecContext<?> getNotificationContext(final SchemaPath notification) {
+    NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
         return root.getNotification(notification);
     }
 
-    RpcInputCodec<?> getRpcInputCodec(final SchemaPath path) {
-        return root.getRpc(path);
+    RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
+        return root.getRpc(containerPath);
     }
 
     ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
@@ -344,33 +343,43 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     }
 
     @Override
-    public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> parentClass,
-            final DataNodeContainer childSchema) {
+    public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> type,
+            final EffectiveStatement<?, ?> schema) {
         final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
-        for (final DataSchemaNode leaf : childSchema.getChildNodes()) {
-            if (leaf instanceof TypedDataSchemaNode || leaf instanceof AnyxmlSchemaNode
-                    || leaf instanceof AnydataSchemaNode) {
-                getterToLeafSchema.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
+        for (var stmt : schema.effectiveSubstatements()) {
+            if (stmt instanceof TypedDataSchemaNode) {
+                putLeaf(getterToLeafSchema, (TypedDataSchemaNode) stmt);
+            } else if (stmt instanceof AnydataSchemaNode) {
+                putLeaf(getterToLeafSchema, (AnydataSchemaNode) stmt);
+            } else if (stmt instanceof AnyxmlSchemaNode) {
+                putLeaf(getterToLeafSchema, (AnyxmlSchemaNode) stmt);
             }
         }
-        return getLeafNodesUsingReflection(parentClass, getterToLeafSchema);
+        return getLeafNodesUsingReflection(type, getterToLeafSchema);
+    }
+
+    private static void putLeaf(final Map<String, DataSchemaNode> map, final DataSchemaNode leaf) {
+        map.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
     }
 
     private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
             final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
         final Map<Method, ValueNodeCodecContext> leaves = new HashMap<>();
         for (final Method method : parentClass.getMethods()) {
-            if (method.getParameterCount() == 0) {
+            // Only consider non-bridge methods with no arguments
+            if (method.getParameterCount() == 0 && !method.isBridge()) {
                 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
 
                 final ValueNodeCodecContext valueNode;
                 if (schema instanceof LeafSchemaNode) {
                     final LeafSchemaNode leafSchema = (LeafSchemaNode) schema;
 
+                    // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
+                    //                   Object.class
                     final Class<?> valueType = method.getReturnType();
                     final IllegalArgumentCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
                     valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
-                        context.getSchemaContext());
+                        context.getEffectiveModelContext());
                 } else if (schema instanceof LeafListSchemaNode) {
                     final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
                         method.getGenericReturnType());
@@ -382,6 +391,9 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
                         valueType = (Class<?>) genericType;
                     } else if (genericType instanceof ParameterizedType) {
                         valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
+                    } else if (genericType instanceof WildcardType) {
+                        // FIXME: MDSAL-670: this is not right as we need to find a concrete type
+                        valueType = Object.class;
                     } else {
                         throw new IllegalStateException("Unexpected return type " + genericType);
                     }
@@ -420,7 +432,9 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
         } else if (BindingReflections.isBindingClass(valueType)) {
             return getCodecForBindingClass(valueType, instantiatedType);
         }
-        return ValueTypeCodec.NOOP_CODEC;
+        // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
+        //                   valueType=Object.class
+        return SchemaUnawareCodec.NOOP_CODEC;
     }
 
     @SuppressWarnings("checkstyle:illegalCatch")
@@ -428,43 +442,53 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     private IllegalArgumentCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
             final TypeDefinition<?> typeDef) {
         if (typeDef instanceof IdentityrefTypeDefinition) {
-            return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, identityCodec);
+            return new CompositeValueCodec(valueType, identityCodec);
         } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
-            return ValueTypeCodec.encapsulatedValueCodecFor(valueType, typeDef, instanceIdentifierCodec);
+            return new CompositeValueCodec(valueType, instanceIdentifierCodec);
         } else if (typeDef instanceof UnionTypeDefinition) {
-            final Callable<UnionTypeCodec> unionLoader = UnionTypeCodec.loader(valueType, (UnionTypeDefinition) typeDef,
-                this);
             try {
-                return unionLoader.call();
-            } catch (final Exception e) {
+                return UnionTypeCodec.of(valueType, (UnionTypeDefinition) typeDef, this);
+            } catch (Exception e) {
                 throw new IllegalStateException("Unable to load codec for " + valueType, e);
             }
         } else if (typeDef instanceof LeafrefTypeDefinition) {
-            final Entry<GeneratedType, WithStatus> typeWithSchema = context.getTypeWithSchema(valueType);
-            final WithStatus schema = typeWithSchema.getValue();
-            checkState(schema instanceof TypeDefinition);
-            return getCodec(valueType, (TypeDefinition<?>) schema);
+            final var typeWithSchema = context.getTypeWithSchema(valueType);
+            final var schema = typeWithSchema.statement();
+            final TypeDefinition<?> def;
+            if (schema instanceof TypeDefinitionAware) {
+                def = ((TypeDefinitionAware) schema).getTypeDefinition();
+            } else if (schema instanceof TypeAware) {
+                def = ((TypeAware) schema).getType();
+            } else {
+                throw new IllegalStateException("Unexpected schema " + schema);
+            }
+            return getCodec(valueType, def);
         }
-        return ValueTypeCodec.getCodecFor(valueType, typeDef);
+        return SchemaUnawareCodec.of(valueType, typeDef);
     }
 
     @Override
-    public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListSchemaNode schema) {
+    public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
         final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
                 Identifiable.class);
         checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
 
         final Class<Identifier<?>> identifier = optIdentifier.get();
         final Map<QName, ValueContext> valueCtx = new HashMap<>();
-        for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, schema).values()) {
+        for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
             final QName name = leaf.getDomPathArgument().getNodeType();
             valueCtx.put(name, new ValueContext(identifier, leaf));
         }
-        return IdentifiableItemCodec.of(schema, identifier, listClz, valueCtx);
+        return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
+    }
+
+    @Override
+    public <E extends DataObject> BindingDataObjectCodecTreeNode<E> streamChild(final Class<E> childClass) {
+        return root.streamChild(childClass);
     }
 
-    @SuppressWarnings("unchecked")
     @Override
+    @SuppressWarnings("unchecked")
     public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
         // TODO Do we need defensive check here?
         return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
@@ -491,7 +515,7 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     }
 
     @Override
-    public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode<?,?>> toNormalizedNode(
+    public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode> toNormalizedNode(
             final InstanceIdentifier<T> path, final T data) {
         final NormalizedNodeResult result = new NormalizedNodeResult();
         // We create DOM stream writer which produces normalized nodes
@@ -508,12 +532,12 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
             throw new IllegalStateException("Failed to create normalized node", e);
         }
-        return new SimpleEntry<>(writeCtx.getKey(),result.getResult());
+        return Map.entry(writeCtx.getKey(), result.getResult());
     }
 
     @Override
     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
-            final NormalizedNode<?, ?> data) {
+            final NormalizedNode data) {
         if (notBindingRepresentable(data)) {
             return null;
         }
@@ -529,26 +553,25 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
         }
 
         final DataObject lazyObj = codec.deserialize(data);
-        final InstanceIdentifier<?> bindingPath = InstanceIdentifier.create(builder);
-        return new SimpleEntry<>(bindingPath, lazyObj);
+        final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
+        return Map.entry(bindingPath, lazyObj);
     }
 
     @Override
-    public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
+    public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
         return getNotificationContext(path).deserialize(data);
     }
 
     @Override
-    public Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
+    public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
             final Instant eventInstant) {
         return eventInstant == null ? fromNormalizedNodeNotification(path, data)
                 : getNotificationContext(path).deserialize(data, eventInstant);
-
     }
 
     @Override
-    public DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
-        return getRpcInputCodec(path).deserialize(data);
+    public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
+        return getRpcInputCodec(containerPath).deserialize(data);
     }
 
     @Override
@@ -565,17 +588,29 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
 
     @Override
     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
-    public ContainerNode toNormalizedNodeNotification(@NonNull final Notification data) {
+    public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
         // FIXME: Should the cast to DataObject be necessary?
         return serializeDataObject((DataObject) data,
-            (ctx, iface, domWriter) -> ctx.newNotificationWriter(iface.asSubclass(Notification.class), domWriter));
+            (ctx, iface, domWriter) -> ctx.newNotificationWriter(
+                (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
+    }
+
+    @Override
+    public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
+        checkArgument(data instanceof DataObject, "Unexpected data %s", data);
+        @SuppressWarnings("rawtypes")
+        final NotificationCodecContext notifContext = getNotificationContext(path);
+        @SuppressWarnings("unchecked")
+        final var result = notifContext.serialize((DataObject) data);
+        verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
+        return (ContainerNode) result;
     }
 
     @Override
     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
         // FIXME: Should the cast to DataObject be necessary?
-        return serializeDataObject((DataObject) data, (ctx, iface, domWriter) -> ctx.newRpcWriter(iface, domWriter));
+        return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
     }
 
     @Override
@@ -608,7 +643,7 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     }
 
 
-    private static boolean notBindingRepresentable(final NormalizedNode<?, ?> data) {
+    private static boolean notBindingRepresentable(final NormalizedNode data) {
         // ValueNode covers LeafNode and LeafSetEntryNode
         return data instanceof ValueNode
                 || data instanceof MapNode || data instanceof UnkeyedListNode