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