restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/transactions/RestconfStrategy.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.restconf.nb.rfc8040.rests.transactions;
   9
  10 import static com.google.common.base.Verify.verifyNotNull;
  11 import static java.util.Objects.requireNonNull;
  12 import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.fromInstanceId;
  13
  14 import com.google.common.annotations.VisibleForTesting;
  15 import com.google.common.collect.ImmutableMap;
  16 import com.google.common.io.CharSource;
  17 import com.google.common.util.concurrent.FutureCallback;
  18 import com.google.common.util.concurrent.Futures;
  19 import com.google.common.util.concurrent.ListenableFuture;
  20 import com.google.common.util.concurrent.MoreExecutors;
  21 import java.io.IOException;
  22 import java.net.URI;
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.NoSuchElementException;
  28 import java.util.Optional;
  29 import java.util.concurrent.CancellationException;
  30 import java.util.function.BiFunction;
  31 import java.util.function.Function;
  32 import java.util.stream.Collectors;
  33 import org.eclipse.jdt.annotation.NonNull;
  34 import org.eclipse.jdt.annotation.NonNullByDefault;
  35 import org.eclipse.jdt.annotation.Nullable;
  36 import org.opendaylight.mdsal.common.api.CommitInfo;
  37 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  38 import org.opendaylight.mdsal.dom.api.DOMActionException;
  39 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  40 import org.opendaylight.mdsal.dom.api.DOMActionService;
  41 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
  42 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  43 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
  44 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
  45 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  46 import org.opendaylight.mdsal.dom.api.DOMRpcService;
  47 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
  48 import org.opendaylight.mdsal.dom.api.DOMSchemaService.YangTextSourceExtension;
  49 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
  50 import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
  51 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
  52 import org.opendaylight.restconf.api.ApiPath;
  53 import org.opendaylight.restconf.api.FormattableBody;
  54 import org.opendaylight.restconf.api.query.ContentParam;
  55 import org.opendaylight.restconf.api.query.WithDefaultsParam;
  56 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
  57 import org.opendaylight.restconf.common.errors.RestconfError;
  58 import org.opendaylight.restconf.common.errors.RestconfFuture;
  59 import org.opendaylight.restconf.common.errors.SettableRestconfFuture;
  60 import org.opendaylight.restconf.common.patch.PatchContext;
  61 import org.opendaylight.restconf.nb.rfc8040.Insert;
  62 import org.opendaylight.restconf.nb.rfc8040.legacy.ErrorTags;
  63 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
  64 import org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters;
  65 import org.opendaylight.restconf.server.api.ChildBody;
  66 import org.opendaylight.restconf.server.api.ConfigurationMetadata;
  67 import org.opendaylight.restconf.server.api.CreateResourceResult;
  68 import org.opendaylight.restconf.server.api.DataGetParams;
  69 import org.opendaylight.restconf.server.api.DataGetResult;
  70 import org.opendaylight.restconf.server.api.DataPatchResult;
  71 import org.opendaylight.restconf.server.api.DataPostBody;
  72 import org.opendaylight.restconf.server.api.DataPostResult;
  73 import org.opendaylight.restconf.server.api.DataPutResult;
  74 import org.opendaylight.restconf.server.api.DataYangPatchResult;
  75 import org.opendaylight.restconf.server.api.DatabindContext;
  76 import org.opendaylight.restconf.server.api.DatabindPath;
  77 import org.opendaylight.restconf.server.api.DatabindPath.Action;
  78 import org.opendaylight.restconf.server.api.DatabindPath.Data;
  79 import org.opendaylight.restconf.server.api.DatabindPath.InstanceReference;
  80 import org.opendaylight.restconf.server.api.DatabindPath.OperationPath;
  81 import org.opendaylight.restconf.server.api.DatabindPath.Rpc;
  82 import org.opendaylight.restconf.server.api.InvokeParams;
  83 import org.opendaylight.restconf.server.api.InvokeResult;
  84 import org.opendaylight.restconf.server.api.OperationInputBody;
  85 import org.opendaylight.restconf.server.api.PatchBody;
  86 import org.opendaylight.restconf.server.api.PatchStatusContext;
  87 import org.opendaylight.restconf.server.api.PatchStatusEntity;
  88 import org.opendaylight.restconf.server.api.ResourceBody;
  89 import org.opendaylight.restconf.server.spi.ApiPathCanonizer;
  90 import org.opendaylight.restconf.server.spi.ApiPathNormalizer;
  91 import org.opendaylight.restconf.server.spi.DefaultResourceContext;
  92 import org.opendaylight.restconf.server.spi.OperationInput;
  93 import org.opendaylight.restconf.server.spi.OperationOutputBody;
  94 import org.opendaylight.restconf.server.spi.OperationsResource;
  95 import org.opendaylight.restconf.server.spi.RpcImplementation;
  96 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.with.defaults.rev110601.WithDefaultsMode;
  97 import org.opendaylight.yangtools.yang.common.Empty;
  98 import org.opendaylight.yangtools.yang.common.ErrorTag;
  99 import org.opendaylight.yangtools.yang.common.ErrorType;
 100 import org.opendaylight.yangtools.yang.common.QName;
 101 import org.opendaylight.yangtools.yang.common.QNameModule;
 102 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
 103 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
 104 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
 105 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
 106 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
 107 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
 108 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
 109 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
 110 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
 111 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
 112 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
 113 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
 114 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
 115 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
 116 import org.opendaylight.yangtools.yang.data.api.schema.SystemLeafSetNode;
 117 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
 118 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
 119 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
 120 import org.opendaylight.yangtools.yang.data.api.schema.UserLeafSetNode;
 121 import org.opendaylight.yangtools.yang.data.api.schema.UserMapNode;
 122 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
 123 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
 124 import org.opendaylight.yangtools.yang.data.api.schema.builder.NormalizedNodeContainerBuilder;
 125 import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
 126 import org.opendaylight.yangtools.yang.data.util.DataSchemaContext;
 127 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
 128 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
 129 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
 130 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
 131 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
 132 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
 133 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
 134 import org.opendaylight.yangtools.yang.model.api.source.SourceRepresentation;
 135 import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
 136 import org.opendaylight.yangtools.yang.model.api.source.YinTextSource;
 137 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
 138 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
 139 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
 140 import org.slf4j.Logger;
 141 import org.slf4j.LoggerFactory;
 142
 143 /**
 144  * Baseline execution strategy for various RESTCONF operations.
 145  *
 146  * @see NetconfRestconfStrategy
 147  * @see MdsalRestconfStrategy
 148  */
 149 // FIXME: it seems the first three operations deal with lifecycle of a transaction, while others invoke various
 150 //        operations. This should be handled through proper allocation indirection.
 151 public abstract class RestconfStrategy {
 152     @NonNullByDefault
 153     public record StrategyAndPath(RestconfStrategy strategy, Data path) {
 154         public StrategyAndPath {
 155             requireNonNull(strategy);
 156             requireNonNull(path);
 157         }
 158     }
 159
 160     /**
 161      * Result of a partial {@link ApiPath} lookup for the purposes of supporting {@code yang-ext:mount}-delimited mount
 162      * points with possible nesting.
 163      *
 164      * @param strategy the strategy to use
 165      * @param tail the {@link ApiPath} tail to use with the strategy
 166      */
 167     @NonNullByDefault
 168     public record StrategyAndTail(RestconfStrategy strategy, ApiPath tail) {
 169         public StrategyAndTail {
 170             requireNonNull(strategy);
 171             requireNonNull(tail);
 172         }
 173     }
 174
 175     private static final Logger LOG = LoggerFactory.getLogger(RestconfStrategy.class);
 176     private static final @NonNull DataPutResult PUT_CREATED = new DataPutResult(true);
 177     private static final @NonNull DataPutResult PUT_REPLACED = new DataPutResult(false);
 178     private static final @NonNull DataPatchResult PATCH_EMPTY = new DataPatchResult();
 179
 180     private final @NonNull ImmutableMap<QName, RpcImplementation> localRpcs;
 181     private final @NonNull ApiPathNormalizer pathNormalizer;
 182     private final @NonNull DatabindContext databind;
 183     private final YangTextSourceExtension sourceProvider;
 184     private final DOMMountPointService mountPointService;
 185     private final DOMActionService actionService;
 186     private final DOMRpcService rpcService;
 187     private final OperationsResource operations;
 188
 189     RestconfStrategy(final DatabindContext databind, final ImmutableMap<QName, RpcImplementation> localRpcs,
 190             final @Nullable DOMRpcService rpcService, final @Nullable DOMActionService actionService,
 191             final YangTextSourceExtension sourceProvider, final @Nullable DOMMountPointService mountPointService) {
 192         this.databind = requireNonNull(databind);
 193         this.localRpcs = requireNonNull(localRpcs);
 194         this.rpcService = rpcService;
 195         this.actionService = actionService;
 196         this.sourceProvider = sourceProvider;
 197         this.mountPointService = mountPointService;
 198         pathNormalizer = new ApiPathNormalizer(databind);
 199         operations = new OperationsResource(pathNormalizer);
 200     }
 201
 202     public final @NonNull StrategyAndPath resolveStrategyPath(final ApiPath path) {
 203         final var andTail = resolveStrategy(path);
 204         final var strategy = andTail.strategy();
 205         return new StrategyAndPath(strategy, strategy.pathNormalizer.normalizeDataPath(andTail.tail()));
 206     }
 207
 208     /**
 209      * Resolve any and all {@code yang-ext:mount} to the target {@link StrategyAndTail}.
 210      *
 211      * @param path {@link ApiPath} to resolve
 212      * @return A strategy and the remaining path
 213      * @throws NullPointerException if {@code path} is {@code null}
 214      */
 215     public final @NonNull StrategyAndTail resolveStrategy(final ApiPath path) {
 216         var mount = path.indexOf("yang-ext", "mount");
 217         if (mount == -1) {
 218             return new StrategyAndTail(this, path);
 219         }
 220         if (mountPointService == null) {
 221             throw new RestconfDocumentedException("Mount point service is not available",
 222                 ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
 223         }
 224         final var mountPath = path.subPath(0, mount);
 225         final var dataPath = pathNormalizer.normalizeDataPath(path.subPath(0, mount));
 226         final var mountPoint = mountPointService.getMountPoint(dataPath.instance())
 227             .orElseThrow(() -> new RestconfDocumentedException("Mount point '" + mountPath + "' does not exist",
 228                 ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT));
 229
 230         return createStrategy(mountPath, mountPoint).resolveStrategy(path.subPath(mount + 1));
 231     }
 232
 233     private static @NonNull RestconfStrategy createStrategy(final ApiPath mountPath, final DOMMountPoint mountPoint) {
 234         final var mountSchemaService = mountPoint.getService(DOMSchemaService.class)
 235             .orElseThrow(() -> new RestconfDocumentedException(
 236                 "Mount point '" + mountPath + "' does not expose DOMSchemaService",
 237                 ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT));
 238         final var mountModelContext = mountSchemaService.getGlobalContext();
 239         if (mountModelContext == null) {
 240             throw new RestconfDocumentedException("Mount point '" + mountPath + "' does not have any models",
 241                 ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT);
 242         }
 243         final var mountDatabind = DatabindContext.ofModel(mountModelContext);
 244         final var mountPointService = mountPoint.getService(DOMMountPointService.class).orElse(null);
 245         final var rpcService = mountPoint.getService(DOMRpcService.class).orElse(null);
 246         final var actionService = mountPoint.getService(DOMActionService.class).orElse(null);
 247         final var sourceProvider = mountPoint.getService(DOMSchemaService.class)
 248             .flatMap(schema -> Optional.ofNullable(schema.extension(YangTextSourceExtension.class)))
 249             .orElse(null);
 250
 251         final var netconfService = mountPoint.getService(NetconfDataTreeService.class);
 252         if (netconfService.isPresent()) {
 253             return new NetconfRestconfStrategy(mountDatabind, netconfService.orElseThrow(), rpcService, actionService,
 254                 sourceProvider, mountPointService);
 255         }
 256         final var dataBroker = mountPoint.getService(DOMDataBroker.class);
 257         if (dataBroker.isPresent()) {
 258             return new MdsalRestconfStrategy(mountDatabind, dataBroker.orElseThrow(), rpcService, actionService,
 259                 sourceProvider, mountPointService);
 260         }
 261         LOG.warn("Mount point {} does not expose a suitable access interface", mountPath);
 262         throw new RestconfDocumentedException("Could not find a supported access interface in mount point",
 263             ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, mountPoint.getIdentifier());
 264     }
 265
 266     public final @NonNull DatabindContext databind() {
 267         return databind;
 268     }
 269
 270     public final @NonNull EffectiveModelContext modelContext() {
 271         return databind.modelContext();
 272     }
 273
 274     /**
 275      * Lock the entire datastore.
 276      *
 277      * @return A {@link RestconfTransaction}. This transaction needs to be either committed or canceled before doing
 278      *         anything else.
 279      */
 280     abstract RestconfTransaction prepareWriteExecution();
 281
 282     /**
 283      * Read data from the datastore.
 284      *
 285      * @param store the logical data store which should be modified
 286      * @param path the data object path
 287      * @return a ListenableFuture containing the result of the read
 288      */
 289     abstract ListenableFuture<Optional<NormalizedNode>> read(LogicalDatastoreType store, YangInstanceIdentifier path);
 290
 291     /**
 292      * Check if data already exists in the configuration datastore.
 293      *
 294      * @param path the data object path
 295      * @return a ListenableFuture containing the result of the check
 296      */
 297     // FIXME: this method should be hosted in RestconfTransaction
 298     // FIXME: this method should only be needed in MdsalRestconfStrategy
 299     abstract ListenableFuture<Boolean> exists(YangInstanceIdentifier path);
 300
 301     @VisibleForTesting
 302     final @NonNull RestconfFuture<DataPatchResult> merge(final YangInstanceIdentifier path, final NormalizedNode data) {
 303         final var ret = new SettableRestconfFuture<DataPatchResult>();
 304         merge(ret, requireNonNull(path), requireNonNull(data));
 305         return ret;
 306     }
 307
 308     private void merge(final @NonNull SettableRestconfFuture<DataPatchResult> future,
 309             final @NonNull YangInstanceIdentifier path, final @NonNull NormalizedNode data) {
 310         final var tx = prepareWriteExecution();
 311         // FIXME: this method should be further specialized to eliminate this call -- it is only needed for MD-SAL
 312         tx.ensureParentsByMerge(path);
 313         tx.merge(path, data);
 314         Futures.addCallback(tx.commit(), new FutureCallback<CommitInfo>() {
 315             @Override
 316             public void onSuccess(final CommitInfo result) {
 317                 // TODO: extract details once CommitInfo can communicate them
 318                 future.set(PATCH_EMPTY);
 319             }
 320
 321             @Override
 322             public void onFailure(final Throwable cause) {
 323                 future.setFailure(TransactionUtil.decodeException(cause, "MERGE", path, modelContext()));
 324             }
 325         }, MoreExecutors.directExecutor());
 326     }
 327
 328     public @NonNull RestconfFuture<DataPutResult> dataPUT(final ApiPath apiPath, final ResourceBody body,
 329             final Map<String, String> queryParameters) {
 330         final Data path;
 331         try {
 332             path = pathNormalizer.normalizeDataPath(apiPath);
 333         } catch (RestconfDocumentedException e) {
 334             return RestconfFuture.failed(e);
 335         }
 336
 337         final Insert insert;
 338         try {
 339             insert = Insert.ofQueryParameters(databind, queryParameters);
 340         } catch (IllegalArgumentException e) {
 341             return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
 342                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
 343         }
 344         final NormalizedNode data;
 345         try {
 346             data = body.toNormalizedNode(path);
 347         } catch (RestconfDocumentedException e) {
 348             return RestconfFuture.failed(e);
 349         }
 350         return putData(path.instance(), data, insert);
 351     }
 352
 353     /**
 354      * Check mount point and prepare variables for put data to DS.
 355      *
 356      * @param path    path of data
 357      * @param data    data
 358      * @param insert  {@link Insert}
 359      * @return A {@link DataPutResult}
 360      */
 361     public final @NonNull RestconfFuture<DataPutResult> putData(final YangInstanceIdentifier path,
 362             final NormalizedNode data, final @Nullable Insert insert) {
 363         final var exists = TransactionUtil.syncAccess(exists(path), path);
 364
 365         final ListenableFuture<? extends CommitInfo> commitFuture;
 366         if (insert != null) {
 367             final var parentPath = path.coerceParent();
 368             checkListAndOrderedType(parentPath);
 369             commitFuture = insertAndCommitPut(path, data, insert, parentPath);
 370         } else {
 371             commitFuture = replaceAndCommit(prepareWriteExecution(), path, data);
 372         }
 373
 374         final var ret = new SettableRestconfFuture<DataPutResult>();
 375
 376         Futures.addCallback(commitFuture, new FutureCallback<CommitInfo>() {
 377             @Override
 378             public void onSuccess(final CommitInfo result) {
 379                 ret.set(exists ? PUT_REPLACED : PUT_CREATED);
 380             }
 381
 382             @Override
 383             public void onFailure(final Throwable cause) {
 384                 ret.setFailure(TransactionUtil.decodeException(cause, "PUT", path, modelContext()));
 385             }
 386         }, MoreExecutors.directExecutor());
 387
 388         return ret;
 389     }
 390
 391     private ListenableFuture<? extends CommitInfo> insertAndCommitPut(final YangInstanceIdentifier path,
 392             final NormalizedNode data, final @NonNull Insert insert, final YangInstanceIdentifier parentPath) {
 393         final var tx = prepareWriteExecution();
 394
 395         return switch (insert.insert()) {
 396             case FIRST -> {
 397                 final var readData = tx.readList(parentPath);
 398                 if (readData == null || readData.isEmpty()) {
 399                     yield replaceAndCommit(tx, path, data);
 400                 }
 401                 tx.remove(parentPath);
 402                 tx.replace(path, data);
 403                 tx.replace(parentPath, readData);
 404                 yield tx.commit();
 405             }
 406             case LAST -> replaceAndCommit(tx, path, data);
 407             case BEFORE -> {
 408                 final var readData = tx.readList(parentPath);
 409                 if (readData == null || readData.isEmpty()) {
 410                     yield replaceAndCommit(tx, path, data);
 411                 }
 412                 insertWithPointPut(tx, path, data, verifyNotNull(insert.pointArg()), readData, true);
 413                 yield tx.commit();
 414             }
 415             case AFTER -> {
 416                 final var readData = tx.readList(parentPath);
 417                 if (readData == null || readData.isEmpty()) {
 418                     yield replaceAndCommit(tx, path, data);
 419                 }
 420                 insertWithPointPut(tx, path, data, verifyNotNull(insert.pointArg()), readData, false);
 421                 yield tx.commit();
 422             }
 423         };
 424     }
 425
 426     private void insertWithPointPut(final RestconfTransaction tx, final YangInstanceIdentifier path,
 427             final NormalizedNode data, final @NonNull PathArgument pointArg, final NormalizedNodeContainer<?> readList,
 428             final boolean before) {
 429         tx.remove(path.getParent());
 430
 431         int lastItemPosition = 0;
 432         for (var nodeChild : readList.body()) {
 433             if (nodeChild.name().equals(pointArg)) {
 434                 break;
 435             }
 436             lastItemPosition++;
 437         }
 438         if (!before) {
 439             lastItemPosition++;
 440         }
 441
 442         int lastInsertedPosition = 0;
 443         final var emptySubtree = fromInstanceId(modelContext(), path.getParent());
 444         tx.merge(YangInstanceIdentifier.of(emptySubtree.name()), emptySubtree);
 445         for (var nodeChild : readList.body()) {
 446             if (lastInsertedPosition == lastItemPosition) {
 447                 tx.replace(path, data);
 448             }
 449             final var childPath = path.coerceParent().node(nodeChild.name());
 450             tx.replace(childPath, nodeChild);
 451             lastInsertedPosition++;
 452         }
 453
 454         // In case we are inserting after last element
 455         if (!before) {
 456             if (lastInsertedPosition == lastItemPosition) {
 457                 tx.replace(path, data);
 458             }
 459         }
 460     }
 461
 462     private static ListenableFuture<? extends CommitInfo> replaceAndCommit(final RestconfTransaction tx,
 463             final YangInstanceIdentifier path, final NormalizedNode data) {
 464         tx.replace(path, data);
 465         return tx.commit();
 466     }
 467
 468     private DataSchemaNode checkListAndOrderedType(final YangInstanceIdentifier path) {
 469         // FIXME: we have this available in InstanceIdentifierContext
 470         final var dataSchemaNode = databind.schemaTree().findChild(path).orElseThrow().dataSchemaNode();
 471
 472         final String message;
 473         if (dataSchemaNode instanceof ListSchemaNode listSchema) {
 474             if (listSchema.isUserOrdered()) {
 475                 return listSchema;
 476             }
 477             message = "Insert parameter can be used only with ordered-by user list.";
 478         } else if (dataSchemaNode instanceof LeafListSchemaNode leafListSchema) {
 479             if (leafListSchema.isUserOrdered()) {
 480                 return leafListSchema;
 481             }
 482             message = "Insert parameter can be used only with ordered-by user leaf-list.";
 483         } else {
 484             message = "Insert parameter can be used only with list or leaf-list";
 485         }
 486         throw new RestconfDocumentedException(message, ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
 487     }
 488
 489     /**
 490      * Check mount point and prepare variables for post data.
 491      *
 492      * @param path    path
 493      * @param data    data
 494      * @param insert  {@link Insert}
 495      * @return A {@link RestconfFuture}
 496      */
 497     public final @NonNull RestconfFuture<CreateResourceResult> postData(final YangInstanceIdentifier path,
 498             final NormalizedNode data, final @Nullable Insert insert) {
 499         final ListenableFuture<? extends CommitInfo> future;
 500         if (insert != null) {
 501             checkListAndOrderedType(path);
 502             future = insertAndCommitPost(path, data, insert);
 503         } else {
 504             future = createAndCommit(prepareWriteExecution(), path, data);
 505         }
 506
 507         final var ret = new SettableRestconfFuture<CreateResourceResult>();
 508         Futures.addCallback(future, new FutureCallback<CommitInfo>() {
 509             @Override
 510             public void onSuccess(final CommitInfo result) {
 511                 ret.set(new CreateResourceResult(new ApiPathCanonizer(databind).dataToApiPath(
 512                     data instanceof MapNode mapData && !mapData.isEmpty()
 513                         ? path.node(mapData.body().iterator().next().name()) : path)));
 514             }
 515
 516             @Override
 517             public void onFailure(final Throwable cause) {
 518                 ret.setFailure(TransactionUtil.decodeException(cause, "POST", path, modelContext()));
 519             }
 520
 521         }, MoreExecutors.directExecutor());
 522         return ret;
 523     }
 524
 525     private ListenableFuture<? extends CommitInfo> insertAndCommitPost(final YangInstanceIdentifier path,
 526             final NormalizedNode data, final @NonNull Insert insert) {
 527         final var tx = prepareWriteExecution();
 528
 529         return switch (insert.insert()) {
 530             case FIRST -> {
 531                 final var readData = tx.readList(path);
 532                 if (readData == null || readData.isEmpty()) {
 533                     tx.replace(path, data);
 534                 } else {
 535                     checkListDataDoesNotExist(path, data);
 536                     tx.remove(path);
 537                     tx.replace(path, data);
 538                     tx.replace(path, readData);
 539                 }
 540                 yield tx.commit();
 541             }
 542             case LAST -> createAndCommit(tx, path, data);
 543             case BEFORE -> {
 544                 final var readData = tx.readList(path);
 545                 if (readData == null || readData.isEmpty()) {
 546                     tx.replace(path, data);
 547                 } else {
 548                     checkListDataDoesNotExist(path, data);
 549                     insertWithPointPost(tx, path, data, verifyNotNull(insert.pointArg()), readData, true);
 550                 }
 551                 yield tx.commit();
 552             }
 553             case AFTER -> {
 554                 final var readData = tx.readList(path);
 555                 if (readData == null || readData.isEmpty()) {
 556                     tx.replace(path, data);
 557                 } else {
 558                     checkListDataDoesNotExist(path, data);
 559                     insertWithPointPost(tx, path, data, verifyNotNull(insert.pointArg()), readData, false);
 560                 }
 561                 yield tx.commit();
 562             }
 563         };
 564     }
 565
 566     /**
 567      * Merge data into the configuration datastore, as outlined in
 568      * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040 section 4.6.1</a>.
 569      *
 570      * @param apiPath Path to merge
 571      * @param body Data to merge
 572      * @return A {@link RestconfFuture}
 573      * @throws NullPointerException if any argument is {@code null}
 574      */
 575     public final @NonNull RestconfFuture<DataPatchResult> dataPATCH(final ApiPath apiPath, final ResourceBody body) {
 576         final Data path;
 577         try {
 578             path = pathNormalizer.normalizeDataPath(apiPath);
 579         } catch (RestconfDocumentedException e) {
 580             return RestconfFuture.failed(e);
 581         }
 582
 583         final NormalizedNode data;
 584         try {
 585             data = body.toNormalizedNode(path);
 586         } catch (RestconfDocumentedException e) {
 587             return RestconfFuture.failed(e);
 588         }
 589
 590         return merge(path.instance(), data);
 591     }
 592
 593     public final @NonNull RestconfFuture<DataYangPatchResult> dataPATCH(final ApiPath apiPath,
 594             final Map<String, String> queryParameters, final PatchBody body) {
 595         final Data path;
 596         try {
 597             path = pathNormalizer.normalizeDataPath(apiPath);
 598         } catch (RestconfDocumentedException e) {
 599             return RestconfFuture.failed(e);
 600         }
 601
 602         final PatchContext patch;
 603         try {
 604             patch = body.toPatchContext(new DefaultResourceContext(path));
 605         } catch (IOException e) {
 606             LOG.debug("Error parsing YANG Patch input", e);
 607             return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
 608                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
 609         }
 610         return patchData(patch);
 611     }
 612
 613     /**
 614      * Process edit operations of one {@link PatchContext}.
 615      *
 616      * @param patch Patch context to be processed
 617      * @return {@link PatchStatusContext}
 618      */
 619     public final @NonNull RestconfFuture<DataYangPatchResult> patchData(final PatchContext patch) {
 620         final var editCollection = new ArrayList<PatchStatusEntity>();
 621         final var tx = prepareWriteExecution();
 622
 623         boolean noError = true;
 624         for (var patchEntity : patch.entities()) {
 625             if (noError) {
 626                 final var targetNode = patchEntity.getTargetNode();
 627                 final var editId = patchEntity.getEditId();
 628
 629                 switch (patchEntity.getOperation()) {
 630                     case Create:
 631                         try {
 632                             tx.create(targetNode, patchEntity.getNode());
 633                             editCollection.add(new PatchStatusEntity(editId, true, null));
 634                         } catch (RestconfDocumentedException e) {
 635                             editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
 636                             noError = false;
 637                         }
 638                         break;
 639                     case Delete:
 640                         try {
 641                             tx.delete(targetNode);
 642                             editCollection.add(new PatchStatusEntity(editId, true, null));
 643                         } catch (RestconfDocumentedException e) {
 644                             editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
 645                             noError = false;
 646                         }
 647                         break;
 648                     case Merge:
 649                         try {
 650                             tx.ensureParentsByMerge(targetNode);
 651                             tx.merge(targetNode, patchEntity.getNode());
 652                             editCollection.add(new PatchStatusEntity(editId, true, null));
 653                         } catch (RestconfDocumentedException e) {
 654                             editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
 655                             noError = false;
 656                         }
 657                         break;
 658                     case Replace:
 659                         try {
 660                             tx.replace(targetNode, patchEntity.getNode());
 661                             editCollection.add(new PatchStatusEntity(editId, true, null));
 662                         } catch (RestconfDocumentedException e) {
 663                             editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
 664                             noError = false;
 665                         }
 666                         break;
 667                     case Remove:
 668                         try {
 669                             tx.remove(targetNode);
 670                             editCollection.add(new PatchStatusEntity(editId, true, null));
 671                         } catch (RestconfDocumentedException e) {
 672                             editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
 673                             noError = false;
 674                         }
 675                         break;
 676                     default:
 677                         editCollection.add(new PatchStatusEntity(editId, false, List.of(
 678                             new RestconfError(ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED,
 679                                 "Not supported Yang Patch operation"))));
 680                         noError = false;
 681                         break;
 682                 }
 683             } else {
 684                 break;
 685             }
 686         }
 687
 688         final var ret = new SettableRestconfFuture<DataYangPatchResult>();
 689         // We have errors
 690         if (!noError) {
 691             tx.cancel();
 692             ret.set(new DataYangPatchResult(
 693                 new PatchStatusContext(databind(), patch.patchId(), List.copyOf(editCollection), false, null)));
 694             return ret;
 695         }
 696
 697         Futures.addCallback(tx.commit(), new FutureCallback<CommitInfo>() {
 698             @Override
 699             public void onSuccess(final CommitInfo result) {
 700                 ret.set(new DataYangPatchResult(
 701                     new PatchStatusContext(databind(), patch.patchId(), List.copyOf(editCollection), true, null)));
 702             }
 703
 704             @Override
 705             public void onFailure(final Throwable cause) {
 706                 // if errors occurred during transaction commit then patch failed and global errors are reported
 707                 ret.set(new DataYangPatchResult(
 708                     new PatchStatusContext(databind(), patch.patchId(), List.copyOf(editCollection), false,
 709                         TransactionUtil.decodeException(cause, "PATCH", null, modelContext()).getErrors())));
 710             }
 711         }, MoreExecutors.directExecutor());
 712
 713         return ret;
 714     }
 715
 716     private static void insertWithPointPost(final RestconfTransaction tx, final YangInstanceIdentifier path,
 717             final NormalizedNode data, final PathArgument pointArg, final NormalizedNodeContainer<?> readList,
 718             final boolean before) {
 719         tx.remove(path);
 720
 721         int lastItemPosition = 0;
 722         for (var nodeChild : readList.body()) {
 723             if (nodeChild.name().equals(pointArg)) {
 724                 break;
 725             }
 726             lastItemPosition++;
 727         }
 728         if (!before) {
 729             lastItemPosition++;
 730         }
 731
 732         int lastInsertedPosition = 0;
 733         for (var nodeChild : readList.body()) {
 734             if (lastInsertedPosition == lastItemPosition) {
 735                 tx.replace(path, data);
 736             }
 737             tx.replace(path.node(nodeChild.name()), nodeChild);
 738             lastInsertedPosition++;
 739         }
 740
 741         // In case we are inserting after last element
 742         if (!before) {
 743             if (lastInsertedPosition == lastItemPosition) {
 744                 tx.replace(path, data);
 745             }
 746         }
 747     }
 748
 749     private static ListenableFuture<? extends CommitInfo> createAndCommit(final RestconfTransaction tx,
 750             final YangInstanceIdentifier path, final NormalizedNode data) {
 751         try {
 752             tx.create(path, data);
 753         } catch (RestconfDocumentedException e) {
 754             // close transaction if any and pass exception further
 755             tx.cancel();
 756             throw e;
 757         }
 758
 759         return tx.commit();
 760     }
 761
 762     /**
 763      * Check if child items do NOT already exists in List at specified {@code path}.
 764      *
 765      * @param data Data to be checked
 766      * @param path Path to be checked
 767      * @throws RestconfDocumentedException if data already exists.
 768      */
 769     private void checkListDataDoesNotExist(final YangInstanceIdentifier path, final NormalizedNode data) {
 770         if (data instanceof NormalizedNodeContainer<?> dataNode) {
 771             for (final var node : dataNode.body()) {
 772                 checkItemDoesNotExists(exists(path.node(node.name())), path.node(node.name()));
 773             }
 774         } else {
 775             throw new RestconfDocumentedException("Unexpected node type: " + data.getClass().getName());
 776         }
 777     }
 778
 779     /**
 780      * Check if items do NOT already exists at specified {@code path}.
 781      *
 782      * @param existsFuture if checked data exists
 783      * @param path         Path to be checked
 784      * @throws RestconfDocumentedException if data already exists.
 785      */
 786     static void checkItemDoesNotExists(final ListenableFuture<Boolean> existsFuture,
 787             final YangInstanceIdentifier path) {
 788         if (TransactionUtil.syncAccess(existsFuture, path)) {
 789             LOG.trace("Operation via Restconf was not executed because data at {} already exists", path);
 790             throw new RestconfDocumentedException("Data already exists", ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS,
 791                 path);
 792         }
 793     }
 794
 795     /**
 796      * Delete data from the configuration datastore. If the data does not exist, this operation will fail, as outlined
 797      * in <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.7">RFC8040 section 4.7</a>
 798      *
 799      * @param apiPath Path to delete
 800      * @return A {@link RestconfFuture}
 801      * @throws NullPointerException if {@code apiPath} is {@code null}
 802      */
 803     @SuppressWarnings("checkstyle:abbreviationAsWordInName")
 804     public final @NonNull RestconfFuture<Empty> dataDELETE(final ApiPath apiPath) {
 805         final Data path;
 806         try {
 807             path = pathNormalizer.normalizeDataPath(apiPath);
 808         } catch (RestconfDocumentedException e) {
 809             return RestconfFuture.failed(e);
 810         }
 811
 812         // FIXME: reject empty YangInstanceIdentifier, as datastores may not be deleted
 813         final var ret = new SettableRestconfFuture<Empty>();
 814         delete(ret, path.instance());
 815         return ret;
 816     }
 817
 818     abstract void delete(@NonNull SettableRestconfFuture<Empty> future, @NonNull YangInstanceIdentifier path);
 819
 820     public final @NonNull RestconfFuture<DataGetResult> dataGET(final ApiPath apiPath,
 821             final DataGetParams params) {
 822         final Data path;
 823         try {
 824             path = pathNormalizer.normalizeDataPath(apiPath);
 825         } catch (RestconfDocumentedException e) {
 826             return RestconfFuture.failed(e);
 827         }
 828         return dataGET(path, params);
 829     }
 830
 831     abstract @NonNull RestconfFuture<DataGetResult> dataGET(Data path, DataGetParams params);
 832
 833     static final @NonNull RestconfFuture<DataGetResult> completeDataGET(final Inference inference,
 834             final QueryParameters queryParams, final @Nullable NormalizedNode node,
 835             final @Nullable ConfigurationMetadata metadata) {
 836         if (node == null) {
 837             return RestconfFuture.failed(new RestconfDocumentedException(
 838                 "Request could not be completed because the relevant data model content does not exist",
 839                 ErrorType.PROTOCOL, ErrorTag.DATA_MISSING));
 840         }
 841
 842         final var payload = new NormalizedNodePayload(inference, node, queryParams);
 843         return RestconfFuture.of(metadata == null ? new DataGetResult(payload)
 844             : new DataGetResult(payload, metadata.entityTag(), metadata.lastModified()));
 845     }
 846
 847     /**
 848      * Read specific type of data from data store via transaction. Close {@link DOMTransactionChain} if any
 849      * inside of object {@link RestconfStrategy} provided as a parameter.
 850      *
 851      * @param content      type of data to read (config, state, all)
 852      * @param path         the path to read
 853      * @param defaultsMode value of with-defaults parameter
 854      * @return {@link NormalizedNode}
 855      */
 856     // FIXME: NETCONF-1155: this method should asynchronous
 857     @VisibleForTesting
 858     final @Nullable NormalizedNode readData(final @NonNull ContentParam content,
 859             final @NonNull YangInstanceIdentifier path, final WithDefaultsParam defaultsMode) {
 860         return switch (content) {
 861             case ALL -> {
 862                 // PREPARE STATE DATA NODE
 863                 final var stateDataNode = readDataViaTransaction(LogicalDatastoreType.OPERATIONAL, path);
 864                 // PREPARE CONFIG DATA NODE
 865                 final var configDataNode = readDataViaTransaction(LogicalDatastoreType.CONFIGURATION, path);
 866
 867                 yield mergeConfigAndSTateDataIfNeeded(stateDataNode, defaultsMode == null ? configDataNode
 868                     : prepareDataByParamWithDef(configDataNode, path, defaultsMode.mode()));
 869             }
 870             case CONFIG -> {
 871                 final var read = readDataViaTransaction(LogicalDatastoreType.CONFIGURATION, path);
 872                 yield defaultsMode == null ? read
 873                     : prepareDataByParamWithDef(read, path, defaultsMode.mode());
 874             }
 875             case NONCONFIG -> readDataViaTransaction(LogicalDatastoreType.OPERATIONAL, path);
 876         };
 877     }
 878
 879     private @Nullable NormalizedNode readDataViaTransaction(final LogicalDatastoreType store,
 880             final YangInstanceIdentifier path) {
 881         return TransactionUtil.syncAccess(read(store, path), path).orElse(null);
 882     }
 883
 884     final NormalizedNode prepareDataByParamWithDef(final NormalizedNode readData, final YangInstanceIdentifier path,
 885             final WithDefaultsMode defaultsMode) {
 886         final boolean trim = switch (defaultsMode) {
 887             case Trim -> true;
 888             case Explicit -> false;
 889             case ReportAll, ReportAllTagged -> throw new RestconfDocumentedException(
 890                 "Unsupported with-defaults value " + defaultsMode.getName());
 891         };
 892
 893         // FIXME: we have this readily available in InstanceIdentifierContext
 894         final var ctxNode = databind.schemaTree().findChild(path).orElseThrow();
 895         if (readData instanceof ContainerNode container) {
 896             final var builder = ImmutableNodes.newContainerBuilder().withNodeIdentifier(container.name());
 897             buildCont(builder, container.body(), ctxNode, trim);
 898             return builder.build();
 899         } else if (readData instanceof MapEntryNode mapEntry) {
 900             if (!(ctxNode.dataSchemaNode() instanceof ListSchemaNode listSchema)) {
 901                 throw new IllegalStateException("Input " + mapEntry + " does not match " + ctxNode);
 902             }
 903
 904             final var builder = ImmutableNodes.newMapEntryBuilder().withNodeIdentifier(mapEntry.name());
 905             buildMapEntryBuilder(builder, mapEntry.body(), ctxNode, trim, listSchema.getKeyDefinition());
 906             return builder.build();
 907         } else {
 908             throw new IllegalStateException("Unhandled data contract " + readData.contract());
 909         }
 910     }
 911
 912     private static void buildMapEntryBuilder(
 913             final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder,
 914             final Collection<@NonNull DataContainerChild> children, final DataSchemaContext ctxNode,
 915             final boolean trim, final List<QName> keys) {
 916         for (var child : children) {
 917             final var childCtx = getChildContext(ctxNode, child);
 918
 919             if (child instanceof ContainerNode container) {
 920                 appendContainer(builder, container, childCtx, trim);
 921             } else if (child instanceof MapNode map) {
 922                 appendMap(builder, map, childCtx, trim);
 923             } else if (child instanceof LeafNode<?> leaf) {
 924                 appendLeaf(builder, leaf, childCtx, trim, keys);
 925             } else {
 926                 // FIXME: we should never hit this, throw an ISE if this ever happens
 927                 LOG.debug("Ignoring unhandled child contract {}", child.contract());
 928             }
 929         }
 930     }
 931
 932     private static void appendContainer(final DataContainerNodeBuilder<?, ?> builder, final ContainerNode container,
 933             final DataSchemaContext ctxNode, final boolean trim) {
 934         final var childBuilder = ImmutableNodes.newContainerBuilder().withNodeIdentifier(container.name());
 935         buildCont(childBuilder, container.body(), ctxNode, trim);
 936         builder.withChild(childBuilder.build());
 937     }
 938
 939     private static void appendLeaf(final DataContainerNodeBuilder<?, ?> builder, final LeafNode<?> leaf,
 940             final DataSchemaContext ctxNode, final boolean trim, final List<QName> keys) {
 941         if (!(ctxNode.dataSchemaNode() instanceof LeafSchemaNode leafSchema)) {
 942             throw new IllegalStateException("Input " + leaf + " does not match " + ctxNode);
 943         }
 944
 945         // FIXME: Document now this works with the likes of YangInstanceIdentifier. I bet it does not.
 946         final var defaultVal = leafSchema.getType().getDefaultValue().orElse(null);
 947
 948         // This is a combined check for when we need to emit the leaf.
 949         if (
 950             // We always have to emit key leaf values
 951             keys.contains(leafSchema.getQName())
 952             // trim == WithDefaultsParam.TRIM and the source is assumed to store explicit values:
 953             //
 954             //            When data is retrieved with a <with-defaults> parameter equal to
 955             //            'trim', data nodes MUST NOT be reported if they contain the schema
 956             //            default value.  Non-configuration data nodes containing the schema
 957             //            default value MUST NOT be reported.
 958             //
 959             || trim && (defaultVal == null || !defaultVal.equals(leaf.body()))
 960             // !trim == WithDefaultsParam.EXPLICIT and the source is assume to store explicit values... but I fail to
 961             // grasp what we are doing here... emit only if it matches default ???!!!
 962             // FIXME: The WithDefaultsParam.EXPLICIT says:
 963             //
 964             //            Data nodes set to the YANG default by the client are reported.
 965             //
 966             //        and RFC8040 (https://www.rfc-editor.org/rfc/rfc8040#page-60) says:
 967             //
 968             //            If the "with-defaults" parameter is set to "explicit", then the
 969             //            server MUST adhere to the default-reporting behavior defined in
 970             //            Section 3.3 of [RFC6243].
 971             //
 972             //        and then RFC6243 (https://www.rfc-editor.org/rfc/rfc6243#section-3.3) says:
 973             //
 974             //            When data is retrieved with a <with-defaults> parameter equal to
 975             //            'explicit', a data node that was set by a client to its schema
 976             //            default value MUST be reported.  A conceptual data node that would be
 977             //            set by the server to the schema default value MUST NOT be reported.
 978             //            Non-configuration data nodes containing the schema default value MUST
 979             //            be reported.
 980             //
 981             // (rovarga): The source reports explicitly-defined leaves and does *not* create defaults by itself.
 982             //            This seems to disregard the 'trim = true' case semantics (see above).
 983             //            Combining the above, though, these checks are missing the 'non-config' check, which would
 984             //            distinguish, but barring that this check is superfluous and results in the wrong semantics.
 985             //            Without that input, this really should be  covered by the previous case.
 986                 || !trim && defaultVal != null && defaultVal.equals(leaf.body())) {
 987             builder.withChild(leaf);
 988         }
 989     }
 990
 991     private static void appendMap(final DataContainerNodeBuilder<?, ?> builder, final MapNode map,
 992             final DataSchemaContext childCtx, final boolean trim) {
 993         if (!(childCtx.dataSchemaNode() instanceof ListSchemaNode listSchema)) {
 994             throw new IllegalStateException("Input " + map + " does not match " + childCtx);
 995         }
 996
 997         final var childBuilder = switch (map.ordering()) {
 998             case SYSTEM -> ImmutableNodes.newSystemMapBuilder();
 999             case USER -> ImmutableNodes.newUserMapBuilder();
1000         };
1001         buildList(childBuilder.withNodeIdentifier(map.name()), map.body(), childCtx, trim,
1002             listSchema.getKeyDefinition());
1003         builder.withChild(childBuilder.build());
1004     }
1005
1006     private static void buildList(final CollectionNodeBuilder<MapEntryNode, ? extends MapNode> builder,
1007             final Collection<@NonNull MapEntryNode> entries, final DataSchemaContext ctxNode, final boolean trim,
1008             final List<@NonNull QName> keys) {
1009         for (var entry : entries) {
1010             final var childCtx = getChildContext(ctxNode, entry);
1011             final var mapEntryBuilder = ImmutableNodes.newMapEntryBuilder().withNodeIdentifier(entry.name());
1012             buildMapEntryBuilder(mapEntryBuilder, entry.body(), childCtx, trim, keys);
1013             builder.withChild(mapEntryBuilder.build());
1014         }
1015     }
1016
1017     private static void buildCont(final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder,
1018             final Collection<DataContainerChild> children, final DataSchemaContext ctxNode, final boolean trim) {
1019         for (var child : children) {
1020             final var childCtx = getChildContext(ctxNode, child);
1021             if (child instanceof ContainerNode container) {
1022                 appendContainer(builder, container, childCtx, trim);
1023             } else if (child instanceof MapNode map) {
1024                 appendMap(builder, map, childCtx, trim);
1025             } else if (child instanceof LeafNode<?> leaf) {
1026                 appendLeaf(builder, leaf, childCtx, trim, List.of());
1027             }
1028         }
1029     }
1030
1031     private static @NonNull DataSchemaContext getChildContext(final DataSchemaContext ctxNode,
1032             final NormalizedNode child) {
1033         final var childId = child.name();
1034         final var childCtx = ctxNode instanceof DataSchemaContext.Composite composite ? composite.childByArg(childId)
1035             : null;
1036         if (childCtx == null) {
1037             throw new NoSuchElementException("Cannot resolve child " + childId + " in " + ctxNode);
1038         }
1039         return childCtx;
1040     }
1041
1042     static final NormalizedNode mergeConfigAndSTateDataIfNeeded(final NormalizedNode stateDataNode,
1043             final NormalizedNode configDataNode) {
1044         if (stateDataNode == null) {
1045             // No state, return config
1046             return configDataNode;
1047         }
1048         if (configDataNode == null) {
1049             // No config, return state
1050             return stateDataNode;
1051         }
1052         // merge config and state
1053         return mergeStateAndConfigData(stateDataNode, configDataNode);
1054     }
1055
1056     /**
1057      * Merge state and config data into a single NormalizedNode.
1058      *
1059      * @param stateDataNode  data node of state data
1060      * @param configDataNode data node of config data
1061      * @return {@link NormalizedNode}
1062      */
1063     private static @NonNull NormalizedNode mergeStateAndConfigData(
1064             final @NonNull NormalizedNode stateDataNode, final @NonNull NormalizedNode configDataNode) {
1065         validateNodeMerge(stateDataNode, configDataNode);
1066         // FIXME: this check is bogus, as it confuses yang.data.api (NormalizedNode) with yang.model.api (RpcDefinition)
1067         if (configDataNode instanceof RpcDefinition) {
1068             return prepareRpcData(configDataNode, stateDataNode);
1069         } else {
1070             return prepareData(configDataNode, stateDataNode);
1071         }
1072     }
1073
1074     /**
1075      * Validates whether the two NormalizedNodes can be merged.
1076      *
1077      * @param stateDataNode  data node of state data
1078      * @param configDataNode data node of config data
1079      */
1080     private static void validateNodeMerge(final @NonNull NormalizedNode stateDataNode,
1081                                           final @NonNull NormalizedNode configDataNode) {
1082         final QNameModule moduleOfStateData = stateDataNode.name().getNodeType().getModule();
1083         final QNameModule moduleOfConfigData = configDataNode.name().getNodeType().getModule();
1084         if (!moduleOfStateData.equals(moduleOfConfigData)) {
1085             throw new RestconfDocumentedException("Unable to merge data from different modules.");
1086         }
1087     }
1088
1089     /**
1090      * Prepare and map data for rpc.
1091      *
1092      * @param configDataNode data node of config data
1093      * @param stateDataNode  data node of state data
1094      * @return {@link NormalizedNode}
1095      */
1096     private static @NonNull NormalizedNode prepareRpcData(final @NonNull NormalizedNode configDataNode,
1097                                                           final @NonNull NormalizedNode stateDataNode) {
1098         final var mapEntryBuilder = ImmutableNodes.newMapEntryBuilder()
1099             .withNodeIdentifier((NodeIdentifierWithPredicates) configDataNode.name());
1100
1101         // MAP CONFIG DATA
1102         mapRpcDataNode(configDataNode, mapEntryBuilder);
1103         // MAP STATE DATA
1104         mapRpcDataNode(stateDataNode, mapEntryBuilder);
1105
1106         return ImmutableNodes.newSystemMapBuilder()
1107             .withNodeIdentifier(NodeIdentifier.create(configDataNode.name().getNodeType()))
1108             .addChild(mapEntryBuilder.build())
1109             .build();
1110     }
1111
1112     /**
1113      * Map node to map entry builder.
1114      *
1115      * @param dataNode        data node
1116      * @param mapEntryBuilder builder for mapping data
1117      */
1118     private static void mapRpcDataNode(final @NonNull NormalizedNode dataNode,
1119             final @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder) {
1120         ((ContainerNode) dataNode).body().forEach(mapEntryBuilder::addChild);
1121     }
1122
1123     /**
1124      * Prepare and map all data from DS.
1125      *
1126      * @param configDataNode data node of config data
1127      * @param stateDataNode  data node of state data
1128      * @return {@link NormalizedNode}
1129      */
1130     @SuppressWarnings("unchecked")
1131     private static @NonNull NormalizedNode prepareData(final @NonNull NormalizedNode configDataNode,
1132                                                        final @NonNull NormalizedNode stateDataNode) {
1133         if (configDataNode instanceof UserMapNode configMap) {
1134             final var builder = ImmutableNodes.newUserMapBuilder().withNodeIdentifier(configMap.name());
1135             mapValueToBuilder(configMap.body(), ((UserMapNode) stateDataNode).body(), builder);
1136             return builder.build();
1137         } else if (configDataNode instanceof SystemMapNode configMap) {
1138             final var builder = ImmutableNodes.newSystemMapBuilder().withNodeIdentifier(configMap.name());
1139             mapValueToBuilder(configMap.body(), ((SystemMapNode) stateDataNode).body(), builder);
1140             return builder.build();
1141         } else if (configDataNode instanceof MapEntryNode configEntry) {
1142             final var builder = ImmutableNodes.newMapEntryBuilder().withNodeIdentifier(configEntry.name());
1143             mapValueToBuilder(configEntry.body(), ((MapEntryNode) stateDataNode).body(), builder);
1144             return builder.build();
1145         } else if (configDataNode instanceof ContainerNode configContaienr) {
1146             final var builder = ImmutableNodes.newContainerBuilder().withNodeIdentifier(configContaienr.name());
1147             mapValueToBuilder(configContaienr.body(), ((ContainerNode) stateDataNode).body(), builder);
1148             return builder.build();
1149         } else if (configDataNode instanceof ChoiceNode configChoice) {
1150             final var builder = ImmutableNodes.newChoiceBuilder().withNodeIdentifier(configChoice.name());
1151             mapValueToBuilder(configChoice.body(), ((ChoiceNode) stateDataNode).body(), builder);
1152             return builder.build();
1153         } else if (configDataNode instanceof LeafNode configLeaf) {
1154             // config trumps oper
1155             return configLeaf;
1156         } else if (configDataNode instanceof UserLeafSetNode) {
1157             final var configLeafSet = (UserLeafSetNode<Object>) configDataNode;
1158             final var builder = ImmutableNodes.<Object>newUserLeafSetBuilder().withNodeIdentifier(configLeafSet.name());
1159             mapValueToBuilder(configLeafSet.body(), ((UserLeafSetNode<Object>) stateDataNode).body(), builder);
1160             return builder.build();
1161         } else if (configDataNode instanceof SystemLeafSetNode) {
1162             final var configLeafSet = (SystemLeafSetNode<Object>) configDataNode;
1163             final var builder = ImmutableNodes.<Object>newSystemLeafSetBuilder()
1164                 .withNodeIdentifier(configLeafSet.name());
1165             mapValueToBuilder(configLeafSet.body(), ((SystemLeafSetNode<Object>) stateDataNode).body(), builder);
1166             return builder.build();
1167         } else if (configDataNode instanceof LeafSetEntryNode<?> configEntry) {
1168             // config trumps oper
1169             return configEntry;
1170         } else if (configDataNode instanceof UnkeyedListNode configList) {
1171             final var builder = ImmutableNodes.newUnkeyedListBuilder().withNodeIdentifier(configList.name());
1172             mapValueToBuilder(configList.body(), ((UnkeyedListNode) stateDataNode).body(), builder);
1173             return builder.build();
1174         } else if (configDataNode instanceof UnkeyedListEntryNode configEntry) {
1175             final var builder = ImmutableNodes.newUnkeyedListEntryBuilder().withNodeIdentifier(configEntry.name());
1176             mapValueToBuilder(configEntry.body(), ((UnkeyedListEntryNode) stateDataNode).body(), builder);
1177             return builder.build();
1178         } else {
1179             throw new RestconfDocumentedException("Unexpected node type: " + configDataNode.getClass().getName());
1180         }
1181     }
1182
1183     /**
1184      * Map value from container node to builder.
1185      *
1186      * @param configData collection of config data nodes
1187      * @param stateData  collection of state data nodes
1188      * @param builder    builder
1189      */
1190     private static <T extends NormalizedNode> void mapValueToBuilder(
1191             final @NonNull Collection<T> configData, final @NonNull Collection<T> stateData,
1192             final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
1193         final var configMap = configData.stream().collect(Collectors.toMap(NormalizedNode::name, Function.identity()));
1194         final var stateMap = stateData.stream().collect(Collectors.toMap(NormalizedNode::name, Function.identity()));
1195
1196         // merge config and state data of children with different identifiers
1197         mapDataToBuilder(configMap, stateMap, builder);
1198
1199         // merge config and state data of children with the same identifiers
1200         mergeDataToBuilder(configMap, stateMap, builder);
1201     }
1202
1203     /**
1204      * Map data with different identifiers to builder. Data with different identifiers can be just added
1205      * as childs to parent node.
1206      *
1207      * @param configMap map of config data nodes
1208      * @param stateMap  map of state data nodes
1209      * @param builder   - builder
1210      */
1211     private static <T extends NormalizedNode> void mapDataToBuilder(
1212             final @NonNull Map<PathArgument, T> configMap, final @NonNull Map<PathArgument, T> stateMap,
1213             final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
1214         configMap.entrySet().stream().filter(x -> !stateMap.containsKey(x.getKey())).forEach(
1215             y -> builder.addChild(y.getValue()));
1216         stateMap.entrySet().stream().filter(x -> !configMap.containsKey(x.getKey())).forEach(
1217             y -> builder.addChild(y.getValue()));
1218     }
1219
1220     /**
1221      * Map data with the same identifiers to builder. Data with the same identifiers cannot be just added but we need to
1222      * go one level down with {@code prepareData} method.
1223      *
1224      * @param configMap immutable config data
1225      * @param stateMap  immutable state data
1226      * @param builder   - builder
1227      */
1228     @SuppressWarnings("unchecked")
1229     private static <T extends NormalizedNode> void mergeDataToBuilder(
1230             final @NonNull Map<PathArgument, T> configMap, final @NonNull Map<PathArgument, T> stateMap,
1231             final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
1232         // it is enough to process only config data because operational contains the same data
1233         configMap.entrySet().stream().filter(x -> stateMap.containsKey(x.getKey())).forEach(
1234             y -> builder.addChild((T) prepareData(y.getValue(), stateMap.get(y.getKey()))));
1235     }
1236
1237     public @NonNull RestconfFuture<FormattableBody> operationsGET() {
1238         return operations.httpGET();
1239     }
1240
1241     public @NonNull RestconfFuture<FormattableBody> operationsGET(final ApiPath apiPath) {
1242         return operations.httpGET(apiPath);
1243     }
1244
1245     public @NonNull RestconfFuture<InvokeResult> operationsPOST(final URI restconfURI, final ApiPath apiPath,
1246             final Map<String, String> queryParameters, final OperationInputBody body) {
1247         final Rpc path;
1248         try {
1249             path = pathNormalizer.normalizeRpcPath(apiPath);
1250         } catch (RestconfDocumentedException e) {
1251             return RestconfFuture.failed(e);
1252         }
1253
1254         final InvokeParams params;
1255         try {
1256             params = InvokeParams.ofQueryParameters(queryParameters);
1257         } catch (IllegalArgumentException e) {
1258             return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
1259                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
1260         }
1261
1262         final ContainerNode data;
1263         try {
1264             data = body.toContainerNode(path);
1265         } catch (IOException e) {
1266             LOG.debug("Error reading input", e);
1267             return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
1268                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
1269         }
1270
1271         final var type = path.rpc().argument();
1272         final var local = localRpcs.get(type);
1273         if (local != null) {
1274             return local.invoke(restconfURI, new OperationInput(path, data))
1275                 .transform(output -> outputToInvokeResult(path, params, output));
1276         }
1277         if (rpcService == null) {
1278             LOG.debug("RPC invocation is not available");
1279             return RestconfFuture.failed(new RestconfDocumentedException("RPC invocation is not available",
1280                 ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED));
1281         }
1282
1283         final var ret = new SettableRestconfFuture<InvokeResult>();
1284         Futures.addCallback(rpcService.invokeRpc(type, data), new FutureCallback<DOMRpcResult>() {
1285             @Override
1286             public void onSuccess(final DOMRpcResult response) {
1287                 final var errors = response.errors();
1288                 if (errors.isEmpty()) {
1289                     ret.set(outputToInvokeResult(path, params, response.value()));
1290                 } else {
1291                     LOG.debug("RPC invocation reported {}", response.errors());
1292                     ret.setFailure(new RestconfDocumentedException("RPC implementation reported errors", null,
1293                         response.errors()));
1294                 }
1295             }
1296
1297             @Override
1298             public void onFailure(final Throwable cause) {
1299                 LOG.debug("RPC invocation failed, cause");
1300                 if (cause instanceof RestconfDocumentedException ex) {
1301                     ret.setFailure(ex);
1302                 } else {
1303                     // TODO: YangNetconfErrorAware if we ever get into a broader invocation scope
1304                     ret.setFailure(new RestconfDocumentedException(cause,
1305                         new RestconfError(ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage())));
1306                 }
1307             }
1308         }, MoreExecutors.directExecutor());
1309         return ret;
1310     }
1311
1312     private static @NonNull InvokeResult outputToInvokeResult(final @NonNull OperationPath path,
1313             final @NonNull InvokeParams params, final @Nullable ContainerNode value) {
1314         return value == null || value.isEmpty() ? InvokeResult.EMPTY
1315             : new InvokeResult(new OperationOutputBody(params, path, value));
1316     }
1317
1318     public @NonNull RestconfFuture<CharSource> resolveSource(final SourceIdentifier source,
1319             final Class<? extends SourceRepresentation> representation) {
1320         final var src = requireNonNull(source);
1321         if (YangTextSource.class.isAssignableFrom(representation)) {
1322             if (sourceProvider != null) {
1323                 final var ret = new SettableRestconfFuture<CharSource>();
1324                 Futures.addCallback(sourceProvider.getYangTexttSource(src), new FutureCallback<>() {
1325                     @Override
1326                     public void onSuccess(final YangTextSource result) {
1327                         ret.set(result);
1328                     }
1329
1330                     @Override
1331                     public void onFailure(final Throwable cause) {
1332                         ret.setFailure(cause instanceof RestconfDocumentedException e ? e
1333                             : new RestconfDocumentedException(cause.getMessage(), ErrorType.RPC,
1334                                 ErrorTag.OPERATION_FAILED, cause));
1335                     }
1336                 }, MoreExecutors.directExecutor());
1337                 return ret;
1338             }
1339             return exportSource(modelContext(), src, YangCharSource::new, YangCharSource::new);
1340         }
1341         if (YinTextSource.class.isAssignableFrom(representation)) {
1342             return exportSource(modelContext(), src, YinCharSource.OfModule::new, YinCharSource.OfSubmodule::new);
1343         }
1344         return RestconfFuture.failed(new RestconfDocumentedException(
1345             "Unsupported source representation " + representation.getName()));
1346     }
1347
1348     private static @NonNull RestconfFuture<CharSource> exportSource(final EffectiveModelContext modelContext,
1349             final SourceIdentifier source, final Function<ModuleEffectiveStatement, CharSource> moduleCtor,
1350             final BiFunction<ModuleEffectiveStatement, SubmoduleEffectiveStatement, CharSource> submoduleCtor) {
1351         // If the source identifies a module, things are easy
1352         final var name = source.name().getLocalName();
1353         final var optRevision = Optional.ofNullable(source.revision());
1354         final var optModule = modelContext.findModule(name, optRevision);
1355         if (optModule.isPresent()) {
1356             return RestconfFuture.of(moduleCtor.apply(optModule.orElseThrow().asEffectiveStatement()));
1357         }
1358
1359         // The source could be a submodule, which we need to hunt down
1360         for (var module : modelContext.getModules()) {
1361             for (var submodule : module.getSubmodules()) {
1362                 if (name.equals(submodule.getName()) && optRevision.equals(submodule.getRevision())) {
1363                     return RestconfFuture.of(submoduleCtor.apply(module.asEffectiveStatement(),
1364                         submodule.asEffectiveStatement()));
1365                 }
1366             }
1367         }
1368
1369         final var sb = new StringBuilder().append("Source ").append(source.name().getLocalName());
1370         optRevision.ifPresent(rev -> sb.append('@').append(rev));
1371         sb.append(" not found");
1372         return RestconfFuture.failed(new RestconfDocumentedException(sb.toString(),
1373             ErrorType.APPLICATION, ErrorTag.DATA_MISSING));
1374     }
1375
1376     public final @NonNull RestconfFuture<? extends DataPostResult> dataPOST(final ApiPath apiPath,
1377             final DataPostBody body, final Map<String, String> queryParameters) {
1378         if (apiPath.steps().isEmpty()) {
1379             return dataCreatePOST(body.toResource(), queryParameters);
1380         }
1381         final InstanceReference path;
1382         try {
1383             path = pathNormalizer.normalizeDataOrActionPath(apiPath);
1384         } catch (RestconfDocumentedException e) {
1385             return RestconfFuture.failed(e);
1386         }
1387         if (path instanceof Data dataPath) {
1388             try (var resourceBody = body.toResource()) {
1389                 return dataCreatePOST(dataPath, resourceBody, queryParameters);
1390             }
1391         }
1392         if (path instanceof Action actionPath) {
1393             try (var inputBody = body.toOperationInput()) {
1394                 return dataInvokePOST(actionPath, inputBody, queryParameters);
1395             }
1396         }
1397         // Note: this should never happen
1398         // FIXME: we should be able to eliminate this path with Java 21+ pattern matching
1399         return RestconfFuture.failed(new RestconfDocumentedException("Unhandled path " + path));
1400     }
1401
1402     public @NonNull RestconfFuture<CreateResourceResult> dataCreatePOST(final ChildBody body,
1403             final Map<String, String> queryParameters) {
1404         return dataCreatePOST(new DatabindPath.Data(databind), body, queryParameters);
1405     }
1406
1407     private @NonNull RestconfFuture<CreateResourceResult> dataCreatePOST(final DatabindPath.Data path,
1408             final ChildBody body, final Map<String, String> queryParameters) {
1409         final Insert insert;
1410         try {
1411             insert = Insert.ofQueryParameters(path.databind(), queryParameters);
1412         } catch (IllegalArgumentException e) {
1413             return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
1414                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
1415         }
1416
1417         final var payload = body.toPayload(path);
1418         return postData(concat(path.instance(), payload.prefix()), payload.body(), insert);
1419     }
1420
1421     private static YangInstanceIdentifier concat(final YangInstanceIdentifier parent, final List<PathArgument> args) {
1422         var ret = parent;
1423         for (var arg : args) {
1424             ret = ret.node(arg);
1425         }
1426         return ret;
1427     }
1428
1429     private @NonNull RestconfFuture<InvokeResult> dataInvokePOST(final @NonNull Action path,
1430             final @NonNull OperationInputBody body, final Map<String, String> queryParameters) {
1431         final InvokeParams params;
1432         try {
1433             params = InvokeParams.ofQueryParameters(queryParameters);
1434         } catch (IllegalArgumentException e) {
1435             return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
1436                 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
1437         }
1438
1439         final ContainerNode input;
1440         try {
1441             input = body.toContainerNode(path);
1442         } catch (IOException e) {
1443             LOG.debug("Error reading input", e);
1444             return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
1445                 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
1446         }
1447
1448         if (actionService == null) {
1449             return RestconfFuture.failed(new RestconfDocumentedException("DOMActionService is missing."));
1450         }
1451
1452         return dataInvokePOST(actionService, path, input)
1453             .transform(result -> outputToInvokeResult(path, params, result.getOutput().orElse(null)));
1454     }
1455
1456     /**
1457      * Invoke Action via ActionServiceHandler.
1458      *
1459      * @param input input data
1460      * @param yangIId invocation context
1461      * @param schemaPath schema path of data
1462      * @param actionService action service to invoke action
1463      * @return {@link DOMActionResult}
1464      */
1465     private static RestconfFuture<DOMActionResult> dataInvokePOST(final DOMActionService actionService,
1466             final Action path, final @NonNull ContainerNode input) {
1467         final var ret = new SettableRestconfFuture<DOMActionResult>();
1468
1469         Futures.addCallback(actionService.invokeAction(
1470             path.inference().toSchemaInferenceStack().toSchemaNodeIdentifier(),
1471             DOMDataTreeIdentifier.of(LogicalDatastoreType.OPERATIONAL, path.instance()), input),
1472             new FutureCallback<DOMActionResult>() {
1473                 @Override
1474                 public void onSuccess(final DOMActionResult result) {
1475                     final var errors = result.getErrors();
1476                     LOG.debug("InvokeAction Error Message {}", errors);
1477                     if (errors.isEmpty()) {
1478                         ret.set(result);
1479                     } else {
1480                         ret.setFailure(new RestconfDocumentedException("InvokeAction Error Message ", null, errors));
1481                     }
1482                 }
1483
1484                 @Override
1485                 public void onFailure(final Throwable cause) {
1486                     if (cause instanceof DOMActionException) {
1487                         ret.set(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
1488                             ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage()))));
1489                     } else if (cause instanceof RestconfDocumentedException e) {
1490                         ret.setFailure(e);
1491                     } else if (cause instanceof CancellationException) {
1492                         ret.setFailure(new RestconfDocumentedException("Action cancelled while executing",
1493                             ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, cause));
1494                     } else {
1495                         ret.setFailure(new RestconfDocumentedException("Invocation failed", cause));
1496                     }
1497                 }
1498             }, MoreExecutors.directExecutor());
1499
1500         return ret;
1501     }
1502 }