Do not require DataObject for streaming
[yangtools.git] / binding / mdsal-binding-dom-codec / src / main / java / org / opendaylight / mdsal / binding / dom / codec / impl / BindingCodecContext.java
index dd108c2c818d5d33ac99510d1352706575341df9..e0798e20988d2a6468d124e61e38a2999cabd14e 100644 (file)
@@ -10,6 +10,7 @@ package org.opendaylight.mdsal.binding.dom.codec.impl;
 import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkState;
 import static com.google.common.base.Verify.verify;
+import static com.google.common.base.Verify.verifyNotNull;
 import static java.util.Objects.requireNonNull;
 
 import com.google.common.base.Strings;
@@ -21,7 +22,6 @@ import com.google.common.collect.ImmutableMap;
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import java.io.File;
 import java.io.IOException;
-import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
@@ -46,7 +46,6 @@ import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCod
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
 import org.opendaylight.mdsal.binding.dom.codec.api.CommonDataObjectCodecTreeNode;
-import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory;
 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;
@@ -54,7 +53,6 @@ import org.opendaylight.mdsal.binding.loader.BindingClassLoader;
 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.Immutable;
 import org.opendaylight.yangtools.util.ClassLoaderUtils;
 import org.opendaylight.yangtools.yang.binding.Action;
@@ -63,10 +61,10 @@ import org.opendaylight.yangtools.yang.binding.BaseIdentity;
 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;
-import org.opendaylight.yangtools.yang.binding.Identifier;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.binding.Key;
+import org.opendaylight.yangtools.yang.binding.KeyAware;
 import org.opendaylight.yangtools.yang.binding.Notification;
 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
 import org.opendaylight.yangtools.yang.binding.RpcInput;
@@ -104,25 +102,7 @@ import org.slf4j.LoggerFactory;
 
 @MetaInfServices(value = BindingDOMCodecServices.class)
 public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer
-        implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataObjectSerializerRegistry {
-    private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectStreamer<?>> {
-        private final @NonNull DataObjectStreamer<?> delegate;
-
-        DataObjectSerializerProxy(final DataObjectStreamer<?> delegate) {
-            this.delegate = requireNonNull(delegate);
-        }
-
-        @Override
-        public DataObjectStreamer<?> getDelegate() {
-            return delegate;
-        }
-
-        @Override
-        public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
-            delegate.serialize(BindingCodecContext.this, obj, stream);
-        }
-    }
-
+        implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataContainerSerializerRegistry {
     private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
     private static final @NonNull NodeIdentifier FAKE_NODEID = new NodeIdentifier(QName.create("fake", "fake"));
     private static final File BYTECODE_DIRECTORY;
@@ -132,21 +112,21 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
         BYTECODE_DIRECTORY = Strings.isNullOrEmpty(dir) ? null : new File(dir);
     }
 
-    private final LoadingCache<Class<?>, DataObjectStreamer<?>> streamers = CacheBuilder.newBuilder().build(
-        new CacheLoader<Class<?>, DataObjectStreamer<?>>() {
+    private final LoadingCache<Class<?>, DataContainerStreamer<?>> streamers = CacheBuilder.newBuilder().build(
+        new CacheLoader<>() {
             @Override
-            public DataObjectStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
-                final Class<?> streamer = DataObjectStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
+            public DataContainerStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
+                final var streamer = DataContainerStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
                     key);
-                final Field instance = streamer.getDeclaredField(DataObjectStreamerGenerator.INSTANCE_FIELD);
-                return (DataObjectStreamer<?>) instance.get(null);
+                final var instance = streamer.getDeclaredField(DataContainerStreamerGenerator.INSTANCE_FIELD);
+                return (DataContainerStreamer<?>) instance.get(null);
             }
         });
-    private final LoadingCache<Class<?>, DataObjectSerializer> serializers = CacheBuilder.newBuilder().build(
-        new CacheLoader<Class<?>, DataObjectSerializer>() {
+    private final LoadingCache<Class<?>, DataContainerSerializer> serializers = CacheBuilder.newBuilder().build(
+        new CacheLoader<>() {
             @Override
-            public DataObjectSerializer load(final Class<?> key) throws ExecutionException {
-                return new DataObjectSerializerProxy(streamers.get(key));
+            public DataContainerSerializer load(final Class<?> key) throws ExecutionException {
+                return new DataContainerSerializer(BindingCodecContext.this, streamers.get(key));
             }
         });
 
@@ -155,7 +135,7 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
     private final @NonNull IdentityCodec identityCodec;
     private final @NonNull BindingRuntimeContext context;
-    private final @NonNull SchemaRootCodecContext<?> root;
+    private final @NonNull RootCodecContext<?> root;
 
     public BindingCodecContext() {
         this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
@@ -164,7 +144,7 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
 
     public BindingCodecContext(final BindingRuntimeContext context) {
         this.context = requireNonNull(context, "Binding Runtime Context is required.");
-        root = new SchemaRootCodecContext<>(this);
+        root = new RootCodecContext<>(this);
         identityCodec = new IdentityCodec(context);
         instanceIdentifierCodec = new InstanceIdentifierCodec(this);
     }
@@ -190,17 +170,17 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     }
 
     @Override
-    public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
+    public DataContainerSerializer getEventStreamSerializer(final Class<?> type) {
         return serializers.getUnchecked(type);
     }
 
     @Override
-    public DataObjectStreamer<?> getDataObjectSerializer(final Class<?> type) {
+    public DataContainerStreamer<?> getDataContainerStreamer(final Class<?> type) {
         return streamers.getUnchecked(type);
     }
 
     @Override
-    public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
+    public DataContainerSerializer getSerializer(final Class<? extends DataContainer> type) {
         return serializers.getUnchecked(type);
     }
 
@@ -271,8 +251,8 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
      */
     @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
             final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
-        NodeCodecContext currentNode = root;
-        ListNodeCodecContext<?> currentList = null;
+        CodecContext currentNode = root;
+        ListCodecContext<?> currentList = null;
 
         for (var domArg : dom.getPathArguments()) {
             checkArgument(currentNode instanceof DataContainerCodecContext,
@@ -284,7 +264,7 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
              * Compatibility case: if it's determined the node belongs to augmentation
              * then insert augmentation path argument in between.
              */
-            if (nextNode instanceof AugmentationNodeContext<?> augmContext) {
+            if (nextNode instanceof AugmentationCodecContext<?> augmContext) {
                 if (bindingArguments != null) {
                     bindingArguments.add(augmContext.bindingArg());
                 }
@@ -311,11 +291,11 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
                 }
                 currentList = null;
                 currentNode = nextNode;
-            } else if (nextNode instanceof ListNodeCodecContext<?> listNode) {
+            } else if (nextNode instanceof ListCodecContext<?> listNode) {
                 // We enter list, we do not update current Node yet,
                 // since we need to verify
                 currentList = listNode;
-            } else if (nextNode instanceof ChoiceNodeCodecContext) {
+            } else if (nextNode instanceof ChoiceCodecContext) {
                 // We do not add path argument for choice, since
                 // it is not supported by binding instance identifier.
                 currentNode = nextNode;
@@ -332,11 +312,11 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
 
         // Algorithm ended in list as whole representation
         // we sill need to emit identifier for list
-        if (currentNode instanceof ChoiceNodeCodecContext) {
+        if (currentNode instanceof ChoiceCodecContext) {
             LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
             return null;
         }
-        if (currentNode instanceof CaseNodeCodecContext) {
+        if (currentNode instanceof CaseCodecContext) {
             LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
             return null;
         }
@@ -424,11 +404,11 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
                     valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
                 } else if (schema instanceof AnyxmlSchemaNode anyxmlSchema) {
-                    valueNode = new OpaqueNodeCodecContext.Anyxml<>(anyxmlSchema, method.getName(),
-                            opaqueReturnType(method), loader);
+                    valueNode = new AnyxmlCodecContext<>(anyxmlSchema, method.getName(), opaqueReturnType(method),
+                        loader);
                 } else if (schema instanceof AnydataSchemaNode anydataSchema) {
-                    valueNode = new OpaqueNodeCodecContext.Anydata<>(anydataSchema, method.getName(),
-                            opaqueReturnType(method), loader);
+                    valueNode = new AnydataCodecContext<>(anydataSchema, method.getName(), opaqueReturnType(method),
+                        loader);
                 } else {
                     verify(schema == null, "Unhandled schema %s for method %s", schema, method);
                     // We do not have schema for leaf, so we will ignore it (e.g. getClass).
@@ -491,11 +471,11 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
 
     @Override
     public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
-        final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
-                Identifiable.class);
+        final Optional<Class<Key<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
+                KeyAware.class);
         checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
 
-        final Class<Identifier<?>> identifier = optIdentifier.orElseThrow();
+        final Class<Key<?>> identifier = optIdentifier.orElseThrow();
         final Map<QName, ValueContext> valueCtx = new HashMap<>();
         for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
             final QName name = leaf.getDomPathArgument().getNodeType();
@@ -505,8 +485,8 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
     }
 
     @Override
-    public <E extends DataObject> CommonDataObjectCodecTreeNode<E> streamChild(final Class<E> childClass) {
-        return root.streamChild(childClass);
+    public <E extends DataObject> CommonDataObjectCodecTreeNode<E> getStreamChild(final Class<E> childClass) {
+        return root.getStreamChild(childClass);
     }
 
     @Override
@@ -718,6 +698,16 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
         return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
     }
 
+    @Override
+    protected NodeIdentifier actionInputName(final Class<? extends Action<?, ?, ?>> action) {
+        return verifyNotNull(getActionCodec(action).input().getDomPathArgument());
+    }
+
+    @Override
+    protected NodeIdentifier actionOutputName(final Class<? extends Action<?, ?, ?>> action) {
+        return verifyNotNull(getActionCodec(action).output().getDomPathArgument());
+    }
+
     private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
             final WriterFactoryMethod<T> newWriter) {
         final var result = new NormalizationResultHolder();
@@ -735,7 +725,6 @@ public final class BindingCodecContext extends AbstractBindingNormalizedNodeSeri
         return (ContainerNode) result.getResult().data();
     }
 
-
     private static boolean notBindingRepresentable(final NormalizedNode data) {
         // ValueNode covers LeafNode and LeafSetEntryNode
         return data instanceof ValueNode