binding/mdsal-binding-dom-codec/src/main/java/org/opendaylight/mdsal/binding/dom/codec/impl/BindingCodecContext.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.binding.dom.codec.impl;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import static com.google.common.base.Verify.verify;
  13 import static java.util.Objects.requireNonNull;
  14
  15 import com.google.common.cache.CacheBuilder;
  16 import com.google.common.cache.CacheLoader;
  17 import com.google.common.cache.LoadingCache;
  18 import com.google.common.collect.ImmutableMap;
  19 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  20 import java.io.IOException;
  21 import java.lang.reflect.Field;
  22 import java.lang.reflect.Method;
  23 import java.lang.reflect.ParameterizedType;
  24 import java.lang.reflect.Type;
  25 import java.lang.reflect.WildcardType;
  26 import java.time.Instant;
  27 import java.util.ArrayList;
  28 import java.util.Collection;
  29 import java.util.HashMap;
  30 import java.util.LinkedList;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Map.Entry;
  34 import java.util.Optional;
  35 import java.util.ServiceLoader;
  36 import java.util.concurrent.ExecutionException;
  37 import org.eclipse.jdt.annotation.NonNull;
  38 import org.eclipse.jdt.annotation.Nullable;
  39 import org.kohsuke.MetaInfServices;
  40 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  41 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  42 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
  43 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
  44 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
  45 import org.opendaylight.mdsal.binding.dom.codec.impl.NodeCodecContext.CodecContextFactory;
  46 import org.opendaylight.mdsal.binding.dom.codec.impl.loader.CodecClassLoader;
  47 import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer;
  48 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
  49 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
  50 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
  51 import org.opendaylight.mdsal.binding.runtime.api.ListRuntimeType;
  52 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  53 import org.opendaylight.yangtools.concepts.Delegator;
  54 import org.opendaylight.yangtools.concepts.Immutable;
  55 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  56 import org.opendaylight.yangtools.yang.binding.Action;
  57 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  58 import org.opendaylight.yangtools.yang.binding.BaseNotification;
  59 import org.opendaylight.yangtools.yang.binding.DataContainer;
  60 import org.opendaylight.yangtools.yang.binding.DataObject;
  61 import org.opendaylight.yangtools.yang.binding.Identifiable;
  62 import org.opendaylight.yangtools.yang.binding.Identifier;
  63 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  64 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
  65 import org.opendaylight.yangtools.yang.binding.Notification;
  66 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
  67 import org.opendaylight.yangtools.yang.binding.RpcInput;
  68 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  69 import org.opendaylight.yangtools.yang.common.QName;
  70 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  71 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  72 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  73 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  74 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  75 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  76 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  77 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
  78 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  79 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  80 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  81 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
  82 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
  83 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  84 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  85 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  86 import org.opendaylight.yangtools.yang.model.api.TypeAware;
  87 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
  88 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
  89 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  90 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  91 import org.opendaylight.yangtools.yang.model.api.stmt.TypeDefinitionAware;
  92 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
  93 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
  94 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
  95 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
  96 import org.slf4j.Logger;
  97 import org.slf4j.LoggerFactory;
  98
  99 @MetaInfServices(value = BindingDOMCodecServices.class)
 100 public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer
 101         implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataObjectSerializerRegistry {
 102     private final class DataObjectSerializerProxy implements DataObjectSerializer, Delegator<DataObjectStreamer<?>> {
 103         private final @NonNull DataObjectStreamer<?> delegate;
 104
 105         DataObjectSerializerProxy(final DataObjectStreamer<?> delegate) {
 106             this.delegate = requireNonNull(delegate);
 107         }
 108
 109         @Override
 110         public DataObjectStreamer<?> getDelegate() {
 111             return delegate;
 112         }
 113
 114         @Override
 115         public void serialize(final DataObject obj, final BindingStreamEventWriter stream) throws IOException {
 116             delegate.serialize(BindingCodecContext.this, obj, stream);
 117         }
 118     }
 119
 120     private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
 121
 122     private final LoadingCache<Class<?>, DataObjectStreamer<?>> streamers = CacheBuilder.newBuilder().build(
 123         new CacheLoader<Class<?>, DataObjectStreamer<?>>() {
 124             @Override
 125             public DataObjectStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
 126                 final Class<?> streamer = DataObjectStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
 127                     key);
 128                 final Field instance = streamer.getDeclaredField(DataObjectStreamerGenerator.INSTANCE_FIELD);
 129                 return (DataObjectStreamer<?>) instance.get(null);
 130             }
 131         });
 132     private final LoadingCache<Class<?>, DataObjectSerializer> serializers = CacheBuilder.newBuilder().build(
 133         new CacheLoader<Class<?>, DataObjectSerializer>() {
 134             @Override
 135             public DataObjectSerializer load(final Class<?> key) throws ExecutionException {
 136                 return new DataObjectSerializerProxy(streamers.get(key));
 137             }
 138         });
 139
 140     private final @NonNull CodecClassLoader loader = CodecClassLoader.create();
 141     private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
 142     private final @NonNull IdentityCodec identityCodec;
 143     private final @NonNull BindingRuntimeContext context;
 144     private final SchemaRootCodecContext<?> root;
 145
 146     public BindingCodecContext() {
 147         this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
 148             .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext")));
 149     }
 150
 151     public BindingCodecContext(final BindingRuntimeContext context) {
 152         this.context = requireNonNull(context, "Binding Runtime Context is required.");
 153         root = SchemaRootCodecContext.create(this);
 154         identityCodec = new IdentityCodec(context);
 155         instanceIdentifierCodec = new InstanceIdentifierCodec(this);
 156     }
 157
 158     @Override
 159     public BindingRuntimeContext getRuntimeContext() {
 160         return context;
 161     }
 162
 163     @Override
 164     public CodecClassLoader getLoader() {
 165         return loader;
 166     }
 167
 168     @Override
 169     public IdentityCodec getIdentityCodec() {
 170         return identityCodec;
 171     }
 172
 173     @Override
 174     public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() {
 175         return instanceIdentifierCodec;
 176     }
 177
 178     @Override
 179     public DataObjectSerializer getEventStreamSerializer(final Class<?> type) {
 180         return serializers.getUnchecked(type);
 181     }
 182
 183     @Override
 184     public DataObjectStreamer<?> getDataObjectSerializer(final Class<?> type) {
 185         return streamers.getUnchecked(type);
 186     }
 187
 188     @Override
 189     public DataObjectSerializer getSerializer(final Class<? extends DataObject> type) {
 190         return serializers.getUnchecked(type);
 191     }
 192
 193     @Override
 194     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
 195             final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 196         final List<YangInstanceIdentifier.PathArgument> yangArgs = new LinkedList<>();
 197         final DataContainerCodecContext<?,?> codecContext = getCodecContextNode(path, yangArgs);
 198         return Map.entry(YangInstanceIdentifier.create(yangArgs), codecContext.createWriter(domWriter));
 199     }
 200
 201     @Override
 202     public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
 203             final NormalizedNodeStreamWriter domWriter) {
 204         return getCodecContextNode(path, null).createWriter(domWriter);
 205     }
 206
 207     @Override
 208     public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
 209             final NormalizedNodeStreamWriter domWriter) {
 210         return root.getRpc(rpcInputOrOutput).createWriter(domWriter);
 211     }
 212
 213     @Override
 214     public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification<?>> notification,
 215             final NormalizedNodeStreamWriter domWriter) {
 216         return root.getNotification(notification).createWriter(domWriter);
 217     }
 218
 219     @Override
 220     public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
 221             final NormalizedNodeStreamWriter domWriter) {
 222         return getActionCodec(action).input().createWriter(domWriter);
 223     }
 224
 225     @Override
 226     public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
 227             final NormalizedNodeStreamWriter domWriter) {
 228         return getActionCodec(action).output().createWriter(domWriter);
 229     }
 230
 231     DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
 232             final List<YangInstanceIdentifier.PathArgument> builder) {
 233         DataContainerCodecContext<?,?> currentNode = root;
 234         for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
 235             currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
 236             checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
 237         }
 238         return currentNode;
 239     }
 240
 241     /**
 242      * Multi-purpose utility function. Traverse the codec tree, looking for
 243      * the appropriate codec for the specified {@link YangInstanceIdentifier}.
 244      * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
 245      * into the supplied collection.
 246      *
 247      * @param dom {@link YangInstanceIdentifier} which is to be translated
 248      * @param bindingArguments Collection for traversed path arguments
 249      * @return Codec for target node, or @null if the node does not have a
 250      *         binding representation (choice, case, leaf).
 251      *
 252      */
 253     @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
 254             final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
 255         NodeCodecContext currentNode = root;
 256         ListNodeCodecContext<?> currentList = null;
 257
 258         for (final YangInstanceIdentifier.PathArgument domArg : dom.getPathArguments()) {
 259             checkArgument(currentNode instanceof DataContainerCodecContext,
 260                 "Unexpected child of non-container node %s", currentNode);
 261             final DataContainerCodecContext<?,?> previous = (DataContainerCodecContext<?, ?>) currentNode;
 262             final NodeCodecContext nextNode = previous.yangPathArgumentChild(domArg);
 263
 264             /*
 265              * List representation in YANG Instance Identifier consists of two
 266              * arguments: first is list as a whole, second is list as an item so
 267              * if it is /list it means list as whole, if it is /list/list - it
 268              * is wildcarded and if it is /list/list[key] it is concrete item,
 269              * all this variations are expressed in Binding Aware Instance
 270              * Identifier as Item or IdentifiableItem
 271              */
 272             if (currentList != null) {
 273                 checkArgument(currentList == nextNode,
 274                         "List should be referenced two times in YANG Instance Identifier %s", dom);
 275
 276                 // We entered list, so now we have all information to emit
 277                 // list path using second list argument.
 278                 if (bindingArguments != null) {
 279                     bindingArguments.add(currentList.getBindingPathArgument(domArg));
 280                 }
 281                 currentList = null;
 282                 currentNode = nextNode;
 283             } else if (nextNode instanceof ListNodeCodecContext) {
 284                 // We enter list, we do not update current Node yet,
 285                 // since we need to verify
 286                 currentList = (ListNodeCodecContext<?>) nextNode;
 287             } else if (nextNode instanceof ChoiceNodeCodecContext) {
 288                 // We do not add path argument for choice, since
 289                 // it is not supported by binding instance identifier.
 290                 currentNode = nextNode;
 291             } else if (nextNode instanceof DataContainerCodecContext) {
 292                 if (bindingArguments != null) {
 293                     bindingArguments.add(((DataContainerCodecContext<?, ?>) nextNode).getBindingPathArgument(domArg));
 294                 }
 295                 currentNode = nextNode;
 296             } else if (nextNode instanceof ValueNodeCodecContext) {
 297                 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
 298                 return null;
 299             }
 300         }
 301
 302         // Algorithm ended in list as whole representation
 303         // we sill need to emit identifier for list
 304         if (currentNode instanceof ChoiceNodeCodecContext) {
 305             LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
 306             return null;
 307         }
 308         if (currentNode instanceof CaseNodeCodecContext) {
 309             LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
 310             return null;
 311         }
 312
 313         if (currentList != null) {
 314             if (bindingArguments != null) {
 315                 bindingArguments.add(currentList.getBindingPathArgument(null));
 316             }
 317             return currentList;
 318         }
 319         if (currentNode != null) {
 320             verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
 321                 currentNode, dom);
 322             return (BindingDataObjectCodecTreeNode<?>) currentNode;
 323         }
 324         return null;
 325     }
 326
 327     NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
 328         return root.getNotification(notification);
 329     }
 330
 331     RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
 332         return root.getRpc(containerPath);
 333     }
 334
 335     ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
 336         return root.getAction(action);
 337     }
 338
 339     @Override
 340     public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> type,
 341             final EffectiveStatement<?, ?> schema) {
 342         final Map<String, DataSchemaNode> getterToLeafSchema = new HashMap<>();
 343         for (var stmt : schema.effectiveSubstatements()) {
 344             if (stmt instanceof TypedDataSchemaNode) {
 345                 putLeaf(getterToLeafSchema, (TypedDataSchemaNode) stmt);
 346             } else if (stmt instanceof AnydataSchemaNode) {
 347                 putLeaf(getterToLeafSchema, (AnydataSchemaNode) stmt);
 348             } else if (stmt instanceof AnyxmlSchemaNode) {
 349                 putLeaf(getterToLeafSchema, (AnyxmlSchemaNode) stmt);
 350             }
 351         }
 352         return getLeafNodesUsingReflection(type, getterToLeafSchema);
 353     }
 354
 355     private static void putLeaf(final Map<String, DataSchemaNode> map, final DataSchemaNode leaf) {
 356         map.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
 357     }
 358
 359     private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
 360             final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
 361         final Map<Method, ValueNodeCodecContext> leaves = new HashMap<>();
 362         for (final Method method : parentClass.getMethods()) {
 363             // Only consider non-bridge methods with no arguments
 364             if (method.getParameterCount() == 0 && !method.isBridge()) {
 365                 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
 366
 367                 final ValueNodeCodecContext valueNode;
 368                 if (schema instanceof LeafSchemaNode leafSchema) {
 369                     // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
 370                     //                   Object.class
 371                     final Class<?> valueType = method.getReturnType();
 372                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
 373                     valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
 374                         context.getEffectiveModelContext());
 375                 } else if (schema instanceof LeafListSchemaNode) {
 376                     final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
 377                         method.getGenericReturnType());
 378                     checkState(optType.isPresent(), "Failed to find return type for %s", method);
 379
 380                     final Class<?> valueType;
 381                     final Type genericType = optType.get();
 382                     if (genericType instanceof Class<?>) {
 383                         valueType = (Class<?>) genericType;
 384                     } else if (genericType instanceof ParameterizedType) {
 385                         valueType = (Class<?>) ((ParameterizedType) genericType).getRawType();
 386                     } else if (genericType instanceof WildcardType) {
 387                         // FIXME: MDSAL-670: this is not right as we need to find a concrete type
 388                         valueType = Object.class;
 389                     } else {
 390                         throw new IllegalStateException("Unexpected return type " + genericType);
 391                     }
 392
 393                     final LeafListSchemaNode leafListSchema = (LeafListSchemaNode) schema;
 394                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
 395                     valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
 396                 } else if (schema instanceof AnyxmlSchemaNode) {
 397                     valueNode = new OpaqueNodeCodecContext.Anyxml<>((AnyxmlSchemaNode) schema, method.getName(),
 398                             opaqueReturnType(method), loader);
 399                 } else if (schema instanceof AnydataSchemaNode) {
 400                     valueNode = new OpaqueNodeCodecContext.Anydata<>((AnydataSchemaNode) schema, method.getName(),
 401                             opaqueReturnType(method), loader);
 402                 } else {
 403                     verify(schema == null, "Unhandled schema %s for method %s", schema, method);
 404                     // We do not have schema for leaf, so we will ignore it (e.g. getClass).
 405                     continue;
 406                 }
 407
 408                 leaves.put(method, valueNode);
 409             }
 410         }
 411         return ImmutableMap.copyOf(leaves);
 412     }
 413
 414     // FIXME: this is probably not right w.r.t. nulls
 415     ValueCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
 416         if (BaseIdentity.class.isAssignableFrom(valueType)) {
 417             @SuppressWarnings({ "unchecked", "rawtypes" })
 418             final ValueCodec<Object, Object> casted = (ValueCodec) identityCodec;
 419             return casted;
 420         } else if (InstanceIdentifier.class.equals(valueType)) {
 421             @SuppressWarnings({ "unchecked", "rawtypes" })
 422             final ValueCodec<Object, Object> casted = (ValueCodec) instanceIdentifierCodec;
 423             return casted;
 424         } else if (BindingReflections.isBindingClass(valueType)) {
 425             return getCodecForBindingClass(valueType, instantiatedType);
 426         }
 427         // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
 428         //                   valueType=Object.class
 429         return SchemaUnawareCodec.NOOP_CODEC;
 430     }
 431
 432     @SuppressWarnings("checkstyle:illegalCatch")
 433     // FIXME: this is probably not right w.r.t. nulls
 434     private ValueCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
 435             final TypeDefinition<?> typeDef) {
 436         if (typeDef instanceof IdentityrefTypeDefinition) {
 437             return new CompositeValueCodec.OfIdentity(valueType, identityCodec);
 438         } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
 439             return new CompositeValueCodec.OfInstanceIdentifier(valueType, instanceIdentifierCodec);
 440         } else if (typeDef instanceof UnionTypeDefinition) {
 441             try {
 442                 return UnionTypeCodec.of(valueType, (UnionTypeDefinition) typeDef, this);
 443             } catch (Exception e) {
 444                 throw new IllegalStateException("Unable to load codec for " + valueType, e);
 445             }
 446         } else if (typeDef instanceof LeafrefTypeDefinition) {
 447             final var typeWithSchema = context.getTypeWithSchema(valueType);
 448             final var schema = typeWithSchema.statement();
 449             final TypeDefinition<?> def;
 450             if (schema instanceof TypeDefinitionAware) {
 451                 def = ((TypeDefinitionAware) schema).getTypeDefinition();
 452             } else if (schema instanceof TypeAware) {
 453                 def = ((TypeAware) schema).getType();
 454             } else {
 455                 throw new IllegalStateException("Unexpected schema " + schema);
 456             }
 457             return getCodec(valueType, def);
 458         }
 459         return SchemaUnawareCodec.of(valueType, typeDef);
 460     }
 461
 462     @Override
 463     public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
 464         final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
 465                 Identifiable.class);
 466         checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
 467
 468         final Class<Identifier<?>> identifier = optIdentifier.get();
 469         final Map<QName, ValueContext> valueCtx = new HashMap<>();
 470         for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
 471             final QName name = leaf.getDomPathArgument().getNodeType();
 472             valueCtx.put(name, new ValueContext(identifier, leaf));
 473         }
 474         return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
 475     }
 476
 477     @Override
 478     public <E extends DataObject> BindingDataObjectCodecTreeNode<E> streamChild(final Class<E> childClass) {
 479         return root.streamChild(childClass);
 480     }
 481
 482     @Override
 483     @SuppressWarnings("unchecked")
 484     public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
 485         // TODO Do we need defensive check here?
 486         return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
 487     }
 488
 489     @Override
 490     public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
 491         return getCodecContextNode(path, null);
 492     }
 493
 494     @Override
 495     public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
 496         throw new UnsupportedOperationException("Not implemented yet.");
 497     }
 498
 499     @Override
 500     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 501         return instanceIdentifierCodec.fromBinding(binding);
 502     }
 503
 504     @Override
 505     public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 506         return instanceIdentifierCodec.toBinding(dom);
 507     }
 508
 509     @Override
 510     public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode> toNormalizedNode(
 511             final InstanceIdentifier<T> path, final T data) {
 512         final NormalizedNodeResult result = new NormalizedNodeResult();
 513         // We create DOM stream writer which produces normalized nodes
 514         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 515
 516         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
 517         final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = newWriterAndIdentifier(path,
 518             domWriter);
 519
 520         // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
 521         try {
 522             getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
 523         } catch (final IOException e) {
 524             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
 525             throw new IllegalStateException("Failed to create normalized node", e);
 526         }
 527         return Map.entry(writeCtx.getKey(), result.getResult());
 528     }
 529
 530     @Override
 531     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 532             final NormalizedNode data) {
 533         if (notBindingRepresentable(data)) {
 534             return null;
 535         }
 536
 537         final List<PathArgument> builder = new ArrayList<>();
 538         final BindingDataObjectCodecTreeNode<?> codec = getCodecContextNode(path, builder);
 539         if (codec == null) {
 540             if (data != null) {
 541                 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
 542                     data.getClass());
 543             }
 544             return null;
 545         }
 546
 547         final DataObject lazyObj = codec.deserialize(data);
 548         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
 549         return Map.entry(bindingPath, lazyObj);
 550     }
 551
 552     @Override
 553     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
 554         return getNotificationContext(path).deserialize(data);
 555     }
 556
 557     @Override
 558     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
 559             final Instant eventInstant) {
 560         return eventInstant == null ? fromNormalizedNodeNotification(path, data)
 561                 : getNotificationContext(path).deserialize(data, eventInstant);
 562     }
 563
 564     @Override
 565     public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
 566         return getRpcInputCodec(containerPath).deserialize(data);
 567     }
 568
 569     @Override
 570     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 571             final ContainerNode input) {
 572         return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
 573     }
 574
 575     @Override
 576     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 577             final ContainerNode output) {
 578         return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
 579     }
 580
 581     @Override
 582     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 583     public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
 584         // FIXME: Should the cast to DataObject be necessary?
 585         return serializeDataObject((DataObject) data,
 586             (ctx, iface, domWriter) -> ctx.newNotificationWriter(
 587                 (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
 588     }
 589
 590     @Override
 591     public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
 592         checkArgument(data instanceof DataObject, "Unexpected data %s", data);
 593         @SuppressWarnings("rawtypes")
 594         final NotificationCodecContext notifContext = getNotificationContext(path);
 595         @SuppressWarnings("unchecked")
 596         final var result = notifContext.serialize((DataObject) data);
 597         verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
 598         return (ContainerNode) result;
 599     }
 600
 601     @Override
 602     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 603     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 604         // FIXME: Should the cast to DataObject be necessary?
 605         return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
 606     }
 607
 608     @Override
 609     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 610             final RpcInput input) {
 611         return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
 612     }
 613
 614     @Override
 615     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 616             final RpcOutput output) {
 617         return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
 618     }
 619
 620     private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
 621             final WriterFactoryMethod<T> newWriter) {
 622         final NormalizedNodeResult result = new NormalizedNodeResult();
 623         // We create DOM stream writer which produces normalized nodes
 624         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 625         final Class<? extends DataObject> type = data.implementedInterface();
 626         @SuppressWarnings("unchecked")
 627         final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
 628         try {
 629             getSerializer(type).serialize(data, writer);
 630         } catch (final IOException e) {
 631             LOG.error("Unexpected failure while serializing data {}", data, e);
 632             throw new IllegalStateException("Failed to create normalized node", e);
 633         }
 634         return (ContainerNode) result.getResult();
 635     }
 636
 637
 638     private static boolean notBindingRepresentable(final NormalizedNode data) {
 639         // ValueNode covers LeafNode and LeafSetEntryNode
 640         return data instanceof ValueNode
 641                 || data instanceof MapNode || data instanceof UnkeyedListNode
 642                 || data instanceof ChoiceNode
 643                 || data instanceof LeafSetNode;
 644     }
 645
 646     @SuppressWarnings("rawtypes")
 647     private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
 648         final Class<?> valueType = method.getReturnType();
 649         verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
 650         return valueType.asSubclass(OpaqueObject.class);
 651     }
 652
 653     @FunctionalInterface
 654     private interface WriterFactoryMethod<T extends DataContainer> {
 655         BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
 656                 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);
 657     }
 658 }