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.Function;
  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.ChoiceRuntimeType;
  63 import org.opendaylight.mdsal.binding.runtime.api.ContainerLikeRuntimeType;
  64 import org.opendaylight.mdsal.binding.runtime.api.ContainerRuntimeType;
  65 import org.opendaylight.mdsal.binding.runtime.api.DataRuntimeType;
  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.RpcRuntimeType;
  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 Function<RpcRuntimeType, ContainerLikeRuntimeType<?, ?>> lookup;
 307                 if (RpcInput.class.isAssignableFrom(key)) {
 308                     lookup = RpcRuntimeType::input;
 309                 } else if (RpcOutput.class.isAssignableFrom(key)) {
 310                     lookup = RpcRuntimeType::output;
 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 runtimeType = context.getTypes().schemaTreeChild(potentialQName);
 335                         if (runtimeType instanceof RpcRuntimeType rpcType) {
 336                             // FIXME: accurate type
 337                             return new ContainerLikeCodecContext(key, lookup.apply(rpcType), BindingCodecContext.this);
 338                         }
 339                         throw new IllegalArgumentException("Cannot find runtime type for " + key);
 340                     }
 341                 }
 342
 343                 throw new IllegalArgumentException("Supplied class " + key + " is not valid RPC class.");
 344             }
 345
 346             /**
 347              * Returns RPC input or output schema based on supplied QName.
 348              *
 349              * @param rpc RPC Definition
 350              * @param qname input or output QName with namespace same as RPC
 351              * @return input or output schema. Returns null if RPC does not have input/output specified.
 352              */
 353             private static @Nullable ContainerLike getRpcDataSchema(final @NonNull RpcDefinition rpc,
 354                     final @NonNull QName qname) {
 355                 requireNonNull(rpc, "Rpc Schema must not be null");
 356                 return switch (requireNonNull(qname, "QName must not be null").getLocalName()) {
 357                     case "input" -> rpc.getInput();
 358                     case "output" -> rpc.getOutput();
 359                     default -> throw new IllegalArgumentException(
 360                         "Supplied qname " + qname + " does not represent rpc input or output.");
 361                 };
 362             }
 363         });
 364     private final LoadingCache<Absolute, RpcInputCodec<?>> rpcDataByPath =
 365         CacheBuilder.newBuilder().build(new CacheLoader<>() {
 366             @Override
 367             public RpcInputCodec<?> load(final Absolute key) {
 368                 final var rpcName = key.firstNodeIdentifier();
 369
 370                 final Class<? extends DataContainer> container = switch (key.lastNodeIdentifier().getLocalName()) {
 371                     case "input" -> context.getRpcInput(rpcName);
 372                     case "output" -> context.getRpcOutput(rpcName);
 373                     default -> throw new IllegalArgumentException("Unhandled path " + key);
 374                 };
 375
 376                 return getRpc(container);
 377             }
 378         });
 379
 380     private final @NonNull BindingClassLoader loader =
 381         BindingClassLoader.create(BindingCodecContext.class, BYTECODE_DIRECTORY);
 382     private final @NonNull InstanceIdentifierCodec instanceIdentifierCodec;
 383     private final @NonNull IdentityCodec identityCodec;
 384     private final @NonNull BindingRuntimeContext context;
 385
 386     public BindingCodecContext() {
 387         this(ServiceLoader.load(BindingRuntimeContext.class).findFirst()
 388             .orElseThrow(() -> new IllegalStateException("Failed to load BindingRuntimeContext")));
 389     }
 390
 391     public BindingCodecContext(final BindingRuntimeContext context) {
 392         this.context = requireNonNull(context, "Binding Runtime Context is required.");
 393         identityCodec = new IdentityCodec(context);
 394         instanceIdentifierCodec = new InstanceIdentifierCodec(this);
 395     }
 396
 397     @Override
 398     public BindingRuntimeContext getRuntimeContext() {
 399         return context;
 400     }
 401
 402     @Override
 403     public BindingClassLoader getLoader() {
 404         return loader;
 405     }
 406
 407     @Override
 408     public IdentityCodec getIdentityCodec() {
 409         return identityCodec;
 410     }
 411
 412     @Override
 413     public BindingInstanceIdentifierCodec getInstanceIdentifierCodec() {
 414         return instanceIdentifierCodec;
 415     }
 416
 417     @Override
 418     public <T extends YangData<T>> BindingYangDataCodecTreeNode<T> getYangDataCodec(final Class<T> yangDataClass) {
 419         throw new UnsupportedOperationException("Not implemented yet");
 420     }
 421
 422     @Override
 423     public BindingYangDataCodecTreeNode<?> getYangDataCodec(final YangDataName yangDataName) {
 424         throw new UnsupportedOperationException("Not implemented yet");
 425     }
 426
 427     @Override
 428     public DataContainerSerializer getEventStreamSerializer(final Class<?> type) {
 429         return serializers.getUnchecked(type);
 430     }
 431
 432     @Override
 433     public DataContainerStreamer<?> getDataContainerStreamer(final Class<?> type) {
 434         return streamers.getUnchecked(type);
 435     }
 436
 437     @Override
 438     public DataContainerSerializer getSerializer(final Class<? extends DataContainer> type) {
 439         return serializers.getUnchecked(type);
 440     }
 441
 442     @Override
 443     public Entry<YangInstanceIdentifier, BindingStreamEventWriter> newWriterAndIdentifier(
 444             final InstanceIdentifier<?> path, final NormalizedNodeStreamWriter domWriter) {
 445         final var yangArgs = new ArrayList<PathArgument>();
 446         final var codecContext = getCodecContextNode(path, yangArgs);
 447         return Map.entry(YangInstanceIdentifier.of(yangArgs),
 448             new BindingToNormalizedStreamWriter(codecContext, domWriter));
 449     }
 450
 451     @Override
 452     public BindingStreamEventWriter newWriter(final InstanceIdentifier<?> path,
 453             final NormalizedNodeStreamWriter domWriter) {
 454         return new BindingToNormalizedStreamWriter(getCodecContextNode(path, null), domWriter);
 455     }
 456
 457     @Override
 458     public BindingStreamEventWriter newRpcWriter(final Class<? extends DataContainer> rpcInputOrOutput,
 459             final NormalizedNodeStreamWriter domWriter) {
 460         return new BindingToNormalizedStreamWriter(getRpc(rpcInputOrOutput), domWriter);
 461     }
 462
 463     @Override
 464     public BindingStreamEventWriter newNotificationWriter(final Class<? extends Notification<?>> notification,
 465             final NormalizedNodeStreamWriter domWriter) {
 466         return new BindingToNormalizedStreamWriter(getNotificationContext(notification), domWriter);
 467     }
 468
 469     @Override
 470     public BindingStreamEventWriter newActionInputWriter(final Class<? extends Action<?, ?, ?>> action,
 471             final NormalizedNodeStreamWriter domWriter) {
 472         return new BindingToNormalizedStreamWriter(getActionCodec(action).input(), domWriter);
 473     }
 474
 475     @Override
 476     public BindingStreamEventWriter newActionOutputWriter(final Class<? extends Action<?, ?, ?>> action,
 477             final NormalizedNodeStreamWriter domWriter) {
 478         return new BindingToNormalizedStreamWriter(getActionCodec(action).output(), domWriter);
 479     }
 480
 481     @NonNull DataContainerCodecContext<?,?> getCodecContextNode(final InstanceIdentifier<?> binding,
 482             final List<PathArgument> builder) {
 483         final var it = binding.getPathArguments().iterator();
 484         final var arg = it.next();
 485
 486         DataContainerCodecContext<?, ?> current;
 487         final var caseType = arg.getCaseType();
 488         if (caseType.isPresent()) {
 489             final @NonNull Class<? extends DataObject> type = caseType.orElseThrow();
 490             final var choice = choicesByClass.getUnchecked(type);
 491             choice.addYangPathArgument(arg, builder);
 492             final var caze = choice.getStreamChild(type);
 493             caze.addYangPathArgument(arg, builder);
 494             current = caze.bindingPathArgumentChild(arg, builder);
 495         } else {
 496             final var child = getStreamChild(arg.getType());
 497             child.addYangPathArgument(arg, builder);
 498             current = child;
 499         }
 500
 501         while (it.hasNext()) {
 502             current = current.bindingPathArgumentChild(it.next(), builder);
 503         }
 504         return current;
 505     }
 506
 507     /**
 508      * Multi-purpose utility function. Traverse the codec tree, looking for
 509      * the appropriate codec for the specified {@link YangInstanceIdentifier}.
 510      * As a side-effect, gather all traversed binding {@link InstanceIdentifier.PathArgument}s
 511      * into the supplied collection.
 512      *
 513      * @param dom {@link YangInstanceIdentifier} which is to be translated
 514      * @param bindingArguments Collection for traversed path arguments
 515      * @return Codec for target node, or {@code null} if the node does not have a binding representation (choice, case,
 516      *         leaf).
 517      * @throws IllegalArgumentException if {@code dom} is empty
 518      */
 519     @Nullable BindingDataObjectCodecTreeNode<?> getCodecContextNode(final @NonNull YangInstanceIdentifier dom,
 520             final @Nullable Collection<InstanceIdentifier.PathArgument> bindingArguments) {
 521         final var it = dom.getPathArguments().iterator();
 522         if (!it.hasNext()) {
 523             throw new IllegalArgumentException("Path may not be empty");
 524         }
 525
 526         // First item is somewhat special:
 527         // 1. it has to be a NodeIdentifier, otherwise it is a malformed identifier and we do not find it
 528         var domArg = it.next();
 529         if (!(domArg instanceof NodeIdentifier)) {
 530             return null;
 531         }
 532         CodecContext nextNode = getOrRethrow(childrenByDomArg, domArg.getNodeType());
 533
 534         CodecContext currentNode;
 535         if (nextNode instanceof ListCodecContext<?> listNode) {
 536             // 2. if it is a list, we need to see if we are consuming another item.
 537             if (!it.hasNext()) {
 538                 // 2a: not further items: it boils down to a wildcard
 539                 if (bindingArguments != null) {
 540                     bindingArguments.add(listNode.getBindingPathArgument(null));
 541                 }
 542                 return listNode;
 543             }
 544
 545             // 2b: there is a next item: it should either be a NodeIdentifier or a NodeIdentifierWithPredicates, but it
 546             //     has to have the same node type
 547             final var nextArg = it.next();
 548             if (nextArg instanceof NodeWithValue || !nextArg.getNodeType().equals(domArg.getNodeType())) {
 549                 throw new IllegalArgumentException(
 550                     "List should be referenced two times in YANG Instance Identifier " + dom);
 551             }
 552             if (bindingArguments != null) {
 553                 bindingArguments.add(listNode.getBindingPathArgument(nextArg));
 554             }
 555             currentNode = nextNode;
 556         } else if (nextNode instanceof ChoiceCodecContext) {
 557             currentNode = nextNode;
 558         } else if (nextNode instanceof CommonDataObjectCodecContext<?, ?> firstContainer) {
 559             if (bindingArguments != null) {
 560                 bindingArguments.add(firstContainer.getBindingPathArgument(domArg));
 561             }
 562             currentNode = nextNode;
 563         } else {
 564             return null;
 565         }
 566
 567         ListCodecContext<?> currentList = null;
 568         while (it.hasNext()) {
 569             domArg = it.next();
 570             if (!(currentNode instanceof DataContainerCodecContext previous)) {
 571                 throw new IllegalArgumentException("Unexpected child of non-container node " + currentNode);
 572             }
 573
 574             nextNode = previous.yangPathArgumentChild(domArg);
 575
 576             /**
 577              * Compatibility case: if it's determined the node belongs to augmentation
 578              * then insert augmentation path argument in between.
 579              */
 580             if (nextNode instanceof AugmentationCodecContext<?> augmContext) {
 581                 if (bindingArguments != null) {
 582                     bindingArguments.add(augmContext.bindingArg());
 583                 }
 584                 currentNode = nextNode;
 585                 nextNode = augmContext.yangPathArgumentChild(domArg);
 586             }
 587
 588             /*
 589              * List representation in YANG Instance Identifier consists of two arguments: first is list as a whole,
 590              * second is list as an item so if it is /list it means list as whole, if it is /list/list - it is
 591              * wildcarded and if it is /list/list[key] it is concrete item, all this variations are expressed in
 592              * InstanceIdentifier as Item or IdentifiableItem
 593              */
 594             if (currentList != null) {
 595                 checkArgument(currentList == nextNode,
 596                         "List should be referenced two times in YANG Instance Identifier %s", dom);
 597
 598                 // We entered list, so now we have all information to emit
 599                 // list path using second list argument.
 600                 if (bindingArguments != null) {
 601                     bindingArguments.add(currentList.getBindingPathArgument(domArg));
 602                 }
 603                 currentList = null;
 604                 currentNode = nextNode;
 605             } else if (nextNode instanceof ListCodecContext<?> listNode) {
 606                 // We enter list, we do not update current Node yet,
 607                 // since we need to verify
 608                 currentList = listNode;
 609             } else if (nextNode instanceof ChoiceCodecContext) {
 610                 // We do not add path argument for choice, since
 611                 // it is not supported by binding instance identifier.
 612                 currentNode = nextNode;
 613             } else if (nextNode instanceof CommonDataObjectCodecContext<?, ?> containerNode) {
 614                 if (bindingArguments != null) {
 615                     bindingArguments.add(containerNode.getBindingPathArgument(domArg));
 616                 }
 617                 currentNode = nextNode;
 618             } else if (nextNode instanceof ValueNodeCodecContext) {
 619                 LOG.debug("Instance identifier referencing a leaf is not representable ({})", dom);
 620                 return null;
 621             }
 622         }
 623
 624         // Algorithm ended in list as whole representation
 625         // we sill need to emit identifier for list
 626         if (currentNode instanceof ChoiceCodecContext) {
 627             LOG.debug("Instance identifier targeting a choice is not representable ({})", dom);
 628             return null;
 629         }
 630         if (currentNode instanceof CaseCodecContext) {
 631             LOG.debug("Instance identifier targeting a case is not representable ({})", dom);
 632             return null;
 633         }
 634
 635         if (currentList != null) {
 636             if (bindingArguments != null) {
 637                 bindingArguments.add(currentList.getBindingPathArgument(null));
 638             }
 639             return currentList;
 640         }
 641         if (currentNode != null) {
 642             verify(currentNode instanceof BindingDataObjectCodecTreeNode, "Illegal return node %s for identifier %s",
 643                 currentNode, dom);
 644             return (BindingDataObjectCodecTreeNode<?>) currentNode;
 645         }
 646         return null;
 647     }
 648
 649     NotificationCodecContext<?> getNotificationContext(final Absolute notification) {
 650         return getOrRethrow(notificationsByPath, notification);
 651     }
 652
 653     private NotificationCodecContext<?> getNotificationContext(final Class<?> notification) {
 654         return getOrRethrow(notificationsByClass, notification);
 655     }
 656
 657     ContainerLikeCodecContext<?> getRpc(final Class<? extends DataContainer> rpcInputOrOutput) {
 658         return getOrRethrow(rpcDataByClass, rpcInputOrOutput);
 659     }
 660
 661     RpcInputCodec<?> getRpcInputCodec(final Absolute containerPath) {
 662         return getOrRethrow(rpcDataByPath, containerPath);
 663     }
 664
 665     ActionCodecContext getActionCodec(final Class<? extends Action<?, ?, ?>> action) {
 666         return getOrRethrow(actionsByClass, action);
 667     }
 668
 669     @Override
 670     public ImmutableMap<Method, ValueNodeCodecContext> getLeafNodes(final Class<?> type,
 671             final EffectiveStatement<?, ?> schema) {
 672         final var getterToLeafSchema = new HashMap<String, DataSchemaNode>();
 673         for (var stmt : schema.effectiveSubstatements()) {
 674             if (stmt instanceof TypedDataSchemaNode typedSchema) {
 675                 putLeaf(getterToLeafSchema, typedSchema);
 676             } else if (stmt instanceof AnydataSchemaNode anydataSchema) {
 677                 putLeaf(getterToLeafSchema, anydataSchema);
 678             } else if (stmt instanceof AnyxmlSchemaNode anyxmlSchema) {
 679                 putLeaf(getterToLeafSchema, anyxmlSchema);
 680             }
 681         }
 682         return getLeafNodesUsingReflection(type, getterToLeafSchema);
 683     }
 684
 685     private static void putLeaf(final Map<String, DataSchemaNode> map, final DataSchemaNode leaf) {
 686         map.put(BindingSchemaMapping.getGetterMethodName(leaf), leaf);
 687     }
 688
 689     private ImmutableMap<Method, ValueNodeCodecContext> getLeafNodesUsingReflection(
 690             final Class<?> parentClass, final Map<String, DataSchemaNode> getterToLeafSchema) {
 691         final var leaves = new HashMap<Method, ValueNodeCodecContext>();
 692         for (var method : parentClass.getMethods()) {
 693             // Only consider non-bridge methods with no arguments
 694             if (method.getParameterCount() == 0 && !method.isBridge()) {
 695                 final DataSchemaNode schema = getterToLeafSchema.get(method.getName());
 696
 697                 final ValueNodeCodecContext valueNode;
 698                 if (schema instanceof LeafSchemaNode leafSchema) {
 699                     // FIXME: MDSAL-670: this is not right as we need to find a concrete type, but this may return
 700                     //                   Object.class
 701                     final Class<?> valueType = method.getReturnType();
 702                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafSchema.getType());
 703                     valueNode = LeafNodeCodecContext.of(leafSchema, codec, method.getName(), valueType,
 704                         context.getEffectiveModelContext());
 705                 } else if (schema instanceof LeafListSchemaNode leafListSchema) {
 706                     final Optional<Type> optType = ClassLoaderUtils.getFirstGenericParameter(
 707                         method.getGenericReturnType());
 708                     checkState(optType.isPresent(), "Failed to find return type for %s", method);
 709
 710                     final Class<?> valueType;
 711                     final Type genericType = optType.orElseThrow();
 712                     if (genericType instanceof Class<?> clazz) {
 713                         valueType = clazz;
 714                     } else if (genericType instanceof ParameterizedType parameterized) {
 715                         valueType = (Class<?>) parameterized.getRawType();
 716                     } else if (genericType instanceof WildcardType) {
 717                         // FIXME: MDSAL-670: this is not right as we need to find a concrete type
 718                         valueType = Object.class;
 719                     } else {
 720                         throw new IllegalStateException("Unexpected return type " + genericType);
 721                     }
 722
 723                     final ValueCodec<Object, Object> codec = getCodec(valueType, leafListSchema.getType());
 724                     valueNode = new LeafSetNodeCodecContext(leafListSchema, codec, method.getName());
 725                 } else if (schema instanceof AnyxmlSchemaNode anyxmlSchema) {
 726                     valueNode = new AnyxmlCodecContext<>(anyxmlSchema, method.getName(), opaqueReturnType(method),
 727                         loader);
 728                 } else if (schema instanceof AnydataSchemaNode anydataSchema) {
 729                     valueNode = new AnydataCodecContext<>(anydataSchema, method.getName(), opaqueReturnType(method),
 730                         loader);
 731                 } else {
 732                     verify(schema == null, "Unhandled schema %s for method %s", schema, method);
 733                     // We do not have schema for leaf, so we will ignore it (e.g. getClass).
 734                     continue;
 735                 }
 736
 737                 leaves.put(method, valueNode);
 738             }
 739         }
 740         return ImmutableMap.copyOf(leaves);
 741     }
 742
 743     // FIXME: this is probably not right w.r.t. nulls
 744     ValueCodec<Object, Object> getCodec(final Class<?> valueType, final TypeDefinition<?> instantiatedType) {
 745         if (BaseIdentity.class.isAssignableFrom(valueType)) {
 746             @SuppressWarnings({ "unchecked", "rawtypes" })
 747             final ValueCodec<Object, Object> casted = (ValueCodec) identityCodec;
 748             return casted;
 749         } else if (InstanceIdentifier.class.equals(valueType)) {
 750             @SuppressWarnings({ "unchecked", "rawtypes" })
 751             final ValueCodec<Object, Object> casted = (ValueCodec) instanceIdentifierCodec;
 752             return casted;
 753         } else if (BindingReflections.isBindingClass(valueType)) {
 754             return getCodecForBindingClass(valueType, instantiatedType);
 755         }
 756         // FIXME: MDSAL-670: this is right for most situations, but we must never return NOOP_CODEC for
 757         //                   valueType=Object.class
 758         return SchemaUnawareCodec.NOOP_CODEC;
 759     }
 760
 761     @SuppressWarnings("checkstyle:illegalCatch")
 762     // FIXME: this is probably not right w.r.t. nulls
 763     private ValueCodec<Object, Object> getCodecForBindingClass(final Class<?> valueType,
 764             final TypeDefinition<?> typeDef) {
 765         if (typeDef instanceof IdentityrefTypeDefinition) {
 766             return new CompositeValueCodec.OfIdentity(valueType, identityCodec);
 767         } else if (typeDef instanceof InstanceIdentifierTypeDefinition) {
 768             return new CompositeValueCodec.OfInstanceIdentifier(valueType, instanceIdentifierCodec);
 769         } else if (typeDef instanceof UnionTypeDefinition unionType) {
 770             try {
 771                 return UnionTypeCodec.of(valueType, unionType, this);
 772             } catch (Exception e) {
 773                 throw new IllegalStateException("Unable to load codec for " + valueType, e);
 774             }
 775         } else if (typeDef instanceof LeafrefTypeDefinition) {
 776             final var typeWithSchema = context.getTypeWithSchema(valueType);
 777             final var schema = typeWithSchema.statement();
 778             final TypeDefinition<?> def;
 779             if (schema instanceof TypeDefinitionAware typeDefAware) {
 780                 def = typeDefAware.getTypeDefinition();
 781             } else if (schema instanceof TypeAware typeAware) {
 782                 def = typeAware.getType();
 783             } else {
 784                 throw new IllegalStateException("Unexpected schema " + schema);
 785             }
 786             return getCodec(valueType, def);
 787         }
 788         return SchemaUnawareCodec.of(valueType, typeDef);
 789     }
 790
 791     @Override
 792     public IdentifiableItemCodec getPathArgumentCodec(final Class<?> listClz, final ListRuntimeType type) {
 793         final Optional<Class<Key<?>>> optIdentifier = ClassLoaderUtils.findFirstGenericArgument(listClz,
 794                 KeyAware.class);
 795         checkState(optIdentifier.isPresent(), "Failed to find identifier for %s", listClz);
 796
 797         final Class<Key<?>> identifier = optIdentifier.orElseThrow();
 798         final Map<QName, ValueContext> valueCtx = new HashMap<>();
 799         for (final ValueNodeCodecContext leaf : getLeafNodes(identifier, type.statement()).values()) {
 800             final QName name = leaf.getDomPathArgument().getNodeType();
 801             valueCtx.put(name, new ValueContext(identifier, leaf));
 802         }
 803         return IdentifiableItemCodec.of(type.statement(), identifier, listClz, valueCtx);
 804     }
 805
 806     @Override
 807     @SuppressWarnings("unchecked")
 808     public <E extends DataObject> CommonDataObjectCodecContext<E, ?> getStreamChild(final Class<E> childClass) {
 809         final var result = Notification.class.isAssignableFrom(childClass) ? getNotificationContext(childClass)
 810             : getOrRethrow(childrenByClass, childClass);
 811         return (CommonDataObjectCodecContext<E, ?>) result;
 812     }
 813
 814     @Override
 815     @SuppressWarnings("unchecked")
 816     public <A extends Augmentation<?>> BindingAugmentationCodecTreeNode<A> getAugmentationCodec(
 817             final InstanceIdentifier<A> path) {
 818         final var codecContext = getCodecContextNode(path, null);
 819         if (codecContext instanceof BindingAugmentationCodecTreeNode) {
 820             return (BindingAugmentationCodecTreeNode<A>) codecContext;
 821         }
 822         throw new IllegalArgumentException(path + " does not refer to an Augmentation");
 823     }
 824
 825     @Override
 826     @SuppressWarnings("unchecked")
 827     public <T extends DataObject> BindingDataObjectCodecTreeNode<T> getDataObjectCodec(
 828             final InstanceIdentifier<T> path) {
 829         final var codecContext = getCodecContextNode(path, null);
 830         if (codecContext instanceof BindingDataObjectCodecTreeNode) {
 831             return (BindingDataObjectCodecTreeNode<T>) codecContext;
 832         }
 833         throw new IllegalArgumentException(path + " does not refer to a plain DataObject");
 834     }
 835
 836     @Override
 837     @SuppressWarnings("unchecked")
 838     public <T extends DataObject> CodecWithPath<T> getSubtreeCodecWithPath(final InstanceIdentifier<T> path) {
 839         final var yangArgs = new ArrayList<PathArgument>();
 840         final var codecContext = getCodecContextNode(path, yangArgs);
 841
 842         // TODO Do we need defensive check here?
 843         return new CodecWithPath<>((CommonDataObjectCodecTreeNode<T>) codecContext,
 844             YangInstanceIdentifier.of(yangArgs));
 845     }
 846
 847     @Override
 848     @SuppressWarnings("unchecked")
 849     public <T extends DataObject> CommonDataObjectCodecTreeNode<T> getSubtreeCodec(final InstanceIdentifier<T> path) {
 850         // TODO Do we need defensive check here?
 851         return (CommonDataObjectCodecTreeNode<T>) getCodecContextNode(path, null);
 852     }
 853
 854     @Override
 855     public BindingCodecTreeNode getSubtreeCodec(final YangInstanceIdentifier path) {
 856         return getCodecContextNode(requireNonNull(path), null);
 857     }
 858
 859     @Override
 860     public BindingCodecTreeNode getSubtreeCodec(final Absolute path) {
 861         throw new UnsupportedOperationException("Not implemented yet.");
 862     }
 863
 864     @Override
 865     public YangInstanceIdentifier toYangInstanceIdentifier(final InstanceIdentifier<?> binding) {
 866         return instanceIdentifierCodec.fromBinding(binding);
 867     }
 868
 869     @Override
 870     public <T extends DataObject> InstanceIdentifier<T> fromYangInstanceIdentifier(final YangInstanceIdentifier dom) {
 871         return instanceIdentifierCodec.toBinding(dom);
 872     }
 873
 874     @Override
 875     public <A extends Augmentation<?>> AugmentationResult toNormalizedAugmentation(final InstanceIdentifier<A> path,
 876             final A data) {
 877         final var result = toNormalizedNode(path, data);
 878         if (result instanceof AugmentationResult augment) {
 879             return augment;
 880         }
 881         throw new IllegalArgumentException(path + " does not identify an Augmentation");
 882     }
 883
 884     @Override
 885     public <T extends DataObject> NodeResult toNormalizedDataObject(final InstanceIdentifier<T> path, final T data) {
 886         final var result = toNormalizedNode(path, data);
 887         if (result instanceof NodeResult node) {
 888             return node;
 889         }
 890         throw new IllegalArgumentException(path + " does not identify a plain DataObject");
 891     }
 892
 893     @Override
 894     public <T extends DataObject> NormalizedResult toNormalizedNode(final InstanceIdentifier<T> path, final T data) {
 895         // We create Binding Stream Writer which translates from Binding to Normalized Nodes
 896         final var yangArgs = new ArrayList<PathArgument>();
 897         final var codecContext = getCodecContextNode(path, yangArgs);
 898         final var yangPath = YangInstanceIdentifier.of(yangArgs);
 899
 900         // We create DOM stream writer which produces normalized nodes
 901         final var result = new NormalizationResultHolder();
 902         final var domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
 903         final var bindingWriter = new BindingToNormalizedStreamWriter(codecContext, domWriter);
 904         final var augment = codecContext instanceof BindingAugmentationCodecTreeNode<?> augmentNode ? augmentNode
 905             : null;
 906
 907         try {
 908             // Augmentations do not have a representation, so we are faking a ContainerNode as the parent and we will be
 909             // extracting the resulting children.
 910             if (augment != null) {
 911                 domWriter.startContainerNode(FAKE_NODEID, NormalizedNodeStreamWriter.UNKNOWN_SIZE);
 912             }
 913
 914             // We get serializer which reads binding data and uses Binding To Normalized Node writer to write result
 915             getSerializer(path.getTargetType()).serialize(data, bindingWriter);
 916
 917             if (augment != null) {
 918                 domWriter.endNode();
 919             }
 920         } catch (final IOException e) {
 921             LOG.error("Unexpected failure while serializing path {} data {}", path, data, e);
 922             throw new IllegalStateException("Failed to create normalized node", e);
 923         }
 924
 925         // Terminate the fake container and extract it to the result
 926         if (augment != null) {
 927             return new AugmentationResult(yangPath, augment.childPathArguments(),
 928                 ImmutableList.copyOf(((ContainerNode) result.getResult().data()).body()));
 929         }
 930         return new NodeResult(yangPath, result.getResult().data());
 931     }
 932
 933     @Override
 934     public Entry<InstanceIdentifier<?>, DataObject> fromNormalizedNode(final YangInstanceIdentifier path,
 935             final NormalizedNode data) {
 936         if (notBindingRepresentable(data)) {
 937             return null;
 938         }
 939
 940         final var builder = new ArrayList<InstanceIdentifier.PathArgument>();
 941         final var codec = getCodecContextNode(path, builder);
 942         if (codec == null) {
 943             if (data != null) {
 944                 LOG.warn("Path {} does not have a binding equivalent, should have been caught earlier ({})", path,
 945                     data.getClass());
 946             }
 947             return null;
 948         }
 949
 950         final DataObject lazyObj = codec.deserialize(data);
 951         final InstanceIdentifier<?> bindingPath = InstanceIdentifier.unsafeOf(builder);
 952         return Map.entry(bindingPath, lazyObj);
 953     }
 954
 955     @Override
 956     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data) {
 957         return getNotificationContext(path).deserialize(data);
 958     }
 959
 960     @Override
 961     public BaseNotification fromNormalizedNodeNotification(final Absolute path, final ContainerNode data,
 962             final Instant eventInstant) {
 963         return eventInstant == null ? fromNormalizedNodeNotification(path, data)
 964                 : getNotificationContext(path).deserialize(data, eventInstant);
 965     }
 966
 967     @Override
 968     public DataObject fromNormalizedNodeRpcData(final Absolute containerPath, final ContainerNode data) {
 969         return getRpcInputCodec(containerPath).deserialize(data);
 970     }
 971
 972     @Override
 973     public <T extends RpcInput> T fromNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
 974             final ContainerNode input) {
 975         return (T) requireNonNull(getActionCodec(action).input().deserialize(requireNonNull(input)));
 976     }
 977
 978     @Override
 979     public <T extends RpcOutput> T fromNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
 980             final ContainerNode output) {
 981         return (T) requireNonNull(getActionCodec(action).output().deserialize(requireNonNull(output)));
 982     }
 983
 984     @Override
 985     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
 986     public ContainerNode toNormalizedNodeNotification(final Notification<?> data) {
 987         // FIXME: Should the cast to DataObject be necessary?
 988         return serializeDataObject((DataObject) data,
 989             (ctx, iface, domWriter) -> ctx.newNotificationWriter(
 990                 (Class<? extends Notification<?>>) iface.asSubclass(Notification.class), domWriter));
 991     }
 992
 993     @Override
 994     public ContainerNode toNormalizedNodeNotification(final Absolute path, final BaseNotification data) {
 995         checkArgument(data instanceof DataObject, "Unexpected data %s", data);
 996         @SuppressWarnings("rawtypes")
 997         final NotificationCodecContext notifContext = getNotificationContext(path);
 998         @SuppressWarnings("unchecked")
 999         final var result = notifContext.serialize((DataObject) data);
1000         verify(result instanceof ContainerNode, "Unexpected result %s from %s", result, data);
1001         return (ContainerNode) result;
1002     }
1003
1004     @Override
1005     @SuppressFBWarnings("BC_UNCONFIRMED_CAST")
1006     public ContainerNode toNormalizedNodeRpcData(final DataContainer data) {
1007         // FIXME: Should the cast to DataObject be necessary?
1008         return serializeDataObject((DataObject) data, BindingNormalizedNodeWriterFactory::newRpcWriter);
1009     }
1010
1011     @Override
1012     public ContainerNode toNormalizedNodeActionInput(final Class<? extends Action<?, ?, ?>> action,
1013             final RpcInput input) {
1014         return serializeDataObject(input,(ctx, iface, domWriter) -> ctx.newActionInputWriter(action, domWriter));
1015     }
1016
1017     @Override
1018     public ContainerNode toNormalizedNodeActionOutput(final Class<? extends Action<?, ?, ?>> action,
1019             final RpcOutput output) {
1020         return serializeDataObject(output, (ctx, iface, domWriter) -> ctx.newActionOutputWriter(action, domWriter));
1021     }
1022
1023     @Override
1024     protected NodeIdentifier actionInputName(final Class<? extends Action<?, ?, ?>> action) {
1025         return verifyNotNull(getActionCodec(action).input().getDomPathArgument());
1026     }
1027
1028     @Override
1029     protected NodeIdentifier actionOutputName(final Class<? extends Action<?, ?, ?>> action) {
1030         return verifyNotNull(getActionCodec(action).output().getDomPathArgument());
1031     }
1032
1033     private <T extends DataContainer> @NonNull ContainerNode serializeDataObject(final DataObject data,
1034             final WriterFactoryMethod<T> newWriter) {
1035         final var result = new NormalizationResultHolder();
1036         // We create DOM stream writer which produces normalized nodes
1037         final var domWriter = ImmutableNormalizedNodeStreamWriter.from(result);
1038         final Class<? extends DataObject> type = data.implementedInterface();
1039         @SuppressWarnings("unchecked")
1040         final BindingStreamEventWriter writer = newWriter.createWriter(this, (Class<T>) type, domWriter);
1041         try {
1042             getSerializer(type).serialize(data, writer);
1043         } catch (final IOException e) {
1044             LOG.error("Unexpected failure while serializing data {}", data, e);
1045             throw new IllegalStateException("Failed to create normalized node", e);
1046         }
1047         return (ContainerNode) result.getResult().data();
1048     }
1049
1050     private static boolean notBindingRepresentable(final NormalizedNode data) {
1051         // ValueNode covers LeafNode and LeafSetEntryNode
1052         return data instanceof ValueNode
1053             || data instanceof MapNode || data instanceof UnkeyedListNode
1054             || data instanceof ChoiceNode
1055             || data instanceof LeafSetNode;
1056     }
1057
1058     private static <K,V> V getOrRethrow(final LoadingCache<K, V> cache, final K key) {
1059         try {
1060             return cache.getUnchecked(key);
1061         } catch (UncheckedExecutionException e) {
1062             final var cause = e.getCause();
1063             if (cause != null) {
1064                 Throwables.throwIfUnchecked(cause);
1065             }
1066             throw e;
1067         }
1068     }
1069
1070     @SuppressWarnings("rawtypes")
1071     private static Class<? extends OpaqueObject> opaqueReturnType(final Method method) {
1072         final Class<?> valueType = method.getReturnType();
1073         verify(OpaqueObject.class.isAssignableFrom(valueType), "Illegal value type %s", valueType);
1074         return valueType.asSubclass(OpaqueObject.class);
1075     }
1076
1077     @FunctionalInterface
1078     private interface WriterFactoryMethod<T extends DataContainer> {
1079         BindingStreamEventWriter createWriter(@NonNull BindingNormalizedNodeWriterFactory factory,
1080                 @NonNull Class<? extends T> bindingClass, @NonNull NormalizedNodeStreamWriter domWriter);
1081     }
1082 }