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 com.google.common.base.Verify.verifyNotNull;
  14 import static java.util.Objects.requireNonNull;
  15
  16 import com.google.common.base.Strings;
  17 import com.google.common.base.Throwables;
  18 import com.google.common.cache.CacheBuilder;
  19 import com.google.common.cache.CacheLoader;
  20 import com.google.common.cache.LoadingCache;
  21 import com.google.common.collect.ImmutableList;
  22 import com.google.common.collect.ImmutableMap;
  23 import com.google.common.util.concurrent.UncheckedExecutionException;
  24 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  25 import java.io.File;
  26 import java.io.IOException;
  27 import java.lang.reflect.Method;
  28 import java.lang.reflect.ParameterizedType;
  29 import java.lang.reflect.Type;
  30 import java.lang.reflect.WildcardType;
  31 import java.time.Instant;
  32 import java.util.ArrayList;
  33 import java.util.Collection;
  34 import java.util.HashMap;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.Map.Entry;
  38 import java.util.Optional;
  39 import java.util.ServiceLoader;
  40 import java.util.concurrent.ExecutionException;
  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.BindingAugmentationCodecTreeNode;
  45 import org.opendaylight.mdsal.binding.dom.codec.api.BindingCodecTreeNode;
  46 import org.opendaylight.mdsal.binding.dom.codec.api.BindingDataObjectCodecTreeNode;
  47 import org.opendaylight.mdsal.binding.dom.codec.api.BindingInstanceIdentifierCodec;
  48 import org.opendaylight.mdsal.binding.dom.codec.api.BindingNormalizedNodeWriterFactory;
  49 import org.opendaylight.mdsal.binding.dom.codec.api.BindingStreamEventWriter;
  50 import org.opendaylight.mdsal.binding.dom.codec.api.BindingYangDataCodecTreeNode;
  51 import org.opendaylight.mdsal.binding.dom.codec.api.CommonDataObjectCodecTreeNode;
  52 import org.opendaylight.mdsal.binding.dom.codec.api.IncorrectNestingException;
  53 import org.opendaylight.mdsal.binding.dom.codec.api.MissingSchemaException;
  54 import org.opendaylight.mdsal.binding.dom.codec.spi.AbstractBindingNormalizedNodeSerializer;
  55 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
  56 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingSchemaMapping;
  57 import org.opendaylight.mdsal.binding.loader.BindingClassLoader;
  58 import org.opendaylight.mdsal.binding.model.api.JavaTypeName;
  59 import org.opendaylight.mdsal.binding.runtime.api.ActionRuntimeType;
  60 import org.opendaylight.mdsal.binding.runtime.api.BindingRuntimeContext;
  61 import org.opendaylight.mdsal.binding.runtime.api.ChoiceRuntimeType;
  62 import org.opendaylight.mdsal.binding.runtime.api.ContainerLikeRuntimeType;
  63 import org.opendaylight.mdsal.binding.runtime.api.ContainerRuntimeType;
  64 import org.opendaylight.mdsal.binding.runtime.api.DataRuntimeType;
  65 import org.opendaylight.mdsal.binding.runtime.api.InputRuntimeType;
  66 import org.opendaylight.mdsal.binding.runtime.api.ListRuntimeType;
  67 import org.opendaylight.mdsal.binding.runtime.api.NotificationRuntimeType;
  68 import org.opendaylight.mdsal.binding.runtime.api.OutputRuntimeType;
  69 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
  70 import org.opendaylight.yangtools.concepts.Immutable;
  71 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  72 import org.opendaylight.yangtools.yang.binding.Action;
  73 import org.opendaylight.yangtools.yang.binding.Augmentation;
  74 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  75 import org.opendaylight.yangtools.yang.binding.BaseNotification;
  76 import org.opendaylight.yangtools.yang.binding.ChoiceIn;
  77 import org.opendaylight.yangtools.yang.binding.DataContainer;
  78 import org.opendaylight.yangtools.yang.binding.DataObject;
  79 import org.opendaylight.yangtools.yang.binding.DataObjectStep;
  80 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  81 import org.opendaylight.yangtools.yang.binding.Key;
  82 import org.opendaylight.yangtools.yang.binding.KeyAware;
  83 import org.opendaylight.yangtools.yang.binding.KeyedListAction;
  84 import org.opendaylight.yangtools.yang.binding.Notification;
  85 import org.opendaylight.yangtools.yang.binding.OpaqueObject;
  86 import org.opendaylight.yangtools.yang.binding.RpcInput;
  87 import org.opendaylight.yangtools.yang.binding.RpcOutput;
  88 import org.opendaylight.yangtools.yang.binding.YangData;
  89 import org.opendaylight.yangtools.yang.common.QName;
  90 import org.opendaylight.yangtools.yang.common.YangDataName;
  91 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  92 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  93 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  94 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  95 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  96 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  97 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  98 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  99 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 100 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
 101 import org.opendaylight.yangtools.yang.data.api.schema.ValueNode;
 102 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
 103 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
 104 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
 105 import org.opendaylight.yangtools.yang.model.api.AnydataSchemaNode;
 106 import org.opendaylight.yangtools.yang.model.api.AnyxmlSchemaNode;
 107 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
 108 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
 109 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 110 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
 111 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 112 import org.opendaylight.yangtools.yang.model.api.TypeAware;
 113 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 114 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
 115 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
 116 import org.opendaylight.yangtools.yang.model.api.stmt.PresenceEffectiveStatement;
 117 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
 118 import org.opendaylight.yangtools.yang.model.api.stmt.TypeDefinitionAware;
 119 import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
 120 import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
 121 import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
 122 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
 123 import org.slf4j.Logger;
 124 import org.slf4j.LoggerFactory;
 125
 126 @MetaInfServices(value = BindingDOMCodecServices.class)
 127 public final class BindingCodecContext extends AbstractBindingNormalizedNodeSerializer
 128         implements BindingDOMCodecServices, Immutable, CodecContextFactory, DataContainerSerializerRegistry {
 129     private static final Logger LOG = LoggerFactory.getLogger(BindingCodecContext.class);
 130     private static final @NonNull NodeIdentifier FAKE_NODEID = new NodeIdentifier(QName.create("fake", "fake"));
 131     private static final File BYTECODE_DIRECTORY;
 132
 133     static {
 134         final String dir = System.getProperty("org.opendaylight.mdsal.binding.dom.codec.loader.bytecodeDumpDirectory");
 135         BYTECODE_DIRECTORY = Strings.isNullOrEmpty(dir) ? null : new File(dir);
 136     }
 137
 138     private final LoadingCache<Class<?>, DataContainerStreamer<?>> streamers = CacheBuilder.newBuilder()
 139         .build(new CacheLoader<>() {
 140             @Override
 141             public DataContainerStreamer<?> load(final Class<?> key) throws ReflectiveOperationException {
 142                 final var streamer = DataContainerStreamerGenerator.generateStreamer(loader, BindingCodecContext.this,
 143                     key);
 144                 final var instance = streamer.getDeclaredField(DataContainerStreamerGenerator.INSTANCE_FIELD);
 145                 return (DataContainerStreamer<?>) instance.get(null);
 146             }
 147         });
 148     private final LoadingCache<Class<?>, DataContainerSerializer> serializers = CacheBuilder.newBuilder()
 149         .build(new CacheLoader<>() {
 150             @Override
 151             public DataContainerSerializer load(final Class<?> key) throws ExecutionException {
 152                 return new DataContainerSerializer(BindingCodecContext.this, streamers.get(key));
 153             }
 154         });
 155     private final LoadingCache<Class<? extends DataObject>, DataContainerCodecContext<?, ?, ?>> childrenByClass =
 156         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 157             @Override
 158             public DataContainerCodecContext<?, ?, ?> load(final Class<? extends DataObject> key) {
 159                 final var childSchema = context.getTypes().bindingChild(JavaTypeName.create(key));
 160                 if (childSchema instanceof ContainerLikeRuntimeType containerLike) {
 161                     if (childSchema instanceof ContainerRuntimeType container
 162                         && container.statement().findFirstEffectiveSubstatement(PresenceEffectiveStatement.class)
 163                             .isEmpty()) {
 164                         return new StructuralContainerCodecContext<>(key, container, BindingCodecContext.this);
 165                     }
 166                     return new ContainerLikeCodecContext<>(key, containerLike, BindingCodecContext.this);
 167                 } else if (childSchema instanceof ListRuntimeType list) {
 168                     return list.keyType() == null ? new ListCodecContext<>(key, list, BindingCodecContext.this)
 169                         : MapCodecContext.of(key, list, BindingCodecContext.this);
 170                 } else if (childSchema instanceof ChoiceRuntimeType choice) {
 171                     return new ChoiceCodecContext<>(key.asSubclass(ChoiceIn.class), choice, BindingCodecContext.this);
 172                 } else if (childSchema == null) {
 173                     throw DataContainerCodecContext.childNullException(context, key, "%s is not top-level item.", key);
 174                 } else {
 175                     throw new IncorrectNestingException("%s is not a valid data tree child of %s", key, this);
 176                 }
 177             }
 178         });
 179
 180     // FIXME: this could also be a leaf!
 181     private final LoadingCache<QName, DataContainerCodecContext<?, ?, ?>> childrenByDomArg =
 182         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 183             @Override
 184             public DataContainerCodecContext<?, ?, ?> load(final QName qname) throws ClassNotFoundException {
 185                 final var type = context.getTypes();
 186                 final var child = type.schemaTreeChild(qname);
 187                 if (child == null) {
 188                     final var module = qname.getModule();
 189                     if (context.modelContext().findModule(module).isEmpty()) {
 190                         throw new MissingSchemaException(
 191                             "Module " + module + " is not present in current schema context.");
 192                     }
 193                     throw new IncorrectNestingException("Argument %s is not valid child of %s", qname, type);
 194                 }
 195
 196                 if (!(child instanceof DataRuntimeType)) {
 197                     throw new IncorrectNestingException("Argument %s is not valid data tree child of %s", qname, type);
 198                 }
 199
 200                 // TODO: improve this check?
 201                 final var childSchema = child.statement();
 202                 if (childSchema instanceof DataNodeContainer || childSchema instanceof ChoiceSchemaNode) {
 203                     return getStreamChild(context.loadClass(child.javaType()));
 204                 }
 205
 206                 throw new UnsupportedOperationException("Unsupported child type " + childSchema.getClass());
 207             }
 208         });
 209
 210     private final LoadingCache<Class<? extends DataObject>, ChoiceCodecContext<?>> choicesByClass =
 211         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 212             @Override
 213             public ChoiceCodecContext<?> load(final Class<? extends DataObject> caseType) {
 214                 final var choiceClass = findCaseChoice(caseType);
 215                 if (choiceClass == null) {
 216                     throw new IllegalArgumentException(caseType + " is not a valid case representation");
 217                 }
 218                 if (context.getSchemaDefinition(choiceClass) instanceof ChoiceRuntimeType choiceType) {
 219                     // FIXME: accurate type!
 220                     return new ChoiceCodecContext(choiceClass, choiceType, BindingCodecContext.this);
 221                 }
 222                 throw new IllegalArgumentException(caseType + " does not refer to a choice");
 223             }
 224
 225             private static Class<?> findCaseChoice(final Class<? extends DataObject> caseClass) {
 226                 for (var type : caseClass.getGenericInterfaces()) {
 227                     if (type instanceof Class<?> typeClass && ChoiceIn.class.isAssignableFrom(typeClass)) {
 228                         return typeClass.asSubclass(ChoiceIn.class);
 229                     }
 230                 }
 231                 return null;
 232             }
 233         });
 234
 235     private final LoadingCache<Class<? extends Action<?, ?, ?>>, ActionCodecContext> actionsByClass =
 236         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 237             @Override
 238             public ActionCodecContext load(final Class<? extends Action<?, ?, ?>> action) {
 239                 if (KeyedListAction.class.isAssignableFrom(action)) {
 240                     return prepareActionContext(2, 3, 4, action, KeyedListAction.class);
 241                 } else if (Action.class.isAssignableFrom(action)) {
 242                     return prepareActionContext(1, 2, 3, action, Action.class);
 243                 }
 244                 throw new IllegalArgumentException("The specific action type does not exist for action "
 245                     + action.getName());
 246             }
 247
 248             private ActionCodecContext prepareActionContext(final int inputOffset, final int outputOffset,
 249                     final int expectedArgsLength, final Class<? extends Action<?, ?, ?>> action,
 250                     final Class<?> actionType) {
 251                 final var args = ClassLoaderUtils.findParameterizedType(action, actionType)
 252                     .orElseThrow(() -> new IllegalStateException(action + " does not specialize " + actionType))
 253                     .getActualTypeArguments();
 254                 checkArgument(args.length == expectedArgsLength, "Unexpected (%s) Action generatic arguments",
 255                     args.length);
 256                 final ActionRuntimeType schema = context.getActionDefinition(action);
 257                 return new ActionCodecContext(
 258                     new ContainerLikeCodecContext(asClass(args[inputOffset], RpcInput.class), schema.input(),
 259                         BindingCodecContext.this),
 260                     new ContainerLikeCodecContext(asClass(args[outputOffset], RpcOutput.class), schema.output(),
 261                         BindingCodecContext.this));
 262             }
 263
 264             private static <T extends DataObject> Class<? extends T> asClass(final Type type, final Class<T> target) {
 265                 verify(type instanceof Class, "Type %s is not a class", type);
 266                 return ((Class<?>) type).asSubclass(target);
 267             }
 268         });
 269
 270     private final LoadingCache<Class<?>, NotificationCodecContext<?>> notificationsByClass = CacheBuilder.newBuilder()
 271         .build(new CacheLoader<>() {
 272             @Override
 273             public NotificationCodecContext<?> load(final Class<?> key) {
 274                 final var runtimeType = context.getTypes().bindingChild(JavaTypeName.create(key));
 275                 if (runtimeType instanceof NotificationRuntimeType notification) {
 276                     return new NotificationCodecContext<>(key, notification, BindingCodecContext.this);
 277                 } if (runtimeType != null) {
 278                     throw new IllegalArgumentException(key + " maps to unexpected " + runtimeType);
 279                 }
 280                 throw new IllegalArgumentException(key + " is not a known class");
 281             }
 282         });
 283     private final LoadingCache<Absolute, NotificationCodecContext<?>> notificationsByPath =
 284         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 285             @Override
 286             public NotificationCodecContext<?> load(final Absolute key) {
 287                 final var cls = context.getClassForSchema(key);
 288                 try {
 289                     return getNotificationContext(cls.asSubclass(Notification.class));
 290                 } catch (ClassCastException e) {
 291                     throw new IllegalArgumentException("Path " + key + " does not represent a notification", e);
 292                 }
 293             }
 294         });
 295
 296     private final LoadingCache<Class<?>, ContainerLikeCodecContext<?>> rpcDataByClass =
 297         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 298             @Override
 299             public ContainerLikeCodecContext<?> load(final Class<?> key) {
 300                 final var runtimeType = context.getTypes().findSchema(JavaTypeName.create(key))
 301                     .orElseThrow(() -> new IllegalArgumentException(key + " is not a known class"));
 302                 if (RpcInput.class.isAssignableFrom(key) && runtimeType instanceof InputRuntimeType input) {
 303                     // FIXME: accurate type
 304                     return new ContainerLikeCodecContext(key, input, BindingCodecContext.this);
 305                 } else if (RpcOutput.class.isAssignableFrom(key) && runtimeType instanceof OutputRuntimeType output) {
 306                     // FIXME: accurate type
 307                     return new ContainerLikeCodecContext(key, output, BindingCodecContext.this);
 308                 } else {
 309                     throw new IllegalArgumentException(key + " maps to unexpected " + runtimeType);
 310                 }
 311             }
 312         });
 313     private final LoadingCache<Absolute, RpcInputCodec<?>> rpcDataByPath =
 314         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 315             @Override
 316             public RpcInputCodec<?> load(final Absolute key) {
 317                 final var rpcName = key.firstNodeIdentifier();
 318
 319                 final Class<? extends DataContainer> container = switch (key.lastNodeIdentifier().getLocalName()) {
 320                     case "input" -> context.getRpcInput(rpcName);
 321                     case "output" -> context.getRpcOutput(rpcName);
 322                     default -> throw new IllegalArgumentException("Unhandled path " + key);
 323                 };
 324
 325                 return getRpc(container);
 326             }
 327         });
 328
 329     private final @NonNull BindingClassLoader loader =
 330         BindingClassLoader.create(BindingCodecContext.class, BYTECODE_DIRECTORY);
 331     private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
 332     private final @NonNull IdentityCodec identityCodec;
 333     private final @NonNull BindingRuntimeContext context;
 334
 335     public BindingCodecContext() {
 336         this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
 337             .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext")));
 338     }
 339
 340     public BindingCodecContext(final BindingRuntimeContext context) {
 341         this.context = requireNonNull(context, "Binding Runtime Context is required.");
 342         identityCodec = new IdentityCodec(context);
 343         instanceIdentifierCodec = new InstanceIdentifierCodec(this);
 344     }
 345
 346     @Override
 347     public BindingRuntimeContext getRuntimeContext() {
 348         return context;
 349     }
 350
 351     @Override
 352     public BindingClassLoader getLoader() {
 353         return loader;
 354     }
 355
 356     @Override
 357     public IdentityCodec getIdentityCodec() {
 358         return identityCodec;
 359     }
 360
 361     @Override
 362     public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() {
 363         return instanceIdentifierCodec;
 364     }
 365
 366     @Override
 367     public <T extends YangData<T>> BindingYangDataCodecTreeNode<T> getYangDataCodec(final Class<T> yangDataClass) {
 368         throw new UnsupportedOperationException("Not implemented yet");
 369     }
 370
 371     @Override
 372     public BindingYangDataCodecTreeNode<?> getYangDataCodec(final YangDataName yangDataName) {
 373         throw new UnsupportedOperationException("Not implemented yet");
 374     }
 375
 376     @Override
 377     public DataContainerSerializer getEventStreamSerializer(final Class<?> type) {
 378         return serializers.getUnchecked(type);
 379     }
 380
 381     @Override
 382     public DataContainerStreamer<?> getDataContainerStreamer(final Class<?> type) {
 383         return streamers.getUnchecked(type);
 384     }
 385
 386     @Override
 387     public DataContainerSerializer getSerializer(final Class<? extends DataContainer> type) {
 388         return serializers.getUnchecked(type);
 389     }
 390
 391     @Override
 392     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
 393             final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 394         final var yangArgs = new ArrayList<PathArgument>();
 395         final var codecContext = getCodecContextNode(path, yangArgs);
 396         return Map.entry(YangInstanceIdentifier.of(yangArgs),
 397             new BindingToNormalizedStreamWriter(codecContext, domWriter));
 398     }
 399
 400     @Override
 401     public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
 402             final NormalizedNodeStreamWriter domWriter) {
 403         return new BindingToNormalizedStreamWriter(getCodecContextNode(path, null), domWriter);
 404     }
 405
 406     @Override
 407     public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
 408             final NormalizedNodeStreamWriter domWriter) {
 409         return new BindingToNormalizedStreamWriter(getRpc(rpcInputOrOutput), domWriter);
 410     }
 411
 412     @Override
 413     public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification<?>> notification,
 414             final NormalizedNodeStreamWriter domWriter) {
 415         return new BindingToNormalizedStreamWriter(getNotificationContext(notification), domWriter);
 416     }
 417
 418     @Override
 419     public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
 420             final NormalizedNodeStreamWriter domWriter) {
 421         return new BindingToNormalizedStreamWriter(getActionCodec(action).input(), domWriter);
 422     }
 423
 424     @Override
 425     public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
 426             final NormalizedNodeStreamWriter domWriter) {
 427         return new BindingToNormalizedStreamWriter(getActionCodec(action).output(), domWriter);
 428     }
 429
 430     @NonNull DataContainerCodecContext<?, ?, ?> getCodecContextNode(final InstanceIdentifier<?> binding,
 431             final List<PathArgument> builder) {
 432         final var it = binding.getPathArguments().iterator();
 433         final var step = it.next();
 434
 435         final DataContainerCodecContext<?, ?, ?> start;
 436         final var caseType = step.caseType();
 437         if (caseType != null) {
 438             final var choice = choicesByClass.getUnchecked(caseType);
 439             choice.addYangPathArgument(step, builder);
 440             final var caze = choice.getStreamChild(caseType);
 441             caze.addYangPathArgument(step, builder);
 442             start = caze.bindingPathArgumentChild(step, builder);
 443         } else {
 444             final var child = getStreamChild(step.type());
 445             child.addYangPathArgument(step, builder);
 446             start = child;
 447         }
 448
 449         var current = start;
 450         while (it.hasNext()) {
 451             current = current.bindingPathArgumentChild(it.next(), builder);
 452         }
 453         return current;
 454     }
 455
 456     /**
 457      * Multi-purpose utility function. Traverse the codec tree, looking for
 458      * the appropriate codec for the specified {@link YangInstanceIdentifier}.
 459      * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
 460      * into the supplied collection.
 461      *
 462      * @param dom {@link YangInstanceIdentifier} which is to be translated
 463      * @param bindingArguments Collection for traversed path arguments
 464      * @return Codec for target node, or {@code null} if the node does not have a binding representation (choice, case,
 465      *         leaf).
 466      * @throws IllegalArgumentException if {@code dom} is empty
 467      */
 468     @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
 469             final @Nullable Collection<DataObjectStep<?>> bindingArguments) {
 470         final var it = dom.getPathArguments().iterator();
 471         if (!it.hasNext()) {
 472             throw new IllegalArgumentException("Path may not be empty");
 473         }
 474
 475         // First item is somewhat special:
 476         // 1. it has to be a NodeIdentifier, otherwise it is a malformed identifier and we do not find it
 477         var domArg = it.next();
 478         if (!(domArg instanceof NodeIdentifier)) {
 479             return null;
 480         }
 481         CodecContext nextNode = getOrRethrow(childrenByDomArg, domArg.getNodeType());
 482
 483         CodecContext currentNode;
 484         if (nextNode instanceof ListCodecContext<?> listNode) {
 485             // 2. if it is a list, we need to see if we are consuming another item.
 486             if (!it.hasNext()) {
 487                 // 2a: not further items: it boils down to a wildcard
 488                 if (bindingArguments != null) {
 489                     bindingArguments.add(listNode.getBindingPathArgument(null));
 490                 }
 491                 return listNode;
 492             }
 493
 494             // 2b: there is a next item: it should either be a NodeIdentifier or a NodeIdentifierWithPredicates, but it
 495             //     has to have the same node type
 496             final var nextArg = it.next();
 497             if (nextArg instanceof NodeWithValue || !nextArg.getNodeType().equals(domArg.getNodeType())) {
 498                 throw new IllegalArgumentException(
 499                     "List should be referenced two times in YANG Instance Identifier " + dom);
 500             }
 501             if (bindingArguments != null) {
 502                 bindingArguments.add(listNode.getBindingPathArgument(nextArg));
 503             }
 504             currentNode = nextNode;
 505         } else if (nextNode instanceof ChoiceCodecContext) {
 506             currentNode = nextNode;
 507         } else if (nextNode instanceof CommonDataObjectCodecContext<?, ?> firstContainer) {
 508             if (bindingArguments != null) {
 509                 bindingArguments.add(firstContainer.getBindingPathArgument(domArg));
 510             }
 511             currentNode = nextNode;
 512         } else {
 513             return null;
 514         }
 515
 516         ListCodecContext<?> currentList = null;
 517         while (it.hasNext()) {
 518             domArg = it.next();
 519             if (!(currentNode instanceof DataContainerCodecContext previous)) {
 520                 throw new IllegalArgumentException("Unexpected child of non-container node " + currentNode);
 521             }
 522
 523             nextNode = previous.yangPathArgumentChild(domArg);
 524
 525             /**
 526              * Compatibility case: if it's determined the node belongs to augmentation
 527              * then insert augmentation path argument in between.
 528              */
 529             if (nextNode instanceof AugmentationCodecContext<?> augmContext) {
 530                 if (bindingArguments != null) {
 531                     bindingArguments.add(augmContext.bindingArg());
 532                 }
 533                 currentNode = nextNode;
 534                 nextNode = augmContext.yangPathArgumentChild(domArg);
 535             }
 536
 537             /*
 538              * List representation in YANG Instance Identifier consists of two arguments: first is list as a whole,
 539              * second is list as an item so if it is /list it means list as whole, if it is /list/list - it is
 540              * wildcarded and if it is /list/list[key] it is concrete item, all this variations are expressed in
 541              * InstanceIdentifier as Item or IdentifiableItem
 542              */
 543             if (currentList != null) {
 544                 checkArgument(currentList == nextNode,
 545                         "List should be referenced two times in YANG Instance Identifier %s", dom);
 546
 547                 // We entered list, so now we have all information to emit
 548                 // list path using second list argument.
 549                 if (bindingArguments != null) {
 550                     bindingArguments.add(currentList.getBindingPathArgument(domArg));
 551                 }
 552                 currentList = null;
 553                 currentNode = nextNode;
 554             } else if (nextNode instanceof ListCodecContext<?> listNode) {
 555                 // We enter list, we do not update current Node yet,
 556                 // since we need to verify
 557                 currentList = listNode;
 558             } else if (nextNode instanceof ChoiceCodecContext) {
 559                 // We do not add path argument for choice, since
 560                 // it is not supported by binding instance identifier.
 561                 currentNode = nextNode;
 562             } else if (nextNode instanceof CommonDataObjectCodecContext<?, ?> containerNode) {
 563                 if (bindingArguments != null) {
 564                     bindingArguments.add(containerNode.getBindingPathArgument(domArg));
 565                 }
 566                 currentNode = nextNode;
 567             } else if (nextNode instanceof ValueNodeCodecContext) {
 568                 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
 569                 return null;
 570             }
 571         }
 572
 573         // Algorithm ended in list as whole representation
 574         // we sill need to emit identifier for list
 575         if (currentNode instanceof ChoiceCodecContext) {
 576             LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
 577             return null;
 578         }
 579         if (currentNode instanceof CaseCodecContext) {
 580             LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
 581             return null;
 582         }
 583
 584         if (currentList != null) {
 585             if (bindingArguments != null) {
 586                 bindingArguments.add(currentList.getBindingPathArgument(null));
 587             }
 588             return currentList;
 589         }
 590         if (currentNode != null) {
 591             verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
 592                 currentNode, dom);
 593             return (BindingDataObjectCodecTreeNode<?>) currentNode;
 594         }
 595         return null;
 596     }
 597
 598     NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
 599         return getOrRethrow(notificationsByPath, notification);
 600     }
 601
 602     private NotificationCodecContext<?> getNotificationContext(final Class<?> notification) {
 603         return getOrRethrow(notificationsByClass, notification);
 604     }
 605
 606     ContainerLikeCodecContext<?> getRpc(final Class<? extends DataContainer> rpcInputOrOutput) {
 607         return getOrRethrow(rpcDataByClass, rpcInputOrOutput);
 608     }
 609
 610     RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
 611         return getOrRethrow(rpcDataByPath, containerPath);
 612     }
 613
 614     ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
 615         return getOrRethrow(actionsByClass, action);
 616     }
 617
 618     @Override
 619     public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> type,
 620             final EffectiveStatement<?, ?> schema) {
 621         final var getterToLeafSchema = new HashMap<String, DataSchemaNode>();
 622         for (var stmt : schema.effectiveSubstatements()) {
 623             if (stmt instanceof TypedDataSchemaNode typedSchema) {
 624                 putLeaf(getterToLeafSchema, typedSchema);
 625             } else if (stmt instanceof AnydataSchemaNode anydataSchema) {
 626                 putLeaf(getterToLeafSchema, anydataSchema);
 627             } else if (stmt instanceof AnyxmlSchemaNode anyxmlSchema) {
 628                 putLeaf(getterToLeafSchema, anyxmlSchema);
 629             }
 630         }
 631         return getLeafNodesUsingReflection(type, getterToLeafSchema);
 632     }
 633
 634     private static void putLeaf(final Map<String, DataSchemaNode> map, final DataSchemaNode leaf) {
 635         map.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
 636     }
 637
 638     private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
 639             final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
 640         final var leaves = new HashMap<Method, ValueNodeCodecContext>();
 641         for (var method : parentClass.getMethods()) {
 642             // Only consider non-bridge methods with no arguments
 643             if (method.getParameterCount() == 0 && !method.isBridge()) {
 644                 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
 645
 646                 final ValueNodeCodecContext valueNode;
 647                 if (schema instanceof LeafSchemaNode leafSchema) {
 648                     // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
 649                     //                   Object.class
 650                     final Class<?> valueType = method.getReturnType();
 651                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
 652                     valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
 653                         context.modelContext());
 654                 } else if (schema instanceof LeafListSchemaNode leafListSchema) {
 655                     final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
 656                         method.getGenericReturnType());
 657                     checkState(optType.isPresent(), "Failed to find return type for %s", method);
 658
 659                     final Class<?> valueType;
 660                     final Type genericType = optType.orElseThrow();
 661                     if (genericType instanceof Class<?> clazz) {
 662                         valueType = clazz;
 663                     } else if (genericType instanceof ParameterizedType parameterized) {
 664                         valueType = (Class<?>) parameterized.getRawType();
 665                     } else if (genericType instanceof WildcardType) {
 666                         // FIXME: MDSAL-670: this is not right as we need to find a concrete type
 667                         valueType = Object.class;
 668                     } else {
 669                         throw new IllegalStateException("Unexpected return type " + genericType);
 670                     }
 671
 672                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
 673                     valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
 674                 } else if (schema instanceof AnyxmlSchemaNode anyxmlSchema) {
 675                     valueNode = new AnyxmlCodecContext<>(anyxmlSchema, method.getName(), opaqueReturnType(method),
 676                         loader);
 677                 } else if (schema instanceof AnydataSchemaNode anydataSchema) {
 678                     valueNode = new AnydataCodecContext<>(anydataSchema, method.getName(), opaqueReturnType(method),
 679                         loader);
 680                 } else {
 681                     verify(schema == null, "Unhandled schema %s for method %s", schema, method);
 682                     // We do not have schema for leaf, so we will ignore it (e.g. getClass).
 683                     continue;
 684                 }
 685
 686                 leaves.put(method, valueNode);
 687             }
 688         }
 689         return ImmutableMap.copyOf(leaves);
 690     }
 691
 692     // FIXME: this is probably not right w.r.t. nulls
 693     ValueCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
 694         if (BaseIdentity.class.isAssignableFrom(valueType)) {
 695             @SuppressWarnings({ "unchecked", "rawtypes" })
 696             final ValueCodec<Object, Object> casted = (ValueCodec) identityCodec;
 697             return casted;
 698         } else if (InstanceIdentifier.class.equals(valueType)) {
 699             @SuppressWarnings({ "unchecked", "rawtypes" })
 700             final ValueCodec<Object, Object> casted = (ValueCodec) instanceIdentifierCodec;
 701             return casted;
 702         } else if (BindingReflections.isBindingClass(valueType)) {
 703             return getCodecForBindingClass(valueType, instantiatedType);
 704         }
 705         // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
 706         //                   valueType=Object.class
 707         return SchemaUnawareCodec.NOOP_CODEC;
 708     }
 709
 710     @SuppressWarnings("checkstyle:illegalCatch")
 711     // FIXME: this is probably not right w.r.t. nulls
 712     private ValueCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
 713             final TypeDefinition<?> typeDef) {
 714         if (typeDef instanceof IdentityrefTypeDefinition) {
 715             return new CompositeValueCodec.OfIdentity(valueType, identityCodec);
 716         } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
 717             return new CompositeValueCodec.OfInstanceIdentifier(valueType, instanceIdentifierCodec);
 718         } else if (typeDef instanceof UnionTypeDefinition unionType) {
 719             try {
 720                 return UnionTypeCodec.of(valueType, unionType, this);
 721             } catch (Exception e) {
 722                 throw new IllegalStateException("Unable to load codec for " + valueType, e);
 723             }
 724         } else if (typeDef instanceof LeafrefTypeDefinition) {
 725             final var typeWithSchema = context.getTypeWithSchema(valueType);
 726             final var schema = typeWithSchema.statement();
 727             final TypeDefinition<?> def;
 728             if (schema instanceof TypeDefinitionAware typeDefAware) {
 729                 def = typeDefAware.getTypeDefinition();
 730             } else if (schema instanceof TypeAware typeAware) {
 731                 def = typeAware.getType();
 732             } else {
 733                 throw new IllegalStateException("Unexpected schema " + schema);
 734             }
 735             return getCodec(valueType, def);
 736         }
 737         return SchemaUnawareCodec.of(valueType, typeDef);
 738     }
 739
 740     @Override
 741     public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
 742         final Optional<Class<Key<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
 743                 KeyAware.class);
 744         checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
 745
 746         final Class<Key<?>> identifier = optIdentifier.orElseThrow();
 747         final Map<QName, ValueContext> valueCtx = new HashMap<>();
 748         for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
 749             final QName name = leaf.getDomPathArgument().getNodeType();
 750             valueCtx.put(name, new ValueContext(identifier, leaf));
 751         }
 752         return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
 753     }
 754
 755     @Override
 756     @SuppressWarnings("unchecked")
 757     public <E extends DataObject> DataContainerCodecContext<E, ?, ?> getStreamChild(final Class<E> childClass) {
 758         final var result = Notification.class.isAssignableFrom(childClass) ? getNotificationContext(childClass)
 759             : getOrRethrow(childrenByClass, childClass);
 760         return (DataContainerCodecContext<E, ?, ?>) result;
 761     }
 762
 763     @Override
 764     @SuppressWarnings("unchecked")
 765     public <A extends Augmentation<?>> BindingAugmentationCodecTreeNode<A> getAugmentationCodec(
 766             final InstanceIdentifier<A> path) {
 767         final var codecContext = getCodecContextNode(path, null);
 768         if (codecContext instanceof BindingAugmentationCodecTreeNode) {
 769             return (BindingAugmentationCodecTreeNode<A>) codecContext;
 770         }
 771         throw new IllegalArgumentException(path + " does not refer to an Augmentation");
 772     }
 773
 774     @Override
 775     @SuppressWarnings("unchecked")
 776     public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getDataObjectCodec(
 777             final InstanceIdentifier<T> path) {
 778         final var codecContext = getCodecContextNode(path, null);
 779         if (codecContext instanceof BindingDataObjectCodecTreeNode) {
 780             return (BindingDataObjectCodecTreeNode<T>) codecContext;
 781         }
 782         throw new IllegalArgumentException(path + " does not refer to a plain DataObject");
 783     }
 784
 785     @Override
 786     @SuppressWarnings("unchecked")
 787     public <T extends DataObject> CodecWithPath<T> getSubtreeCodecWithPath(final InstanceIdentifier<T> path) {
 788         final var yangArgs = new ArrayList<PathArgument>();
 789         final var codecContext = getCodecContextNode(path, yangArgs);
 790
 791         // TODO Do we need defensive check here?
 792         return new CodecWithPath<>((CommonDataObjectCodecTreeNode<T>) codecContext,
 793             YangInstanceIdentifier.of(yangArgs));
 794     }
 795
 796     @Override
 797     @SuppressWarnings("unchecked")
 798     public <T extends DataObject> CommonDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
 799         // TODO Do we need defensive check here?
 800         return (CommonDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
 801     }
 802
 803     @Override
 804     public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
 805         return getCodecContextNode(requireNonNull(path), null);
 806     }
 807
 808     @Override
 809     public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
 810         throw new UnsupportedOperationException("Not implemented yet.");
 811     }
 812
 813     @Override
 814     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 815         return instanceIdentifierCodec.fromBinding(binding);
 816     }
 817
 818     @Override
 819     public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 820         return instanceIdentifierCodec.toBinding(dom);
 821     }
 822
 823     @Override
 824     public <A extends Augmentation<?>> AugmentationResult toNormalizedAugmentation(final InstanceIdentifier<A> path,
 825             final A data) {
 826         final var result = toNormalizedNode(path, data);
 827         if (result instanceof AugmentationResult augment) {
 828             return augment;
 829         }
 830         throw new IllegalArgumentException(path + " does not identify an Augmentation");
 831     }
 832
 833     @Override
 834     public <T extends DataObject> NodeResult toNormalizedDataObject(final InstanceIdentifier<T> path, final T data) {
 835         final var result = toNormalizedNode(path, data);
 836         if (result instanceof NodeResult node) {
 837             return node;
 838         }
 839         throw new IllegalArgumentException(path + " does not identify a plain DataObject");
 840     }
 841
 842     @Override
 843     public <T extends DataObject> NormalizedResult toNormalizedNode(final InstanceIdentifier<T> path, final T data) {
 844         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
 845         final var yangArgs = new ArrayList<PathArgument>();
 846         final var codecContext = getCodecContextNode(path, yangArgs);
 847         final var yangPath = YangInstanceIdentifier.of(yangArgs);
 848
 849         // We create DOM stream writer which produces normalized nodes
 850         final var result = new NormalizationResultHolder();
 851         final var domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 852         final var bindingWriter = new BindingToNormalizedStreamWriter(codecContext, domWriter);
 853         final var augment = codecContext instanceof BindingAugmentationCodecTreeNode<?> augmentNode ? augmentNode
 854             : null;
 855
 856         try {
 857             // Augmentations do not have a representation, so we are faking a ContainerNode as the parent and we will be
 858             // extracting the resulting children.
 859             if (augment != null) {
 860                 domWriter.startContainerNode(FAKE_NODEID, NormalizedNodeStreamWriter.UNKNOWN_SIZE);
 861             }
 862
 863             // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
 864             getSerializer(path.getTargetType()).serialize(data, bindingWriter);
 865
 866             if (augment != null) {
 867                 domWriter.endNode();
 868             }
 869         } catch (final IOException e) {
 870             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
 871             throw new IllegalStateException("Failed to create normalized node", e);
 872         }
 873
 874         // Terminate the fake container and extract it to the result
 875         if (augment != null) {
 876             return new AugmentationResult(yangPath, augment.childPathArguments(),
 877                 ImmutableList.copyOf(((ContainerNode) result.getResult().data()).body()));
 878         }
 879         return new NodeResult(yangPath, result.getResult().data());
 880     }
 881
 882     @Override
 883     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 884             final NormalizedNode data) {
 885         if (notBindingRepresentable(data)) {
 886             return null;
 887         }
 888
 889         final var builder = new ArrayList<DataObjectStep<?>>();
 890         final var codec = getCodecContextNode(path, builder);
 891         if (codec == null) {
 892             if (data != null) {
 893                 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
 894                     data.getClass());
 895             }
 896             return null;
 897         }
 898
 899         final DataObject lazyObj = codec.deserialize(data);
 900         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
 901         return Map.entry(bindingPath, lazyObj);
 902     }
 903
 904     @Override
 905     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
 906         return getNotificationContext(path).deserialize(data);
 907     }
 908
 909     @Override
 910     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
 911             final Instant eventInstant) {
 912         return eventInstant == null ? fromNormalizedNodeNotification(path, data)
 913                 : getNotificationContext(path).deserialize(data, eventInstant);
 914     }
 915
 916     @Override
 917     public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
 918         return getRpcInputCodec(containerPath).deserialize(data);
 919     }
 920
 921     @Override
 922     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 923             final ContainerNode input) {
 924         return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
 925     }
 926
 927     @Override
 928     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 929             final ContainerNode output) {
 930         return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
 931     }
 932
 933     @Override
 934     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 935     public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
 936         // FIXME: Should the cast to DataObject be necessary?
 937         return serializeDataObject((DataObject) data,
 938             (ctx, iface, domWriter) -> ctx.newNotificationWriter(
 939                 (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
 940     }
 941
 942     @Override
 943     public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
 944         checkArgument(data instanceof DataObject, "Unexpected data %s", data);
 945         @SuppressWarnings("rawtypes")
 946         final NotificationCodecContext notifContext = getNotificationContext(path);
 947         @SuppressWarnings("unchecked")
 948         final var result = notifContext.serialize((DataObject) data);
 949         verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
 950         return (ContainerNode) result;
 951     }
 952
 953     @Override
 954     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 955     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
 956         // FIXME: Should the cast to DataObject be necessary?
 957         return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
 958     }
 959
 960     @Override
 961     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 962             final RpcInput input) {
 963         return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
 964     }
 965
 966     @Override
 967     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 968             final RpcOutput output) {
 969         return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
 970     }
 971
 972     @Override
 973     protected NodeIdentifier actionInputName(final Class<? extends Action<?, ?, ?>> action) {
 974         return verifyNotNull(getActionCodec(action).input().getDomPathArgument());
 975     }
 976
 977     @Override
 978     protected NodeIdentifier actionOutputName(final Class<? extends Action<?, ?, ?>> action) {
 979         return verifyNotNull(getActionCodec(action).output().getDomPathArgument());
 980     }
 981
 982     private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
 983             final WriterFactoryMethod<T> newWriter) {
 984         final var result = new NormalizationResultHolder();
 985         // We create DOM stream writer which produces normalized nodes
 986         final var domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 987         final Class<? extends DataObject> type = data.implementedInterface();
 988         @SuppressWarnings("unchecked")
 989         final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
 990         try {
 991             getSerializer(type).serialize(data, writer);
 992         } catch (final IOException e) {
 993             LOG.error("Unexpected failure while serializing data {}", data, e);
 994             throw new IllegalStateException("Failed to create normalized node", e);
 995         }
 996         return (ContainerNode) result.getResult().data();
 997     }
 998
 999     private static boolean notBindingRepresentable(final NormalizedNode data) {
1000         // ValueNode covers LeafNode and LeafSetEntryNode
1001         return data instanceof ValueNode
1002             || data instanceof MapNode || data instanceof UnkeyedListNode
1003             || data instanceof ChoiceNode
1004             || data instanceof LeafSetNode;
1005     }
1006
1007     private static <K,V> V getOrRethrow(final LoadingCache<K, V> cache, final K key) {
1008         try {
1009             return cache.getUnchecked(key);
1010         } catch (UncheckedExecutionException e) {
1011             final var cause = e.getCause();
1012             if (cause != null) {
1013                 Throwables.throwIfUnchecked(cause);
1014             }
1015             throw e;
1016         }
1017     }
1018
1019     @SuppressWarnings("rawtypes")
1020     private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
1021         final Class<?> valueType = method.getReturnType();
1022         verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
1023         return valueType.asSubclass(OpaqueObject.class);
1024     }
1025
1026     @FunctionalInterface
1027     private interface WriterFactoryMethod<T extends DataContainer> {
1028         BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
1029                 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);
1030     }
1031 }