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