Add mdsal-binding-dom-codec-osgi dependency
[mdsal.git] / binding / mdsal-binding-dom-adapter / src / main / java / org / opendaylight / mdsal / binding / dom / adapter / BindingToNormalizedNodeCodec.java
index dbf76b5f4240183747b4ce427e5c6558a1887ad2..d296fa2fc329b036cbf4a7d78226b64cea226ac7 100644 (file)
@@ -11,6 +11,7 @@ import static com.google.common.base.Preconditions.checkArgument;
 import static com.google.common.base.Preconditions.checkState;
 import static java.util.Objects.requireNonNull;
 
+import com.google.common.annotations.Beta;
 import com.google.common.cache.CacheBuilder;
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
@@ -18,29 +19,29 @@ import com.google.common.collect.ImmutableBiMap;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Iterators;
 import java.lang.reflect.Method;
+import java.time.Instant;
 import java.util.AbstractMap.SimpleEntry;
 import java.util.Collection;
-import java.util.HashSet;
 import java.util.Map.Entry;
 import java.util.Optional;
-import java.util.Set;
 import java.util.concurrent.TimeUnit;
-import java.util.function.Function;
 import java.util.stream.Collectors;
-import javassist.ClassPool;
-import javax.annotation.Nonnull;
+import javax.annotation.PreDestroy;
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import org.eclipse.jdt.annotation.NonNull;
+import org.opendaylight.binding.runtime.api.BindingRuntimeContext;
+import org.opendaylight.binding.runtime.api.BindingRuntimeGenerator;
+import org.opendaylight.binding.runtime.api.ClassLoadingStrategy;
+import org.opendaylight.binding.runtime.api.DefaultBindingRuntimeContext;
 import org.opendaylight.mdsal.binding.api.DataTreeIdentifier;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTree;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeFactory;
-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.BindingLazyContainerNode;
 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeSerializer;
-import org.opendaylight.mdsal.binding.dom.codec.gen.impl.StreamWriterGenerator;
+import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
 import org.opendaylight.mdsal.binding.dom.codec.impl.BindingNormalizedNodeCodecRegistry;
-import org.opendaylight.mdsal.binding.dom.codec.impl.MissingSchemaException;
-import org.opendaylight.mdsal.binding.generator.api.ClassLoadingStrategy;
-import org.opendaylight.mdsal.binding.generator.util.BindingRuntimeContext;
-import org.opendaylight.mdsal.binding.generator.util.JavassistUtils;
 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
@@ -61,16 +62,12 @@ import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdent
 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 import org.opendaylight.yangtools.yang.data.impl.codec.DeserializationException;
-import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
-import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
-import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
-import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextListener;
 import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.model.api.SchemaContextListener;
 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -82,8 +79,9 @@ import org.slf4j.LoggerFactory;
  * <p>
  * NOTE: this class is non-final to allow controller adapter migration without duplicated code.
  */
-public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
-        BindingNormalizedNodeSerializer, SchemaContextListener, AutoCloseable {
+@Singleton
+public class BindingToNormalizedNodeCodec implements BindingNormalizedNodeSerializer, EffectiveModelContextListener,
+        AutoCloseable {
 
     private static final long WAIT_DURATION_SEC = 5;
     private static final Logger LOG = LoggerFactory.getLogger(BindingToNormalizedNodeCodec.class);
@@ -91,33 +89,49 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
     private final LoadingCache<InstanceIdentifier<?>, YangInstanceIdentifier> iiCache = CacheBuilder.newBuilder()
             .softValues().build(new CacheLoader<InstanceIdentifier<?>, YangInstanceIdentifier>() {
                 @Override
-                public YangInstanceIdentifier load(@Nonnull final InstanceIdentifier<?> key) {
+                public YangInstanceIdentifier load(final InstanceIdentifier<?> key) {
                     return toYangInstanceIdentifierBlocking(key);
                 }
             });
     private final BindingNormalizedNodeCodecRegistry codecRegistry;
     private final ClassLoadingStrategy classLoadingStrategy;
+    private final BindingRuntimeGenerator generator;
     private final FutureSchema futureSchema;
+
     private ListenerRegistration<?> listenerRegistration;
 
-    public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
-            final BindingNormalizedNodeCodecRegistry codecRegistry) {
-        this(classLoadingStrategy, codecRegistry, false);
+    @Inject
+    public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
+            final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry) {
+        this(generator, classLoadingStrategy, codecRegistry, false);
+    }
+
+    @Beta
+    public BindingToNormalizedNodeCodec(final BindingRuntimeContext runtimeContext) {
+        generator = (final SchemaContext context) -> {
+            throw new UnsupportedOperationException("Static context assigned");
+        };
+        classLoadingStrategy = runtimeContext.getStrategy();
+        codecRegistry = new BindingNormalizedNodeCodecRegistry(runtimeContext);
+        // TODO: this should have a specialized constructor or not be needed
+        futureSchema = FutureSchema.create(0, TimeUnit.SECONDS, false);
+        futureSchema.onRuntimeContextUpdated(runtimeContext);
     }
 
-    public BindingToNormalizedNodeCodec(final ClassLoadingStrategy classLoadingStrategy,
-            final BindingNormalizedNodeCodecRegistry codecRegistry, final boolean waitForSchema) {
+    public BindingToNormalizedNodeCodec(final BindingRuntimeGenerator generator,
+            final ClassLoadingStrategy classLoadingStrategy, final BindingNormalizedNodeCodecRegistry codecRegistry,
+            final boolean waitForSchema) {
+        this.generator = requireNonNull(generator, "generator");
         this.classLoadingStrategy = requireNonNull(classLoadingStrategy, "classLoadingStrategy");
         this.codecRegistry = requireNonNull(codecRegistry, "codecRegistry");
         this.futureSchema = FutureSchema.create(WAIT_DURATION_SEC, TimeUnit.SECONDS, waitForSchema);
     }
 
-    public static BindingToNormalizedNodeCodec newInstance(final ClassLoadingStrategy classLoadingStrategy,
-            final DOMSchemaService schemaService) {
-        final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry(
-                StreamWriterGenerator.create(JavassistUtils.forClassPool(ClassPool.getDefault())));
-        BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(
-                classLoadingStrategy, codecRegistry, true);
+    public static BindingToNormalizedNodeCodec newInstance(final BindingRuntimeGenerator generator,
+            final ClassLoadingStrategy classLoadingStrategy, final DOMSchemaService schemaService) {
+        final BindingNormalizedNodeCodecRegistry codecRegistry = new BindingNormalizedNodeCodecRegistry();
+        BindingToNormalizedNodeCodec instance = new BindingToNormalizedNodeCodec(generator, classLoadingStrategy,
+            codecRegistry, true);
         instance.listenerRegistration = schemaService.registerSchemaContextListener(instance);
         return instance;
     }
@@ -132,22 +146,8 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
         }
     }
 
-    /**
-     * Translates supplied Binding Instance Identifier into NormalizedNode
-     * instance identifier.
-     *
-     * @param binding
-     *            Binding Instance Identifier
-     * @return DOM Instance Identifier
-     * @throws IllegalArgumentException
-     *             If supplied Instance Identifier is not valid.
-     */
-    public final YangInstanceIdentifier toNormalized(final InstanceIdentifier<? extends DataObject> binding) {
-        return codecRegistry.toYangInstanceIdentifier(binding);
-    }
-
     @Override
-    public final YangInstanceIdentifier toYangInstanceIdentifier(@Nonnull final InstanceIdentifier<?> binding) {
+    public final YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
         return codecRegistry.toYangInstanceIdentifier(binding);
     }
 
@@ -166,37 +166,25 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
         }
     }
 
-    /**
-     * Converts Binding Map.Entry to DOM Map.Entry.
-     *
-     * <p>
-     * Same as {@link #toNormalizedNode(InstanceIdentifier, DataObject)}.
-     *
-     * @param binding Map Entry with InstanceIdentifier as key and DataObject as value.
-     * @return DOM Map Entry with {@link YangInstanceIdentifier} as key and {@link NormalizedNode}
-     *         as value.
-     */
-    @SuppressWarnings({"unchecked", "rawtypes"})
-    public final Entry<YangInstanceIdentifier, NormalizedNode<?, ?>> toNormalizedNode(
-            final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding) {
-        return toNormalizedNode((InstanceIdentifier) binding.getKey(), binding.getValue());
-    }
-
     @Override
-    public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(@Nonnull final YangInstanceIdentifier path,
+    public final Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
             final NormalizedNode<?, ?> data) {
         return codecRegistry.fromNormalizedNode(path, data);
     }
 
     @Override
-    public final Notification fromNormalizedNodeNotification(@Nonnull final SchemaPath path,
-            @Nonnull final ContainerNode data) {
+    public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data) {
         return codecRegistry.fromNormalizedNodeNotification(path, data);
     }
 
     @Override
-    public final DataObject fromNormalizedNodeRpcData(@Nonnull final SchemaPath path,
-            @Nonnull final ContainerNode data) {
+    public final Notification fromNormalizedNodeNotification(final SchemaPath path, final ContainerNode data,
+            final Instant eventInstant) {
+        return codecRegistry.fromNormalizedNodeNotification(path, data, eventInstant);
+    }
+
+    @Override
+    public final DataObject fromNormalizedNodeRpcData(final SchemaPath path, final ContainerNode data) {
         return codecRegistry.fromNormalizedNodeRpcData(path, data);
     }
 
@@ -213,17 +201,18 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
     }
 
     @Override
-    public final InstanceIdentifier<?> fromYangInstanceIdentifier(@Nonnull final YangInstanceIdentifier dom) {
+    public final <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(
+            final YangInstanceIdentifier dom) {
         return codecRegistry.fromYangInstanceIdentifier(dom);
     }
 
     @Override
-    public final ContainerNode toNormalizedNodeNotification(@Nonnull final Notification data) {
+    public final ContainerNode toNormalizedNodeNotification(final Notification data) {
         return codecRegistry.toNormalizedNodeNotification(data);
     }
 
     @Override
-    public final ContainerNode toNormalizedNodeRpcData(@Nonnull final DataContainer data) {
+    public final ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
         return codecRegistry.toNormalizedNodeRpcData(data);
     }
 
@@ -268,66 +257,26 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
         }
     }
 
-    public final Optional<Entry<InstanceIdentifier<? extends DataObject>, DataObject>> toBinding(
-            @Nonnull final Entry<YangInstanceIdentifier, ? extends NormalizedNode<?, ?>> normalized)
-                    throws DeserializationException {
-        try {
-            /*
-             * This cast is required, due to generics behaviour in openjdk / oracle javac.
-             *
-             * <p>
-             * InstanceIdentifier has definition InstanceIdentifier<T extends DataObject>,
-             * this means '?' is always  <? extends DataObject>. Eclipse compiler
-             * is able to determine this relationship and treats
-             * Entry<InstanceIdentifier<?>, DataObject> and Entry<InstanceIdentifier<? extends DataObject, DataObject>
-             * as assignable. However openjdk / oracle javac treats this two types
-             * as incompatible and issues a compile error.
-             *
-             * <p>
-             * It is safe to lose generic information and cast it to other generic signature.
-             */
-            @SuppressWarnings("unchecked")
-            final Entry<InstanceIdentifier<? extends DataObject>, DataObject> binding = Entry.class.cast(
-                    codecRegistry.fromNormalizedNode(normalized.getKey(), normalized.getValue()));
-            return Optional.ofNullable(binding);
-        } catch (final IllegalArgumentException e) {
-            return Optional.empty();
-        }
-    }
-
     @Override
-    public void onGlobalContextUpdated(final SchemaContext context) {
-        final BindingRuntimeContext runtimeContext = BindingRuntimeContext.create(classLoadingStrategy, context);
+    public void onModelContextUpdated(final EffectiveModelContext newModelContext) {
+        final BindingRuntimeContext runtimeContext = DefaultBindingRuntimeContext.create(
+            generator.generateTypeMapping(newModelContext), classLoadingStrategy);
         codecRegistry.onBindingRuntimeContextUpdated(runtimeContext);
         futureSchema.onRuntimeContextUpdated(runtimeContext);
     }
 
-    /**
-     * Deprecated.
-     *
-     * @deprecated Use {@link BindingNormalizedNodeCodecRegistry#deserializeFunction} instead.
-     */
-    @Deprecated
-    public final <T extends DataObject> Function<Optional<NormalizedNode<?, ?>>, Optional<T>> deserializeFunction(
-            final InstanceIdentifier<T> path) {
-        return codecRegistry.deserializeFunction(path)::apply;
-    }
-
     public final BindingNormalizedNodeCodecRegistry getCodecRegistry() {
         return codecRegistry;
     }
 
     @Override
+    @PreDestroy
     public void close() {
         if (listenerRegistration != null) {
             listenerRegistration.close();
         }
     }
 
-    public final BindingNormalizedNodeCodecRegistry getCodecFactory() {
-        return codecRegistry;
-    }
-
     // FIXME: This should be probably part of Binding Runtime context
     public final ImmutableBiMap<Method, SchemaPath> getRpcMethodToSchemaPath(final Class<? extends RpcService> key) {
         final Module module = getModuleBlocking(key);
@@ -387,23 +336,12 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
 
     private Method findRpcMethod(final Class<? extends RpcService> key, final RpcDefinition rpcDef)
             throws NoSuchMethodException {
-        final String methodName = BindingMapping.getMethodName(rpcDef.getQName());
+        final String methodName = BindingMapping.getRpcMethodName(rpcDef.getQName());
         final Class<?> inputClz = runtimeContext().getClassForSchema(rpcDef.getInput());
         return key.getMethod(methodName, inputClz);
     }
 
-    @Override
-    public final BindingCodecTree create(final BindingRuntimeContext context) {
-        return codecRegistry.create(context);
-    }
-
-    @Override
-    public final BindingCodecTree create(final SchemaContext context, final Class<?>... bindingClasses) {
-        return codecRegistry.create(context, bindingClasses);
-    }
-
-    @Nonnull
-    protected Entry<InstanceIdentifier<?>, BindingCodecTreeNode<?>> getSubtreeCodec(
+    protected @NonNull Entry<InstanceIdentifier<?>, BindingDataObjectCodecTreeNode<?>> getSubtreeCodec(
             final YangInstanceIdentifier domIdentifier) {
 
         final BindingCodecTree currentCodecTree = codecRegistry.getCodecContext();
@@ -413,34 +351,17 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
          * If we are able to deserialize YANG instance identifier, getSubtreeCodec must
          * return non-null value.
          */
-        final BindingCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
+        final BindingDataObjectCodecTreeNode<?> codecContext = currentCodecTree.getSubtreeCodec(bindingPath);
         return new SimpleEntry<>(bindingPath, codecContext);
     }
 
-    @SuppressWarnings("unchecked")
-    public final Set<Class<? extends Notification>> getNotificationClasses(final Set<SchemaPath> interested) {
-        final Set<Class<? extends Notification>> result = new HashSet<>();
-        final BindingRuntimeContext runtimeContext = runtimeContext();
-        for (final NotificationDefinition notification : runtimeContext.getSchemaContext().getNotifications()) {
-            if (interested.contains(notification.getPath())) {
-                try {
-                    result.add((Class<? extends Notification>) runtimeContext.getClassForSchema(notification));
-                } catch (final IllegalStateException e) {
-                    // Ignore
-                    LOG.warn("Class for {} is currently not known.", notification.getPath(), e);
-                }
-            }
-        }
-        return result;
-    }
-
-    SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
+    final SchemaPath getActionPath(final Class<? extends Action<?, ?, ?>> type) {
         final ActionDefinition schema = runtimeContext().getActionDefinition(type);
         checkArgument(schema != null, "Failed to find schema for %s", type);
         return schema.getPath();
     }
 
-    private BindingRuntimeContext runtimeContext() {
+    final BindingRuntimeContext runtimeContext() {
         return futureSchema.runtimeContext();
     }
 
@@ -448,23 +369,6 @@ public class BindingToNormalizedNodeCodec implements BindingCodecTreeFactory,
         return ImmutableSet.copyOf(Iterators.transform(path.getPathArguments().iterator(), PathArgument::getType));
     }
 
-    protected NormalizedNode<?, ?> instanceIdentifierToNode(final YangInstanceIdentifier parentPath) {
-        return ImmutableNodes.fromInstanceId(runtimeContext().getSchemaContext(), parentPath);
-    }
-
-    public NormalizedNode<?, ?> getDefaultNodeFor(final YangInstanceIdentifier parentMapPath) {
-        final BindingCodecTreeNode<?> mapCodec = requireNonNull(
-                codecRegistry.getCodecContext().getSubtreeCodec(parentMapPath),
-                "Codec not found for yang instance identifier: " + parentMapPath);
-        final WithStatus schema = mapCodec.getSchema();
-        if (schema instanceof ListSchemaNode) {
-            final ListSchemaNode castedSchema = (ListSchemaNode) schema;
-            return castedSchema.isUserOrdered() ? Builders.orderedMapBuilder(castedSchema).build()
-                    : Builders.mapBuilder(castedSchema).build();
-        }
-        throw new IllegalArgumentException("Path does not point to list schema node");
-    }
-
     protected Collection<DOMDataTreeIdentifier> toDOMDataTreeIdentifiers(
             final Collection<DataTreeIdentifier<?>> subtrees) {
         return subtrees.stream().map(this::toDOMDataTreeIdentifier).collect(Collectors.toSet());