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