import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;
+import static org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes.fromInstanceId;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.collect.ImmutableMap;
+import com.google.common.io.CharSource;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
+import java.io.IOException;
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collection;
import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
import java.util.Optional;
+import java.util.concurrent.CancellationException;
+import java.util.function.BiFunction;
+import java.util.function.Function;
+import java.util.stream.Collectors;
import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.mdsal.common.api.CommitInfo;
import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.dom.api.DOMActionException;
+import org.opendaylight.mdsal.dom.api.DOMActionResult;
+import org.opendaylight.mdsal.dom.api.DOMActionService;
import org.opendaylight.mdsal.dom.api.DOMDataBroker;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
import org.opendaylight.mdsal.dom.api.DOMMountPoint;
+import org.opendaylight.mdsal.dom.api.DOMMountPointService;
+import org.opendaylight.mdsal.dom.api.DOMRpcResult;
+import org.opendaylight.mdsal.dom.api.DOMRpcService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService;
+import org.opendaylight.mdsal.dom.api.DOMSchemaService.YangTextSourceExtension;
+import org.opendaylight.mdsal.dom.api.DOMTransactionChain;
+import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
import org.opendaylight.netconf.dom.api.NetconfDataTreeService;
-import org.opendaylight.restconf.api.query.PointParam;
+import org.opendaylight.restconf.api.ApiPath;
+import org.opendaylight.restconf.api.FormattableBody;
+import org.opendaylight.restconf.api.query.ContentParam;
+import org.opendaylight.restconf.api.query.WithDefaultsParam;
import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
+import org.opendaylight.restconf.common.errors.RestconfError;
import org.opendaylight.restconf.common.errors.RestconfFuture;
import org.opendaylight.restconf.common.errors.SettableRestconfFuture;
+import org.opendaylight.restconf.common.patch.PatchContext;
import org.opendaylight.restconf.nb.rfc8040.Insert;
-import org.opendaylight.restconf.nb.rfc8040.rests.utils.TransactionUtil;
-import org.opendaylight.restconf.nb.rfc8040.utils.parser.YangInstanceIdentifierDeserializer;
+import org.opendaylight.restconf.nb.rfc8040.legacy.ErrorTags;
+import org.opendaylight.restconf.server.api.ChildBody;
+import org.opendaylight.restconf.server.api.ConfigurationMetadata;
+import org.opendaylight.restconf.server.api.CreateResourceResult;
+import org.opendaylight.restconf.server.api.DataGetParams;
+import org.opendaylight.restconf.server.api.DataGetResult;
+import org.opendaylight.restconf.server.api.DataPatchResult;
+import org.opendaylight.restconf.server.api.DataPostBody;
+import org.opendaylight.restconf.server.api.DataPostResult;
+import org.opendaylight.restconf.server.api.DataPutResult;
+import org.opendaylight.restconf.server.api.DataYangPatchResult;
+import org.opendaylight.restconf.server.api.DatabindContext;
+import org.opendaylight.restconf.server.api.DatabindPath;
+import org.opendaylight.restconf.server.api.DatabindPath.Action;
+import org.opendaylight.restconf.server.api.DatabindPath.Data;
+import org.opendaylight.restconf.server.api.DatabindPath.InstanceReference;
+import org.opendaylight.restconf.server.api.DatabindPath.OperationPath;
+import org.opendaylight.restconf.server.api.DatabindPath.Rpc;
+import org.opendaylight.restconf.server.api.InvokeResult;
+import org.opendaylight.restconf.server.api.OperationInputBody;
+import org.opendaylight.restconf.server.api.PatchBody;
+import org.opendaylight.restconf.server.api.PatchStatusContext;
+import org.opendaylight.restconf.server.api.PatchStatusEntity;
+import org.opendaylight.restconf.server.api.ResourceBody;
+import org.opendaylight.restconf.server.api.ServerRequest;
+import org.opendaylight.restconf.server.spi.ApiPathCanonizer;
+import org.opendaylight.restconf.server.spi.ApiPathNormalizer;
+import org.opendaylight.restconf.server.spi.DefaultResourceContext;
+import org.opendaylight.restconf.server.spi.HttpGetResource;
+import org.opendaylight.restconf.server.spi.NormalizedFormattableBody;
+import org.opendaylight.restconf.server.spi.NormalizedNodeWriterFactory;
+import org.opendaylight.restconf.server.spi.OperationInput;
+import org.opendaylight.restconf.server.spi.OperationOutputBody;
+import org.opendaylight.restconf.server.spi.OperationsResource;
+import org.opendaylight.restconf.server.spi.RpcImplementation;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.with.defaults.rev110601.WithDefaultsMode;
import org.opendaylight.yangtools.yang.common.Empty;
import org.opendaylight.yangtools.yang.common.ErrorTag;
import org.opendaylight.yangtools.yang.common.ErrorType;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
+import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
+import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
+import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
+import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
+import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
+import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
-import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
-import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
+import org.opendaylight.yangtools.yang.data.api.schema.SystemLeafSetNode;
+import org.opendaylight.yangtools.yang.data.api.schema.SystemMapNode;
+import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
+import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
+import org.opendaylight.yangtools.yang.data.api.schema.UserLeafSetNode;
+import org.opendaylight.yangtools.yang.data.api.schema.UserMapNode;
+import org.opendaylight.yangtools.yang.data.api.schema.builder.CollectionNodeBuilder;
+import org.opendaylight.yangtools.yang.data.api.schema.builder.DataContainerNodeBuilder;
+import org.opendaylight.yangtools.yang.data.api.schema.builder.NormalizedNodeContainerBuilder;
+import org.opendaylight.yangtools.yang.data.spi.node.ImmutableNodes;
+import org.opendaylight.yangtools.yang.data.util.DataSchemaContext;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
+import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
+import org.opendaylight.yangtools.yang.model.api.source.SourceRepresentation;
+import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
+import org.opendaylight.yangtools.yang.model.api.source.YinTextSource;
+import org.opendaylight.yangtools.yang.model.api.stmt.ModuleEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.stmt.SubmoduleEffectiveStatement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
// FIXME: it seems the first three operations deal with lifecycle of a transaction, while others invoke various
// operations. This should be handled through proper allocation indirection.
public abstract class RestconfStrategy {
+ @NonNullByDefault
+ public record StrategyAndPath(RestconfStrategy strategy, Data path) {
+ public StrategyAndPath {
+ requireNonNull(strategy);
+ requireNonNull(path);
+ }
+ }
+
/**
- * Result of a {@code PUT} request as defined in
- * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.5">RFC8040 section 4.5</a>. The definition makes it
- * clear that the logical operation is {@code create-or-replace}.
+ * Result of a partial {@link ApiPath} lookup for the purposes of supporting {@code yang-ext:mount}-delimited mount
+ * points with possible nesting.
+ *
+ * @param strategy the strategy to use
+ * @param tail the {@link ApiPath} tail to use with the strategy
*/
- public enum CreateOrReplaceResult {
- /**
- * A new resource has been created.
- */
- CREATED,
- /*
- * An existing resources has been replaced.
- */
- REPLACED;
+ @NonNullByDefault
+ public record StrategyAndTail(RestconfStrategy strategy, ApiPath tail) {
+ public StrategyAndTail {
+ requireNonNull(strategy);
+ requireNonNull(tail);
+ }
}
private static final Logger LOG = LoggerFactory.getLogger(RestconfStrategy.class);
+ private static final @NonNull DataPutResult PUT_CREATED = new DataPutResult(true);
+ private static final @NonNull DataPutResult PUT_REPLACED = new DataPutResult(false);
+ private static final @NonNull DataPatchResult PATCH_EMPTY = new DataPatchResult();
+
+ private final @NonNull ImmutableMap<QName, RpcImplementation> localRpcs;
+ private final @NonNull ApiPathNormalizer pathNormalizer;
+ private final @NonNull DatabindContext databind;
+ private final YangTextSourceExtension sourceProvider;
+ private final DOMMountPointService mountPointService;
+ private final DOMActionService actionService;
+ private final DOMRpcService rpcService;
+ private final HttpGetResource operations;
- RestconfStrategy() {
- // Hidden on purpose
+ RestconfStrategy(final DatabindContext databind, final ImmutableMap<QName, RpcImplementation> localRpcs,
+ final @Nullable DOMRpcService rpcService, final @Nullable DOMActionService actionService,
+ final @Nullable YangTextSourceExtension sourceProvider,
+ final @Nullable DOMMountPointService mountPointService) {
+ this.databind = requireNonNull(databind);
+ this.localRpcs = requireNonNull(localRpcs);
+ this.rpcService = rpcService;
+ this.actionService = actionService;
+ this.sourceProvider = sourceProvider;
+ this.mountPointService = mountPointService;
+ pathNormalizer = new ApiPathNormalizer(databind);
+ operations = new OperationsResource(pathNormalizer);
+ }
+
+ public final @NonNull StrategyAndPath resolveStrategyPath(final ApiPath path) {
+ final var andTail = resolveStrategy(path);
+ final var strategy = andTail.strategy();
+ return new StrategyAndPath(strategy, strategy.pathNormalizer.normalizeDataPath(andTail.tail()));
}
/**
- * Look up the appropriate strategy for a particular mount point.
+ * Resolve any and all {@code yang-ext:mount} to the target {@link StrategyAndTail}.
*
- * @param mountPoint Target mount point
- * @return A strategy, or null if the mount point does not expose a supported interface
- * @throws NullPointerException if {@code mountPoint} is null
+ * @param path {@link ApiPath} to resolve
+ * @return A strategy and the remaining path
+ * @throws NullPointerException if {@code path} is {@code null}
*/
- public static Optional<RestconfStrategy> forMountPoint(final DOMMountPoint mountPoint) {
- final Optional<RestconfStrategy> netconf = mountPoint.getService(NetconfDataTreeService.class)
- .map(NetconfRestconfStrategy::new);
- if (netconf.isPresent()) {
- return netconf;
+ public final @NonNull StrategyAndTail resolveStrategy(final ApiPath path) {
+ var mount = path.indexOf("yang-ext", "mount");
+ if (mount == -1) {
+ return new StrategyAndTail(this, path);
+ }
+ if (mountPointService == null) {
+ throw new RestconfDocumentedException("Mount point service is not available",
+ ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED);
+ }
+ final var mountPath = path.subPath(0, mount);
+ final var dataPath = pathNormalizer.normalizeDataPath(path.subPath(0, mount));
+ final var mountPoint = mountPointService.getMountPoint(dataPath.instance())
+ .orElseThrow(() -> new RestconfDocumentedException("Mount point '" + mountPath + "' does not exist",
+ ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT));
+
+ return createStrategy(mountPath, mountPoint).resolveStrategy(path.subPath(mount + 1));
+ }
+
+ private static @NonNull RestconfStrategy createStrategy(final ApiPath mountPath, final DOMMountPoint mountPoint) {
+ final var mountSchemaService = mountPoint.getService(DOMSchemaService.class)
+ .orElseThrow(() -> new RestconfDocumentedException(
+ "Mount point '" + mountPath + "' does not expose DOMSchemaService",
+ ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT));
+ final var mountModelContext = mountSchemaService.getGlobalContext();
+ if (mountModelContext == null) {
+ throw new RestconfDocumentedException("Mount point '" + mountPath + "' does not have any models",
+ ErrorType.PROTOCOL, ErrorTags.RESOURCE_DENIED_TRANSPORT);
+ }
+ final var mountDatabind = DatabindContext.ofModel(mountModelContext);
+ final var mountPointService = mountPoint.getService(DOMMountPointService.class).orElse(null);
+ final var rpcService = mountPoint.getService(DOMRpcService.class).orElse(null);
+ final var actionService = mountPoint.getService(DOMActionService.class).orElse(null);
+ final var sourceProvider = mountPoint.getService(DOMSchemaService.class)
+ .flatMap(schema -> Optional.ofNullable(schema.extension(YangTextSourceExtension.class)))
+ .orElse(null);
+
+ final var netconfService = mountPoint.getService(NetconfDataTreeService.class);
+ if (netconfService.isPresent()) {
+ return new NetconfRestconfStrategy(mountDatabind, netconfService.orElseThrow(), rpcService, actionService,
+ sourceProvider, mountPointService);
+ }
+ final var dataBroker = mountPoint.getService(DOMDataBroker.class);
+ if (dataBroker.isPresent()) {
+ return new MdsalRestconfStrategy(mountDatabind, dataBroker.orElseThrow(), ImmutableMap.of(), rpcService,
+ actionService, sourceProvider, mountPointService);
}
+ LOG.warn("Mount point {} does not expose a suitable access interface", mountPath);
+ throw new RestconfDocumentedException("Could not find a supported access interface in mount point",
+ ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, mountPoint.getIdentifier());
+ }
- return mountPoint.getService(DOMDataBroker.class).map(MdsalRestconfStrategy::new);
+ public final @NonNull DatabindContext databind() {
+ return databind;
+ }
+
+ public final @NonNull EffectiveModelContext modelContext() {
+ return databind.modelContext();
}
/**
* @return A {@link RestconfTransaction}. This transaction needs to be either committed or canceled before doing
* anything else.
*/
- public abstract RestconfTransaction prepareWriteExecution();
+ abstract RestconfTransaction prepareWriteExecution();
/**
* Read data from the datastore.
* @param path the data object path
* @return a ListenableFuture containing the result of the read
*/
- public abstract ListenableFuture<Optional<NormalizedNode>> read(LogicalDatastoreType store,
- YangInstanceIdentifier path);
-
- /**
- * Read data selected using fields from the datastore.
- *
- * @param store the logical data store which should be modified
- * @param path the parent data object path
- * @param fields paths to selected fields relative to parent path
- * @return a ListenableFuture containing the result of the read
- */
- public abstract ListenableFuture<Optional<NormalizedNode>> read(LogicalDatastoreType store,
- YangInstanceIdentifier path, List<YangInstanceIdentifier> fields);
+ abstract ListenableFuture<Optional<NormalizedNode>> read(LogicalDatastoreType store, YangInstanceIdentifier path);
/**
* Check if data already exists in the configuration datastore.
// FIXME: this method should only be needed in MdsalRestconfStrategy
abstract ListenableFuture<Boolean> exists(YangInstanceIdentifier path);
- /**
- * Delete data from the configuration datastore. If the data does not exist, this operation will fail, as outlined
- * in <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.7">RFC8040 section 4.7</a>
- *
- * @param path Path to delete
- * @return A {@link RestconfFuture}
- * @throws NullPointerException if {@code path} is {@code null}
- */
- public final @NonNull RestconfFuture<Empty> delete(final YangInstanceIdentifier path) {
- final var ret = new SettableRestconfFuture<Empty>();
- delete(ret, requireNonNull(path));
+ @VisibleForTesting
+ final @NonNull RestconfFuture<DataPatchResult> merge(final YangInstanceIdentifier path, final NormalizedNode data) {
+ final var ret = new SettableRestconfFuture<DataPatchResult>();
+ merge(ret, requireNonNull(path), requireNonNull(data));
return ret;
}
- protected abstract void delete(@NonNull SettableRestconfFuture<Empty> future, @NonNull YangInstanceIdentifier path);
-
- /**
- * Merge data into the configuration datastore, as outlined in
- * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040 section 4.6.1</a>.
- *
- * @param path Path to merge
- * @param data Data to merge
- * @param context Corresponding EffectiveModelContext
- * @return A {@link RestconfFuture}
- * @throws NullPointerException if any argument is {@code null}
- */
- public final @NonNull RestconfFuture<Empty> merge(final YangInstanceIdentifier path, final NormalizedNode data,
- final EffectiveModelContext context) {
- final var ret = new SettableRestconfFuture<Empty>();
- merge(ret, requireNonNull(path), requireNonNull(data), requireNonNull(context));
- return ret;
- }
-
- private void merge(final @NonNull SettableRestconfFuture<Empty> future,
- final @NonNull YangInstanceIdentifier path, final @NonNull NormalizedNode data,
- final @NonNull EffectiveModelContext context) {
+ private void merge(final @NonNull SettableRestconfFuture<DataPatchResult> future,
+ final @NonNull YangInstanceIdentifier path, final @NonNull NormalizedNode data) {
final var tx = prepareWriteExecution();
// FIXME: this method should be further specialized to eliminate this call -- it is only needed for MD-SAL
- TransactionUtil.ensureParentsByMerge(path, context, tx);
+ tx.ensureParentsByMerge(path);
tx.merge(path, data);
Futures.addCallback(tx.commit(), new FutureCallback<CommitInfo>() {
@Override
public void onSuccess(final CommitInfo result) {
- future.set(Empty.value());
+ // TODO: extract details once CommitInfo can communicate them
+ future.set(PATCH_EMPTY);
}
@Override
public void onFailure(final Throwable cause) {
- future.setFailure(TransactionUtil.decodeException(cause, "MERGE", path));
+ future.setFailure(TransactionUtil.decodeException(cause, "MERGE", path, modelContext()));
}
}, MoreExecutors.directExecutor());
}
+ public @NonNull RestconfFuture<DataPutResult> dataPUT(final ServerRequest request, final ApiPath apiPath,
+ final ResourceBody body) {
+ final Data path;
+ try {
+ path = pathNormalizer.normalizeDataPath(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+
+ final Insert insert;
+ try {
+ insert = Insert.of(databind, request.queryParameters());
+ } catch (IllegalArgumentException e) {
+ return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
+ ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
+ }
+ final NormalizedNode data;
+ try {
+ data = body.toNormalizedNode(path);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+ return putData(path.instance(), data, insert);
+ }
+
/**
* Check mount point and prepare variables for put data to DS.
*
* @param path path of data
* @param data data
- * @param context reference to {@link EffectiveModelContext}
* @param insert {@link Insert}
- * @return A {@link CreateOrReplaceResult}
+ * @return A {@link DataPutResult}
*/
- public @NonNull CreateOrReplaceResult putData(final YangInstanceIdentifier path, final NormalizedNode data,
- final EffectiveModelContext context, final @Nullable Insert insert) {
+ public final @NonNull RestconfFuture<DataPutResult> putData(final YangInstanceIdentifier path,
+ final NormalizedNode data, final @Nullable Insert insert) {
final var exists = TransactionUtil.syncAccess(exists(path), path);
final ListenableFuture<? extends CommitInfo> commitFuture;
if (insert != null) {
final var parentPath = path.coerceParent();
- checkListAndOrderedType(context, parentPath);
- commitFuture = insertAndCommitPut(path, data, insert, parentPath, context);
+ checkListAndOrderedType(parentPath);
+ commitFuture = insertAndCommitPut(path, data, insert, parentPath);
} else {
- commitFuture = replaceAndCommit(prepareWriteExecution(), path, data, context);
+ commitFuture = replaceAndCommit(prepareWriteExecution(), path, data);
}
- TransactionUtil.syncCommit(commitFuture, "PUT", path);
- return exists ? CreateOrReplaceResult.REPLACED : CreateOrReplaceResult.CREATED;
+ final var ret = new SettableRestconfFuture<DataPutResult>();
+
+ Futures.addCallback(commitFuture, new FutureCallback<CommitInfo>() {
+ @Override
+ public void onSuccess(final CommitInfo result) {
+ ret.set(exists ? PUT_REPLACED : PUT_CREATED);
+ }
+
+ @Override
+ public void onFailure(final Throwable cause) {
+ ret.setFailure(TransactionUtil.decodeException(cause, "PUT", path, modelContext()));
+ }
+ }, MoreExecutors.directExecutor());
+
+ return ret;
}
private ListenableFuture<? extends CommitInfo> insertAndCommitPut(final YangInstanceIdentifier path,
- final NormalizedNode data, final @NonNull Insert insert, final YangInstanceIdentifier parentPath,
- final EffectiveModelContext context) {
+ final NormalizedNode data, final @NonNull Insert insert, final YangInstanceIdentifier parentPath) {
final var tx = prepareWriteExecution();
return switch (insert.insert()) {
case FIRST -> {
final var readData = tx.readList(parentPath);
if (readData == null || readData.isEmpty()) {
- yield replaceAndCommit(tx, path, data, context);
+ yield replaceAndCommit(tx, path, data);
}
tx.remove(parentPath);
- tx.replace(path, data, context);
- tx.replace(parentPath, readData, context);
+ tx.replace(path, data);
+ tx.replace(parentPath, readData);
yield tx.commit();
}
- case LAST -> replaceAndCommit(tx, path, data, context);
+ case LAST -> replaceAndCommit(tx, path, data);
case BEFORE -> {
final var readData = tx.readList(parentPath);
if (readData == null || readData.isEmpty()) {
- yield replaceAndCommit(tx, path, data, context);
+ yield replaceAndCommit(tx, path, data);
}
- insertWithPointPut(tx, path, data, verifyNotNull(insert.point()), readData, true, context);
+ insertWithPointPut(tx, path, data, verifyNotNull(insert.pointArg()), readData, true);
yield tx.commit();
}
case AFTER -> {
final var readData = tx.readList(parentPath);
if (readData == null || readData.isEmpty()) {
- yield replaceAndCommit(tx, path, data, context);
+ yield replaceAndCommit(tx, path, data);
}
- insertWithPointPut(tx, path, data, verifyNotNull(insert.point()), readData, false, context);
+ insertWithPointPut(tx, path, data, verifyNotNull(insert.pointArg()), readData, false);
yield tx.commit();
}
};
}
- private static void insertWithPointPut(final RestconfTransaction tx, final YangInstanceIdentifier path,
- final NormalizedNode data, final @NonNull PointParam point, final NormalizedNodeContainer<?> readList,
- final boolean before, final EffectiveModelContext context) {
+ private void insertWithPointPut(final RestconfTransaction tx, final YangInstanceIdentifier path,
+ final NormalizedNode data, final @NonNull PathArgument pointArg, final NormalizedNodeContainer<?> readList,
+ final boolean before) {
tx.remove(path.getParent());
- final var pointArg = YangInstanceIdentifierDeserializer.create(context, point.value()).path
- .getLastPathArgument();
+
int lastItemPosition = 0;
for (var nodeChild : readList.body()) {
if (nodeChild.name().equals(pointArg)) {
if (!before) {
lastItemPosition++;
}
+
int lastInsertedPosition = 0;
- final var emptySubtree = ImmutableNodes.fromInstanceId(context, path.getParent());
+ final var emptySubtree = fromInstanceId(modelContext(), path.getParent());
tx.merge(YangInstanceIdentifier.of(emptySubtree.name()), emptySubtree);
for (var nodeChild : readList.body()) {
if (lastInsertedPosition == lastItemPosition) {
- tx.replace(path, data, context);
+ tx.replace(path, data);
}
final var childPath = path.coerceParent().node(nodeChild.name());
- tx.replace(childPath, nodeChild, context);
+ tx.replace(childPath, nodeChild);
lastInsertedPosition++;
}
+
+ // In case we are inserting after last element
+ if (!before) {
+ if (lastInsertedPosition == lastItemPosition) {
+ tx.replace(path, data);
+ }
+ }
}
private static ListenableFuture<? extends CommitInfo> replaceAndCommit(final RestconfTransaction tx,
- final YangInstanceIdentifier path, final NormalizedNode data, final EffectiveModelContext context) {
- tx.replace(path, data, context);
+ final YangInstanceIdentifier path, final NormalizedNode data) {
+ tx.replace(path, data);
return tx.commit();
}
- private static DataSchemaNode checkListAndOrderedType(final EffectiveModelContext ctx,
- final YangInstanceIdentifier path) {
- final var dataSchemaNode = DataSchemaContextTree.from(ctx).findChild(path).orElseThrow().dataSchemaNode();
+ private DataSchemaNode checkListAndOrderedType(final YangInstanceIdentifier path) {
+ // FIXME: we have this available in InstanceIdentifierContext
+ final var dataSchemaNode = databind.schemaTree().findChild(path).orElseThrow().dataSchemaNode();
final String message;
if (dataSchemaNode instanceof ListSchemaNode listSchema) {
*
* @param path path
* @param data data
- * @param context reference to actual {@link EffectiveModelContext}
* @param insert {@link Insert}
+ * @return A {@link RestconfFuture}
*/
- public final void postData(final YangInstanceIdentifier path, final NormalizedNode data,
- final EffectiveModelContext context, final @Nullable Insert insert) {
+ public final @NonNull RestconfFuture<CreateResourceResult> postData(final YangInstanceIdentifier path,
+ final NormalizedNode data, final @Nullable Insert insert) {
final ListenableFuture<? extends CommitInfo> future;
if (insert != null) {
- final var parentPath = path.coerceParent();
- checkListAndOrderedType(context, parentPath);
- future = insertAndCommitPost(path, data, insert, parentPath, context);
+ checkListAndOrderedType(path);
+ future = insertAndCommitPost(path, data, insert);
} else {
- future = createAndCommit(prepareWriteExecution(), path, data, context);
+ future = createAndCommit(prepareWriteExecution(), path, data);
}
- TransactionUtil.syncCommit(future, "POST", path);
+
+ final var ret = new SettableRestconfFuture<CreateResourceResult>();
+ Futures.addCallback(future, new FutureCallback<CommitInfo>() {
+ @Override
+ public void onSuccess(final CommitInfo result) {
+ ret.set(new CreateResourceResult(new ApiPathCanonizer(databind).dataToApiPath(
+ data instanceof MapNode mapData && !mapData.isEmpty()
+ ? path.node(mapData.body().iterator().next().name()) : path)));
+ }
+
+ @Override
+ public void onFailure(final Throwable cause) {
+ ret.setFailure(TransactionUtil.decodeException(cause, "POST", path, modelContext()));
+ }
+
+ }, MoreExecutors.directExecutor());
+ return ret;
}
private ListenableFuture<? extends CommitInfo> insertAndCommitPost(final YangInstanceIdentifier path,
- final NormalizedNode data, final @NonNull Insert insert, final YangInstanceIdentifier parent,
- final EffectiveModelContext context) {
- final var grandParent = parent.coerceParent();
+ final NormalizedNode data, final @NonNull Insert insert) {
final var tx = prepareWriteExecution();
return switch (insert.insert()) {
case FIRST -> {
- final var readData = tx.readList(grandParent);
+ final var readData = tx.readList(path);
if (readData == null || readData.isEmpty()) {
- tx.replace(path, data, context);
+ tx.replace(path, data);
} else {
- checkItemDoesNotExists(exists(path), path);
- tx.remove(grandParent);
- tx.replace(path, data, context);
- tx.replace(grandParent, readData, context);
+ checkListDataDoesNotExist(path, data);
+ tx.remove(path);
+ tx.replace(path, data);
+ tx.replace(path, readData);
}
yield tx.commit();
}
- case LAST -> createAndCommit(tx, path, data, context);
+ case LAST -> createAndCommit(tx, path, data);
case BEFORE -> {
- final var readData = tx.readList(grandParent);
+ final var readData = tx.readList(path);
if (readData == null || readData.isEmpty()) {
- tx.replace(path, data, context);
+ tx.replace(path, data);
} else {
- checkItemDoesNotExists(exists(path), path);
- insertWithPointPost(tx, path, data, verifyNotNull(insert.point()), readData, grandParent, true,
- context);
+ checkListDataDoesNotExist(path, data);
+ insertWithPointPost(tx, path, data, verifyNotNull(insert.pointArg()), readData, true);
}
yield tx.commit();
}
case AFTER -> {
- final var readData = tx.readList(grandParent);
+ final var readData = tx.readList(path);
if (readData == null || readData.isEmpty()) {
- tx.replace(path, data, context);
+ tx.replace(path, data);
} else {
- checkItemDoesNotExists(exists(path), path);
- insertWithPointPost(tx, path, data, verifyNotNull(insert.point()), readData, grandParent, false,
- context);
+ checkListDataDoesNotExist(path, data);
+ insertWithPointPost(tx, path, data, verifyNotNull(insert.pointArg()), readData, false);
}
yield tx.commit();
}
};
}
+ /**
+ * Merge data into the configuration datastore, as outlined in
+ * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.6.1">RFC8040 section 4.6.1</a>.
+ *
+ * @param apiPath Path to merge
+ * @param body Data to merge
+ * @return A {@link RestconfFuture}
+ * @throws NullPointerException if any argument is {@code null}
+ */
+ public final @NonNull RestconfFuture<DataPatchResult> dataPATCH(final ApiPath apiPath, final ResourceBody body) {
+ final Data path;
+ try {
+ path = pathNormalizer.normalizeDataPath(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+
+ final NormalizedNode data;
+ try {
+ data = body.toNormalizedNode(path);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+
+ return merge(path.instance(), data);
+ }
+
+ public final @NonNull RestconfFuture<DataYangPatchResult> dataPATCH(final ApiPath apiPath, final PatchBody body) {
+ final Data path;
+ try {
+ path = pathNormalizer.normalizeDataPath(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+
+ final PatchContext patch;
+ try {
+ patch = body.toPatchContext(new DefaultResourceContext(path));
+ } catch (IOException e) {
+ LOG.debug("Error parsing YANG Patch input", e);
+ return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
+ ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
+ }
+ return patchData(patch);
+ }
+
+ /**
+ * Process edit operations of one {@link PatchContext}.
+ *
+ * @param patch Patch context to be processed
+ * @return {@link PatchStatusContext}
+ */
+ @VisibleForTesting
+ public final @NonNull RestconfFuture<DataYangPatchResult> patchData(final PatchContext patch) {
+ final var editCollection = new ArrayList<PatchStatusEntity>();
+ final var tx = prepareWriteExecution();
+
+ boolean noError = true;
+ for (var patchEntity : patch.entities()) {
+ if (noError) {
+ final var targetNode = patchEntity.getTargetNode();
+ final var editId = patchEntity.getEditId();
+
+ switch (patchEntity.getOperation()) {
+ case Create:
+ try {
+ tx.create(targetNode, patchEntity.getNode());
+ editCollection.add(new PatchStatusEntity(editId, true, null));
+ } catch (RestconfDocumentedException e) {
+ editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
+ noError = false;
+ }
+ break;
+ case Delete:
+ try {
+ tx.delete(targetNode);
+ editCollection.add(new PatchStatusEntity(editId, true, null));
+ } catch (RestconfDocumentedException e) {
+ editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
+ noError = false;
+ }
+ break;
+ case Merge:
+ try {
+ tx.ensureParentsByMerge(targetNode);
+ tx.merge(targetNode, patchEntity.getNode());
+ editCollection.add(new PatchStatusEntity(editId, true, null));
+ } catch (RestconfDocumentedException e) {
+ editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
+ noError = false;
+ }
+ break;
+ case Replace:
+ try {
+ tx.replace(targetNode, patchEntity.getNode());
+ editCollection.add(new PatchStatusEntity(editId, true, null));
+ } catch (RestconfDocumentedException e) {
+ editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
+ noError = false;
+ }
+ break;
+ case Remove:
+ try {
+ tx.remove(targetNode);
+ editCollection.add(new PatchStatusEntity(editId, true, null));
+ } catch (RestconfDocumentedException e) {
+ editCollection.add(new PatchStatusEntity(editId, false, e.getErrors()));
+ noError = false;
+ }
+ break;
+ default:
+ editCollection.add(new PatchStatusEntity(editId, false, List.of(
+ new RestconfError(ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED,
+ "Not supported Yang Patch operation"))));
+ noError = false;
+ break;
+ }
+ } else {
+ break;
+ }
+ }
+
+ final var ret = new SettableRestconfFuture<DataYangPatchResult>();
+ // We have errors
+ if (!noError) {
+ tx.cancel();
+ ret.set(new DataYangPatchResult(
+ new PatchStatusContext(databind(), patch.patchId(), List.copyOf(editCollection), false, null)));
+ return ret;
+ }
+
+ Futures.addCallback(tx.commit(), new FutureCallback<CommitInfo>() {
+ @Override
+ public void onSuccess(final CommitInfo result) {
+ ret.set(new DataYangPatchResult(
+ new PatchStatusContext(databind(), patch.patchId(), List.copyOf(editCollection), true, null)));
+ }
+
+ @Override
+ public void onFailure(final Throwable cause) {
+ // if errors occurred during transaction commit then patch failed and global errors are reported
+ ret.set(new DataYangPatchResult(
+ new PatchStatusContext(databind(), patch.patchId(), List.copyOf(editCollection), false,
+ TransactionUtil.decodeException(cause, "PATCH", null, modelContext()).getErrors())));
+ }
+ }, MoreExecutors.directExecutor());
+
+ return ret;
+ }
+
private static void insertWithPointPost(final RestconfTransaction tx, final YangInstanceIdentifier path,
- final NormalizedNode data, final PointParam point, final NormalizedNodeContainer<?> readList,
- final YangInstanceIdentifier grandParentPath, final boolean before, final EffectiveModelContext context) {
- tx.remove(grandParentPath);
- final var pointArg = YangInstanceIdentifierDeserializer.create(context, point.value()).path
- .getLastPathArgument();
+ final NormalizedNode data, final PathArgument pointArg, final NormalizedNodeContainer<?> readList,
+ final boolean before) {
+ tx.remove(path);
+
int lastItemPosition = 0;
for (var nodeChild : readList.body()) {
if (nodeChild.name().equals(pointArg)) {
if (!before) {
lastItemPosition++;
}
+
int lastInsertedPosition = 0;
- final var emptySubtree = ImmutableNodes.fromInstanceId(context, grandParentPath);
- tx.merge(YangInstanceIdentifier.of(emptySubtree.name()), emptySubtree);
for (var nodeChild : readList.body()) {
if (lastInsertedPosition == lastItemPosition) {
- tx.replace(path, data, context);
+ tx.replace(path, data);
}
- final YangInstanceIdentifier childPath = grandParentPath.node(nodeChild.name());
- tx.replace(childPath, nodeChild, context);
+ tx.replace(path.node(nodeChild.name()), nodeChild);
lastInsertedPosition++;
}
+
+ // In case we are inserting after last element
+ if (!before) {
+ if (lastInsertedPosition == lastItemPosition) {
+ tx.replace(path, data);
+ }
+ }
}
private static ListenableFuture<? extends CommitInfo> createAndCommit(final RestconfTransaction tx,
- final YangInstanceIdentifier path, final NormalizedNode data, final EffectiveModelContext context) {
+ final YangInstanceIdentifier path, final NormalizedNode data) {
try {
- tx.create(path, data, context);
+ tx.create(path, data);
} catch (RestconfDocumentedException e) {
// close transaction if any and pass exception further
tx.cancel();
return tx.commit();
}
+ /**
+ * Check if child items do NOT already exists in List at specified {@code path}.
+ *
+ * @param data Data to be checked
+ * @param path Path to be checked
+ * @throws RestconfDocumentedException if data already exists.
+ */
+ private void checkListDataDoesNotExist(final YangInstanceIdentifier path, final NormalizedNode data) {
+ if (data instanceof NormalizedNodeContainer<?> dataNode) {
+ for (final var node : dataNode.body()) {
+ checkItemDoesNotExists(exists(path.node(node.name())), path.node(node.name()));
+ }
+ } else {
+ throw new RestconfDocumentedException("Unexpected node type: " + data.getClass().getName());
+ }
+ }
+
/**
* Check if items do NOT already exists at specified {@code path}.
*
path);
}
}
+
+ /**
+ * Delete data from the configuration datastore. If the data does not exist, this operation will fail, as outlined
+ * in <a href="https://www.rfc-editor.org/rfc/rfc8040#section-4.7">RFC8040 section 4.7</a>
+ *
+ * @param apiPath Path to delete
+ * @return A {@link RestconfFuture}
+ * @throws NullPointerException if {@code apiPath} is {@code null}
+ */
+ @NonNullByDefault
+ @SuppressWarnings("checkstyle:abbreviationAsWordInName")
+ public final RestconfFuture<Empty> dataDELETE(final ServerRequest request, final ApiPath apiPath) {
+ final Data path;
+ try {
+ path = pathNormalizer.normalizeDataPath(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+
+ // FIXME: reject empty YangInstanceIdentifier, as datastores may not be deleted
+ final var ret = new SettableRestconfFuture<Empty>();
+ delete(ret, request, path.instance());
+ return ret;
+ }
+
+ @NonNullByDefault
+ abstract void delete(SettableRestconfFuture<Empty> future, ServerRequest request, YangInstanceIdentifier path);
+
+ public final @NonNull RestconfFuture<DataGetResult> dataGET(final ServerRequest request, final ApiPath apiPath) {
+ final Data path;
+ try {
+ path = pathNormalizer.normalizeDataPath(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+
+ final DataGetParams getParams;
+ try {
+ getParams = DataGetParams.of(request.queryParameters());
+ } catch (IllegalArgumentException e) {
+ return RestconfFuture.failed(new RestconfDocumentedException(e,
+ new RestconfError(ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, "Invalid GET /data parameters", null,
+ e.getMessage())));
+ }
+ return dataGET(request, path, getParams);
+ }
+
+ abstract @NonNull RestconfFuture<DataGetResult> dataGET(ServerRequest request, Data path, DataGetParams params);
+
+ @NonNullByDefault
+ static final RestconfFuture<DataGetResult> completeDataGET(final @Nullable NormalizedNode node, final Data path,
+ final NormalizedNodeWriterFactory writerFactory, final @Nullable ConfigurationMetadata metadata) {
+ // Non-existing data
+ if (node == null) {
+ return RestconfFuture.failed(new RestconfDocumentedException(
+ "Request could not be completed because the relevant data model content does not exist",
+ ErrorType.PROTOCOL, ErrorTag.DATA_MISSING));
+ }
+
+ final var body = NormalizedFormattableBody.of(path, node, writerFactory);
+ return RestconfFuture.of(metadata == null ? new DataGetResult(body)
+ : new DataGetResult(body, metadata.entityTag(), metadata.lastModified()));
+ }
+
+ /**
+ * Read specific type of data from data store via transaction. Close {@link DOMTransactionChain} if any
+ * inside of object {@link RestconfStrategy} provided as a parameter.
+ *
+ * @param content type of data to read (config, state, all)
+ * @param path the path to read
+ * @param defaultsMode value of with-defaults parameter
+ * @return {@link NormalizedNode}
+ */
+ // FIXME: NETCONF-1155: this method should asynchronous
+ @VisibleForTesting
+ final @Nullable NormalizedNode readData(final @NonNull ContentParam content,
+ final @NonNull YangInstanceIdentifier path, final WithDefaultsParam defaultsMode) {
+ return switch (content) {
+ case ALL -> {
+ // PREPARE STATE DATA NODE
+ final var stateDataNode = readDataViaTransaction(LogicalDatastoreType.OPERATIONAL, path);
+ // PREPARE CONFIG DATA NODE
+ final var configDataNode = readDataViaTransaction(LogicalDatastoreType.CONFIGURATION, path);
+
+ yield mergeConfigAndSTateDataIfNeeded(stateDataNode, defaultsMode == null ? configDataNode
+ : prepareDataByParamWithDef(configDataNode, path, defaultsMode.mode()));
+ }
+ case CONFIG -> {
+ final var read = readDataViaTransaction(LogicalDatastoreType.CONFIGURATION, path);
+ yield defaultsMode == null ? read
+ : prepareDataByParamWithDef(read, path, defaultsMode.mode());
+ }
+ case NONCONFIG -> readDataViaTransaction(LogicalDatastoreType.OPERATIONAL, path);
+ };
+ }
+
+ private @Nullable NormalizedNode readDataViaTransaction(final LogicalDatastoreType store,
+ final YangInstanceIdentifier path) {
+ return TransactionUtil.syncAccess(read(store, path), path).orElse(null);
+ }
+
+ final NormalizedNode prepareDataByParamWithDef(final NormalizedNode readData, final YangInstanceIdentifier path,
+ final WithDefaultsMode defaultsMode) {
+ final boolean trim = switch (defaultsMode) {
+ case Trim -> true;
+ case Explicit -> false;
+ case ReportAll, ReportAllTagged -> throw new RestconfDocumentedException(
+ "Unsupported with-defaults value " + defaultsMode.getName());
+ };
+
+ // FIXME: we have this readily available in InstanceIdentifierContext
+ final var ctxNode = databind.schemaTree().findChild(path).orElseThrow();
+ if (readData instanceof ContainerNode container) {
+ final var builder = ImmutableNodes.newContainerBuilder().withNodeIdentifier(container.name());
+ buildCont(builder, container.body(), ctxNode, trim);
+ return builder.build();
+ } else if (readData instanceof MapEntryNode mapEntry) {
+ if (!(ctxNode.dataSchemaNode() instanceof ListSchemaNode listSchema)) {
+ throw new IllegalStateException("Input " + mapEntry + " does not match " + ctxNode);
+ }
+
+ final var builder = ImmutableNodes.newMapEntryBuilder().withNodeIdentifier(mapEntry.name());
+ buildMapEntryBuilder(builder, mapEntry.body(), ctxNode, trim, listSchema.getKeyDefinition());
+ return builder.build();
+ } else {
+ throw new IllegalStateException("Unhandled data contract " + readData.contract());
+ }
+ }
+
+ private static void buildMapEntryBuilder(
+ final DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder,
+ final Collection<@NonNull DataContainerChild> children, final DataSchemaContext ctxNode,
+ final boolean trim, final List<QName> keys) {
+ for (var child : children) {
+ final var childCtx = getChildContext(ctxNode, child);
+
+ if (child instanceof ContainerNode container) {
+ appendContainer(builder, container, childCtx, trim);
+ } else if (child instanceof MapNode map) {
+ appendMap(builder, map, childCtx, trim);
+ } else if (child instanceof LeafNode<?> leaf) {
+ appendLeaf(builder, leaf, childCtx, trim, keys);
+ } else {
+ // FIXME: we should never hit this, throw an ISE if this ever happens
+ LOG.debug("Ignoring unhandled child contract {}", child.contract());
+ }
+ }
+ }
+
+ private static void appendContainer(final DataContainerNodeBuilder<?, ?> builder, final ContainerNode container,
+ final DataSchemaContext ctxNode, final boolean trim) {
+ final var childBuilder = ImmutableNodes.newContainerBuilder().withNodeIdentifier(container.name());
+ buildCont(childBuilder, container.body(), ctxNode, trim);
+ builder.withChild(childBuilder.build());
+ }
+
+ private static void appendLeaf(final DataContainerNodeBuilder<?, ?> builder, final LeafNode<?> leaf,
+ final DataSchemaContext ctxNode, final boolean trim, final List<QName> keys) {
+ if (!(ctxNode.dataSchemaNode() instanceof LeafSchemaNode leafSchema)) {
+ throw new IllegalStateException("Input " + leaf + " does not match " + ctxNode);
+ }
+
+ // FIXME: Document now this works with the likes of YangInstanceIdentifier. I bet it does not.
+ final var defaultVal = leafSchema.getType().getDefaultValue().orElse(null);
+
+ // This is a combined check for when we need to emit the leaf.
+ if (
+ // We always have to emit key leaf values
+ keys.contains(leafSchema.getQName())
+ // trim == WithDefaultsParam.TRIM and the source is assumed to store explicit values:
+ //
+ // When data is retrieved with a <with-defaults> parameter equal to
+ // 'trim', data nodes MUST NOT be reported if they contain the schema
+ // default value. Non-configuration data nodes containing the schema
+ // default value MUST NOT be reported.
+ //
+ || trim && (defaultVal == null || !defaultVal.equals(leaf.body()))
+ // !trim == WithDefaultsParam.EXPLICIT and the source is assume to store explicit values... but I fail to
+ // grasp what we are doing here... emit only if it matches default ???!!!
+ // FIXME: The WithDefaultsParam.EXPLICIT says:
+ //
+ // Data nodes set to the YANG default by the client are reported.
+ //
+ // and RFC8040 (https://www.rfc-editor.org/rfc/rfc8040#page-60) says:
+ //
+ // If the "with-defaults" parameter is set to "explicit", then the
+ // server MUST adhere to the default-reporting behavior defined in
+ // Section 3.3 of [RFC6243].
+ //
+ // and then RFC6243 (https://www.rfc-editor.org/rfc/rfc6243#section-3.3) says:
+ //
+ // When data is retrieved with a <with-defaults> parameter equal to
+ // 'explicit', a data node that was set by a client to its schema
+ // default value MUST be reported. A conceptual data node that would be
+ // set by the server to the schema default value MUST NOT be reported.
+ // Non-configuration data nodes containing the schema default value MUST
+ // be reported.
+ //
+ // (rovarga): The source reports explicitly-defined leaves and does *not* create defaults by itself.
+ // This seems to disregard the 'trim = true' case semantics (see above).
+ // Combining the above, though, these checks are missing the 'non-config' check, which would
+ // distinguish, but barring that this check is superfluous and results in the wrong semantics.
+ // Without that input, this really should be covered by the previous case.
+ || !trim && defaultVal != null && defaultVal.equals(leaf.body())) {
+ builder.withChild(leaf);
+ }
+ }
+
+ private static void appendMap(final DataContainerNodeBuilder<?, ?> builder, final MapNode map,
+ final DataSchemaContext childCtx, final boolean trim) {
+ if (!(childCtx.dataSchemaNode() instanceof ListSchemaNode listSchema)) {
+ throw new IllegalStateException("Input " + map + " does not match " + childCtx);
+ }
+
+ final var childBuilder = switch (map.ordering()) {
+ case SYSTEM -> ImmutableNodes.newSystemMapBuilder();
+ case USER -> ImmutableNodes.newUserMapBuilder();
+ };
+ buildList(childBuilder.withNodeIdentifier(map.name()), map.body(), childCtx, trim,
+ listSchema.getKeyDefinition());
+ builder.withChild(childBuilder.build());
+ }
+
+ private static void buildList(final CollectionNodeBuilder<MapEntryNode, ? extends MapNode> builder,
+ final Collection<@NonNull MapEntryNode> entries, final DataSchemaContext ctxNode, final boolean trim,
+ final List<@NonNull QName> keys) {
+ for (var entry : entries) {
+ final var childCtx = getChildContext(ctxNode, entry);
+ final var mapEntryBuilder = ImmutableNodes.newMapEntryBuilder().withNodeIdentifier(entry.name());
+ buildMapEntryBuilder(mapEntryBuilder, entry.body(), childCtx, trim, keys);
+ builder.withChild(mapEntryBuilder.build());
+ }
+ }
+
+ private static void buildCont(final DataContainerNodeBuilder<NodeIdentifier, ContainerNode> builder,
+ final Collection<DataContainerChild> children, final DataSchemaContext ctxNode, final boolean trim) {
+ for (var child : children) {
+ final var childCtx = getChildContext(ctxNode, child);
+ if (child instanceof ContainerNode container) {
+ appendContainer(builder, container, childCtx, trim);
+ } else if (child instanceof MapNode map) {
+ appendMap(builder, map, childCtx, trim);
+ } else if (child instanceof LeafNode<?> leaf) {
+ appendLeaf(builder, leaf, childCtx, trim, List.of());
+ }
+ }
+ }
+
+ private static @NonNull DataSchemaContext getChildContext(final DataSchemaContext ctxNode,
+ final NormalizedNode child) {
+ final var childId = child.name();
+ final var childCtx = ctxNode instanceof DataSchemaContext.Composite composite ? composite.childByArg(childId)
+ : null;
+ if (childCtx == null) {
+ throw new NoSuchElementException("Cannot resolve child " + childId + " in " + ctxNode);
+ }
+ return childCtx;
+ }
+
+ static final NormalizedNode mergeConfigAndSTateDataIfNeeded(final NormalizedNode stateDataNode,
+ final NormalizedNode configDataNode) {
+ if (stateDataNode == null) {
+ // No state, return config
+ return configDataNode;
+ }
+ if (configDataNode == null) {
+ // No config, return state
+ return stateDataNode;
+ }
+ // merge config and state
+ return mergeStateAndConfigData(stateDataNode, configDataNode);
+ }
+
+ /**
+ * Merge state and config data into a single NormalizedNode.
+ *
+ * @param stateDataNode data node of state data
+ * @param configDataNode data node of config data
+ * @return {@link NormalizedNode}
+ */
+ private static @NonNull NormalizedNode mergeStateAndConfigData(
+ final @NonNull NormalizedNode stateDataNode, final @NonNull NormalizedNode configDataNode) {
+ validateNodeMerge(stateDataNode, configDataNode);
+ // FIXME: this check is bogus, as it confuses yang.data.api (NormalizedNode) with yang.model.api (RpcDefinition)
+ if (configDataNode instanceof RpcDefinition) {
+ return prepareRpcData(configDataNode, stateDataNode);
+ } else {
+ return prepareData(configDataNode, stateDataNode);
+ }
+ }
+
+ /**
+ * Validates whether the two NormalizedNodes can be merged.
+ *
+ * @param stateDataNode data node of state data
+ * @param configDataNode data node of config data
+ */
+ private static void validateNodeMerge(final @NonNull NormalizedNode stateDataNode,
+ final @NonNull NormalizedNode configDataNode) {
+ final QNameModule moduleOfStateData = stateDataNode.name().getNodeType().getModule();
+ final QNameModule moduleOfConfigData = configDataNode.name().getNodeType().getModule();
+ if (!moduleOfStateData.equals(moduleOfConfigData)) {
+ throw new RestconfDocumentedException("Unable to merge data from different modules.");
+ }
+ }
+
+ /**
+ * Prepare and map data for rpc.
+ *
+ * @param configDataNode data node of config data
+ * @param stateDataNode data node of state data
+ * @return {@link NormalizedNode}
+ */
+ private static @NonNull NormalizedNode prepareRpcData(final @NonNull NormalizedNode configDataNode,
+ final @NonNull NormalizedNode stateDataNode) {
+ final var mapEntryBuilder = ImmutableNodes.newMapEntryBuilder()
+ .withNodeIdentifier((NodeIdentifierWithPredicates) configDataNode.name());
+
+ // MAP CONFIG DATA
+ mapRpcDataNode(configDataNode, mapEntryBuilder);
+ // MAP STATE DATA
+ mapRpcDataNode(stateDataNode, mapEntryBuilder);
+
+ return ImmutableNodes.newSystemMapBuilder()
+ .withNodeIdentifier(NodeIdentifier.create(configDataNode.name().getNodeType()))
+ .addChild(mapEntryBuilder.build())
+ .build();
+ }
+
+ /**
+ * Map node to map entry builder.
+ *
+ * @param dataNode data node
+ * @param mapEntryBuilder builder for mapping data
+ */
+ private static void mapRpcDataNode(final @NonNull NormalizedNode dataNode,
+ final @NonNull DataContainerNodeBuilder<NodeIdentifierWithPredicates, MapEntryNode> mapEntryBuilder) {
+ ((ContainerNode) dataNode).body().forEach(mapEntryBuilder::addChild);
+ }
+
+ /**
+ * Prepare and map all data from DS.
+ *
+ * @param configDataNode data node of config data
+ * @param stateDataNode data node of state data
+ * @return {@link NormalizedNode}
+ */
+ @SuppressWarnings("unchecked")
+ private static @NonNull NormalizedNode prepareData(final @NonNull NormalizedNode configDataNode,
+ final @NonNull NormalizedNode stateDataNode) {
+ if (configDataNode instanceof UserMapNode configMap) {
+ final var builder = ImmutableNodes.newUserMapBuilder().withNodeIdentifier(configMap.name());
+ mapValueToBuilder(configMap.body(), ((UserMapNode) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof SystemMapNode configMap) {
+ final var builder = ImmutableNodes.newSystemMapBuilder().withNodeIdentifier(configMap.name());
+ mapValueToBuilder(configMap.body(), ((SystemMapNode) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof MapEntryNode configEntry) {
+ final var builder = ImmutableNodes.newMapEntryBuilder().withNodeIdentifier(configEntry.name());
+ mapValueToBuilder(configEntry.body(), ((MapEntryNode) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof ContainerNode configContaienr) {
+ final var builder = ImmutableNodes.newContainerBuilder().withNodeIdentifier(configContaienr.name());
+ mapValueToBuilder(configContaienr.body(), ((ContainerNode) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof ChoiceNode configChoice) {
+ final var builder = ImmutableNodes.newChoiceBuilder().withNodeIdentifier(configChoice.name());
+ mapValueToBuilder(configChoice.body(), ((ChoiceNode) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof LeafNode configLeaf) {
+ // config trumps oper
+ return configLeaf;
+ } else if (configDataNode instanceof UserLeafSetNode) {
+ final var configLeafSet = (UserLeafSetNode<Object>) configDataNode;
+ final var builder = ImmutableNodes.<Object>newUserLeafSetBuilder().withNodeIdentifier(configLeafSet.name());
+ mapValueToBuilder(configLeafSet.body(), ((UserLeafSetNode<Object>) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof SystemLeafSetNode) {
+ final var configLeafSet = (SystemLeafSetNode<Object>) configDataNode;
+ final var builder = ImmutableNodes.<Object>newSystemLeafSetBuilder()
+ .withNodeIdentifier(configLeafSet.name());
+ mapValueToBuilder(configLeafSet.body(), ((SystemLeafSetNode<Object>) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof LeafSetEntryNode<?> configEntry) {
+ // config trumps oper
+ return configEntry;
+ } else if (configDataNode instanceof UnkeyedListNode configList) {
+ final var builder = ImmutableNodes.newUnkeyedListBuilder().withNodeIdentifier(configList.name());
+ mapValueToBuilder(configList.body(), ((UnkeyedListNode) stateDataNode).body(), builder);
+ return builder.build();
+ } else if (configDataNode instanceof UnkeyedListEntryNode configEntry) {
+ final var builder = ImmutableNodes.newUnkeyedListEntryBuilder().withNodeIdentifier(configEntry.name());
+ mapValueToBuilder(configEntry.body(), ((UnkeyedListEntryNode) stateDataNode).body(), builder);
+ return builder.build();
+ } else {
+ throw new RestconfDocumentedException("Unexpected node type: " + configDataNode.getClass().getName());
+ }
+ }
+
+ /**
+ * Map value from container node to builder.
+ *
+ * @param configData collection of config data nodes
+ * @param stateData collection of state data nodes
+ * @param builder builder
+ */
+ private static <T extends NormalizedNode> void mapValueToBuilder(
+ final @NonNull Collection<T> configData, final @NonNull Collection<T> stateData,
+ final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
+ final var configMap = configData.stream().collect(Collectors.toMap(NormalizedNode::name, Function.identity()));
+ final var stateMap = stateData.stream().collect(Collectors.toMap(NormalizedNode::name, Function.identity()));
+
+ // merge config and state data of children with different identifiers
+ mapDataToBuilder(configMap, stateMap, builder);
+
+ // merge config and state data of children with the same identifiers
+ mergeDataToBuilder(configMap, stateMap, builder);
+ }
+
+ /**
+ * Map data with different identifiers to builder. Data with different identifiers can be just added
+ * as childs to parent node.
+ *
+ * @param configMap map of config data nodes
+ * @param stateMap map of state data nodes
+ * @param builder - builder
+ */
+ private static <T extends NormalizedNode> void mapDataToBuilder(
+ final @NonNull Map<PathArgument, T> configMap, final @NonNull Map<PathArgument, T> stateMap,
+ final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
+ configMap.entrySet().stream().filter(x -> !stateMap.containsKey(x.getKey())).forEach(
+ y -> builder.addChild(y.getValue()));
+ stateMap.entrySet().stream().filter(x -> !configMap.containsKey(x.getKey())).forEach(
+ y -> builder.addChild(y.getValue()));
+ }
+
+ /**
+ * Map data with the same identifiers to builder. Data with the same identifiers cannot be just added but we need to
+ * go one level down with {@code prepareData} method.
+ *
+ * @param configMap immutable config data
+ * @param stateMap immutable state data
+ * @param builder - builder
+ */
+ @SuppressWarnings("unchecked")
+ private static <T extends NormalizedNode> void mergeDataToBuilder(
+ final @NonNull Map<PathArgument, T> configMap, final @NonNull Map<PathArgument, T> stateMap,
+ final @NonNull NormalizedNodeContainerBuilder<?, PathArgument, T, ?> builder) {
+ // it is enough to process only config data because operational contains the same data
+ configMap.entrySet().stream().filter(x -> stateMap.containsKey(x.getKey())).forEach(
+ y -> builder.addChild((T) prepareData(y.getValue(), stateMap.get(y.getKey()))));
+ }
+
+ @NonNullByDefault
+ public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request) {
+ return operations.httpGET(request);
+ }
+
+ @NonNullByDefault
+ public RestconfFuture<FormattableBody> operationsGET(final ServerRequest request, final ApiPath apiPath) {
+ return operations.httpGET(request, apiPath);
+ }
+
+ public @NonNull RestconfFuture<InvokeResult> operationsPOST(final ServerRequest request, final URI restconfURI,
+ final ApiPath apiPath, final OperationInputBody body) {
+ final Rpc path;
+ try {
+ path = pathNormalizer.normalizeRpcPath(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+
+ final ContainerNode data;
+ try {
+ data = body.toContainerNode(path);
+ } catch (IOException e) {
+ LOG.debug("Error reading input", e);
+ return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
+ ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
+ }
+
+ final var type = path.rpc().argument();
+ final var local = localRpcs.get(type);
+ if (local != null) {
+ return local.invoke(restconfURI, new OperationInput(path, data))
+ .transform(output -> outputToInvokeResult(path, output));
+ }
+ if (rpcService == null) {
+ LOG.debug("RPC invocation is not available");
+ return RestconfFuture.failed(new RestconfDocumentedException("RPC invocation is not available",
+ ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED));
+ }
+
+ final var ret = new SettableRestconfFuture<InvokeResult>();
+ Futures.addCallback(rpcService.invokeRpc(type, data), new FutureCallback<DOMRpcResult>() {
+ @Override
+ public void onSuccess(final DOMRpcResult response) {
+ final var errors = response.errors();
+ if (errors.isEmpty()) {
+ ret.set(outputToInvokeResult(path, response.value()));
+ } else {
+ LOG.debug("RPC invocation reported {}", response.errors());
+ ret.setFailure(new RestconfDocumentedException("RPC implementation reported errors", null,
+ response.errors()));
+ }
+ }
+
+ @Override
+ public void onFailure(final Throwable cause) {
+ LOG.debug("RPC invocation failed, cause");
+ if (cause instanceof RestconfDocumentedException ex) {
+ ret.setFailure(ex);
+ } else {
+ // TODO: YangNetconfErrorAware if we ever get into a broader invocation scope
+ ret.setFailure(new RestconfDocumentedException(cause,
+ new RestconfError(ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage())));
+ }
+ }
+ }, MoreExecutors.directExecutor());
+ return ret;
+ }
+
+ private static @NonNull InvokeResult outputToInvokeResult(final @NonNull OperationPath path,
+ final @Nullable ContainerNode value) {
+ return value == null || value.isEmpty() ? InvokeResult.EMPTY
+ : new InvokeResult(new OperationOutputBody(path, value));
+ }
+
+ public @NonNull RestconfFuture<CharSource> resolveSource(final SourceIdentifier source,
+ final Class<? extends SourceRepresentation> representation) {
+ final var src = requireNonNull(source);
+ if (YangTextSource.class.isAssignableFrom(representation)) {
+ if (sourceProvider != null) {
+ final var ret = new SettableRestconfFuture<CharSource>();
+ Futures.addCallback(sourceProvider.getYangTexttSource(src), new FutureCallback<>() {
+ @Override
+ public void onSuccess(final YangTextSource result) {
+ ret.set(result);
+ }
+
+ @Override
+ public void onFailure(final Throwable cause) {
+ ret.setFailure(cause instanceof RestconfDocumentedException e ? e
+ : new RestconfDocumentedException(cause.getMessage(), ErrorType.RPC,
+ ErrorTag.OPERATION_FAILED, cause));
+ }
+ }, MoreExecutors.directExecutor());
+ return ret;
+ }
+ return exportSource(modelContext(), src, YangCharSource::new, YangCharSource::new);
+ }
+ if (YinTextSource.class.isAssignableFrom(representation)) {
+ return exportSource(modelContext(), src, YinCharSource.OfModule::new, YinCharSource.OfSubmodule::new);
+ }
+ return RestconfFuture.failed(new RestconfDocumentedException(
+ "Unsupported source representation " + representation.getName()));
+ }
+
+ private static @NonNull RestconfFuture<CharSource> exportSource(final EffectiveModelContext modelContext,
+ final SourceIdentifier source, final Function<ModuleEffectiveStatement, CharSource> moduleCtor,
+ final BiFunction<ModuleEffectiveStatement, SubmoduleEffectiveStatement, CharSource> submoduleCtor) {
+ // If the source identifies a module, things are easy
+ final var name = source.name().getLocalName();
+ final var optRevision = Optional.ofNullable(source.revision());
+ final var optModule = modelContext.findModule(name, optRevision);
+ if (optModule.isPresent()) {
+ return RestconfFuture.of(moduleCtor.apply(optModule.orElseThrow().asEffectiveStatement()));
+ }
+
+ // The source could be a submodule, which we need to hunt down
+ for (var module : modelContext.getModules()) {
+ for (var submodule : module.getSubmodules()) {
+ if (name.equals(submodule.getName()) && optRevision.equals(submodule.getRevision())) {
+ return RestconfFuture.of(submoduleCtor.apply(module.asEffectiveStatement(),
+ submodule.asEffectiveStatement()));
+ }
+ }
+ }
+
+ final var sb = new StringBuilder().append("Source ").append(source.name().getLocalName());
+ optRevision.ifPresent(rev -> sb.append('@').append(rev));
+ sb.append(" not found");
+ return RestconfFuture.failed(new RestconfDocumentedException(sb.toString(),
+ ErrorType.APPLICATION, ErrorTag.DATA_MISSING));
+ }
+
+ public final @NonNull RestconfFuture<? extends DataPostResult> dataPOST(final ServerRequest request,
+ final ApiPath apiPath, final DataPostBody body) {
+ if (apiPath.isEmpty()) {
+ return dataCreatePOST(request, body.toResource());
+ }
+ final InstanceReference path;
+ try {
+ path = pathNormalizer.normalizeDataOrActionPath(apiPath);
+ } catch (RestconfDocumentedException e) {
+ return RestconfFuture.failed(e);
+ }
+ if (path instanceof Data dataPath) {
+ try (var resourceBody = body.toResource()) {
+ return dataCreatePOST(request, dataPath, resourceBody);
+ }
+ }
+ if (path instanceof Action actionPath) {
+ try (var inputBody = body.toOperationInput()) {
+ return dataInvokePOST(actionPath, inputBody);
+ }
+ }
+ // Note: this should never happen
+ // FIXME: we should be able to eliminate this path with Java 21+ pattern matching
+ return RestconfFuture.failed(new RestconfDocumentedException("Unhandled path " + path));
+ }
+
+ public @NonNull RestconfFuture<CreateResourceResult> dataCreatePOST(final ServerRequest request,
+ final ChildBody body) {
+ return dataCreatePOST(request, new DatabindPath.Data(databind), body);
+ }
+
+ private @NonNull RestconfFuture<CreateResourceResult> dataCreatePOST(final ServerRequest request,
+ final DatabindPath.Data path, final ChildBody body) {
+ final Insert insert;
+ try {
+ insert = Insert.of(path.databind(), request.queryParameters());
+ } catch (IllegalArgumentException e) {
+ return RestconfFuture.failed(new RestconfDocumentedException(e.getMessage(),
+ ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e));
+ }
+
+ final var payload = body.toPayload(path);
+ return postData(concat(path.instance(), payload.prefix()), payload.body(), insert);
+ }
+
+ private static YangInstanceIdentifier concat(final YangInstanceIdentifier parent, final List<PathArgument> args) {
+ var ret = parent;
+ for (var arg : args) {
+ ret = ret.node(arg);
+ }
+ return ret;
+ }
+
+ private @NonNull RestconfFuture<InvokeResult> dataInvokePOST(final @NonNull Action path,
+ final @NonNull OperationInputBody body) {
+ final ContainerNode input;
+ try {
+ input = body.toContainerNode(path);
+ } catch (IOException e) {
+ LOG.debug("Error reading input", e);
+ return RestconfFuture.failed(new RestconfDocumentedException("Error parsing input: " + e.getMessage(),
+ ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e));
+ }
+
+ if (actionService == null) {
+ return RestconfFuture.failed(new RestconfDocumentedException("DOMActionService is missing."));
+ }
+
+ return dataInvokePOST(actionService, path, input)
+ .transform(result -> outputToInvokeResult(path, result.getOutput().orElse(null)));
+ }
+
+ /**
+ * Invoke Action via ActionServiceHandler.
+ *
+ * @param input input data
+ * @param yangIId invocation context
+ * @param schemaPath schema path of data
+ * @param actionService action service to invoke action
+ * @return {@link DOMActionResult}
+ */
+ private static RestconfFuture<DOMActionResult> dataInvokePOST(final DOMActionService actionService,
+ final Action path, final @NonNull ContainerNode input) {
+ final var ret = new SettableRestconfFuture<DOMActionResult>();
+
+ Futures.addCallback(actionService.invokeAction(
+ path.inference().toSchemaInferenceStack().toSchemaNodeIdentifier(),
+ DOMDataTreeIdentifier.of(LogicalDatastoreType.OPERATIONAL, path.instance()), input),
+ new FutureCallback<DOMActionResult>() {
+ @Override
+ public void onSuccess(final DOMActionResult result) {
+ final var errors = result.getErrors();
+ LOG.debug("InvokeAction Error Message {}", errors);
+ if (errors.isEmpty()) {
+ ret.set(result);
+ } else {
+ ret.setFailure(new RestconfDocumentedException("InvokeAction Error Message ", null, errors));
+ }
+ }
+
+ @Override
+ public void onFailure(final Throwable cause) {
+ if (cause instanceof DOMActionException) {
+ ret.set(new SimpleDOMActionResult(List.of(RpcResultBuilder.newError(
+ ErrorType.RPC, ErrorTag.OPERATION_FAILED, cause.getMessage()))));
+ } else if (cause instanceof RestconfDocumentedException e) {
+ ret.setFailure(e);
+ } else if (cause instanceof CancellationException) {
+ ret.setFailure(new RestconfDocumentedException("Action cancelled while executing",
+ ErrorType.RPC, ErrorTag.PARTIAL_OPERATION, cause));
+ } else {
+ ret.setFailure(new RestconfDocumentedException("Invocation failed", cause));
+ }
+ }
+ }, MoreExecutors.directExecutor());
+
+ return ret;
+ }
}
Code Review / netconf.git / blobdiff