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