2 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.restconf.nb.rfc8040.rests.transactions;
10 import static com.google.common.base.Verify.verifyNotNull;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.VisibleForTesting;
14 import com.google.common.collect.ImmutableMap;
15 import com.google.common.collect.ImmutableSet;
16 import com.google.common.collect.ImmutableSetMultimap;
17 import com.google.common.io.CharSource;
18 import com.google.common.util.concurrent.FutureCallback;
19 import com.google.common.util.concurrent.Futures;
20 import com.google.common.util.concurrent.ListenableFuture;
21 import com.google.common.util.concurrent.MoreExecutors;
22 import java.io.IOException;
24 import java.util.ArrayList;
25 import java.util.Collection;
26 import java.util.Comparator;
27 import java.util.HashMap;
28 import java.util.List;
30 import java.util.Map.Entry;
31 import java.util.NoSuchElementException;
32 import java.util.Optional;
33 import java.util.concurrent.CancellationException;
34 import java.util.function.BiFunction;
35 import java.util.function.Function;
36 import java.util.stream.Collectors;
37 import org.eclipse.jdt.annotation.NonNull;
38 import org.eclipse.jdt.annotation.NonNullByDefault;
39 import org.eclipse.jdt.annotation.Nullable;
40 import org.opendaylight.mdsal.common.api.CommitInfo;
41 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
42 import org.opendaylight.mdsal.dom.api.DOMActionException;
43 import org.opendaylight.mdsal.dom.api.DOMActionResult;
44 import org.opendaylight.mdsal.dom.api.DOMActionService;
45 import org.opendaylight.mdsal.dom.api.DOMDataBroker;
46 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
47 import org.opendaylight.mdsal.dom.api.DOMMountPoint;
48 import org.opendaylight.mdsal.dom.api.DOMMountPointService;
49 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
50 import org.opendaylight.mdsal.dom.api.DOMRpcService;
51 import org.opendaylight.mdsal.dom.api.DOMSchemaService;
52 import org.opendaylight.mdsal.dom.api.DOMSchemaService.YangTextSourceExtension;
53 import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
54 import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
55 import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
56 import org.opendaylight.restconf.api.ApiPath;
57 import org.opendaylight.restconf.api.query.ContentParam;
58 import org.opendaylight.restconf.api.query.WithDefaultsParam;
59 import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
60 import org.opendaylight.restconf.common.errors.RestconfError;
61 import org.opendaylight.restconf.common.errors.RestconfFuture;
62 import org.opendaylight.restconf.common.errors.SettableRestconfFuture;
63 import org.opendaylight.restconf.common.patch.PatchContext;
64 import org.opendaylight.restconf.common.patch.PatchStatusContext;
65 import org.opendaylight.restconf.common.patch.PatchStatusEntity;
66 import org.opendaylight.restconf.nb.rfc8040.Insert;
67 import org.opendaylight.restconf.nb.rfc8040.databind.ChildBody;
68 import org.opendaylight.restconf.nb.rfc8040.databind.DataPostBody;
69 import org.opendaylight.restconf.nb.rfc8040.databind.OperationInputBody;
70 import org.opendaylight.restconf.nb.rfc8040.databind.PatchBody;
71 import org.opendaylight.restconf.nb.rfc8040.databind.ResourceBody;
72 import org.opendaylight.restconf.nb.rfc8040.legacy.ErrorTags;
73 import org.opendaylight.restconf.nb.rfc8040.legacy.NormalizedNodePayload;
74 import org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters;
75 import org.opendaylight.restconf.nb.rfc8040.utils.parser.YangInstanceIdentifierSerializer;
76 import org.opendaylight.restconf.server.api.ConfigurationMetadata;
77 import org.opendaylight.restconf.server.api.DataGetParams;
78 import org.opendaylight.restconf.server.api.DataGetResult;
79 import org.opendaylight.restconf.server.api.DataPatchPath;
80 import org.opendaylight.restconf.server.api.DataPatchResult;
81 import org.opendaylight.restconf.server.api.DataPostPath;
82 import org.opendaylight.restconf.server.api.DataPostResult;
83 import org.opendaylight.restconf.server.api.DataPostResult.CreateResource;
84 import org.opendaylight.restconf.server.api.DataPostResult.InvokeOperation;
85 import org.opendaylight.restconf.server.api.DataPutPath;
86 import org.opendaylight.restconf.server.api.DataPutResult;
87 import org.opendaylight.restconf.server.api.DataYangPatchResult;
88 import org.opendaylight.restconf.server.api.DatabindContext;
89 import org.opendaylight.restconf.server.api.OperationsGetResult;
90 import org.opendaylight.restconf.server.api.OperationsPostPath;
91 import org.opendaylight.restconf.server.api.OperationsPostResult;
92 import org.opendaylight.restconf.server.spi.ApiPathNormalizer;
93 import org.opendaylight.restconf.server.spi.ApiPathNormalizer.DataPath;
94 import org.opendaylight.restconf.server.spi.ApiPathNormalizer.InstanceReference;
95 import org.opendaylight.restconf.server.spi.ApiPathNormalizer.OperationPath;
96 import org.opendaylight.restconf.server.spi.ApiPathNormalizer.OperationPath.Rpc;
97 import org.opendaylight.restconf.server.spi.OperationInput;
98 import org.opendaylight.restconf.server.spi.RpcImplementation;
99 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.with.defaults.rev110601.WithDefaultsMode;
100 import org.opendaylight.yangtools.yang.common.Empty;
101 import org.opendaylight.yangtools.yang.common.ErrorTag;
102 import org.opendaylight.yangtools.yang.common.ErrorType;
103 import org.opendaylight.yangtools.yang.common.QName;
104 import org.opendaylight.yangtools.yang.common.QNameModule;
105 import org.opendaylight.yangtools.yang.common.Revision;
106 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
107 import org.opendaylight.yangtools.yang.common.XMLNamespace;
108 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
109 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
110 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
111 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
112 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
113 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
114 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
115 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
116 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
117 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
118 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
119 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
120 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
121 import org.opendaylight.yangtools.yang.data.api.schema.SystemLeafSetNode;
122 import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
123 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
124 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
125 import org.opendaylight.yangtools.yang.data.api.schema.UserLeafSetNode;
126 import org.opendaylight.yangtools.yang.data.api.schema.UserMapNode;
127 import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
128 import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
129 import org.opendaylight.yangtools.yang.data.api.schema.builder.NormalizedNodeContainerBuilder;
130 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
131 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
132 import org.opendaylight.yangtools.yang.data.util.DataSchemaContext;
133 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
134 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
135 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
136 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
137 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
138 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
139 import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
140 import org.opendaylight.yangtools.yang.model.api.source.SourceRepresentation;
141 import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
142 import org.opendaylight.yangtools.yang.model.api.source.YinTextSource;
143 import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
144 import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
145 import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
146 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
147 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
148 import org.slf4j.Logger;
149 import org.slf4j.LoggerFactory;
152 * Baseline execution strategy for various RESTCONF operations.
154 * @see NetconfRestconfStrategy
155 * @see MdsalRestconfStrategy
157 // FIXME: it seems the first three operations deal with lifecycle of a transaction, while others invoke various
158 // operations. This should be handled through proper allocation indirection.
159 public abstract class RestconfStrategy {
161 public record StrategyAndPath(RestconfStrategy strategy, DataPath path) {
162 public StrategyAndPath {
163 requireNonNull(strategy);
164 requireNonNull(path);
169 * Result of a partial {@link ApiPath} lookup for the purposes of supporting {@code yang-ext:mount}-delimited mount
170 * points with possible nesting.
172 * @param strategy the strategy to use
173 * @param tail the {@link ApiPath} tail to use with the strategy
176 public record StrategyAndTail(RestconfStrategy strategy, ApiPath tail) {
177 public StrategyAndTail {
178 requireNonNull(strategy);
179 requireNonNull(tail);
183 private static final Logger LOG = LoggerFactory.getLogger(RestconfStrategy.class);
184 private static final @NonNull DataPutResult PUT_CREATED = new DataPutResult(true);
185 private static final @NonNull DataPutResult PUT_REPLACED = new DataPutResult(false);
186 private static final @NonNull DataPatchResult PATCH_EMPTY = new DataPatchResult();
188 private final @NonNull ImmutableMap<QName, RpcImplementation> localRpcs;
189 private final @NonNull ApiPathNormalizer pathNormalizer;
190 private final @NonNull DatabindContext databind;
191 private final YangTextSourceExtension sourceProvider;
192 private final DOMMountPointService mountPointService;
193 private final DOMActionService actionService;
194 private final DOMRpcService rpcService;
196 RestconfStrategy(final DatabindContext databind, final ImmutableMap<QName, RpcImplementation> localRpcs,
197 final @Nullable DOMRpcService rpcService, final @Nullable DOMActionService actionService,
198 final YangTextSourceExtension sourceProvider, final @Nullable DOMMountPointService mountPointService) {
199 this.databind = requireNonNull(databind);
200 this.localRpcs = requireNonNull(localRpcs);
201 this.rpcService = rpcService;
202 this.actionService = actionService;
203 this.sourceProvider = sourceProvider;
204 this.mountPointService = mountPointService;
205 pathNormalizer = new ApiPathNormalizer(databind);
208 public final @NonNull StrategyAndPath resolveStrategyPath(final ApiPath path) {
209 final var andTail = resolveStrategy(path);
210 final var strategy = andTail.strategy();
211 return new StrategyAndPath(strategy, strategy.pathNormalizer.normalizeDataPath(andTail.tail()));
215 * Resolve any and all {@code yang-ext:mount} to the target {@link StrategyAndTail}.
217 * @param path {@link ApiPath} to resolve
218 * @return A strategy and the remaining path
219 * @throws NullPointerException if {@code path} is {@code null}
221 public final @NonNull StrategyAndTail resolveStrategy(final ApiPath path) {
222 var mount = path.indexOf("yang-ext", "mount");
224 return new StrategyAndTail(this, path);
226 if (mountPointService == null) {
227 throw new RestconfDocumentedException("Mount point service is not available",
228 ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
230 final var mountPath = path.subPath(0, mount);
231 final var dataPath = pathNormalizer.normalizeDataPath(path.subPath(0, mount));
232 final var mountPoint = mountPointService.getMountPoint(dataPath.instance())
233 .orElseThrow(() -> new RestconfDocumentedException("Mount point '" + mountPath + "' does not exist",
234 ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT));
236 return createStrategy(mountPath, mountPoint).resolveStrategy(path.subPath(mount + 1));
239 private static @NonNull RestconfStrategy createStrategy(final ApiPath mountPath, final DOMMountPoint mountPoint) {
240 final var mountSchemaService = mountPoint.getService(DOMSchemaService.class)
241 .orElseThrow(() -> new RestconfDocumentedException(
242 "Mount point '" + mountPath + "' does not expose DOMSchemaService",
243 ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT));
244 final var mountModelContext = mountSchemaService.getGlobalContext();
245 if (mountModelContext == null) {
246 throw new RestconfDocumentedException("Mount point '" + mountPath + "' does not have any models",
247 ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT);
249 final var mountDatabind = DatabindContext.ofModel(mountModelContext);
250 final var mountPointService = mountPoint.getService(DOMMountPointService.class).orElse(null);
251 final var rpcService = mountPoint.getService(DOMRpcService.class).orElse(null);
252 final var actionService = mountPoint.getService(DOMActionService.class).orElse(null);
253 final var sourceProvider = mountPoint.getService(DOMSchemaService.class)
254 .flatMap(schema -> Optional.ofNullable(schema.extension(YangTextSourceExtension.class)))
257 final var netconfService = mountPoint.getService(NetconfDataTreeService.class);
258 if (netconfService.isPresent()) {
259 return new NetconfRestconfStrategy(mountDatabind, netconfService.orElseThrow(), rpcService, actionService,
260 sourceProvider, mountPointService);
262 final var dataBroker = mountPoint.getService(DOMDataBroker.class);
263 if (dataBroker.isPresent()) {
264 return new MdsalRestconfStrategy(mountDatabind, dataBroker.orElseThrow(), rpcService, actionService,
265 sourceProvider, mountPointService);
267 LOG.warn("Mount point {} does not expose a suitable access interface", mountPath);
268 throw new RestconfDocumentedException("Could not find a supported access interface in mount point",
269 ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, mountPoint.getIdentifier());
272 public final @NonNull DatabindContext databind() {
276 public final @NonNull EffectiveModelContext modelContext() {
277 return databind.modelContext();
281 * Lock the entire datastore.
283 * @return A {@link RestconfTransaction}. This transaction needs to be either committed or canceled before doing
286 abstract RestconfTransaction prepareWriteExecution();
289 * Read data from the datastore.
291 * @param store the logical data store which should be modified
292 * @param path the data object path
293 * @return a ListenableFuture containing the result of the read
295 abstract ListenableFuture<Optional<NormalizedNode>> read(LogicalDatastoreType store, YangInstanceIdentifier path);
298 * Check if data already exists in the configuration datastore.
300 * @param path the data object path
301 * @return a ListenableFuture containing the result of the check
303 // FIXME: this method should be hosted in RestconfTransaction
304 // FIXME: this method should only be needed in MdsalRestconfStrategy
305 abstract ListenableFuture<Boolean> exists(YangInstanceIdentifier path);
308 final @NonNull RestconfFuture<DataPatchResult> merge(final YangInstanceIdentifier path, final NormalizedNode data) {
309 final var ret = new SettableRestconfFuture<DataPatchResult>();
310 merge(ret, requireNonNull(path), requireNonNull(data));
314 private void merge(final @NonNull SettableRestconfFuture<DataPatchResult> future,
315 final @NonNull YangInstanceIdentifier path, final @NonNull NormalizedNode data) {
316 final var tx = prepareWriteExecution();
317 // FIXME: this method should be further specialized to eliminate this call -- it is only needed for MD-SAL
318 tx.ensureParentsByMerge(path);
319 tx.merge(path, data);
320 Futures.addCallback(tx.commit(), new FutureCallback<CommitInfo>() {
322 public void onSuccess(final CommitInfo result) {
323 // TODO: extract details once CommitInfo can communicate them
324 future.set(PATCH_EMPTY);
328 public void onFailure(final Throwable cause) {
329 future.setFailure(TransactionUtil.decodeException(cause, "MERGE", path, modelContext()));
331 }, MoreExecutors.directExecutor());
334 public @NonNull RestconfFuture<DataPutResult> dataPUT(final ApiPath apiPath, final ResourceBody body,
335 final Map<String, String> queryParameters) {
338 path = pathNormalizer.normalizeDataPath(apiPath);
339 } catch (RestconfDocumentedException e) {
340 return RestconfFuture.failed(e);
345 insert = Insert.ofQueryParameters(databind, queryParameters);
346 } catch (IllegalArgumentException e) {
347 return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
348 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
350 final NormalizedNode data;
352 data = body.toNormalizedNode(new DataPutPath(databind, path.inference(), path.instance()));
353 } catch (RestconfDocumentedException e) {
354 return RestconfFuture.failed(e);
356 return putData(path.instance(), data, insert);
360 * Check mount point and prepare variables for put data to DS.
362 * @param path path of data
364 * @param insert {@link Insert}
365 * @return A {@link DataPutResult}
367 public final @NonNull RestconfFuture<DataPutResult> putData(final YangInstanceIdentifier path,
368 final NormalizedNode data, final @Nullable Insert insert) {
369 final var exists = TransactionUtil.syncAccess(exists(path), path);
371 final ListenableFuture<? extends CommitInfo> commitFuture;
372 if (insert != null) {
373 final var parentPath = path.coerceParent();
374 checkListAndOrderedType(parentPath);
375 commitFuture = insertAndCommitPut(path, data, insert, parentPath);
377 commitFuture = replaceAndCommit(prepareWriteExecution(), path, data);
380 final var ret = new SettableRestconfFuture<DataPutResult>();
382 Futures.addCallback(commitFuture, new FutureCallback<CommitInfo>() {
384 public void onSuccess(final CommitInfo result) {
385 ret.set(exists ? PUT_REPLACED : PUT_CREATED);
389 public void onFailure(final Throwable cause) {
390 ret.setFailure(TransactionUtil.decodeException(cause, "PUT", path, modelContext()));
392 }, MoreExecutors.directExecutor());
397 private ListenableFuture<? extends CommitInfo> insertAndCommitPut(final YangInstanceIdentifier path,
398 final NormalizedNode data, final @NonNull Insert insert, final YangInstanceIdentifier parentPath) {
399 final var tx = prepareWriteExecution();
401 return switch (insert.insert()) {
403 final var readData = tx.readList(parentPath);
404 if (readData == null || readData.isEmpty()) {
405 yield replaceAndCommit(tx, path, data);
407 tx.remove(parentPath);
408 tx.replace(path, data);
409 tx.replace(parentPath, readData);
412 case LAST -> replaceAndCommit(tx, path, data);
414 final var readData = tx.readList(parentPath);
415 if (readData == null || readData.isEmpty()) {
416 yield replaceAndCommit(tx, path, data);
418 insertWithPointPut(tx, path, data, verifyNotNull(insert.pointArg()), readData, true);
422 final var readData = tx.readList(parentPath);
423 if (readData == null || readData.isEmpty()) {
424 yield replaceAndCommit(tx, path, data);
426 insertWithPointPut(tx, path, data, verifyNotNull(insert.pointArg()), readData, false);
432 private void insertWithPointPut(final RestconfTransaction tx, final YangInstanceIdentifier path,
433 final NormalizedNode data, final @NonNull PathArgument pointArg, final NormalizedNodeContainer<?> readList,
434 final boolean before) {
435 tx.remove(path.getParent());
437 int lastItemPosition = 0;
438 for (var nodeChild : readList.body()) {
439 if (nodeChild.name().equals(pointArg)) {
448 int lastInsertedPosition = 0;
449 final var emptySubtree = ImmutableNodes.fromInstanceId(modelContext(), path.getParent());
450 tx.merge(YangInstanceIdentifier.of(emptySubtree.name()), emptySubtree);
451 for (var nodeChild : readList.body()) {
452 if (lastInsertedPosition == lastItemPosition) {
453 tx.replace(path, data);
455 final var childPath = path.coerceParent().node(nodeChild.name());
456 tx.replace(childPath, nodeChild);
457 lastInsertedPosition++;
461 private static ListenableFuture<? extends CommitInfo> replaceAndCommit(final RestconfTransaction tx,
462 final YangInstanceIdentifier path, final NormalizedNode data) {
463 tx.replace(path, data);
467 private DataSchemaNode checkListAndOrderedType(final YangInstanceIdentifier path) {
468 // FIXME: we have this available in InstanceIdentifierContext
469 final var dataSchemaNode = databind.schemaTree().findChild(path).orElseThrow().dataSchemaNode();
471 final String message;
472 if (dataSchemaNode instanceof ListSchemaNode listSchema) {
473 if (listSchema.isUserOrdered()) {
476 message = "Insert parameter can be used only with ordered-by user list.";
477 } else if (dataSchemaNode instanceof LeafListSchemaNode leafListSchema) {
478 if (leafListSchema.isUserOrdered()) {
479 return leafListSchema;
481 message = "Insert parameter can be used only with ordered-by user leaf-list.";
483 message = "Insert parameter can be used only with list or leaf-list";
485 throw new RestconfDocumentedException(message, ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT);
489 * Check mount point and prepare variables for post data.
493 * @param insert {@link Insert}
494 * @return A {@link RestconfFuture}
496 public final @NonNull RestconfFuture<CreateResource> postData(final YangInstanceIdentifier path,
497 final NormalizedNode data, final @Nullable Insert insert) {
498 final ListenableFuture<? extends CommitInfo> future;
499 if (insert != null) {
500 final var parentPath = path.coerceParent();
501 checkListAndOrderedType(parentPath);
502 future = insertAndCommitPost(path, data, insert, parentPath);
504 future = createAndCommit(prepareWriteExecution(), path, data);
507 final var ret = new SettableRestconfFuture<CreateResource>();
508 Futures.addCallback(future, new FutureCallback<CommitInfo>() {
510 public void onSuccess(final CommitInfo result) {
511 ret.set(new CreateResource(new YangInstanceIdentifierSerializer(databind).serializePath(
512 data instanceof MapNode mapData && !mapData.isEmpty()
513 ? path.node(mapData.body().iterator().next().name()) : path)));
517 public void onFailure(final Throwable cause) {
518 ret.setFailure(TransactionUtil.decodeException(cause, "POST", path, modelContext()));
521 }, MoreExecutors.directExecutor());
525 private ListenableFuture<? extends CommitInfo> insertAndCommitPost(final YangInstanceIdentifier path,
526 final NormalizedNode data, final @NonNull Insert insert, final YangInstanceIdentifier parent) {
527 final var grandParent = parent.coerceParent();
528 final var tx = prepareWriteExecution();
530 return switch (insert.insert()) {
532 final var readData = tx.readList(grandParent);
533 if (readData == null || readData.isEmpty()) {
534 tx.replace(path, data);
536 checkItemDoesNotExists(exists(path), path);
537 tx.remove(grandParent);
538 tx.replace(path, data);
539 tx.replace(grandParent, readData);
543 case LAST -> createAndCommit(tx, path, data);
545 final var readData = tx.readList(grandParent);
546 if (readData == null || readData.isEmpty()) {
547 tx.replace(path, data);
549 checkItemDoesNotExists(exists(path), path);
550 insertWithPointPost(tx, path, data, verifyNotNull(insert.pointArg()), readData, grandParent, true);
555 final var readData = tx.readList(grandParent);
556 if (readData == null || readData.isEmpty()) {
557 tx.replace(path, data);
559 checkItemDoesNotExists(exists(path), path);
560 insertWithPointPost(tx, path, data, verifyNotNull(insert.pointArg()), readData, grandParent, false);
568 * Merge data into the configuration datastore, as outlined in
569 * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040 section 4.6.1</a>.
571 * @param apiPath Path to merge
572 * @param body Data to merge
573 * @return A {@link RestconfFuture}
574 * @throws NullPointerException if any argument is {@code null}
576 public final @NonNull RestconfFuture<DataPatchResult> dataPATCH(final ApiPath apiPath, final ResourceBody body) {
579 path = pathNormalizer.normalizeDataPath(apiPath);
580 } catch (RestconfDocumentedException e) {
581 return RestconfFuture.failed(e);
584 final NormalizedNode data;
586 data = body.toNormalizedNode(new DataPutPath(databind, path.inference(), path.instance()));
587 } catch (RestconfDocumentedException e) {
588 return RestconfFuture.failed(e);
591 return merge(path.instance(), data);
594 public final @NonNull RestconfFuture<DataYangPatchResult> dataPATCH(final ApiPath apiPath, final PatchBody body) {
597 path = pathNormalizer.normalizeDataPath(apiPath);
598 } catch (RestconfDocumentedException e) {
599 return RestconfFuture.failed(e);
602 final PatchContext patch;
604 patch = body.toPatchContext(new DataPatchPath(databind, path.instance()));
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));
610 return patchData(patch);
614 * Process edit operations of one {@link PatchContext}.
616 * @param patch Patch context to be processed
617 * @return {@link PatchStatusContext}
619 public final @NonNull RestconfFuture<DataYangPatchResult> patchData(final PatchContext patch) {
620 final var editCollection = new ArrayList<PatchStatusEntity>();
621 final var tx = prepareWriteExecution();
623 boolean noError = true;
624 for (var patchEntity : patch.entities()) {
626 final var targetNode = patchEntity.getTargetNode();
627 final var editId = patchEntity.getEditId();
629 switch (patchEntity.getOperation()) {
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()));
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()));
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()));
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()));
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()));
677 editCollection.add(new PatchStatusEntity(editId, false, List.of(
678 new RestconfError(ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED,
679 "Not supported Yang Patch operation"))));
688 final var ret = new SettableRestconfFuture<DataYangPatchResult>();
692 ret.set(new DataYangPatchResult(
693 new PatchStatusContext(modelContext(), patch.patchId(), List.copyOf(editCollection), false, null)));
697 Futures.addCallback(tx.commit(), new FutureCallback<CommitInfo>() {
699 public void onSuccess(final CommitInfo result) {
700 ret.set(new DataYangPatchResult(
701 new PatchStatusContext(modelContext(), patch.patchId(), List.copyOf(editCollection), true, null)));
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(modelContext(), patch.patchId(), List.copyOf(editCollection), false,
709 TransactionUtil.decodeException(cause, "PATCH", null, modelContext()).getErrors())));
711 }, MoreExecutors.directExecutor());
716 private void insertWithPointPost(final RestconfTransaction tx, final YangInstanceIdentifier path,
717 final NormalizedNode data, final PathArgument pointArg, final NormalizedNodeContainer<?> readList,
718 final YangInstanceIdentifier grandParentPath, final boolean before) {
719 tx.remove(grandParentPath);
721 int lastItemPosition = 0;
722 for (var nodeChild : readList.body()) {
723 if (nodeChild.name().equals(pointArg)) {
732 int lastInsertedPosition = 0;
733 final var emptySubtree = ImmutableNodes.fromInstanceId(modelContext(), grandParentPath);
734 tx.merge(YangInstanceIdentifier.of(emptySubtree.name()), emptySubtree);
735 for (var nodeChild : readList.body()) {
736 if (lastInsertedPosition == lastItemPosition) {
737 tx.replace(path, data);
739 tx.replace(grandParentPath.node(nodeChild.name()), nodeChild);
740 lastInsertedPosition++;
744 private static ListenableFuture<? extends CommitInfo> createAndCommit(final RestconfTransaction tx,
745 final YangInstanceIdentifier path, final NormalizedNode data) {
747 tx.create(path, data);
748 } catch (RestconfDocumentedException e) {
749 // close transaction if any and pass exception further
758 * Check if items do NOT already exists at specified {@code path}.
760 * @param existsFuture if checked data exists
761 * @param path Path to be checked
762 * @throws RestconfDocumentedException if data already exists.
764 static void checkItemDoesNotExists(final ListenableFuture<Boolean> existsFuture,
765 final YangInstanceIdentifier path) {
766 if (TransactionUtil.syncAccess(existsFuture, path)) {
767 LOG.trace("Operation via Restconf was not executed because data at {} already exists", path);
768 throw new RestconfDocumentedException("Data already exists", ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS,
774 * Delete data from the configuration datastore. If the data does not exist, this operation will fail, as outlined
775 * in <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.7">RFC8040 section 4.7</a>
777 * @param apiPath Path to delete
778 * @return A {@link RestconfFuture}
779 * @throws NullPointerException if {@code apiPath} is {@code null}
781 @SuppressWarnings("checkstyle:abbreviationAsWordInName")
782 public final @NonNull RestconfFuture<Empty> dataDELETE(final ApiPath apiPath) {
785 path = pathNormalizer.normalizeDataPath(apiPath);
786 } catch (RestconfDocumentedException e) {
787 return RestconfFuture.failed(e);
790 // FIXME: reject empty YangInstanceIdentifier, as datastores may not be deleted
791 final var ret = new SettableRestconfFuture<Empty>();
792 delete(ret, path.instance());
796 abstract void delete(@NonNull SettableRestconfFuture<Empty> future, @NonNull YangInstanceIdentifier path);
798 public final @NonNull RestconfFuture<DataGetResult> dataGET(final ApiPath apiPath,
799 final DataGetParams params) {
802 path = pathNormalizer.normalizeDataPath(apiPath);
803 } catch (RestconfDocumentedException e) {
804 return RestconfFuture.failed(e);
806 return dataGET(path, params);
809 abstract @NonNull RestconfFuture<DataGetResult> dataGET(DataPath path, DataGetParams params);
811 static final @NonNull RestconfFuture<DataGetResult> completeDataGET(final Inference inference,
812 final QueryParameters queryParams, final @Nullable NormalizedNode node,
813 final @Nullable ConfigurationMetadata metadata) {
815 return RestconfFuture.failed(new RestconfDocumentedException(
816 "Request could not be completed because the relevant data model content does not exist",
817 ErrorType.PROTOCOL, ErrorTag.DATA_MISSING));
820 final var payload = new NormalizedNodePayload(inference, node, queryParams);
821 return RestconfFuture.of(metadata == null ? new DataGetResult(payload)
822 : new DataGetResult(payload, metadata.entityTag(), metadata.lastModified()));
826 * Read specific type of data from data store via transaction. Close {@link DOMTransactionChain} if any
827 * inside of object {@link RestconfStrategy} provided as a parameter.
829 * @param content type of data to read (config, state, all)
830 * @param path the path to read
831 * @param defaultsMode value of with-defaults parameter
832 * @return {@link NormalizedNode}
834 // FIXME: NETCONF-1155: this method should asynchronous
835 public final @Nullable NormalizedNode readData(final @NonNull ContentParam content,
836 final @NonNull YangInstanceIdentifier path, final WithDefaultsParam defaultsMode) {
837 return switch (content) {
839 // PREPARE STATE DATA NODE
840 final var stateDataNode = readDataViaTransaction(LogicalDatastoreType.OPERATIONAL, path);
841 // PREPARE CONFIG DATA NODE
842 final var configDataNode = readDataViaTransaction(LogicalDatastoreType.CONFIGURATION, path);
844 yield mergeConfigAndSTateDataIfNeeded(stateDataNode, defaultsMode == null ? configDataNode
845 : prepareDataByParamWithDef(configDataNode, path, defaultsMode.mode()));
848 final var read = readDataViaTransaction(LogicalDatastoreType.CONFIGURATION, path);
849 yield defaultsMode == null ? read
850 : prepareDataByParamWithDef(read, path, defaultsMode.mode());
852 case NONCONFIG -> readDataViaTransaction(LogicalDatastoreType.OPERATIONAL, path);
856 private @Nullable NormalizedNode readDataViaTransaction(final LogicalDatastoreType store,
857 final YangInstanceIdentifier path) {
858 return TransactionUtil.syncAccess(read(store, path), path).orElse(null);
861 final NormalizedNode prepareDataByParamWithDef(final NormalizedNode readData, final YangInstanceIdentifier path,
862 final WithDefaultsMode defaultsMode) {
863 final boolean trim = switch (defaultsMode) {
865 case Explicit -> false;
866 case ReportAll, ReportAllTagged -> throw new RestconfDocumentedException(
867 "Unsupported with-defaults value " + defaultsMode.getName());
870 // FIXME: we have this readily available in InstanceIdentifierContext
871 final var ctxNode = databind.schemaTree().findChild(path).orElseThrow();
872 if (readData instanceof ContainerNode container) {
873 final var builder = Builders.containerBuilder().withNodeIdentifier(container.name());
874 buildCont(builder, container.body(), ctxNode, trim);
875 return builder.build();
876 } else if (readData instanceof MapEntryNode mapEntry) {
877 if (!(ctxNode.dataSchemaNode() instanceof ListSchemaNode listSchema)) {
878 throw new IllegalStateException("Input " + mapEntry + " does not match " + ctxNode);
881 final var builder = Builders.mapEntryBuilder().withNodeIdentifier(mapEntry.name());
882 buildMapEntryBuilder(builder, mapEntry.body(), ctxNode, trim, listSchema.getKeyDefinition());
883 return builder.build();
885 throw new IllegalStateException("Unhandled data contract " + readData.contract());
889 private static void buildMapEntryBuilder(
890 final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder,
891 final Collection<@NonNull DataContainerChild> children, final DataSchemaContext ctxNode,
892 final boolean trim, final List<QName> keys) {
893 for (var child : children) {
894 final var childCtx = getChildContext(ctxNode, child);
896 if (child instanceof ContainerNode container) {
897 appendContainer(builder, container, childCtx, trim);
898 } else if (child instanceof MapNode map) {
899 appendMap(builder, map, childCtx, trim);
900 } else if (child instanceof LeafNode<?> leaf) {
901 appendLeaf(builder, leaf, childCtx, trim, keys);
903 // FIXME: we should never hit this, throw an ISE if this ever happens
904 LOG.debug("Ignoring unhandled child contract {}", child.contract());
909 private static void appendContainer(final DataContainerNodeBuilder<?, ?> builder, final ContainerNode container,
910 final DataSchemaContext ctxNode, final boolean trim) {
911 final var childBuilder = Builders.containerBuilder().withNodeIdentifier(container.name());
912 buildCont(childBuilder, container.body(), ctxNode, trim);
913 builder.withChild(childBuilder.build());
916 private static void appendLeaf(final DataContainerNodeBuilder<?, ?> builder, final LeafNode<?> leaf,
917 final DataSchemaContext ctxNode, final boolean trim, final List<QName> keys) {
918 if (!(ctxNode.dataSchemaNode() instanceof LeafSchemaNode leafSchema)) {
919 throw new IllegalStateException("Input " + leaf + " does not match " + ctxNode);
922 // FIXME: Document now this works with the likes of YangInstanceIdentifier. I bet it does not.
923 final var defaultVal = leafSchema.getType().getDefaultValue().orElse(null);
925 // This is a combined check for when we need to emit the leaf.
927 // We always have to emit key leaf values
928 keys.contains(leafSchema.getQName())
929 // trim == WithDefaultsParam.TRIM and the source is assumed to store explicit values:
931 // When data is retrieved with a <with-defaults> parameter equal to
932 // 'trim', data nodes MUST NOT be reported if they contain the schema
933 // default value. Non-configuration data nodes containing the schema
934 // default value MUST NOT be reported.
936 || trim && (defaultVal == null || !defaultVal.equals(leaf.body()))
937 // !trim == WithDefaultsParam.EXPLICIT and the source is assume to store explicit values... but I fail to
938 // grasp what we are doing here... emit only if it matches default ???!!!
939 // FIXME: The WithDefaultsParam.EXPLICIT says:
941 // Data nodes set to the YANG default by the client are reported.
943 // and RFC8040 (https://www.rfc-editor.org/rfc/rfc8040#page-60) says:
945 // If the "with-defaults" parameter is set to "explicit", then the
946 // server MUST adhere to the default-reporting behavior defined in
947 // Section 3.3 of [RFC6243].
949 // and then RFC6243 (https://www.rfc-editor.org/rfc/rfc6243#section-3.3) says:
951 // When data is retrieved with a <with-defaults> parameter equal to
952 // 'explicit', a data node that was set by a client to its schema
953 // default value MUST be reported. A conceptual data node that would be
954 // set by the server to the schema default value MUST NOT be reported.
955 // Non-configuration data nodes containing the schema default value MUST
958 // (rovarga): The source reports explicitly-defined leaves and does *not* create defaults by itself.
959 // This seems to disregard the 'trim = true' case semantics (see above).
960 // Combining the above, though, these checks are missing the 'non-config' check, which would
961 // distinguish, but barring that this check is superfluous and results in the wrong semantics.
962 // Without that input, this really should be covered by the previous case.
963 || !trim && defaultVal != null && defaultVal.equals(leaf.body())) {
964 builder.withChild(leaf);
968 private static void appendMap(final DataContainerNodeBuilder<?, ?> builder, final MapNode map,
969 final DataSchemaContext childCtx, final boolean trim) {
970 if (!(childCtx.dataSchemaNode() instanceof ListSchemaNode listSchema)) {
971 throw new IllegalStateException("Input " + map + " does not match " + childCtx);
974 final var childBuilder = switch (map.ordering()) {
975 case SYSTEM -> Builders.mapBuilder();
976 case USER -> Builders.orderedMapBuilder();
978 buildList(childBuilder.withNodeIdentifier(map.name()), map.body(), childCtx, trim,
979 listSchema.getKeyDefinition());
980 builder.withChild(childBuilder.build());
983 private static void buildList(final CollectionNodeBuilder<MapEntryNode, ? extends MapNode> builder,
984 final Collection<@NonNull MapEntryNode> entries, final DataSchemaContext ctxNode, final boolean trim,
985 final List<@NonNull QName> keys) {
986 for (var entry : entries) {
987 final var childCtx = getChildContext(ctxNode, entry);
988 final var mapEntryBuilder = Builders.mapEntryBuilder().withNodeIdentifier(entry.name());
989 buildMapEntryBuilder(mapEntryBuilder, entry.body(), childCtx, trim, keys);
990 builder.withChild(mapEntryBuilder.build());
994 private static void buildCont(final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder,
995 final Collection<DataContainerChild> children, final DataSchemaContext ctxNode, final boolean trim) {
996 for (var child : children) {
997 final var childCtx = getChildContext(ctxNode, child);
998 if (child instanceof ContainerNode container) {
999 appendContainer(builder, container, childCtx, trim);
1000 } else if (child instanceof MapNode map) {
1001 appendMap(builder, map, childCtx, trim);
1002 } else if (child instanceof LeafNode<?> leaf) {
1003 appendLeaf(builder, leaf, childCtx, trim, List.of());
1008 private static @NonNull DataSchemaContext getChildContext(final DataSchemaContext ctxNode,
1009 final NormalizedNode child) {
1010 final var childId = child.name();
1011 final var childCtx = ctxNode instanceof DataSchemaContext.Composite composite ? composite.childByArg(childId)
1013 if (childCtx == null) {
1014 throw new NoSuchElementException("Cannot resolve child " + childId + " in " + ctxNode);
1019 static final NormalizedNode mergeConfigAndSTateDataIfNeeded(final NormalizedNode stateDataNode,
1020 final NormalizedNode configDataNode) {
1021 // if no data exists
1022 if (stateDataNode == null && configDataNode == null) {
1026 // return config data
1027 if (stateDataNode == null) {
1028 return configDataNode;
1031 // return state data
1032 if (configDataNode == null) {
1033 return stateDataNode;
1036 // merge data from config and state
1037 return mergeStateAndConfigData(stateDataNode, configDataNode);
1041 * Merge state and config data into a single NormalizedNode.
1043 * @param stateDataNode data node of state data
1044 * @param configDataNode data node of config data
1045 * @return {@link NormalizedNode}
1047 private static @NonNull NormalizedNode mergeStateAndConfigData(
1048 final @NonNull NormalizedNode stateDataNode, final @NonNull NormalizedNode configDataNode) {
1049 validateNodeMerge(stateDataNode, configDataNode);
1050 // FIXME: this check is bogus, as it confuses yang.data.api (NormalizedNode) with yang.model.api (RpcDefinition)
1051 if (configDataNode instanceof RpcDefinition) {
1052 return prepareRpcData(configDataNode, stateDataNode);
1054 return prepareData(configDataNode, stateDataNode);
1059 * Validates whether the two NormalizedNodes can be merged.
1061 * @param stateDataNode data node of state data
1062 * @param configDataNode data node of config data
1064 private static void validateNodeMerge(final @NonNull NormalizedNode stateDataNode,
1065 final @NonNull NormalizedNode configDataNode) {
1066 final QNameModule moduleOfStateData = stateDataNode.name().getNodeType().getModule();
1067 final QNameModule moduleOfConfigData = configDataNode.name().getNodeType().getModule();
1068 if (!moduleOfStateData.equals(moduleOfConfigData)) {
1069 throw new RestconfDocumentedException("Unable to merge data from different modules.");
1074 * Prepare and map data for rpc.
1076 * @param configDataNode data node of config data
1077 * @param stateDataNode data node of state data
1078 * @return {@link NormalizedNode}
1080 private static @NonNull NormalizedNode prepareRpcData(final @NonNull NormalizedNode configDataNode,
1081 final @NonNull NormalizedNode stateDataNode) {
1082 final var mapEntryBuilder = Builders.mapEntryBuilder()
1083 .withNodeIdentifier((NodeIdentifierWithPredicates) configDataNode.name());
1086 mapRpcDataNode(configDataNode, mapEntryBuilder);
1088 mapRpcDataNode(stateDataNode, mapEntryBuilder);
1090 return Builders.mapBuilder()
1091 .withNodeIdentifier(NodeIdentifier.create(configDataNode.name().getNodeType()))
1092 .addChild(mapEntryBuilder.build())
1097 * Map node to map entry builder.
1099 * @param dataNode data node
1100 * @param mapEntryBuilder builder for mapping data
1102 private static void mapRpcDataNode(final @NonNull NormalizedNode dataNode,
1103 final @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder) {
1104 ((ContainerNode) dataNode).body().forEach(mapEntryBuilder::addChild);
1108 * Prepare and map all data from DS.
1110 * @param configDataNode data node of config data
1111 * @param stateDataNode data node of state data
1112 * @return {@link NormalizedNode}
1114 @SuppressWarnings("unchecked")
1115 private static @NonNull NormalizedNode prepareData(final @NonNull NormalizedNode configDataNode,
1116 final @NonNull NormalizedNode stateDataNode) {
1117 if (configDataNode instanceof UserMapNode configMap) {
1118 final var builder = Builders.orderedMapBuilder().withNodeIdentifier(configMap.name());
1119 mapValueToBuilder(configMap.body(), ((UserMapNode) stateDataNode).body(), builder);
1120 return builder.build();
1121 } else if (configDataNode instanceof SystemMapNode configMap) {
1122 final var builder = Builders.mapBuilder().withNodeIdentifier(configMap.name());
1123 mapValueToBuilder(configMap.body(), ((SystemMapNode) stateDataNode).body(), builder);
1124 return builder.build();
1125 } else if (configDataNode instanceof MapEntryNode configEntry) {
1126 final var builder = Builders.mapEntryBuilder().withNodeIdentifier(configEntry.name());
1127 mapValueToBuilder(configEntry.body(), ((MapEntryNode) stateDataNode).body(), builder);
1128 return builder.build();
1129 } else if (configDataNode instanceof ContainerNode configContaienr) {
1130 final var builder = Builders.containerBuilder().withNodeIdentifier(configContaienr.name());
1131 mapValueToBuilder(configContaienr.body(), ((ContainerNode) stateDataNode).body(), builder);
1132 return builder.build();
1133 } else if (configDataNode instanceof ChoiceNode configChoice) {
1134 final var builder = Builders.choiceBuilder().withNodeIdentifier(configChoice.name());
1135 mapValueToBuilder(configChoice.body(), ((ChoiceNode) stateDataNode).body(), builder);
1136 return builder.build();
1137 } else if (configDataNode instanceof LeafNode configLeaf) {
1138 // config trumps oper
1140 } else if (configDataNode instanceof UserLeafSetNode) {
1141 final var configLeafSet = (UserLeafSetNode<Object>) configDataNode;
1142 final var builder = Builders.<Object>orderedLeafSetBuilder().withNodeIdentifier(configLeafSet.name());
1143 mapValueToBuilder(configLeafSet.body(), ((UserLeafSetNode<Object>) stateDataNode).body(), builder);
1144 return builder.build();
1145 } else if (configDataNode instanceof SystemLeafSetNode) {
1146 final var configLeafSet = (SystemLeafSetNode<Object>) configDataNode;
1147 final var builder = Builders.<Object>leafSetBuilder().withNodeIdentifier(configLeafSet.name());
1148 mapValueToBuilder(configLeafSet.body(), ((SystemLeafSetNode<Object>) stateDataNode).body(), builder);
1149 return builder.build();
1150 } else if (configDataNode instanceof LeafSetEntryNode<?> configEntry) {
1151 // config trumps oper
1153 } else if (configDataNode instanceof UnkeyedListNode configList) {
1154 final var builder = Builders.unkeyedListBuilder().withNodeIdentifier(configList.name());
1155 mapValueToBuilder(configList.body(), ((UnkeyedListNode) stateDataNode).body(), builder);
1156 return builder.build();
1157 } else if (configDataNode instanceof UnkeyedListEntryNode configEntry) {
1158 final var builder = Builders.unkeyedListEntryBuilder().withNodeIdentifier(configEntry.name());
1159 mapValueToBuilder(configEntry.body(), ((UnkeyedListEntryNode) stateDataNode).body(), builder);
1160 return builder.build();
1162 throw new RestconfDocumentedException("Unexpected node type: " + configDataNode.getClass().getName());
1167 * Map value from container node to builder.
1169 * @param configData collection of config data nodes
1170 * @param stateData collection of state data nodes
1171 * @param builder builder
1173 private static <T extends NormalizedNode> void mapValueToBuilder(
1174 final @NonNull Collection<T> configData, final @NonNull Collection<T> stateData,
1175 final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
1176 final var configMap = configData.stream().collect(Collectors.toMap(NormalizedNode::name, Function.identity()));
1177 final var stateMap = stateData.stream().collect(Collectors.toMap(NormalizedNode::name, Function.identity()));
1179 // merge config and state data of children with different identifiers
1180 mapDataToBuilder(configMap, stateMap, builder);
1182 // merge config and state data of children with the same identifiers
1183 mergeDataToBuilder(configMap, stateMap, builder);
1187 * Map data with different identifiers to builder. Data with different identifiers can be just added
1188 * as childs to parent node.
1190 * @param configMap map of config data nodes
1191 * @param stateMap map of state data nodes
1192 * @param builder - builder
1194 private static <T extends NormalizedNode> void mapDataToBuilder(
1195 final @NonNull Map<PathArgument, T> configMap, final @NonNull Map<PathArgument, T> stateMap,
1196 final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
1197 configMap.entrySet().stream().filter(x -> !stateMap.containsKey(x.getKey())).forEach(
1198 y -> builder.addChild(y.getValue()));
1199 stateMap.entrySet().stream().filter(x -> !configMap.containsKey(x.getKey())).forEach(
1200 y -> builder.addChild(y.getValue()));
1204 * Map data with the same identifiers to builder. Data with the same identifiers cannot be just added but we need to
1205 * go one level down with {@code prepareData} method.
1207 * @param configMap immutable config data
1208 * @param stateMap immutable state data
1209 * @param builder - builder
1211 @SuppressWarnings("unchecked")
1212 private static <T extends NormalizedNode> void mergeDataToBuilder(
1213 final @NonNull Map<PathArgument, T> configMap, final @NonNull Map<PathArgument, T> stateMap,
1214 final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
1215 // it is enough to process only config data because operational contains the same data
1216 configMap.entrySet().stream().filter(x -> stateMap.containsKey(x.getKey())).forEach(
1217 y -> builder.addChild((T) prepareData(y.getValue(), stateMap.get(y.getKey()))));
1220 public @NonNull RestconfFuture<OperationsGetResult> operationsGET() {
1221 final var modelContext = modelContext();
1222 final var modules = modelContext.getModuleStatements();
1223 if (modules.isEmpty()) {
1224 // No modules, or defensive return empty content
1225 return RestconfFuture.of(new OperationsGetResult.Container(modelContext, ImmutableSetMultimap.of()));
1228 // RPC QNames by their XMLNamespace/Revision. This should be a Table, but Revision can be null, which wrecks us.
1229 final var table = new HashMap<XMLNamespace, Map<Revision, ImmutableSet<QName>>>();
1230 for (var entry : modules.entrySet()) {
1231 final var module = entry.getValue();
1232 final var rpcNames = module.streamEffectiveSubstatements(RpcEffectiveStatement.class)
1233 .map(RpcEffectiveStatement::argument)
1234 .collect(ImmutableSet.toImmutableSet());
1235 if (!rpcNames.isEmpty()) {
1236 final var namespace = entry.getKey();
1237 table.computeIfAbsent(namespace.getNamespace(), ignored -> new HashMap<>())
1238 .put(namespace.getRevision().orElse(null), rpcNames);
1242 // Now pick the latest revision for each namespace
1243 final var rpcs = ImmutableSetMultimap.<QNameModule, QName>builder();
1244 for (var entry : table.entrySet()) {
1245 entry.getValue().entrySet().stream()
1246 .sorted(Comparator.comparing(Entry::getKey, (first, second) -> Revision.compare(second, first)))
1248 .ifPresent(row -> rpcs.putAll(QNameModule.create(entry.getKey(), row.getKey()), row.getValue()));
1250 return RestconfFuture.of(new OperationsGetResult.Container(modelContext, rpcs.build()));
1253 public @NonNull RestconfFuture<OperationsGetResult> operationsGET(final ApiPath apiPath) {
1254 if (apiPath.steps().isEmpty()) {
1255 return operationsGET();
1260 rpc = pathNormalizer.normalizeRpcPath(apiPath);
1261 } catch (RestconfDocumentedException e) {
1262 return RestconfFuture.failed(e);
1265 return RestconfFuture.of(new OperationsGetResult.Leaf(rpc.inference().modelContext(), rpc.rpc().argument()));
1268 public @NonNull RestconfFuture<OperationsPostResult> operationsPOST(final URI restconfURI, final ApiPath apiPath,
1269 final OperationInputBody body) {
1270 final OperationPath.Rpc path;
1272 path = pathNormalizer.normalizeRpcPath(apiPath);
1273 } catch (RestconfDocumentedException e) {
1274 return RestconfFuture.failed(e);
1277 final var postPath = new OperationsPostPath(databind, path.inference());
1278 final ContainerNode data;
1280 data = body.toContainerNode(postPath);
1281 } catch (IOException e) {
1282 LOG.debug("Error reading input", e);
1283 return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
1284 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
1287 final var type = path.rpc().argument();
1288 final var local = localRpcs.get(type);
1289 if (local != null) {
1290 return local.invoke(restconfURI, new OperationInput(databind, postPath.operation(), data));
1292 if (rpcService == null) {
1293 LOG.debug("RPC invocation is not available");
1294 return RestconfFuture.failed(new RestconfDocumentedException("RPC invocation is not available",
1295 ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED));
1298 final var ret = new SettableRestconfFuture<OperationsPostResult>();
1299 Futures.addCallback(rpcService.invokeRpc(type, data), new FutureCallback<DOMRpcResult>() {
1301 public void onSuccess(final DOMRpcResult response) {
1302 final var errors = response.errors();
1303 if (errors.isEmpty()) {
1304 ret.set(new OperationsPostResult(databind, postPath.operation(), response.value()));
1306 LOG.debug("RPC invocation reported {}", response.errors());
1307 ret.setFailure(new RestconfDocumentedException("RPC implementation reported errors", null,
1308 response.errors()));
1313 public void onFailure(final Throwable cause) {
1314 LOG.debug("RPC invocation failed, cause");
1315 if (cause instanceof RestconfDocumentedException ex) {
1318 // TODO: YangNetconfErrorAware if we ever get into a broader invocation scope
1319 ret.setFailure(new RestconfDocumentedException(cause,
1320 new RestconfError(ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage())));
1323 }, MoreExecutors.directExecutor());
1327 public @NonNull RestconfFuture<CharSource> resolveSource(final SourceIdentifier source,
1328 final Class<? extends SourceRepresentation> representation) {
1329 final var src = requireNonNull(source);
1330 if (YangTextSource.class.isAssignableFrom(representation)) {
1331 if (sourceProvider != null) {
1332 final var ret = new SettableRestconfFuture<CharSource>();
1333 Futures.addCallback(sourceProvider.getYangTexttSource(src), new FutureCallback<>() {
1335 public void onSuccess(final YangTextSource result) {
1340 public void onFailure(final Throwable cause) {
1341 ret.setFailure(cause instanceof RestconfDocumentedException e ? e
1342 : new RestconfDocumentedException(cause.getMessage(), ErrorType.RPC,
1343 ErrorTag.OPERATION_FAILED, cause));
1345 }, MoreExecutors.directExecutor());
1348 return exportSource(modelContext(), src, YangCharSource::new, YangCharSource::new);
1350 if (YinTextSource.class.isAssignableFrom(representation)) {
1351 return exportSource(modelContext(), src, YinCharSource.OfModule::new, YinCharSource.OfSubmodule::new);
1353 return RestconfFuture.failed(new RestconfDocumentedException(
1354 "Unsupported source representation " + representation.getName()));
1357 private static @NonNull RestconfFuture<CharSource> exportSource(final EffectiveModelContext modelContext,
1358 final SourceIdentifier source, final Function<ModuleEffectiveStatement, CharSource> moduleCtor,
1359 final BiFunction<ModuleEffectiveStatement, SubmoduleEffectiveStatement, CharSource> submoduleCtor) {
1360 // If the source identifies a module, things are easy
1361 final var name = source.name().getLocalName();
1362 final var optRevision = Optional.ofNullable(source.revision());
1363 final var optModule = modelContext.findModule(name, optRevision);
1364 if (optModule.isPresent()) {
1365 return RestconfFuture.of(moduleCtor.apply(optModule.orElseThrow().asEffectiveStatement()));
1368 // The source could be a submodule, which we need to hunt down
1369 for (var module : modelContext.getModules()) {
1370 for (var submodule : module.getSubmodules()) {
1371 if (name.equals(submodule.getName()) && optRevision.equals(submodule.getRevision())) {
1372 return RestconfFuture.of(submoduleCtor.apply(module.asEffectiveStatement(),
1373 submodule.asEffectiveStatement()));
1378 final var sb = new StringBuilder().append("Source ").append(source.name().getLocalName());
1379 optRevision.ifPresent(rev -> sb.append('@').append(rev));
1380 sb.append(" not found");
1381 return RestconfFuture.failed(new RestconfDocumentedException(sb.toString(),
1382 ErrorType.APPLICATION, ErrorTag.DATA_MISSING));
1385 public final @NonNull RestconfFuture<? extends DataPostResult> dataPOST(final ApiPath apiPath,
1386 final DataPostBody body, final Map<String, String> queryParameters) {
1387 if (apiPath.steps().isEmpty()) {
1388 return dataCreatePOST(body.toResource(), queryParameters);
1390 final InstanceReference path;
1392 path = pathNormalizer.normalizeDataOrActionPath(apiPath);
1393 } catch (RestconfDocumentedException e) {
1394 return RestconfFuture.failed(e);
1396 if (path instanceof DataPath dataPath) {
1397 try (var resourceBody = body.toResource()) {
1398 return dataCreatePOST(new DataPostPath(databind, dataPath.inference(), dataPath.instance()),
1399 resourceBody, queryParameters);
1402 if (path instanceof OperationPath.Action actionPath) {
1403 try (var inputBody = body.toOperationInput()) {
1404 return dataInvokePOST(actionPath, inputBody);
1407 // Note: this should never happen
1408 // FIXME: we should be able to eliminate this path with Java 21+ pattern matching
1409 return RestconfFuture.failed(new RestconfDocumentedException("Unhandled path " + path));
1412 public @NonNull RestconfFuture<CreateResource> dataCreatePOST(final ChildBody body,
1413 final Map<String, String> queryParameters) {
1414 return dataCreatePOST(new DataPostPath(databind,
1415 SchemaInferenceStack.of(databind.modelContext()).toInference(), YangInstanceIdentifier.of()), body,
1419 private @NonNull RestconfFuture<CreateResource> dataCreatePOST(final DataPostPath path, final ChildBody body,
1420 final Map<String, String> queryParameters) {
1421 final Insert insert;
1423 insert = Insert.ofQueryParameters(path.databind(), queryParameters);
1424 } catch (IllegalArgumentException e) {
1425 return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
1426 ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
1429 final var payload = body.toPayload(path);
1430 return postData(concat(path.instance(), payload.prefix()), payload.body(), insert);
1433 private static YangInstanceIdentifier concat(final YangInstanceIdentifier parent, final List<PathArgument> args) {
1435 for (var arg : args) {
1436 ret = ret.node(arg);
1441 private @NonNull RestconfFuture<InvokeOperation> dataInvokePOST(final OperationPath.Action path,
1442 final OperationInputBody body) {
1443 final var inference = path.inference();
1444 final ContainerNode input;
1446 input = body.toContainerNode(new OperationsPostPath(databind, inference));
1447 } catch (IOException e) {
1448 LOG.debug("Error reading input", e);
1449 return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
1450 ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
1453 if (actionService == null) {
1454 return RestconfFuture.failed(new RestconfDocumentedException("DOMActionService is missing."));
1457 final var future = dataInvokePOST(actionService, path, input);
1458 return future.transform(result -> result.getOutput()
1459 .flatMap(output -> output.isEmpty() ? Optional.empty()
1460 : Optional.of(new InvokeOperation(new NormalizedNodePayload(inference, output))))
1461 .orElse(InvokeOperation.EMPTY));
1465 * Invoke Action via ActionServiceHandler.
1467 * @param input input data
1468 * @param yangIId invocation context
1469 * @param schemaPath schema path of data
1470 * @param actionService action service to invoke action
1471 * @return {@link DOMActionResult}
1473 private static RestconfFuture<DOMActionResult> dataInvokePOST(final DOMActionService actionService,
1474 final OperationPath.Action path, final @NonNull ContainerNode input) {
1475 final var ret = new SettableRestconfFuture<DOMActionResult>();
1477 Futures.addCallback(actionService.invokeAction(
1478 path.inference().toSchemaInferenceStack().toSchemaNodeIdentifier(),
1479 new DOMDataTreeIdentifier(LogicalDatastoreType.OPERATIONAL, path.instance()), input),
1480 new FutureCallback<DOMActionResult>() {
1482 public void onSuccess(final DOMActionResult result) {
1483 final var errors = result.getErrors();
1484 LOG.debug("InvokeAction Error Message {}", errors);
1485 if (errors.isEmpty()) {
1488 ret.setFailure(new RestconfDocumentedException("InvokeAction Error Message ", null, errors));
1493 public void onFailure(final Throwable cause) {
1494 if (cause instanceof DOMActionException) {
1495 ret.set(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
1496 ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage()))));
1497 } else if (cause instanceof RestconfDocumentedException e) {
1499 } else if (cause instanceof CancellationException) {
1500 ret.setFailure(new RestconfDocumentedException("Action cancelled while executing",
1501 ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, cause));
1503 ret.setFailure(new RestconfDocumentedException("Invocation failed", cause));
1506 }, MoreExecutors.directExecutor());