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