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