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 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 = SchemaRootCodecContext.create(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     DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
 242             final List<YangInstanceIdentifier.PathArgument> builder) {
 243         DataContainerCodecContext<?,?> currentNode = root;
 244         for (final InstanceIdentifier.PathArgument bindingArg : binding.getPathArguments()) {
 245             currentNode = currentNode.bindingPathArgumentChild(bindingArg, builder);
 246             checkArgument(currentNode != null, "Supplied Instance Identifier %s is not valid.", binding);
 247         }
 248         return currentNode;
 249     }
 250
 251     /**
 252      * Multi-purpose utility function. Traverse the codec tree, looking for
 253      * the appropriate codec for the specified {@link YangInstanceIdentifier}.
 254      * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
 255      * into the supplied collection.
 256      *
 257      * @param dom {@link YangInstanceIdentifier} which is to be translated
 258      * @param bindingArguments Collection for traversed path arguments
 259      * @return Codec for target node, or @null if the node does not have a
 260      *         binding representation (choice, case, leaf).
 261      *
 262      */
 263     @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
 264             final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
 265         NodeCodecContext currentNode = root;
 266         ListNodeCodecContext<?> currentList = null;
 267
 268         for (var domArg : dom.getPathArguments()) {
 269             checkArgument(currentNode instanceof DataContainerCodecContext,
 270                 "Unexpected child of non-container node %s", currentNode);
 271             final var previous = (DataContainerCodecContext<?, ?>) currentNode;
 272             final var nextNode = previous.yangPathArgumentChild(domArg);
 273
 274             /*
 275              * List representation in YANG Instance Identifier consists of two
 276              * arguments: first is list as a whole, second is list as an item so
 277              * if it is /list it means list as whole, if it is /list/list - it
 278              * is wildcarded and if it is /list/list[key] it is concrete item,
 279              * all this variations are expressed in Binding Aware Instance
 280              * Identifier as Item or IdentifiableItem
 281              */
 282             if (currentList != null) {
 283                 checkArgument(currentList == nextNode,
 284                         "List should be referenced two times in YANG Instance Identifier %s", dom);
 285
 286                 // We entered list, so now we have all information to emit
 287                 // list path using second list argument.
 288                 if (bindingArguments != null) {
 289                     bindingArguments.add(currentList.getBindingPathArgument(domArg));
 290                 }
 291                 currentList = null;
 292                 currentNode = nextNode;
 293             } else if (nextNode instanceof ListNodeCodecContext<?> listNode) {
 294                 // We enter list, we do not update current Node yet,
 295                 // since we need to verify
 296                 currentList = listNode;
 297             } else if (nextNode instanceof ChoiceNodeCodecContext) {
 298                 // We do not add path argument for choice, since
 299                 // it is not supported by binding instance identifier.
 300                 currentNode = nextNode;
 301             } else if (nextNode instanceof DataContainerCodecContext<?, ?> containerNode) {
 302                 if (bindingArguments != null) {
 303                     bindingArguments.add(containerNode.getBindingPathArgument(domArg));
 304                 }
 305                 currentNode = nextNode;
 306             } else if (nextNode instanceof ValueNodeCodecContext) {
 307                 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
 308                 return null;
 309             }
 310         }
 311
 312         // Algorithm ended in list as whole representation
 313         // we sill need to emit identifier for list
 314         if (currentNode instanceof ChoiceNodeCodecContext) {
 315             LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
 316             return null;
 317         }
 318         if (currentNode instanceof CaseNodeCodecContext) {
 319             LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
 320             return null;
 321         }
 322
 323         if (currentList != null) {
 324             if (bindingArguments != null) {
 325                 bindingArguments.add(currentList.getBindingPathArgument(null));
 326             }
 327             return currentList;
 328         }
 329         if (currentNode != null) {
 330             verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
 331                 currentNode, dom);
 332             return (BindingDataObjectCodecTreeNode<?>) currentNode;
 333         }
 334         return null;
 335     }
 336
 337     NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
 338         return root.getNotification(notification);
 339     }
 340
 341     RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
 342         return root.getRpc(containerPath);
 343     }
 344
 345     ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
 346         return root.getAction(action);
 347     }
 348
 349     @Override
 350     public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> type,
 351             final EffectiveStatement<?, ?> schema) {
 352         final var getterToLeafSchema = new HashMap<String, DataSchemaNode>();
 353         for (var stmt : schema.effectiveSubstatements()) {
 354             if (stmt instanceof TypedDataSchemaNode typedSchema) {
 355                 putLeaf(getterToLeafSchema, typedSchema);
 356             } else if (stmt instanceof AnydataSchemaNode anydataSchema) {
 357                 putLeaf(getterToLeafSchema, anydataSchema);
 358             } else if (stmt instanceof AnyxmlSchemaNode anyxmlSchema) {
 359                 putLeaf(getterToLeafSchema, anyxmlSchema);
 360             }
 361         }
 362         return getLeafNodesUsingReflection(type, getterToLeafSchema);
 363     }
 364
 365     private static void putLeaf(final Map<String, DataSchemaNode> map, final DataSchemaNode leaf) {
 366         map.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
 367     }
 368
 369     private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
 370             final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
 371         final var leaves = new HashMap<Method, ValueNodeCodecContext>();
 372         for (var method : parentClass.getMethods()) {
 373             // Only consider non-bridge methods with no arguments
 374             if (method.getParameterCount() == 0 && !method.isBridge()) {
 375                 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
 376
 377                 final ValueNodeCodecContext valueNode;
 378                 if (schema instanceof LeafSchemaNode leafSchema) {
 379                     // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
 380                     //                   Object.class
 381                     final Class<?> valueType = method.getReturnType();
 382                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
 383                     valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
 384                         context.getEffectiveModelContext());
 385                 } else if (schema instanceof LeafListSchemaNode leafListSchema) {
 386                     final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
 387                         method.getGenericReturnType());
 388                     checkState(optType.isPresent(), "Failed to find return type for %s", method);
 389
 390                     final Class<?> valueType;
 391                     final Type genericType = optType.orElseThrow();
 392                     if (genericType instanceof Class<?> clazz) {
 393                         valueType = clazz;
 394                     } else if (genericType instanceof ParameterizedType parameterized) {
 395                         valueType = (Class<?>) parameterized.getRawType();
 396                     } else if (genericType instanceof WildcardType) {
 397                         // FIXME: MDSAL-670: this is not right as we need to find a concrete type
 398                         valueType = Object.class;
 399                     } else {
 400                         throw new IllegalStateException("Unexpected return type " + genericType);
 401                     }
 402
 403                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
 404                     valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
 405                 } else if (schema instanceof AnyxmlSchemaNode anyxmlSchema) {
 406                     valueNode = new OpaqueNodeCodecContext.Anyxml<>(anyxmlSchema, method.getName(),
 407                             opaqueReturnType(method), loader);
 408                 } else if (schema instanceof AnydataSchemaNode anydataSchema) {
 409                     valueNode = new OpaqueNodeCodecContext.Anydata<>(anydataSchema, method.getName(),
 410                             opaqueReturnType(method), loader);
 411                 } else {
 412                     verify(schema == null, "Unhandled schema %s for method %s", schema, method);
 413                     // We do not have schema for leaf, so we will ignore it (e.g. getClass).
 414                     continue;
 415                 }
 416
 417                 leaves.put(method, valueNode);
 418             }
 419         }
 420         return ImmutableMap.copyOf(leaves);
 421     }
 422
 423     // FIXME: this is probably not right w.r.t. nulls
 424     ValueCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
 425         if (BaseIdentity.class.isAssignableFrom(valueType)) {
 426             @SuppressWarnings({ "unchecked", "rawtypes" })
 427             final ValueCodec<Object, Object> casted = (ValueCodec) identityCodec;
 428             return casted;
 429         } else if (InstanceIdentifier.class.equals(valueType)) {
 430             @SuppressWarnings({ "unchecked", "rawtypes" })
 431             final ValueCodec<Object, Object> casted = (ValueCodec) instanceIdentifierCodec;
 432             return casted;
 433         } else if (BindingReflections.isBindingClass(valueType)) {
 434             return getCodecForBindingClass(valueType, instantiatedType);
 435         }
 436         // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
 437         //                   valueType=Object.class
 438         return SchemaUnawareCodec.NOOP_CODEC;
 439     }
 440
 441     @SuppressWarnings("checkstyle:illegalCatch")
 442     // FIXME: this is probably not right w.r.t. nulls
 443     private ValueCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
 444             final TypeDefinition<?> typeDef) {
 445         if (typeDef instanceof IdentityrefTypeDefinition) {
 446             return new CompositeValueCodec.OfIdentity(valueType, identityCodec);
 447         } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
 448             return new CompositeValueCodec.OfInstanceIdentifier(valueType, instanceIdentifierCodec);
 449         } else if (typeDef instanceof UnionTypeDefinition unionType) {
 450             try {
 451                 return UnionTypeCodec.of(valueType, unionType, this);
 452             } catch (Exception e) {
 453                 throw new IllegalStateException("Unable to load codec for " + valueType, e);
 454             }
 455         } else if (typeDef instanceof LeafrefTypeDefinition) {
 456             final var typeWithSchema = context.getTypeWithSchema(valueType);
 457             final var schema = typeWithSchema.statement();
 458             final TypeDefinition<?> def;
 459             if (schema instanceof TypeDefinitionAware typeDefAware) {
 460                 def = typeDefAware.getTypeDefinition();
 461             } else if (schema instanceof TypeAware typeAware) {
 462                 def = typeAware.getType();
 463             } else {
 464                 throw new IllegalStateException("Unexpected schema " + schema);
 465             }
 466             return getCodec(valueType, def);
 467         }
 468         return SchemaUnawareCodec.of(valueType, typeDef);
 469     }
 470
 471     @Override
 472     public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
 473         final Optional<Class<Identifier<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
 474                 Identifiable.class);
 475         checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
 476
 477         final Class<Identifier<?>> identifier = optIdentifier.orElseThrow();
 478         final Map<QName, ValueContext> valueCtx = new HashMap<>();
 479         for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
 480             final QName name = leaf.getDomPathArgument().getNodeType();
 481             valueCtx.put(name, new ValueContext(identifier, leaf));
 482         }
 483         return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
 484     }
 485
 486     @Override
 487     public <E extends DataObject> BindingDataObjectCodecTreeNode<E> streamChild(final Class<E> childClass) {
 488         return root.streamChild(childClass);
 489     }
 490
 491     @Override
 492     @SuppressWarnings("unchecked")
 493     public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
 494         // TODO Do we need defensive check here?
 495         return (BindingDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
 496     }
 497
 498     @Override
 499     public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
 500         return getCodecContextNode(path, null);
 501     }
 502
 503     @Override
 504     public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
 505         throw new UnsupportedOperationException("Not implemented yet.");
 506     }
 507
 508     @Override
 509     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 510         return instanceIdentifierCodec.fromBinding(binding);
 511     }
 512
 513     @Override
 514     public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 515         return instanceIdentifierCodec.toBinding(dom);
 516     }
 517
 518     @Override
 519     public <T extends DataObject> Entry<YangInstanceIdentifier, NormalizedNode> toNormalizedNode(
 520             final InstanceIdentifier<T> path, final T data) {
 521         final NormalizedNodeResult result = new NormalizedNodeResult();
 522         // We create DOM stream writer which produces normalized nodes
 523         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 524
 525         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
 526         final Entry<YangInstanceIdentifier, BindingStreamEventWriter> writeCtx = newWriterAndIdentifier(path,
 527             domWriter);
 528
 529         // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
 530         try {
 531             getSerializer(path.getTargetType()).serialize(data, writeCtx.getValue());
 532         } catch (final IOException e) {
 533             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
 534             throw new IllegalStateException("Failed to create normalized node", e);
 535         }
 536         return Map.entry(writeCtx.getKey(), result.getResult());
 537     }
 538
 539     @Override
 540     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 541             final NormalizedNode data) {
 542         if (notBindingRepresentable(data)) {
 543             return null;
 544         }
 545
 546         final List<PathArgument> builder = new ArrayList<>();
 547         final BindingDataObjectCodecTreeNode<?> codec = getCodecContextNode(path, builder);
 548         if (codec == null) {
 549             if (data != null) {
 550                 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
 551                     data.getClass());
 552             }
 553             return null;
 554         }
 555
 556         final DataObject lazyObj = codec.deserialize(data);
 557         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
 558         return Map.entry(bindingPath, lazyObj);
 559     }
 560
 561     @Override
 562     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
 563         return getNotificationContext(path).deserialize(data);
 564     }
 565
 566     @Override
 567     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
 568             final Instant eventInstant) {
 569         return eventInstant == null ? fromNormalizedNodeNotification(path, data)
 570                 : getNotificationContext(path).deserialize(data, eventInstant);
 571     }
 572
 573     @Override
 574     public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
 575         return getRpcInputCodec(containerPath).deserialize(data);
 576     }
 577
 578     @Override
 579     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 580             final ContainerNode input) {
 581         return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
 582     }
 583
 584     @Override
 585     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 586             final ContainerNode output) {
 587         return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
 588     }
 589
 590     @Override
 591     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 592     public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
 593         // FIXME: Should the cast to DataObject be necessary?
 594         return serializeDataObject((DataObject) data,
 595             (ctx, iface, domWriter) -> ctx.newNotificationWriter(
 596                 (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
 597     }
 598
 599     @Override
 600     public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
 601         checkArgument(data instanceof DataObject, "Unexpected data %s", data);
 602         @SuppressWarnings("rawtypes")
 603         final NotificationCodecContext notifContext = getNotificationContext(path);
 604         @SuppressWarnings("unchecked")
 605         final var result = notifContext.serialize((DataObject) data);
 606         verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
 607         return (ContainerNode) result;
 608     }
 609
 610     @Override
 611     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 612     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 613         // FIXME: Should the cast to DataObject be necessary?
 614         return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
 615     }
 616
 617     @Override
 618     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 619             final RpcInput input) {
 620         return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
 621     }
 622
 623     @Override
 624     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 625             final RpcOutput output) {
 626         return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
 627     }
 628
 629     private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
 630             final WriterFactoryMethod<T> newWriter) {
 631         final NormalizedNodeResult result = new NormalizedNodeResult();
 632         // We create DOM stream writer which produces normalized nodes
 633         final NormalizedNodeStreamWriter domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 634         final Class<? extends DataObject> type = data.implementedInterface();
 635         @SuppressWarnings("unchecked")
 636         final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
 637         try {
 638             getSerializer(type).serialize(data, writer);
 639         } catch (final IOException e) {
 640             LOG.error("Unexpected failure while serializing data {}", data, e);
 641             throw new IllegalStateException("Failed to create normalized node", e);
 642         }
 643         return (ContainerNode) result.getResult();
 644     }
 645
 646
 647     private static boolean notBindingRepresentable(final NormalizedNode data) {
 648         // ValueNode covers LeafNode and LeafSetEntryNode
 649         return data instanceof ValueNode
 650                 || data instanceof MapNode || data instanceof UnkeyedListNode
 651                 || data instanceof ChoiceNode
 652                 || data instanceof LeafSetNode;
 653     }
 654
 655     @SuppressWarnings("rawtypes")
 656     private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
 657         final Class<?> valueType = method.getReturnType();
 658         verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
 659         return valueType.asSubclass(OpaqueObject.class);
 660     }
 661
 662     @FunctionalInterface
 663     private interface WriterFactoryMethod<T extends DataContainer> {
 664         BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
 665                 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);
 666     }
 667 }