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