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