import static com.google.common.base.Verify.verifyNotNull;
import static java.util.Objects.requireNonNull;
+import com.google.common.base.VerifyException;
+import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
+import java.io.IOException;
+import java.text.ParseException;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.jdt.annotation.NonNull;
-import org.eclipse.jdt.annotation.NonNullByDefault;
import org.opendaylight.restconf.api.ApiPath;
+import org.opendaylight.restconf.api.ApiPath.ApiIdentifier;
import org.opendaylight.restconf.api.ApiPath.ListInstance;
+import org.opendaylight.restconf.api.ApiPath.Step;
import org.opendaylight.restconf.common.errors.RestconfDocumentedException;
import org.opendaylight.restconf.nb.rfc8040.Insert.PointNormalizer;
import org.opendaylight.restconf.server.api.DatabindContext;
-import org.opendaylight.restconf.server.spi.ApiPathNormalizer.OperationPath.Rpc;
+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.Rpc;
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.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.NodeWithValue;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
-import org.opendaylight.yangtools.yang.data.impl.codec.TypeDefinitionAwareCodec;
+import org.opendaylight.yangtools.yang.data.codec.gson.JSONCodec;
import org.opendaylight.yangtools.yang.data.util.DataSchemaContext;
+import org.opendaylight.yangtools.yang.data.util.DataSchemaContext.Composite;
import org.opendaylight.yangtools.yang.data.util.DataSchemaContext.PathMixin;
import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
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.TypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.stmt.ActionEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.IdentityEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.stmt.InputEffectiveStatement;
+import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.stmt.RpcEffectiveStatement;
import org.opendaylight.yangtools.yang.model.api.stmt.SchemaTreeEffectiveStatement;
-import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
-import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack.Inference;
/**
- * Deserializer for {@link String} to {@link YangInstanceIdentifier} for restconf.
+ * Utility for normalizing {@link ApiPath}s. An {@link ApiPath} can represent a number of different constructs, as
+ * denoted to in the {@link DatabindPath} interface hierarchy.
+ *
+ * <p>
+ * This process is governed by
+ * <a href="https://www.rfc-editor.org/rfc/rfc8040#section-3.5.3">RFC8040, section 3.5.3</a>. The URI provides the
+ * equivalent of NETCONF XML filter encoding, with data values being escaped RFC7891 strings.
*/
public final class ApiPathNormalizer implements PointNormalizer {
- @NonNullByDefault
- public sealed interface Path {
-
- Inference inference();
- }
-
- @NonNullByDefault
- public sealed interface InstanceReference extends Path {
-
- YangInstanceIdentifier instance();
- }
-
- @NonNullByDefault
- public record DataPath(Inference inference, YangInstanceIdentifier instance, DataSchemaContext schema)
- implements InstanceReference {
- public DataPath {
- requireNonNull(inference);
- requireNonNull(instance);
- requireNonNull(schema);
- }
- }
-
- @NonNullByDefault
- public sealed interface OperationPath extends Path {
-
- InputEffectiveStatement inputStatement();
-
- record Action(Inference inference, YangInstanceIdentifier instance, ActionEffectiveStatement action)
- implements OperationPath, InstanceReference {
- public Action {
- requireNonNull(inference);
- requireNonNull(action);
- requireNonNull(instance);
- }
-
- @Override
- public InputEffectiveStatement inputStatement() {
- return action.input();
- }
- }
-
- record Rpc(Inference inference, RpcEffectiveStatement rpc) implements OperationPath {
- public Rpc {
- requireNonNull(inference);
- requireNonNull(rpc);
- }
-
- @Override
- public InputEffectiveStatement inputStatement() {
- return rpc.input();
- }
- }
- }
-
- private final @NonNull ApiPathInstanceIdentifierCodec instanceIdentifierCodec;
- private final @NonNull EffectiveModelContext modelContext;
private final @NonNull DatabindContext databind;
public ApiPathNormalizer(final DatabindContext databind) {
this.databind = requireNonNull(databind);
- modelContext = databind.modelContext();
- instanceIdentifierCodec = new ApiPathInstanceIdentifierCodec(databind);
}
- public @NonNull Path normalizePath(final ApiPath apiPath) {
+ public @NonNull DatabindPath normalizePath(final ApiPath apiPath) {
final var it = apiPath.steps().iterator();
if (!it.hasNext()) {
- return new DataPath(Inference.ofDataTreePath(modelContext), YangInstanceIdentifier.of(),
- databind.schemaTree().getRoot());
+ return new Data(databind);
}
// First step is somewhat special:
var qname = step.identifier().bindTo(namespace);
// We go through more modern APIs here to get this special out of the way quickly
+ final var modelContext = databind.modelContext();
final var optRpc = modelContext.findModuleStatement(namespace).orElseThrow()
.findSchemaTreeNode(RpcEffectiveStatement.class, qname);
if (optRpc.isPresent()) {
final var stack = SchemaInferenceStack.of(modelContext);
final var stmt = stack.enterSchemaTree(rpc.argument());
verify(rpc.equals(stmt), "Expecting %s, inferred %s", rpc, stmt);
- return new OperationPath.Rpc(stack.toInference(), rpc);
+ return new Rpc(databind, stack.toInference(), rpc);
}
final var stack = SchemaInferenceStack.of(modelContext);
final var actionStmt = action.asEffectiveStatement();
verify(actionStmt.equals(stmt), "Expecting %s, inferred %s", actionStmt, stmt);
- return new OperationPath.Action(stack.toInference(), YangInstanceIdentifier.of(path), actionStmt);
+ return new Action(databind, stack.toInference(), YangInstanceIdentifier.of(path), actionStmt);
}
}
if (step instanceof ListInstance listStep) {
final var values = listStep.keyValues();
final var schema = childNode.dataSchemaNode();
- pathArg = schema instanceof ListSchemaNode listSchema
- ? prepareNodeWithPredicates(stack, qname, listSchema, values)
- : prepareNodeWithValue(stack, qname, schema, values);
+ if (schema instanceof ListSchemaNode listSchema) {
+ pathArg = prepareNodeWithPredicates(stack, qname, listSchema, values);
+ } else if (schema instanceof LeafListSchemaNode leafListSchema) {
+ if (values.size() != 1) {
+ throw new RestconfDocumentedException("Entry '" + qname + "' requires one value predicate.",
+ ErrorType.PROTOCOL, ErrorTag.BAD_ATTRIBUTE);
+ }
+ pathArg = new NodeWithValue<>(qname, parserJsonValue(stack, leafListSchema, values.get(0)));
+ } else {
+ throw new RestconfDocumentedException(
+ "Entry '" + qname + "' does not take a key or value predicate.",
+ ErrorType.PROTOCOL, ErrorTag.MISSING_ATTRIBUTE);
+ }
} else {
if (childNode.dataSchemaNode() instanceof ListSchemaNode list && !list.getKeyDefinition().isEmpty()) {
throw new RestconfDocumentedException(
path.add(pathArg);
if (!it.hasNext()) {
- return new DataPath(stack.toInference(), YangInstanceIdentifier.of(path), childNode);
+ return new Data(databind, stack.toInference(), YangInstanceIdentifier.of(path), childNode);
}
parentNode = childNode;
}
}
- public @NonNull DataPath normalizeDataPath(final ApiPath apiPath) {
+ public @NonNull Data normalizeDataPath(final ApiPath apiPath) {
final var path = normalizePath(apiPath);
- if (path instanceof DataPath dataPath) {
+ if (path instanceof Data dataPath) {
return dataPath;
}
throw new RestconfDocumentedException("Point '" + apiPath + "' resolves to non-data " + path,
ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
}
+ public static @NonNull Data normalizeSubResource(final Data resource, final ApiPath subResource) {
+ // If subResource is empty just return the resource
+ final var urlPath = resource.instance();
+ if (subResource.steps().isEmpty()) {
+ return resource;
+ }
+ final var normalizer = new ApiPathNormalizer(resource.databind());
+ if (urlPath.isEmpty()) {
+ // URL indicates the datastore resource, let's just normalize targetPath
+ return normalizer.normalizeDataPath(subResource);
+ }
+
+ // FIXME: We are re-parsing the concatenation. We should provide enough context for the bottom half of
+ // normalizePath() logic instead
+ final String targetUrl = normalizer.canonicalize(urlPath).toString() + "/" + subResource.toString();
+ try {
+ return normalizer.normalizeDataPath(ApiPath.parse(targetUrl));
+ } catch (ParseException e) {
+ throw new RestconfDocumentedException("Failed to parse target " + targetUrl,
+ ErrorType.PROTOCOL, ErrorTag.MALFORMED_MESSAGE, e);
+ }
+ }
+
@Override
public PathArgument normalizePoint(final ApiPath value) {
final var path = normalizePath(value);
- if (path instanceof DataPath dataPath) {
+ if (path instanceof Data dataPath) {
final var lastArg = dataPath.instance().getLastPathArgument();
if (lastArg != null) {
return lastArg;
final var namespace = resolveNamespace(firstModule);
final var qname = step.identifier().bindTo(namespace);
- final var stack = SchemaInferenceStack.of(modelContext);
+ final var stack = SchemaInferenceStack.of(databind.modelContext());
final SchemaTreeEffectiveStatement<?> stmt;
try {
stmt = stack.enterSchemaTree(qname);
ErrorTag.DATA_MISSING, e);
}
if (stmt instanceof RpcEffectiveStatement rpc) {
- return new Rpc(stack.toInference(), rpc);
+ return new Rpc(databind, stack.toInference(), rpc);
}
throw new RestconfDocumentedException(qname + " does not refer to an RPC", ErrorType.PROTOCOL,
ErrorTag.DATA_MISSING);
}
public @NonNull InstanceReference normalizeDataOrActionPath(final ApiPath apiPath) {
-
-
// FIXME: optimize this
final var path = normalizePath(apiPath);
- if (path instanceof DataPath dataPath) {
+ if (path instanceof Data dataPath) {
return dataPath;
}
- if (path instanceof OperationPath.Action actionPath) {
+ if (path instanceof Action actionPath) {
return actionPath;
}
throw new RestconfDocumentedException("Unexpected path " + path, ErrorType.PROTOCOL, ErrorTag.DATA_MISSING);
}
+ /**
+ * Return the canonical {@link ApiPath} for specified {@link YangInstanceIdentifier}.
+ *
+ * @param path {@link YangInstanceIdentifier} to canonicalize
+ * @return An {@link ApiPath}
+ */
+ public @NonNull ApiPath canonicalize(final YangInstanceIdentifier path) {
+ final var it = path.getPathArguments().iterator();
+ if (!it.hasNext()) {
+ return ApiPath.empty();
+ }
+
+ final var stack = SchemaInferenceStack.of(databind.modelContext());
+ final var builder = ImmutableList.<Step>builder();
+ DataSchemaContext context = databind.schemaTree().getRoot();
+ QNameModule parentModule = null;
+ do {
+ final var arg = it.next();
+
+ // get module of the parent
+ if (!(context instanceof PathMixin)) {
+ parentModule = context.dataSchemaNode().getQName().getModule();
+ }
+
+ final var childContext = context instanceof Composite composite ? composite.enterChild(stack, arg) : null;
+ if (childContext == null) {
+ throw new RestconfDocumentedException(
+ "Invalid input '%s': schema for argument '%s' (after '%s') not found".formatted(path, arg,
+ ApiPath.of(builder.build())), ErrorType.APPLICATION, ErrorTag.UNKNOWN_ELEMENT);
+ }
+
+ context = childContext;
+ if (childContext instanceof PathMixin) {
+ // This PathArgument is a mixed-in YangInstanceIdentifier, do not emit anything and continue
+ continue;
+ }
+
+ builder.add(canonicalize(arg, parentModule, stack, context));
+ } while (it.hasNext());
+
+ return new ApiPath(builder.build());
+ }
+
+ private @NonNull Step canonicalize(final PathArgument arg, final QNameModule prevNamespace,
+ final SchemaInferenceStack stack, final DataSchemaContext context) {
+ // append namespace before every node which is defined in other module than its parent
+ // condition is satisfied also for the first path argument
+ final var nodeType = arg.getNodeType();
+ final var module = nodeType.getModule().equals(prevNamespace) ? null : resolvePrefix(nodeType);
+ final var identifier = nodeType.unbind();
+
+ // NodeIdentifier maps to an ApiIdentifier
+ if (arg instanceof NodeIdentifier) {
+ return new ApiIdentifier(module, identifier);
+ }
+
+ // NodeWithValue addresses a LeafSetEntryNode and maps to a ListInstance with a single value
+ final var schema = context.dataSchemaNode();
+ if (arg instanceof NodeWithValue<?> withValue) {
+ if (!(schema instanceof LeafListSchemaNode leafList)) {
+ throw new RestconfDocumentedException(
+ "Argument '%s' does not map to a leaf-list, but %s".formatted(arg, schema),
+ ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
+ }
+ return ListInstance.of(module, identifier, encodeValue(stack, leafList, withValue.getValue()));
+ }
+
+ // The only remaining case is NodeIdentifierWrithPredicates, verify that instead of an explicit cast
+ if (!(arg instanceof NodeIdentifierWithPredicates withPredicates)) {
+ throw new VerifyException("Unhandled " + arg);
+ }
+ // A NodeIdentifierWithPredicates adresses a MapEntryNode and maps to a ListInstance with one or more values:
+ // 1) schema has to be a ListSchemaNode
+ if (!(schema instanceof ListSchemaNode list)) {
+ throw new RestconfDocumentedException(
+ "Argument '%s' does not map to a list, but %s".formatted(arg, schema),
+ ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
+ }
+ // 2) the key definition must be non-empty
+ final var keyDef = list.getKeyDefinition();
+ final var size = keyDef.size();
+ if (size == 0) {
+ throw new RestconfDocumentedException(
+ "Argument '%s' maps a list without any keys %s".formatted(arg, schema),
+ ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
+ }
+ // 3) the number of predicates has to match the number of keys
+ if (size != withPredicates.size()) {
+ throw new RestconfDocumentedException(
+ "Argument '%s' does not match required keys %s".formatted(arg, keyDef),
+ ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
+ }
+
+ // ListSchemaNode implies the context is a composite, verify that instead of an unexplained cast when we look
+ // up the schema for individual keys
+ if (!(context instanceof Composite composite)) {
+ throw new VerifyException("Unexpected non-composite " + context + " with " + list);
+ }
+
+ final var builder = ImmutableList.<String>builderWithExpectedSize(size);
+ for (var key : keyDef) {
+ final var value = withPredicates.getValue(key);
+ if (value == null) {
+ throw new RestconfDocumentedException("Argument '%s' is missing predicate for %s".formatted(arg, key),
+ ErrorType.APPLICATION, ErrorTag.INVALID_VALUE);
+ }
+
+ final var tmpStack = stack.copy();
+ final var keyContext = composite.enterChild(tmpStack, key);
+ if (keyContext == null) {
+ throw new VerifyException("Failed to find key " + key + " in " + composite);
+ }
+ if (!(keyContext.dataSchemaNode() instanceof LeafSchemaNode leaf)) {
+ throw new VerifyException("Key " + key + " maps to non-leaf context " + keyContext);
+ }
+ builder.add(encodeValue(tmpStack, leaf, value));
+ }
+ return ListInstance.of(module, identifier, builder.build());
+ }
+
+ private String encodeValue(final SchemaInferenceStack stack, final TypedDataSchemaNode schema, final Object value) {
+ @SuppressWarnings("unchecked")
+ final var codec = (JSONCodec<Object>) databind.jsonCodecs().codecFor(schema, stack);
+ try (var jsonWriter = new HackJsonWriter()) {
+ codec.writeValue(jsonWriter, value);
+ return jsonWriter.acquireCaptured().rawString();
+ } catch (IOException e) {
+ throw new IllegalStateException("Failed to serialize '" + value + "'", e);
+ }
+ }
+
private NodeIdentifierWithPredicates prepareNodeWithPredicates(final SchemaInferenceStack stack, final QName qname,
final @NonNull ListSchemaNode schema, final List<@NonNull String> keyValues) {
final var keyDef = schema.getKeyDefinition();
private Object prepareValueByType(final SchemaInferenceStack stack, final DataSchemaNode schemaNode,
final @NonNull String value) {
-
- TypeDefinition<? extends TypeDefinition<?>> typedef;
- if (schemaNode instanceof LeafListSchemaNode leafList) {
- typedef = leafList.getType();
- } else {
- typedef = ((LeafSchemaNode) schemaNode).getType();
- }
- if (typedef instanceof LeafrefTypeDefinition leafref) {
- typedef = stack.resolveLeafref(leafref);
- }
-
- if (typedef instanceof IdentityrefTypeDefinition) {
- return toIdentityrefQName(value, schemaNode);
+ if (schemaNode instanceof TypedDataSchemaNode typedSchema) {
+ return parserJsonValue(stack, typedSchema, value);
}
+ throw new VerifyException("Unhandled schema " + schemaNode + " decoding '" + value + "'");
+ }
+ private Object parserJsonValue(final SchemaInferenceStack stack, final TypedDataSchemaNode schemaNode,
+ final String value) {
+ // As per https://www.rfc-editor.org/rfc/rfc8040#page-29:
+ // The syntax for
+ // "api-identifier" and "key-value" MUST conform to the JSON identifier
+ // encoding rules in Section 4 of [RFC7951]: The RESTCONF root resource
+ // path is required. Additional sub-resource identifiers are optional.
+ // The characters in a key value string are constrained, and some
+ // characters need to be percent-encoded, as described in Section 3.5.3.
try {
- if (typedef instanceof InstanceIdentifierTypeDefinition) {
- return instanceIdentifierCodec.deserialize(value);
- }
-
- return verifyNotNull(TypeDefinitionAwareCodec.from(typedef),
- "Unhandled type %s decoding %s", typedef, value).deserialize(value);
+ return databind.jsonCodecs().codecFor(schemaNode, stack).parseValue(null, value);
} catch (IllegalArgumentException e) {
throw new RestconfDocumentedException("Invalid value '" + value + "' for " + schemaNode.getQName(),
ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE, e);
}
}
- private NodeWithValue<?> prepareNodeWithValue(final SchemaInferenceStack stack, final QName qname,
- final DataSchemaNode schema, final List<String> keyValues) {
- // TODO: qname should be always equal to schema.getQName(), right?
- return new NodeWithValue<>(qname, prepareValueByType(stack, schema,
- // FIXME: ahem: we probably want to do something differently here
- keyValues.get(0)));
- }
-
- private QName toIdentityrefQName(final String value, final DataSchemaNode schemaNode) {
- final QNameModule namespace;
- final String localName;
- final int firstColon = value.indexOf(':');
- if (firstColon != -1) {
- namespace = resolveNamespace(value.substring(0, firstColon));
- localName = value.substring(firstColon + 1);
- } else {
- namespace = schemaNode.getQName().getModule();
- localName = value;
- }
-
- return modelContext.getModuleStatement(namespace)
- .streamEffectiveSubstatements(IdentityEffectiveStatement.class)
- .map(IdentityEffectiveStatement::argument)
- .filter(qname -> localName.equals(qname.getLocalName()))
- .findFirst()
- .orElseThrow(() -> new RestconfDocumentedException(
- "No identity found for '" + localName + "' in namespace " + namespace,
- ErrorType.PROTOCOL, ErrorTag.INVALID_VALUE));
- }
-
private @NonNull QNameModule resolveNamespace(final String moduleName) {
- final var it = modelContext.findModuleStatements(moduleName).iterator();
+ final var it = databind.modelContext().findModuleStatements(moduleName).iterator();
if (it.hasNext()) {
return it.next().localQNameModule();
}
throw new RestconfDocumentedException("Failed to lookup for module with name '" + moduleName + "'.",
ErrorType.PROTOCOL, ErrorTag.UNKNOWN_ELEMENT);
}
+
+ /**
+ * Create prefix of namespace from {@link QName}.
+ *
+ * @param qname {@link QName}
+ * @return {@link String}
+ */
+ private @NonNull String resolvePrefix(final QName qname) {
+ return databind.modelContext().findModuleStatement(qname.getModule()).orElseThrow().argument().getLocalName();
+ }
}
Code Review / netconf.git / blobdiff