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