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