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