X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=restconf%2Frestconf-nb-rfc8040%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Frestconf%2Fnb%2Frfc8040%2Frests%2Futils%2FReadDataTransactionUtil.java;h=2f5554bc645cf8ff6f4953bb248e568eba7ffe35;hb=5f22ebd19472ce152c55f62269f2405cd6904c94;hp=a08be258c74e6dde32586f2b647ce4766404a208;hpb=084d0c1613ecc6e6b098e144b36a3f461ff47c02;p=netconf.git
diff --git a/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/ReadDataTransactionUtil.java b/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/ReadDataTransactionUtil.java
index a08be258c7..2f5554bc64 100644
--- a/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/ReadDataTransactionUtil.java
+++ b/restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/rests/utils/ReadDataTransactionUtil.java
@@ -7,15 +7,20 @@
*/
package org.opendaylight.restconf.nb.rfc8040.rests.utils;
+import static org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserFieldsParameter.parseFieldsParameter;
+import static org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserFieldsParameter.parseFieldsPaths;
+
+import com.google.common.annotations.VisibleForTesting;
import com.google.common.primitives.Ints;
import com.google.common.util.concurrent.ListenableFuture;
import java.util.Collection;
-import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
+import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
+import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.UriInfo;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
@@ -26,8 +31,10 @@ import org.opendaylight.restconf.common.context.WriterParameters;
import org.opendaylight.restconf.common.context.WriterParameters.WriterParametersBuilder;
import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
import org.opendaylight.restconf.common.errors.RestconfError;
+import org.opendaylight.restconf.common.errors.RestconfError.ErrorTag;
+import org.opendaylight.restconf.common.errors.RestconfError.ErrorType;
import org.opendaylight.restconf.nb.rfc8040.rests.transactions.RestconfStrategy;
-import org.opendaylight.restconf.nb.rfc8040.utils.parser.ParserFieldsParameter;
+import org.opendaylight.restconf.nb.rfc8040.rests.utils.RestconfDataServiceConstant.ReadData.WithDefaults;
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.common.QNameModule;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
@@ -45,24 +52,27 @@ import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
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.OrderedLeafSetNode;
-import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
+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.ListNodeBuilder;
+import org.opendaylight.yangtools.yang.data.api.schema.builder.NormalizedNodeBuilder;
+import org.opendaylight.yangtools.yang.data.api.schema.builder.NormalizedNodeContainerBuilder;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
-import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
+import org.opendaylight.yangtools.yang.data.impl.schema.SchemaAwareBuilders;
import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
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.SchemaContext;
/**
* Util class for read data from data store via transaction.
@@ -71,12 +81,19 @@ import org.opendaylight.yangtools.yang.model.api.SchemaContext;
* state
* all (config + state)
*
- *
*/
public final class ReadDataTransactionUtil {
+ private static final Set ALLOWED_PARAMETERS = Set.of(
+ RestconfDataServiceConstant.ReadData.CONTENT,
+ RestconfDataServiceConstant.ReadData.DEPTH,
+ RestconfDataServiceConstant.ReadData.FIELDS,
+ RestconfDataServiceConstant.ReadData.WITH_DEFAULTS);
+ private static final List DEFAULT_CONTENT = List.of(RestconfDataServiceConstant.ReadData.ALL);
+ private static final List DEFAULT_DEPTH = List.of(RestconfDataServiceConstant.ReadData.UNBOUNDED);
+ private static final String READ_TYPE_TX = "READ";
private ReadDataTransactionUtil() {
- throw new UnsupportedOperationException("Util class.");
+ // Hidden on purpose
}
/**
@@ -89,39 +106,29 @@ public final class ReadDataTransactionUtil {
public static WriterParameters parseUriParameters(final InstanceIdentifierContext identifier,
final UriInfo uriInfo) {
final WriterParametersBuilder builder = new WriterParametersBuilder();
-
if (uriInfo == null) {
return builder.build();
}
// check only allowed parameters
- ParametersUtil.checkParametersTypes(
- RestconfDataServiceConstant.ReadData.READ_TYPE_TX,
- uriInfo.getQueryParameters().keySet(),
- RestconfDataServiceConstant.ReadData.CONTENT,
- RestconfDataServiceConstant.ReadData.DEPTH,
- RestconfDataServiceConstant.ReadData.FIELDS, RestconfDataServiceConstant.ReadData.WITH_DEFAULTS);
+ final MultivaluedMap queryParams = uriInfo.getQueryParameters();
+ checkParametersTypes(queryParams.keySet(), ALLOWED_PARAMETERS);
// read parameters from URI or set default values
- final List content = uriInfo.getQueryParameters().getOrDefault(
- RestconfDataServiceConstant.ReadData.CONTENT,
- Collections.singletonList(RestconfDataServiceConstant.ReadData.ALL));
- final List depth = uriInfo.getQueryParameters().getOrDefault(
- RestconfDataServiceConstant.ReadData.DEPTH,
- Collections.singletonList(RestconfDataServiceConstant.ReadData.UNBOUNDED));
- final List withDefaults = uriInfo.getQueryParameters().getOrDefault(
- RestconfDataServiceConstant.ReadData.WITH_DEFAULTS,
- Collections.emptyList());
+ final List content = queryParams.getOrDefault(
+ RestconfDataServiceConstant.ReadData.CONTENT, DEFAULT_CONTENT);
+ final List depth = queryParams.getOrDefault(
+ RestconfDataServiceConstant.ReadData.DEPTH, DEFAULT_DEPTH);
+ final List withDefaults = queryParams.getOrDefault(
+ RestconfDataServiceConstant.ReadData.WITH_DEFAULTS, List.of());
// fields
- final List fields = uriInfo.getQueryParameters().getOrDefault(
- RestconfDataServiceConstant.ReadData.FIELDS,
- Collections.emptyList());
+ final List fields = queryParams.getOrDefault(RestconfDataServiceConstant.ReadData.FIELDS, List.of());
// parameter can be in URI at most once
- ParametersUtil.checkParameterCount(content, RestconfDataServiceConstant.ReadData.CONTENT);
- ParametersUtil.checkParameterCount(depth, RestconfDataServiceConstant.ReadData.DEPTH);
- ParametersUtil.checkParameterCount(fields, RestconfDataServiceConstant.ReadData.FIELDS);
- ParametersUtil.checkParameterCount(fields, RestconfDataServiceConstant.ReadData.WITH_DEFAULTS);
+ checkParameterCount(content, RestconfDataServiceConstant.ReadData.CONTENT);
+ checkParameterCount(depth, RestconfDataServiceConstant.ReadData.DEPTH);
+ checkParameterCount(fields, RestconfDataServiceConstant.ReadData.FIELDS);
+ checkParameterCount(fields, RestconfDataServiceConstant.ReadData.WITH_DEFAULTS);
// check and set content
final String contentValue = content.get(0);
@@ -154,38 +161,36 @@ public final class ReadDataTransactionUtil {
// check and set fields
if (!fields.isEmpty()) {
- builder.setFields(ParserFieldsParameter.parseFieldsParameter(identifier, fields.get(0)));
+ if (identifier.getMountPoint() != null) {
+ builder.setFieldPaths(parseFieldsPaths(identifier, fields.get(0)));
+ } else {
+ builder.setFields(parseFieldsParameter(identifier, fields.get(0)));
+ }
}
// check and set withDefaults parameter
if (!withDefaults.isEmpty()) {
- switch (withDefaults.get(0)) {
- case RestconfDataServiceConstant.ReadData.REPORT_ALL_TAGGED_DEFAULT_VALUE:
- builder.setTagged(true);
+ final String str = withDefaults.get(0);
+ final WithDefaults val = WithDefaults.forValue(str);
+ if (val == null) {
+ throw new RestconfDocumentedException(new RestconfError(RestconfError.ErrorType.PROTOCOL,
+ RestconfError.ErrorTag.INVALID_VALUE, "Invalid with-defaults parameter: " + str, null,
+ "The with-defaults parameter must be a string in " + WithDefaults.possibleValues()));
+ }
+
+ switch (val) {
+ case REPORT_ALL:
break;
- case RestconfDataServiceConstant.ReadData.REPORT_ALL_DEFAULT_VALUE:
+ case REPORT_ALL_TAGGED:
+ builder.setTagged(true);
break;
default:
- builder.setWithDefault(withDefaults.get(0));
+ builder.setWithDefault(val.value());
}
}
return builder.build();
}
- /**
- * Read specific type of data from data store via transaction.
- *
- * @param valueOfContent type of data to read (config, state, all)
- * @param strategy {@link RestconfStrategy} - wrapper for variables
- * @param schemaContext schema context
- * @return {@link NormalizedNode}
- */
- public static @Nullable NormalizedNode readData(final @NonNull String valueOfContent,
- final YangInstanceIdentifier path, final @NonNull RestconfStrategy strategy,
- final SchemaContext schemaContext) {
- return readData(valueOfContent, path, strategy, null, schemaContext);
- }
-
/**
* Read specific type of data from data store via transaction. Close {@link DOMTransactionChain} if any
* inside of object {@link RestconfStrategy} provided as a parameter.
@@ -193,14 +198,14 @@ public final class ReadDataTransactionUtil {
* @param valueOfContent type of data to read (config, state, all)
* @param path the path to read
* @param strategy {@link RestconfStrategy} - object that perform the actual DS operations
- * @param withDefa valee of with-defaults parameter
+ * @param withDefa value of with-defaults parameter
* @param ctx schema context
* @return {@link NormalizedNode}
*/
- public static @Nullable NormalizedNode readData(final @NonNull String valueOfContent,
- final @NonNull YangInstanceIdentifier path,
- final @NonNull RestconfStrategy strategy,
- final String withDefa, final SchemaContext ctx) {
+ public static @Nullable NormalizedNode readData(final @NonNull String valueOfContent,
+ final @NonNull YangInstanceIdentifier path,
+ final @NonNull RestconfStrategy strategy,
+ final String withDefa, final EffectiveModelContext ctx) {
switch (valueOfContent) {
case RestconfDataServiceConstant.ReadData.CONFIG:
if (withDefa == null) {
@@ -215,7 +220,6 @@ public final class ReadDataTransactionUtil {
case RestconfDataServiceConstant.ReadData.ALL:
return readAllData(strategy, path, withDefa, ctx);
default:
- strategy.cancel();
throw new RestconfDocumentedException(
new RestconfError(RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.INVALID_VALUE,
"Invalid content parameter: " + valueOfContent, null,
@@ -223,8 +227,78 @@ public final class ReadDataTransactionUtil {
}
}
- private static NormalizedNode prepareDataByParamWithDef(final NormalizedNode result,
- final YangInstanceIdentifier path, final String withDefa, final SchemaContext ctx) {
+ /**
+ * Read specific type of data from data store via transaction with specified subtrees that should only be read.
+ * Close {@link DOMTransactionChain} inside of object {@link RestconfStrategy} provided as a parameter.
+ *
+ * @param valueOfContent type of data to read (config, state, all)
+ * @param path the parent path to read
+ * @param strategy {@link RestconfStrategy} - object that perform the actual DS operations
+ * @param withDefa value of with-defaults parameter
+ * @param ctx schema context
+ * @param fields paths to selected subtrees which should be read, relative to to the parent path
+ * @return {@link NormalizedNode}
+ */
+ public static @Nullable NormalizedNode readData(final @NonNull String valueOfContent,
+ final @NonNull YangInstanceIdentifier path, final @NonNull RestconfStrategy strategy,
+ final @Nullable String withDefa, @NonNull final EffectiveModelContext ctx,
+ final @NonNull List fields) {
+ switch (valueOfContent) {
+ case RestconfDataServiceConstant.ReadData.CONFIG:
+ if (withDefa == null) {
+ return readDataViaTransaction(strategy, LogicalDatastoreType.CONFIGURATION, path, true, fields);
+ } else {
+ return prepareDataByParamWithDef(
+ readDataViaTransaction(strategy, LogicalDatastoreType.CONFIGURATION, path, true, fields),
+ path, withDefa, ctx);
+ }
+ case RestconfDataServiceConstant.ReadData.NONCONFIG:
+ return readDataViaTransaction(strategy, LogicalDatastoreType.OPERATIONAL, path, true, fields);
+ case RestconfDataServiceConstant.ReadData.ALL:
+ return readAllData(strategy, path, withDefa, ctx, fields);
+ default:
+ throw new RestconfDocumentedException(new RestconfError(RestconfError.ErrorType.PROTOCOL,
+ RestconfError.ErrorTag.INVALID_VALUE, "Invalid content parameter: " + valueOfContent, null,
+ "The content parameter value must be either config, nonconfig or all (default)"));
+ }
+ }
+
+ /**
+ * Check if URI does not contain value for the same parameter more than once.
+ *
+ * @param parameterValues URI parameter values
+ * @param parameterName URI parameter name
+ */
+ @VisibleForTesting
+ static void checkParameterCount(final @NonNull List parameterValues, final @NonNull String parameterName) {
+ if (parameterValues.size() > 1) {
+ throw new RestconfDocumentedException(
+ "Parameter " + parameterName + " can appear at most once in request URI",
+ ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE);
+ }
+ }
+
+ /**
+ * Check if URI does not contain not allowed parameters for specified operation.
+ *
+ * @param usedParameters parameters used in URI request
+ * @param allowedParameters allowed parameters for operation
+ */
+ @VisibleForTesting
+ static void checkParametersTypes(final @NonNull Set usedParameters,
+ final @NonNull Set allowedParameters) {
+ if (!allowedParameters.containsAll(usedParameters)) {
+ final Set notAllowedParameters = usedParameters.stream()
+ .filter(param -> !allowedParameters.contains(param))
+ .collect(Collectors.toSet());
+ throw new RestconfDocumentedException(
+ "Not allowed parameters for " + READ_TYPE_TX + " operation: " + notAllowedParameters,
+ RestconfError.ErrorType.PROTOCOL, RestconfError.ErrorTag.INVALID_VALUE);
+ }
+ }
+
+ private static NormalizedNode prepareDataByParamWithDef(final NormalizedNode result,
+ final YangInstanceIdentifier path, final String withDefa, final EffectiveModelContext ctx) {
boolean trim;
switch (withDefa) {
case "trim":
@@ -238,15 +312,15 @@ public final class ReadDataTransactionUtil {
}
final DataSchemaContextTree baseSchemaCtxTree = DataSchemaContextTree.from(ctx);
- final DataSchemaNode baseSchemaNode = baseSchemaCtxTree.getChild(path).getDataSchemaNode();
+ final DataSchemaNode baseSchemaNode = baseSchemaCtxTree.findChild(path).orElseThrow().getDataSchemaNode();
if (result instanceof ContainerNode) {
final DataContainerNodeBuilder builder =
- Builders.containerBuilder((ContainerSchemaNode) baseSchemaNode);
+ SchemaAwareBuilders.containerBuilder((ContainerSchemaNode) baseSchemaNode);
buildCont(builder, (ContainerNode) result, baseSchemaCtxTree, path, trim);
return builder.build();
} else {
final DataContainerNodeBuilder builder =
- Builders.mapEntryBuilder((ListSchemaNode) baseSchemaNode);
+ SchemaAwareBuilders.mapEntryBuilder((ListSchemaNode) baseSchemaNode);
buildMapEntryBuilder(builder, (MapEntryNode) result, baseSchemaCtxTree, path, trim,
((ListSchemaNode) baseSchemaNode).getKeyDefinition());
return builder.build();
@@ -257,37 +331,37 @@ public final class ReadDataTransactionUtil {
final DataContainerNodeBuilder builder,
final MapEntryNode result, final DataSchemaContextTree baseSchemaCtxTree,
final YangInstanceIdentifier actualPath, final boolean trim, final List keys) {
- for (final DataContainerChild child : result.getValue()) {
+ for (final DataContainerChild child : result.body()) {
final YangInstanceIdentifier path = actualPath.node(child.getIdentifier());
- final DataSchemaNode childSchema = baseSchemaCtxTree.getChild(path).getDataSchemaNode();
+ final DataSchemaNode childSchema = baseSchemaCtxTree.findChild(path).orElseThrow().getDataSchemaNode();
if (child instanceof ContainerNode) {
final DataContainerNodeBuilder childBuilder =
- Builders.containerBuilder((ContainerSchemaNode) childSchema);
+ SchemaAwareBuilders.containerBuilder((ContainerSchemaNode) childSchema);
buildCont(childBuilder, (ContainerNode) child, baseSchemaCtxTree, path, trim);
builder.withChild(childBuilder.build());
} else if (child instanceof MapNode) {
- final CollectionNodeBuilder childBuilder =
- Builders.mapBuilder((ListSchemaNode) childSchema);
+ final CollectionNodeBuilder childBuilder =
+ SchemaAwareBuilders.mapBuilder((ListSchemaNode) childSchema);
buildList(childBuilder, (MapNode) child, baseSchemaCtxTree, path, trim,
((ListSchemaNode) childSchema).getKeyDefinition());
builder.withChild(childBuilder.build());
} else if (child instanceof LeafNode) {
final Object defaultVal = ((LeafSchemaNode) childSchema).getType().getDefaultValue().orElse(null);
- final Object nodeVal = child.getValue();
+ final Object nodeVal = child.body();
final NormalizedNodeBuilder> leafBuilder =
- Builders.leafBuilder((LeafSchemaNode) childSchema);
- if (keys.contains(child.getNodeType())) {
- leafBuilder.withValue(((LeafNode) child).getValue());
+ SchemaAwareBuilders.leafBuilder((LeafSchemaNode) childSchema);
+ if (keys.contains(child.getIdentifier().getNodeType())) {
+ leafBuilder.withValue(((LeafNode) child).body());
builder.withChild(leafBuilder.build());
} else {
if (trim) {
if (defaultVal == null || !defaultVal.equals(nodeVal)) {
- leafBuilder.withValue(((LeafNode) child).getValue());
+ leafBuilder.withValue(((LeafNode) child).body());
builder.withChild(leafBuilder.build());
}
} else {
if (defaultVal != null && defaultVal.equals(nodeVal)) {
- leafBuilder.withValue(((LeafNode) child).getValue());
+ leafBuilder.withValue(((LeafNode) child).body());
builder.withChild(leafBuilder.build());
}
}
@@ -296,14 +370,15 @@ public final class ReadDataTransactionUtil {
}
}
- private static void buildList(final CollectionNodeBuilder builder, final MapNode result,
- final DataSchemaContextTree baseSchemaCtxTree, final YangInstanceIdentifier path, final boolean trim,
- final List keys) {
- for (final MapEntryNode mapEntryNode : result.getValue()) {
+ private static void buildList(final CollectionNodeBuilder builder,
+ final MapNode result, final DataSchemaContextTree baseSchemaCtxTree, final YangInstanceIdentifier path,
+ final boolean trim, final List keys) {
+ for (final MapEntryNode mapEntryNode : result.body()) {
final YangInstanceIdentifier actualNode = path.node(mapEntryNode.getIdentifier());
- final DataSchemaNode childSchema = baseSchemaCtxTree.getChild(actualNode).getDataSchemaNode();
+ final DataSchemaNode childSchema = baseSchemaCtxTree.findChild(actualNode).orElseThrow()
+ .getDataSchemaNode();
final DataContainerNodeBuilder mapEntryBuilder =
- Builders.mapEntryBuilder((ListSchemaNode) childSchema);
+ SchemaAwareBuilders.mapEntryBuilder((ListSchemaNode) childSchema);
buildMapEntryBuilder(mapEntryBuilder, mapEntryNode, baseSchemaCtxTree, actualNode, trim, keys);
builder.withChild(mapEntryBuilder.build());
}
@@ -312,33 +387,33 @@ public final class ReadDataTransactionUtil {
private static void buildCont(final DataContainerNodeBuilder builder,
final ContainerNode result, final DataSchemaContextTree baseSchemaCtxTree,
final YangInstanceIdentifier actualPath, final boolean trim) {
- for (final DataContainerChild child : result.getValue()) {
+ for (final DataContainerChild child : result.body()) {
final YangInstanceIdentifier path = actualPath.node(child.getIdentifier());
- final DataSchemaNode childSchema = baseSchemaCtxTree.getChild(path).getDataSchemaNode();
+ final DataSchemaNode childSchema = baseSchemaCtxTree.findChild(path).orElseThrow().getDataSchemaNode();
if (child instanceof ContainerNode) {
final DataContainerNodeBuilder builderChild =
- Builders.containerBuilder((ContainerSchemaNode) childSchema);
+ SchemaAwareBuilders.containerBuilder((ContainerSchemaNode) childSchema);
buildCont(builderChild, result, baseSchemaCtxTree, actualPath, trim);
builder.withChild(builderChild.build());
} else if (child instanceof MapNode) {
- final CollectionNodeBuilder childBuilder =
- Builders.mapBuilder((ListSchemaNode) childSchema);
+ final CollectionNodeBuilder childBuilder =
+ SchemaAwareBuilders.mapBuilder((ListSchemaNode) childSchema);
buildList(childBuilder, (MapNode) child, baseSchemaCtxTree, path, trim,
((ListSchemaNode) childSchema).getKeyDefinition());
builder.withChild(childBuilder.build());
} else if (child instanceof LeafNode) {
final Object defaultVal = ((LeafSchemaNode) childSchema).getType().getDefaultValue().orElse(null);
- final Object nodeVal = child.getValue();
+ final Object nodeVal = child.body();
final NormalizedNodeBuilder> leafBuilder =
- Builders.leafBuilder((LeafSchemaNode) childSchema);
+ SchemaAwareBuilders.leafBuilder((LeafSchemaNode) childSchema);
if (trim) {
if (defaultVal == null || !defaultVal.equals(nodeVal)) {
- leafBuilder.withValue(((LeafNode) child).getValue());
+ leafBuilder.withValue(((LeafNode) child).body());
builder.withChild(leafBuilder.build());
}
} else {
if (defaultVal != null && defaultVal.equals(nodeVal)) {
- leafBuilder.withValue(((LeafNode) child).getValue());
+ leafBuilder.withValue(((LeafNode) child).body());
builder.withChild(leafBuilder.build());
}
}
@@ -355,19 +430,41 @@ public final class ReadDataTransactionUtil {
* in {@link RestconfStrategy} if any
* @return {@link NormalizedNode}
*/
- private static @Nullable NormalizedNode readDataViaTransaction(
- final @NonNull RestconfStrategy strategy,
+ static @Nullable NormalizedNode readDataViaTransaction(final @NonNull RestconfStrategy strategy,
final LogicalDatastoreType store, final YangInstanceIdentifier path,
final boolean closeTransactionChain) {
+ final ListenableFuture> listenableFuture = strategy.read(store, path);
+ return extractReadData(strategy, path, closeTransactionChain, listenableFuture);
+ }
+
+ /**
+ * Read specific type of data {@link LogicalDatastoreType} via transaction in {@link RestconfStrategy} with
+ * specified subtrees that should only be read.
+ *
+ * @param strategy {@link RestconfStrategy} - object that perform the actual DS operations
+ * @param store datastore type
+ * @param path parent path to selected fields
+ * @param closeTransactionChain if it is set to {@code true}, after transaction it will close transactionChain
+ * in {@link RestconfStrategy} if any
+ * @param fields paths to selected subtrees which should be read, relative to to the parent path
+ * @return {@link NormalizedNode}
+ */
+ private static @Nullable NormalizedNode readDataViaTransaction(final @NonNull RestconfStrategy strategy,
+ final @NonNull LogicalDatastoreType store, final @NonNull YangInstanceIdentifier path,
+ final boolean closeTransactionChain, final @NonNull List fields) {
+ final ListenableFuture> listenableFuture = strategy.read(store, path, fields);
+ return extractReadData(strategy, path, closeTransactionChain, listenableFuture);
+ }
+
+ private static NormalizedNode extractReadData(final RestconfStrategy strategy,
+ final YangInstanceIdentifier path, final boolean closeTransactionChain,
+ final ListenableFuture> dataFuture) {
final NormalizedNodeFactory dataFactory = new NormalizedNodeFactory();
- final ListenableFuture>> listenableFuture = strategy.read(store, path);
if (closeTransactionChain) {
//Method close transactionChain if any
- FutureCallbackTx.addCallback(listenableFuture, RestconfDataServiceConstant.ReadData.READ_TYPE_TX,
- dataFactory, strategy.getTransactionChain());
+ FutureCallbackTx.addCallback(dataFuture, READ_TYPE_TX, dataFactory, strategy, path);
} else {
- FutureCallbackTx.addCallback(listenableFuture, RestconfDataServiceConstant.ReadData.READ_TYPE_TX,
- dataFactory);
+ FutureCallbackTx.addCallback(dataFuture, READ_TYPE_TX, dataFactory);
}
return dataFactory.build();
}
@@ -381,14 +478,14 @@ public final class ReadDataTransactionUtil {
* @param ctx schema context
* @return {@link NormalizedNode}
*/
- private static @Nullable NormalizedNode readAllData(final @NonNull RestconfStrategy strategy,
- final YangInstanceIdentifier path, final String withDefa, final SchemaContext ctx) {
+ private static @Nullable NormalizedNode readAllData(final @NonNull RestconfStrategy strategy,
+ final YangInstanceIdentifier path, final String withDefa, final EffectiveModelContext ctx) {
// PREPARE STATE DATA NODE
- final NormalizedNode stateDataNode = readDataViaTransaction(
- strategy, LogicalDatastoreType.OPERATIONAL, path, false);
+ final NormalizedNode stateDataNode = readDataViaTransaction(strategy, LogicalDatastoreType.OPERATIONAL, path,
+ false);
// PREPARE CONFIG DATA NODE
- final NormalizedNode configDataNode;
+ final NormalizedNode configDataNode;
//Here will be closed transactionChain if any
if (withDefa == null) {
configDataNode = readDataViaTransaction(
@@ -399,6 +496,43 @@ public final class ReadDataTransactionUtil {
path, withDefa, ctx);
}
+ return mergeConfigAndSTateDataIfNeeded(stateDataNode, configDataNode);
+ }
+
+ /**
+ * Read config and state data with selected subtrees that should only be read, then map them.
+ * Close {@link DOMTransactionChain} inside of object {@link RestconfStrategy} provided as a parameter.
+ *
+ * @param strategy {@link RestconfStrategy} - object that perform the actual DS operations
+ * @param path parent path to selected fields
+ * @param withDefa with-defaults parameter
+ * @param ctx schema context
+ * @param fields paths to selected subtrees which should be read, relative to to the parent path
+ * @return {@link NormalizedNode}
+ */
+ private static @Nullable NormalizedNode readAllData(final @NonNull RestconfStrategy strategy,
+ final @NonNull YangInstanceIdentifier path, final @Nullable String withDefa,
+ final @NonNull EffectiveModelContext ctx, final @NonNull List fields) {
+ // PREPARE STATE DATA NODE
+ final NormalizedNode stateDataNode = readDataViaTransaction(strategy, LogicalDatastoreType.OPERATIONAL, path,
+ false, fields);
+
+ // PREPARE CONFIG DATA NODE
+ final NormalizedNode configDataNode;
+ //Here will be closed transactionChain if any
+ if (withDefa == null) {
+ configDataNode = readDataViaTransaction(strategy, LogicalDatastoreType.CONFIGURATION, path, true, fields);
+ } else {
+ configDataNode = prepareDataByParamWithDef(
+ readDataViaTransaction(strategy, LogicalDatastoreType.CONFIGURATION, path, true, fields),
+ path, withDefa, ctx);
+ }
+
+ return mergeConfigAndSTateDataIfNeeded(stateDataNode, configDataNode);
+ }
+
+ private static NormalizedNode mergeConfigAndSTateDataIfNeeded(final NormalizedNode stateDataNode,
+ final NormalizedNode configDataNode) {
// if no data exists
if (stateDataNode == null && configDataNode == null) {
return null;
@@ -425,8 +559,8 @@ public final class ReadDataTransactionUtil {
* @param configDataNode data node of config data
* @return {@link NormalizedNode}
*/
- private static @NonNull NormalizedNode mergeStateAndConfigData(
- final @NonNull NormalizedNode stateDataNode, final @NonNull NormalizedNode configDataNode) {
+ private static @NonNull NormalizedNode mergeStateAndConfigData(
+ final @NonNull NormalizedNode stateDataNode, final @NonNull NormalizedNode configDataNode) {
validateNodeMerge(stateDataNode, configDataNode);
if (configDataNode instanceof RpcDefinition) {
return prepareRpcData(configDataNode, stateDataNode);
@@ -441,8 +575,8 @@ public final class ReadDataTransactionUtil {
* @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) {
+ private static void validateNodeMerge(final @NonNull NormalizedNode stateDataNode,
+ final @NonNull NormalizedNode configDataNode) {
final QNameModule moduleOfStateData = stateDataNode.getIdentifier().getNodeType().getModule();
final QNameModule moduleOfConfigData = configDataNode.getIdentifier().getNodeType().getModule();
if (!moduleOfStateData.equals(moduleOfConfigData)) {
@@ -457,8 +591,8 @@ public final class ReadDataTransactionUtil {
* @param stateDataNode data node of state data
* @return {@link NormalizedNode}
*/
- private static @NonNull NormalizedNode prepareRpcData(final @NonNull NormalizedNode configDataNode,
- final @NonNull NormalizedNode stateDataNode) {
+ private static @NonNull NormalizedNode prepareRpcData(final @NonNull NormalizedNode configDataNode,
+ final @NonNull NormalizedNode stateDataNode) {
final DataContainerNodeBuilder mapEntryBuilder = ImmutableNodes
.mapEntryBuilder();
mapEntryBuilder.withNodeIdentifier((NodeIdentifierWithPredicates) configDataNode.getIdentifier());
@@ -468,7 +602,9 @@ public final class ReadDataTransactionUtil {
// MAP STATE DATA
mapRpcDataNode(stateDataNode, mapEntryBuilder);
- return ImmutableNodes.mapNodeBuilder(configDataNode.getNodeType()).addChild(mapEntryBuilder.build()).build();
+ return ImmutableNodes.mapNodeBuilder(configDataNode.getIdentifier().getNodeType())
+ .addChild(mapEntryBuilder.build())
+ .build();
}
/**
@@ -477,9 +613,9 @@ public final class ReadDataTransactionUtil {
* @param dataNode data node
* @param mapEntryBuilder builder for mapping data
*/
- private static void mapRpcDataNode(final @NonNull NormalizedNode dataNode,
+ private static void mapRpcDataNode(final @NonNull NormalizedNode dataNode,
final @NonNull DataContainerNodeBuilder mapEntryBuilder) {
- ((ContainerNode) dataNode).getValue().forEach(mapEntryBuilder::addChild);
+ ((ContainerNode) dataNode).body().forEach(mapEntryBuilder::addChild);
}
/**
@@ -490,22 +626,22 @@ public final class ReadDataTransactionUtil {
* @return {@link NormalizedNode}
*/
@SuppressWarnings("unchecked")
- private static @NonNull NormalizedNode prepareData(final @NonNull NormalizedNode configDataNode,
- final @NonNull NormalizedNode stateDataNode) {
- if (configDataNode instanceof OrderedMapNode) {
- final CollectionNodeBuilder builder = Builders
+ private static @NonNull NormalizedNode prepareData(final @NonNull NormalizedNode configDataNode,
+ final @NonNull NormalizedNode stateDataNode) {
+ if (configDataNode instanceof UserMapNode) {
+ final CollectionNodeBuilder builder = Builders
.orderedMapBuilder().withNodeIdentifier(((MapNode) configDataNode).getIdentifier());
mapValueToBuilder(
- ((OrderedMapNode) configDataNode).getValue(), ((OrderedMapNode) stateDataNode).getValue(), builder);
+ ((UserMapNode) configDataNode).body(), ((UserMapNode) stateDataNode).body(), builder);
return builder.build();
} else if (configDataNode instanceof MapNode) {
- final CollectionNodeBuilder builder = ImmutableNodes
+ final CollectionNodeBuilder builder = ImmutableNodes
.mapNodeBuilder().withNodeIdentifier(((MapNode) configDataNode).getIdentifier());
mapValueToBuilder(
- ((MapNode) configDataNode).getValue(), ((MapNode) stateDataNode).getValue(), builder);
+ ((MapNode) configDataNode).body(), ((MapNode) stateDataNode).body(), builder);
return builder.build();
} else if (configDataNode instanceof MapEntryNode) {
@@ -513,7 +649,7 @@ public final class ReadDataTransactionUtil {
.mapEntryBuilder().withNodeIdentifier(((MapEntryNode) configDataNode).getIdentifier());
mapValueToBuilder(
- ((MapEntryNode) configDataNode).getValue(), ((MapEntryNode) stateDataNode).getValue(), builder);
+ ((MapEntryNode) configDataNode).body(), ((MapEntryNode) stateDataNode).body(), builder);
return builder.build();
} else if (configDataNode instanceof ContainerNode) {
@@ -521,15 +657,15 @@ public final class ReadDataTransactionUtil {
.containerBuilder().withNodeIdentifier(((ContainerNode) configDataNode).getIdentifier());
mapValueToBuilder(
- ((ContainerNode) configDataNode).getValue(), ((ContainerNode) stateDataNode).getValue(), builder);
+ ((ContainerNode) configDataNode).body(), ((ContainerNode) stateDataNode).body(), builder);
return builder.build();
} else if (configDataNode instanceof AugmentationNode) {
final DataContainerNodeBuilder builder = Builders
.augmentationBuilder().withNodeIdentifier(((AugmentationNode) configDataNode).getIdentifier());
- mapValueToBuilder(((AugmentationNode) configDataNode).getValue(),
- ((AugmentationNode) stateDataNode).getValue(), builder);
+ mapValueToBuilder(((AugmentationNode) configDataNode).body(),
+ ((AugmentationNode) stateDataNode).body(), builder);
return builder.build();
} else if (configDataNode instanceof ChoiceNode) {
@@ -537,43 +673,43 @@ public final class ReadDataTransactionUtil {
.choiceBuilder().withNodeIdentifier(((ChoiceNode) configDataNode).getIdentifier());
mapValueToBuilder(
- ((ChoiceNode) configDataNode).getValue(), ((ChoiceNode) stateDataNode).getValue(), builder);
+ ((ChoiceNode) configDataNode).body(), ((ChoiceNode) stateDataNode).body(), builder);
return builder.build();
} else if (configDataNode instanceof LeafNode) {
- return ImmutableNodes.leafNode(configDataNode.getNodeType(), configDataNode.getValue());
- } else if (configDataNode instanceof OrderedLeafSetNode) {
- final ListNodeBuilder> builder = Builders
- .orderedLeafSetBuilder().withNodeIdentifier(((OrderedLeafSetNode) configDataNode).getIdentifier());
+ return ImmutableNodes.leafNode(configDataNode.getIdentifier().getNodeType(), configDataNode.body());
+ } else if (configDataNode instanceof UserLeafSetNode) {
+ final ListNodeBuilder> builder = Builders
+ .orderedLeafSetBuilder().withNodeIdentifier(((UserLeafSetNode) configDataNode).getIdentifier());
- mapValueToBuilder(((OrderedLeafSetNode