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