*/
package org.opendaylight.yangtools.yang.model.util;
+import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
+import static java.util.Objects.requireNonNull;
+
import com.google.common.annotations.Beta;
import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Preconditions;
import com.google.common.base.Splitter;
import com.google.common.collect.Iterables;
+import com.google.common.collect.Lists;
+import java.util.ArrayDeque;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Deque;
import java.util.HashSet;
import java.util.Iterator;
-import java.util.LinkedList;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Pattern;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import java.util.stream.Collectors;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.yang.common.AbstractQName;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.UnqualifiedQName;
+import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.ContainerLike;
import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
import org.opendaylight.yangtools.yang.model.api.DerivableSchemaNode;
import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
-import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.ModuleIdentifier;
import org.opendaylight.yangtools.yang.model.api.ModuleImport;
+import org.opendaylight.yangtools.yang.model.api.ModuleLike;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
-import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
+import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
+import org.opendaylight.yangtools.yang.model.api.PathExpression;
+import org.opendaylight.yangtools.yang.model.api.PathExpression.DerefSteps;
+import org.opendaylight.yangtools.yang.model.api.PathExpression.LocationPathSteps;
+import org.opendaylight.yangtools.yang.model.api.PathExpression.Steps;
import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaContext;
import org.opendaylight.yangtools.yang.model.api.SchemaNode;
import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.Submodule;
import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.TypedSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
+import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
+import org.opendaylight.yangtools.yang.model.repo.api.RevisionSourceIdentifier;
+import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
+import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath;
+import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.AxisStep;
+import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.QNameStep;
+import org.opendaylight.yangtools.yang.xpath.api.YangLocationPath.Step;
+import org.opendaylight.yangtools.yang.xpath.api.YangXPathAxis;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * The Schema Context Util contains support methods for searching through Schema
- * Context modules for specified schema nodes via Schema Path or Revision Aware
- * XPath. The Schema Context Util is designed as mixin, so it is not
+ * The Schema Context Util contains support methods for searching through Schema Context modules for specified schema
+ * nodes via Schema Path or Revision Aware XPath. The Schema Context Util is designed as mixin, so it is not
* instantiable.
- *
*/
public final class SchemaContextUtil {
private static final Logger LOG = LoggerFactory.getLogger(SchemaContextUtil.class);
private static final Splitter COLON_SPLITTER = Splitter.on(':');
- private static final Splitter SLASH_SPLITTER = Splitter.on('/');
+ private static final Splitter SLASH_SPLITTER = Splitter.on('/').omitEmptyStrings();
+ private static final Pattern GROUPS_PATTERN = Pattern.compile("\\[(.*?)\\]");
private SchemaContextUtil() {
+ // Hidden on purpose
}
/**
- * Method attempts to find DataSchemaNode in Schema Context via specified
- * Schema Path. The returned DataSchemaNode from method will be the node at
- * the end of the SchemaPath. If the DataSchemaNode is not present in the
- * Schema Context the method will return <code>null</code>. <br>
- * In case that Schema Context or Schema Path are not specified correctly
- * (i.e. contains <code>null</code> values) the method will throw
- * IllegalArgumentException.
+ * Method attempts to find DataSchemaNode in Schema Context via specified Schema Path. The returned DataSchemaNode
+ * from method will be the node at the end of the SchemaPath. If the DataSchemaNode is not present in the Schema
+ * Context the method will return {@code null}.
*
- * @param context
- * Schema Context
- * @param schemaPath
- * Schema Path to search for
- * @return SchemaNode from the end of the Schema Path or <code>null</code>
- * if the Node is not present.
- * @throws IllegalArgumentException if context or schemaPath is not correct.
+ * <p>
+ * In case that Schema Context or Schema Path are not specified correctly (i.e. contains {@code null} values) the
+ * method will throw IllegalArgumentException.
+ *
+ * @param context Schema Context
+ * @param schemaPath Schema Path to search for
+ * @return SchemaNode from the end of the Schema Path or {@code null} if the Node is not present.
+ * @throws NullPointerException if context or schemaPath is null
*/
public static SchemaNode findDataSchemaNode(final SchemaContext context, final SchemaPath schemaPath) {
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
- Preconditions.checkArgument(schemaPath != null, "Schema Path reference cannot be NULL");
-
final Iterable<QName> prefixedPath = schemaPath.getPathFromRoot();
if (prefixedPath == null) {
LOG.debug("Schema path {} has null path", schemaPath);
return findNodeInSchemaContext(context, prefixedPath);
}
+ /**
+ * Attempt to find a DataSchemaNode based on its path from root, similar to
+ * {@link #findDataSchemaNode(SchemaContext, Module, PathExpression)} without requiring an expression.
+ *
+ * @param context Schema Context
+ * @param path Path to search for
+ * @return SchemaNode from the end of the Schema Path or {@code null} if the Node is not present.
+ * @throws NullPointerException if a any argument is null or if the path contains a null element
+ */
+ @Beta
+ public static SchemaNode findDataSchemaNode(final SchemaContext context, final List<QName> path) {
+ return findTargetNode(context, null, YangLocationPath.absolute(
+ path.stream().map(YangXPathAxis.CHILD::asStep).collect(Collectors.toList())));
+ }
+
+ /**
+ * Attempt to find a DataSchemaNode based on its path from root, similar to
+ * {@link #findDataSchemaNode(SchemaContext, Module, PathExpression)} without requiring an expression.
+ *
+ * @param context Schema Context
+ * @param path Path to search for
+ * @return SchemaNode from the end of the Schema Path or {@code null} if the Node is not present.
+ * @throws NullPointerException if a any argument is null or if the path contains a null element
+ */
+ @Beta
+ public static SchemaNode findDataSchemaNode(final SchemaContext context, final QName... path) {
+ return findDataSchemaNode(context, Arrays.asList(path));
+ }
+
/**
* Method attempts to find DataSchemaNode inside of provided Schema Context
* and Yang Module accordingly to Non-conditional Revision Aware XPath. The
* Context is completely unaware of data state and will be not able to
* properly resolve XPath. If the XPath contains condition the method will
* return IllegalArgumentException. <br>
- * In case that Schema Context or Module or Revision Aware XPath contains
- * <code>null</code> references the method will throw
- * IllegalArgumentException <br>
* If the Revision Aware XPath is correct and desired Data Schema Node is
* present in Yang module or in depending module in Schema Context the
* method will return specified Data Schema Node, otherwise the operation
* @return Returns Data Schema Node for specified Schema Context for given
* Non-conditional Revision Aware XPath, or <code>null</code> if the
* DataSchemaNode is not present in Schema Context.
+ * @throws NullPointerException if any of the arguments is null
+ * @deprecated Use {@link #findDataTreeSchemaNode(SchemaContext, QNameModule, YangLocationPath)} or
+ * {@link #findDataTreeSchemaNode(SchemaContext, QNameModule, PathExpression)} instead.
*/
+ // FIXME: This entire method is ill-defined, as the resolution process depends on where the XPath is defined --
+ // notably RPCs, actions and notifications modify the data tree temporarily. See sections 6.4.1 and 9.9.2
+ // of RFC7950.
+ //
+ // Most notably we need to understand whether the XPath is being resolved in the data tree, or as part of
+ // a notification/action/RPC, as then the SchemaContext grows tentative nodes ... which could be addressed
+ // via a derived SchemaContext (i.e. this class would have to have a
+ //
+ // SchemaContext notificationSchemaContext(SchemaContext delegate, NotificationDefinition notif)
+ //
+ // which would then be passed in to a method similar to this one. In static contexts, like MD-SAL codegen,
+ // that feels like an overkill.
+ @Deprecated
public static SchemaNode findDataSchemaNode(final SchemaContext context, final Module module,
- final RevisionAwareXPath nonCondXPath) {
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
- Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
- Preconditions.checkArgument(nonCondXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
-
- final String strXPath = nonCondXPath.toString();
- if (strXPath != null) {
- Preconditions.checkArgument(strXPath.indexOf('[') == -1,
- "Revision Aware XPath may not contain a condition");
- if (nonCondXPath.isAbsolute()) {
- final List<QName> qnamedPath = xpathToQNamePath(context, module, strXPath);
- if (qnamedPath != null) {
- return findNodeInSchemaContext(context, qnamedPath);
- }
- }
+ final PathExpression nonCondXPath) {
+ requireNonNull(context, "context");
+ requireNonNull(module, "module");
+
+ final String strXPath = nonCondXPath.getOriginalString();
+ checkArgument(strXPath.indexOf('[') == -1, "Revision Aware XPath may not contain a condition");
+ if (nonCondXPath.isAbsolute()) {
+ return findTargetNode(context, xpathToQNamePath(context, module, strXPath));
}
return null;
}
+ @Beta
+ public static SchemaNode findDataTreeSchemaNode(final SchemaContext ctx, final QNameModule localModule,
+ final YangLocationPath absPath) {
+ checkArgument(absPath.isAbsolute(), "Unsupported relative path %s", absPath);
+ return findTargetNode(ctx, localModule, absPath);
+ }
+
+ @Beta
+ public static SchemaNode findDataTreeSchemaNode(final SchemaContext ctx, final QNameModule localModule,
+ final PathExpression absPath) {
+ final Steps pathSteps = absPath.getSteps();
+ if (pathSteps instanceof LocationPathSteps) {
+ return findDataTreeSchemaNode(ctx, localModule, ((LocationPathSteps) pathSteps).getLocationPath());
+ }
+
+ // We would need a reference schema node and no, we do not want to use SchemaContext in its SchemaNode capacity
+ checkArgument(!(pathSteps instanceof DerefSteps), "No reference node for steps %s", pathSteps);
+
+ // We are missing proper API alignment, if this ever triggers
+ throw new IllegalStateException("Unsupported path " + pathSteps);
+ }
+
/**
* Method attempts to find DataSchemaNode inside of provided Schema Context
* and Yang Module accordingly to Non-conditional relative Revision Aware
* Schema Node will search starts. If the Actual Schema Node is not correct
* the operation will simply fail, because it will be unable to find desired
* DataSchemaNode. <br>
- * In case that Schema Context or Module or Actual Schema Node or relative
- * Revision Aware XPath contains <code>null</code> references the method
- * will throw IllegalArgumentException <br>
* If the Revision Aware XPath doesn't have flag
* <code>isAbsolute == false</code> the method will throw
* IllegalArgumentException. <br>
* @return DataSchemaNode if is present in specified Schema Context for
* given relative Revision Aware XPath, otherwise will return
* <code>null</code>.
+ * @throws NullPointerException if any argument is null
*/
+ // FIXME: This entire method is ill-defined, as the resolution process depends on where the XPath is defined --
+ // notably RPCs, actions and notifications modify the data tree temporarily. See sections 6.4.1 and 9.9.2
+ // of RFC7950.
+ //
+ // Most notably we need to understand whether the XPath is being resolved in the data tree, or as part of
+ // a notification/action/RPC, as then the SchemaContext grows tentative nodes ... which could be addressed
+ // via a derived SchemaContext (i.e. this class would have to have a
+ //
+ // SchemaContext notificationSchemaContext(SchemaContext delegate, NotificationDefinition notif)
+ //
+ // which would then be passed in to a method similar to this one. In static contexts, like MD-SAL codegen,
+ // that feels like an overkill.
+ // FIXME: YANGTOOLS-1052: this is a static analysis util, move it to a dedicated class
public static SchemaNode findDataSchemaNodeForRelativeXPath(final SchemaContext context, final Module module,
- final SchemaNode actualSchemaNode, final RevisionAwareXPath relativeXPath) {
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
- Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
- Preconditions.checkArgument(actualSchemaNode != null, "Actual Schema Node reference cannot be NULL");
- Preconditions.checkArgument(relativeXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
- Preconditions.checkState(!relativeXPath.isAbsolute(),
- "Revision Aware XPath MUST be relative i.e. MUST contains ../, "
- + "for non relative Revision Aware XPath use findDataSchemaNode method");
-
- final SchemaPath actualNodePath = actualSchemaNode.getPath();
- if (actualNodePath != null) {
- final Iterable<QName> qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode);
-
- if (qnamePath != null) {
- return findNodeInSchemaContext(context, qnamePath);
- }
- }
- return null;
+ final SchemaNode actualSchemaNode, final PathExpression relativeXPath) {
+ checkState(!relativeXPath.isAbsolute(), "Revision Aware XPath MUST be relative i.e. MUST contains ../, "
+ + "for non relative Revision Aware XPath use findDataSchemaNode method");
+ return resolveRelativeXPath(context, module, removePredicatesFromXpath(relativeXPath.getOriginalString()),
+ actualSchemaNode);
+ }
+
+ private static String removePredicatesFromXpath(final String xpath) {
+ return GROUPS_PATTERN.matcher(xpath).replaceAll("");
}
/**
* Returns parent Yang Module for specified Schema Context in which Schema
* Node is declared. If the Schema Node is not present in Schema Context the
- * operation will return <code>null</code>. <br>
- * If Schema Context or Schema Node contains <code>null</code> references
- * the method will throw IllegalArgumentException
+ * operation will return <code>null</code>.
*
- * @param context
- * Schema Context
- * @param schemaNode
- * Schema Node
+ * @param context Schema Context
+ * @param schemaNode Schema Node
* @return Yang Module for specified Schema Context and Schema Node, if Schema Node is NOT present, the method will
* return <code>null</code>
+ * @throws NullPointerException if any of the arguments is null
*/
public static Module findParentModule(final SchemaContext context, final SchemaNode schemaNode) {
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL!");
- Preconditions.checkArgument(schemaNode != null, "Schema Node cannot be NULL!");
- Preconditions.checkState(schemaNode.getPath() != null, "Schema Path for Schema Node is not "
- + "set properly (Schema Path is NULL)");
-
final QName qname = schemaNode.getPath().getLastComponent();
- Preconditions.checkState(qname != null, "Schema Path contains invalid state of path parts. "
+ checkState(qname != null, "Schema Path contains invalid state of path parts. "
+ "The Schema Path MUST contain at least ONE QName which defines namespace and Local name of path.");
return context.findModule(qname.getModule()).orElse(null);
}
LOG.trace("Looking up module {} in context {}", current, path);
final Optional<Module> module = context.findModule(current.getModule());
- if (!module.isPresent()) {
+ if (module.isEmpty()) {
LOG.debug("Module {} not found", current);
return null;
}
* @return Notification schema or null, if notification is not present in schema context.
*/
@Beta
- @Nullable
- public static NotificationDefinition getNotificationSchema(@Nonnull final SchemaContext schema,
- @Nonnull final SchemaPath path) {
- Preconditions.checkNotNull(schema, "Schema context must not be null.");
- Preconditions.checkNotNull(path, "Schema path must not be null.");
+ public static @Nullable NotificationDefinition getNotificationSchema(final @NonNull SchemaContext schema,
+ final @NonNull SchemaPath path) {
+ requireNonNull(schema, "Schema context must not be null.");
+ requireNonNull(path, "Schema path must not be null.");
for (final NotificationDefinition potential : schema.getNotifications()) {
if (path.equals(potential.getPath())) {
return potential;
* @return Notification schema or null, if notification is not present in schema context.
*/
@Beta
- @Nullable
- public static ContainerSchemaNode getRpcDataSchema(@Nonnull final SchemaContext schema,
- @Nonnull final SchemaPath path) {
- Preconditions.checkNotNull(schema, "Schema context must not be null.");
- Preconditions.checkNotNull(path, "Schema path must not be null.");
+ public static @Nullable ContainerLike getRpcDataSchema(final @NonNull SchemaContext schema,
+ final @NonNull SchemaPath path) {
+ requireNonNull(schema, "Schema context must not be null.");
+ requireNonNull(path, "Schema path must not be null.");
final Iterator<QName> it = path.getPathFromRoot().iterator();
- Preconditions.checkArgument(it.hasNext(), "Rpc must have QName.");
+ checkArgument(it.hasNext(), "Rpc must have QName.");
final QName rpcName = it.next();
- Preconditions.checkArgument(it.hasNext(), "input or output must be part of path.");
+ checkArgument(it.hasNext(), "input or output must be part of path.");
final QName inOrOut = it.next();
for (final RpcDefinition potential : schema.getOperations()) {
if (rpcName.equals(potential.getQName())) {
* @param context SchemaContext to be examined
* @return Set of ModuleIdentifiers.
*/
- public static Set<ModuleIdentifier> getConstituentModuleIdentifiers(final SchemaContext context) {
- final Set<ModuleIdentifier> ret = new HashSet<>();
+ public static Set<SourceIdentifier> getConstituentModuleIdentifiers(final SchemaContext context) {
+ final Set<SourceIdentifier> ret = new HashSet<>();
for (Module module : context.getModules()) {
ret.add(moduleToIdentifier(module));
- for (Module submodule : module.getSubmodules()) {
+ for (Submodule submodule : module.getSubmodules()) {
ret.add(moduleToIdentifier(submodule));
}
}
return ret;
}
- private static ModuleIdentifier moduleToIdentifier(final Module module) {
- return ModuleIdentifierImpl.create(module.getName(), Optional.of(module.getRevision()));
+ private static SourceIdentifier moduleToIdentifier(final ModuleLike module) {
+ return RevisionSourceIdentifier.create(module.getName(), module.getRevision());
}
private static SchemaNode findNodeInModule(final Module module, final Iterable<QName> path) {
-
- Preconditions.checkArgument(module != null, "Parent reference cannot be NULL");
- Preconditions.checkArgument(path != null, "Path reference cannot be NULL");
-
if (!path.iterator().hasNext()) {
LOG.debug("No node matching {} found in node {}", path, module);
return null;
SchemaNode foundNode = null;
final Iterable<QName> nextPath = nextLevel(path);
- foundNode = module.getDataChildByName(current);
+ foundNode = module.dataChildByName(current);
if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
}
}
return foundNode;
-
}
private static SchemaNode findNodeIn(final SchemaNode parent, final Iterable<QName> path) {
-
- Preconditions.checkArgument(parent != null, "Parent reference cannot be NULL");
- Preconditions.checkArgument(path != null, "Path reference cannot be NULL");
-
if (!path.iterator().hasNext()) {
LOG.debug("No node matching {} found in node {}", path, parent);
return null;
if (parent instanceof DataNodeContainer) {
final DataNodeContainer parentDataNodeContainer = (DataNodeContainer) parent;
- foundNode = parentDataNodeContainer.getDataChildByName(current);
+ foundNode = parentDataNodeContainer.dataChildByName(current);
if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
}
}
}
- if (foundNode == null && parent instanceof RpcDefinition) {
- final RpcDefinition parentRpcDefinition = (RpcDefinition) parent;
+ if (foundNode == null && parent instanceof ActionNodeContainer) {
+ final Optional<? extends SchemaNode> next = ((ActionNodeContainer) parent).getActions().stream()
+ .filter(act -> current.equals(act.getQName())).findFirst();
+ if (next.isPresent() && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(next.orElseThrow(), nextPath);
+ }
+ }
+
+ if (foundNode == null && parent instanceof NotificationNodeContainer) {
+ foundNode = ((NotificationNodeContainer) parent).getNotifications().stream()
+ .filter(notif -> current.equals(notif.getQName())).findFirst().orElse(null);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
+ }
+
+ if (foundNode == null && parent instanceof OperationDefinition) {
+ final OperationDefinition parentRpcDefinition = (OperationDefinition) parent;
if (current.getLocalName().equals("input")) {
foundNode = parentRpcDefinition.getInput();
}
if (foundNode == null && parent instanceof ChoiceSchemaNode) {
- foundNode = ((ChoiceSchemaNode) parent).getCaseNodeByName(current);
+ foundNode = ((ChoiceSchemaNode) parent).findCase(current).orElse(null);
if (foundNode != null && nextPath.iterator().hasNext()) {
foundNode = findNodeIn(foundNode, nextPath);
if (foundNode == null) {
// fallback that tries to map into one of the child cases
- for (final ChoiceCaseNode caseNode : ((ChoiceSchemaNode) parent).getCases()) {
- final DataSchemaNode maybeChild = caseNode.getDataChildByName(current);
+ for (final CaseSchemaNode caseNode : ((ChoiceSchemaNode) parent).getCases()) {
+ final DataSchemaNode maybeChild = caseNode.dataChildByName(current);
if (maybeChild != null) {
foundNode = findNodeIn(maybeChild, nextPath);
break;
return null;
}
- private static GroupingDefinition getGroupingByName(final RpcDefinition rpc, final QName name) {
+ private static GroupingDefinition getGroupingByName(final OperationDefinition rpc, final QName name) {
for (final GroupingDefinition grouping : rpc.getGroupings()) {
if (grouping.getQName().equals(name)) {
return grouping;
* @param xpath
* XPath String
* @return return a list of QName
- *
- * @throws IllegalArgumentException if any arguments are null
- *
*/
private static List<QName> xpathToQNamePath(final SchemaContext context, final Module parentModule,
final String xpath) {
- // FIXME: 2.0.0: this should throw NPE, not IAE
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
- Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
- Preconditions.checkArgument(xpath != null, "XPath string reference cannot be NULL");
-
- final List<QName> path = new LinkedList<>();
+ final List<QName> path = new ArrayList<>();
for (final String pathComponent : SLASH_SPLITTER.split(xpath)) {
- if (!pathComponent.isEmpty()) {
- path.add(stringPathPartToQName(context, parentModule, pathComponent));
- }
+ path.add(stringPathPartToQName(context, parentModule, pathComponent));
}
return path;
}
* can be constructed. <br>
* If the Prefixed Path Part does not contains prefix the Parent's Module
* namespace is taken for construction of QName. <br>
- * If Schema Context, Parent Module or Prefixed Path Part refers to
- * <code>null</code> the method will throw IllegalArgumentException
*
- * @param context
- * Schema Context
- * @param parentModule
- * Parent Module
- * @param prefixedPathPart
- * Prefixed Path Part string
+ * @param context Schema Context
+ * @param parentModule Parent Module
+ * @param prefixedPathPart Prefixed Path Part string
* @return QName from prefixed Path Part String.
- * @throws IllegalArgumentException if any arguments are null
+ * @throws NullPointerException if any arguments are null
*/
private static QName stringPathPartToQName(final SchemaContext context, final Module parentModule,
final String prefixedPathPart) {
- // FIXME: 2.0.0: this should throw NPE, not IAE
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
- Preconditions.checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
- Preconditions.checkArgument(prefixedPathPart != null, "Prefixed Path Part cannot be NULL!");
+ requireNonNull(context, "context");
if (prefixedPathPart.indexOf(':') != -1) {
final Iterator<String> prefixedName = COLON_SPLITTER.split(prefixedPathPart).iterator();
final String modulePrefix = prefixedName.next();
final Module module = resolveModuleForPrefix(context, parentModule, modulePrefix);
- Preconditions.checkArgument(module != null,
- "Failed to resolve xpath: no module found for prefix %s in module %s", modulePrefix,
- parentModule.getName());
+ checkArgument(module != null, "Failed to resolve xpath: no module found for prefix %s in module %s",
+ modulePrefix, parentModule.getName());
return QName.create(module.getQNameModule(), prefixedName.next());
}
- return QName.create(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart);
+ return QName.create(parentModule.getQNameModule(), prefixedPathPart);
}
/**
- * Method will attempt to resolve and provide Module reference for specified
- * module prefix. Each Yang module could contains multiple imports which
- * MUST be associated with corresponding module prefix. The method simply
- * looks into module imports and returns the module that is bounded with
- * specified prefix. If the prefix is not present in module or the prefixed
- * module is not present in specified Schema Context, the method will return
- * <code>null</code>. <br>
- * If String prefix is the same as prefix of the specified Module the
- * reference to this module is returned. <br>
- * If Schema Context, Module or Prefix are referring to <code>null</code>
- * the method will return IllegalArgumentException
+ * Method will attempt to resolve and provide Module reference for specified module prefix. Each Yang module could
+ * contains multiple imports which MUST be associated with corresponding module prefix. The method simply looks into
+ * module imports and returns the module that is bounded with specified prefix. If the prefix is not present
+ * in module or the prefixed module is not present in specified Schema Context, the method will return {@code null}.
+ * <br>
+ * If String prefix is the same as prefix of the specified Module the reference to this module is returned.<br>
*
- * @param context
- * Schema Context
- * @param module
- * Yang Module
- * @param prefix
- * Module Prefix
- * @return Module for given prefix in specified Schema Context if is
- * present, otherwise returns <code>null</code>
- * @throws IllegalArgumentException if any arguments are null
+ * @param context Schema Context
+ * @param module Yang Module
+ * @param prefix Module Prefix
+ * @return Module for given prefix in specified Schema Context if is present, otherwise returns <code>null</code>
+ * @throws NullPointerException if any arguments are null
*/
private static Module resolveModuleForPrefix(final SchemaContext context, final Module module,
final String prefix) {
- // FIXME: 2.0.0: this should throw NPE, not IAE
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
- Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
- Preconditions.checkArgument(prefix != null, "Prefix string cannot be NULL");
+ requireNonNull(context, "context");
if (prefix.equals(module.getPrefix())) {
return module;
}
- final Set<ModuleImport> imports = module.getImports();
- for (final ModuleImport mi : imports) {
+ for (final ModuleImport mi : module.getImports()) {
if (prefix.equals(mi.getPrefix())) {
return context.findModule(mi.getModuleName(), mi.getRevision()).orElse(null);
}
* Schema Context
* @param module
* Yang Module
- * @param relativeXPath
- * Non conditional Revision Aware Relative XPath
+ * @param pathStr
+ * xPath of leafref
* @param actualSchemaNode
* actual schema node
- * @return list of QName
+ * @return target schema node
* @throws IllegalArgumentException if any arguments are null
*/
- private static Iterable<QName> resolveRelativeXPath(final SchemaContext context, final Module module,
- final RevisionAwareXPath relativeXPath, final SchemaNode actualSchemaNode) {
- // FIXME: 2.0.0: this should throw NPE, not IAE
- Preconditions.checkArgument(context != null, "Schema Context reference cannot be NULL");
- Preconditions.checkArgument(module != null, "Module reference cannot be NULL");
- Preconditions.checkArgument(relativeXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
- Preconditions.checkState(!relativeXPath.isAbsolute(),
- "Revision Aware XPath MUST be relative i.e. MUST contains ../, "
- + "for non relative Revision Aware XPath use findDataSchemaNode method");
- Preconditions.checkState(actualSchemaNode.getPath() != null,
- "Schema Path reference for Leafref cannot be NULL");
+ private static @Nullable SchemaNode resolveRelativeXPath(final SchemaContext context, final Module module,
+ final String pathStr, final SchemaNode actualSchemaNode) {
+ checkState(actualSchemaNode.getPath() != null, "Schema Path reference for Leafref cannot be NULL");
+
+ return pathStr.startsWith("deref(") ? resolveDerefPath(context, module, actualSchemaNode, pathStr)
+ : findTargetNode(context, resolveRelativePath(context, module, actualSchemaNode,
+ doSplitXPath(pathStr)));
+ }
+
+ private static Iterable<QName> resolveRelativePath(final SchemaContext context, final Module module,
+ final SchemaNode actualSchemaNode, final List<String> steps) {
+ // Find out how many "parent" components there are and trim them
+ final int colCount = normalizeXPath(steps);
+ final List<String> xpaths = colCount == 0 ? steps : steps.subList(colCount, steps.size());
+
+ final List<QName> walkablePath = createWalkablePath(actualSchemaNode.getPath().getPathFromRoot(),
+ context, colCount);
+
+ if (walkablePath.size() - colCount >= 0) {
+ return Iterables.concat(Iterables.limit(walkablePath, walkablePath.size() - colCount),
+ Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input)));
+ }
+ return Iterables.concat(walkablePath,
+ Iterables.transform(xpaths, input -> stringPathPartToQName(context, module, input)));
+ }
+
+ /**
+ * Return List of qNames that are walkable using xPath. When getting a path from schema node it will return path
+ * with parents like CaseSchemaNode and ChoiceSchemaNode as well if they are parents of the node. We need to get
+ * rid of these in order to find the node that xPath is pointing to. Also we can not remove any node beyond the
+ * amount of "../" because we will not be able to find the correct schema node from schema context
+ *
+ * @param schemaNodePath list of qNames as a path to the leaf of type leafref
+ * @param context create schema context
+ * @param colCount amount of "../" in the xPath expression
+ * @return list of QNames as a path where we should be able to find referenced node
+ */
+ private static List<QName> createWalkablePath(final Iterable<QName> schemaNodePath, final SchemaContext context,
+ final int colCount) {
+ final List<Integer> indexToRemove = new ArrayList<>();
+ List<QName> schemaNodePathRet = Lists.newArrayList(schemaNodePath);
+ for (int j = 0, i = schemaNodePathRet.size() - 1; i >= 0 && j != colCount; i--, j++) {
+ final SchemaNode nodeIn = findTargetNode(context, schemaNodePathRet);
+ if (nodeIn instanceof CaseSchemaNode || nodeIn instanceof ChoiceSchemaNode) {
+ indexToRemove.add(i);
+ j--;
+ }
+ schemaNodePathRet.remove(i);
+ }
+ schemaNodePathRet = Lists.newArrayList(schemaNodePath);
+ for (int i : indexToRemove) {
+ schemaNodePathRet.remove(i);
+ }
+ return schemaNodePathRet;
+ }
- final Iterable<String> xpaths = SLASH_SPLITTER.split(relativeXPath.toString());
+ private static SchemaNode resolveDerefPath(final SchemaContext context, final Module module,
+ final SchemaNode actualSchemaNode, final String xpath) {
+ final int paren = xpath.indexOf(')', 6);
+ checkArgument(paren != -1, "Cannot find matching parentheses in %s", xpath);
+
+ final String derefArg = xpath.substring(6, paren).strip();
+ // Look up the node which we need to reference
+ final SchemaNode derefTarget = findTargetNode(context, resolveRelativePath(context, module, actualSchemaNode,
+ doSplitXPath(derefArg)));
+ checkArgument(derefTarget != null, "Cannot find deref(%s) target node %s in context of %s", derefArg,
+ actualSchemaNode);
+ checkArgument(derefTarget instanceof TypedDataSchemaNode, "deref(%s) resolved to non-typed %s", derefArg,
+ derefTarget);
+
+ // We have a deref() target, decide what to do about it
+ final TypeDefinition<?> targetType = ((TypedDataSchemaNode) derefTarget).getType();
+ if (targetType instanceof InstanceIdentifierTypeDefinition) {
+ // Static inference breaks down, we cannot determine where this points to
+ // FIXME: dedicated exception, users can recover from it, derive from IAE
+ throw new UnsupportedOperationException("Cannot infer instance-identifier reference " + targetType);
+ }
+
+ // deref() is define only for instance-identifier and leafref types, handle the latter
+ checkArgument(targetType instanceof LeafrefTypeDefinition, "Illegal target type %s", targetType);
+
+ final PathExpression targetPath = ((LeafrefTypeDefinition) targetType).getPathStatement();
+ LOG.debug("Derefencing path {}", targetPath);
+
+ final SchemaNode deref = targetPath.isAbsolute()
+ ? findTargetNode(context, actualSchemaNode.getQName().getModule(),
+ ((LocationPathSteps) targetPath.getSteps()).getLocationPath())
+ : findDataSchemaNodeForRelativeXPath(context, module, actualSchemaNode, targetPath);
+ if (deref == null) {
+ LOG.debug("Path {} could not be derefenced", targetPath);
+ return null;
+ }
+
+ checkArgument(deref instanceof LeafSchemaNode, "Unexpected %s reference in %s", deref, targetPath);
+
+ final List<String> qnames = doSplitXPath(xpath.substring(paren + 1).stripLeading());
+ return findTargetNode(context, resolveRelativePath(context, module, deref, qnames));
+ }
- // Find out how many "parent" components there are
- // FIXME: is .contains() the right check here?
- // FIXME: case ../../node1/node2/../node3/../node4
- int colCount = 0;
- for (final Iterator<String> it = xpaths.iterator(); it.hasNext() && it.next().contains(".."); ) {
- ++colCount;
+ private static @Nullable SchemaNode findTargetNode(final SchemaContext context, final QNameModule localNamespace,
+ final YangLocationPath path) {
+ final Deque<QName> ret = new ArrayDeque<>();
+ for (Step step : path.getSteps()) {
+ if (step instanceof AxisStep) {
+ // We only support parent axis steps
+ final YangXPathAxis axis = ((AxisStep) step).getAxis();
+ checkState(axis == YangXPathAxis.PARENT, "Unexpected axis %s", axis);
+ ret.removeLast();
+ continue;
+ }
+
+ // This has to be a QNameStep
+ checkState(step instanceof QNameStep, "Unhandled step %s in %s", step, path);
+ ret.addLast(resolve(((QNameStep) step).getQName(), localNamespace));
}
- final Iterable<QName> schemaNodePath = actualSchemaNode.getPath().getPathFromRoot();
+ return findTargetNode(context, ret);
+ }
- if (Iterables.size(schemaNodePath) - colCount >= 0) {
- return Iterables.concat(Iterables.limit(schemaNodePath, Iterables.size(schemaNodePath) - colCount),
- Iterables.transform(Iterables.skip(xpaths, colCount),
- input -> stringPathPartToQName(context, module, input)));
+ private static @Nullable SchemaNode findTargetNode(final SchemaContext context, final Iterable<QName> qnamePath) {
+ // We do not have enough information about resolution context, hence cannot account for actions, RPCs
+ // and notifications. We therefore attempt to make a best estimate, but this can still fail.
+ final Optional<DataSchemaNode> pureData = context.findDataTreeChild(qnamePath);
+ return pureData.isPresent() ? pureData.get() : findNodeInSchemaContext(context, qnamePath);
+ }
+
+ private static QName resolve(final AbstractQName toResolve, final QNameModule localNamespace) {
+ if (toResolve instanceof QName) {
+ return (QName) toResolve;
+ } else if (toResolve instanceof UnqualifiedQName) {
+ return ((UnqualifiedQName) toResolve).bindTo(localNamespace);
+ } else {
+ throw new IllegalStateException("Unhandled step " + toResolve);
}
- return Iterables.concat(schemaNodePath,
- Iterables.transform(Iterables.skip(xpaths, colCount),
- input -> stringPathPartToQName(context, module, input)));
+ }
+
+ @VisibleForTesting
+ static int normalizeXPath(final List<String> xpath) {
+ LOG.trace("Normalize {}", xpath);
+
+ // We need to make multiple passes here, as the leading XPaths as we can have "../abc/../../def", which really
+ // is "../../def"
+ while (true) {
+ // Next up: count leading ".." components
+ int leadingParents = 0;
+ while (true) {
+ if (leadingParents == xpath.size()) {
+ return leadingParents;
+ }
+ if (!"..".equals(xpath.get(leadingParents))) {
+ break;
+ }
+
+ ++leadingParents;
+ }
+
+ // Now let's see if there there is a '..' in the rest
+ final int dots = findDots(xpath, leadingParents + 1);
+ if (dots == -1) {
+ return leadingParents;
+ }
+
+ xpath.remove(dots - 1);
+ xpath.remove(dots - 1);
+ LOG.trace("Next iteration {}", xpath);
+ }
+ }
+
+ private static int findDots(final List<String> xpath, final int startIndex) {
+ for (int i = startIndex; i < xpath.size(); ++i) {
+ if ("..".equals(xpath.get(i))) {
+ return i;
+ }
+ }
+
+ return -1;
+ }
+
+ private static List<String> doSplitXPath(final String xpath) {
+ final List<String> ret = new ArrayList<>();
+ for (String str : SLASH_SPLITTER.split(xpath)) {
+ ret.add(str);
+ }
+ return ret;
}
/**
*/
public static TypeDefinition<?> getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition,
final SchemaContext schemaContext, final SchemaNode schema) {
- RevisionAwareXPath pathStatement = typeDefinition.getPathStatement();
- pathStatement = new RevisionAwareXPathImpl(stripConditionsFromXPathString(pathStatement),
- pathStatement.isAbsolute());
+ final PathExpression pathStatement = typeDefinition.getPathStatement();
+ final String pathStr = stripConditionsFromXPathString(pathStatement);
final DataSchemaNode dataSchemaNode;
if (pathStatement.isAbsolute()) {
}
}
- Module parentModule = findParentModuleOfReferencingType(schemaContext, baseSchema);
- dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule,
- pathStatement);
+ final Module parentModule = findParentModuleOfReferencingType(schemaContext, baseSchema);
+ dataSchemaNode = (DataSchemaNode) findTargetNode(schemaContext,
+ xpathToQNamePath(schemaContext, parentModule, pathStr));
} else {
Module parentModule = findParentModule(schemaContext, schema);
- dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext,
- parentModule, schema, pathStatement);
+ dataSchemaNode = (DataSchemaNode) resolveRelativeXPath(schemaContext, parentModule, pathStr, schema);
}
// FIXME this is just to preserve backwards compatibility since yangtools do not mind wrong leafref xpaths
*/
public static TypeDefinition<?> getBaseTypeForLeafRef(final LeafrefTypeDefinition typeDefinition,
final SchemaContext schemaContext, final QName qname) {
- final RevisionAwareXPath pathStatement = typeDefinition.getPathStatement();
- final RevisionAwareXPath strippedPathStatement = new RevisionAwareXPathImpl(
- stripConditionsFromXPathString(pathStatement), pathStatement.isAbsolute());
- if (!strippedPathStatement.isAbsolute()) {
+ final PathExpression pathStatement = typeDefinition.getPathStatement();
+ if (!pathStatement.isAbsolute()) {
return null;
}
final Optional<Module> parentModule = schemaContext.findModule(qname.getModule());
- Preconditions.checkArgument(parentModule.isPresent(), "Failed to find parent module for %s", qname);
+ checkArgument(parentModule.isPresent(), "Failed to find parent module for %s", qname);
- final DataSchemaNode dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext,
- parentModule.get(), strippedPathStatement);
+ final DataSchemaNode dataSchemaNode = (DataSchemaNode) findTargetNode(schemaContext,
+ xpathToQNamePath(schemaContext, parentModule.get(), stripConditionsFromXPathString(pathStatement)));
final TypeDefinition<?> targetTypeDefinition = typeDefinition(dataSchemaNode);
if (targetTypeDefinition instanceof LeafrefTypeDefinition) {
return getBaseTypeForLeafRef((LeafrefTypeDefinition) targetTypeDefinition, schemaContext, dataSchemaNode);
private static Module findParentModuleOfReferencingType(final SchemaContext schemaContext,
final SchemaNode schemaNode) {
- Preconditions.checkArgument(schemaContext != null, "Schema Context reference cannot be NULL!");
- Preconditions.checkArgument(schemaNode instanceof TypedSchemaNode, "Unsupported node %s", schemaNode);
+ checkArgument(schemaContext != null, "Schema Context reference cannot be NULL!");
+ checkArgument(schemaNode instanceof TypedDataSchemaNode, "Unsupported node %s", schemaNode);
- TypeDefinition<?> nodeType = ((TypedSchemaNode) schemaNode).getType();
+ TypeDefinition<?> nodeType = ((TypedDataSchemaNode) schemaNode).getType();
if (nodeType.getBaseType() != null) {
while (nodeType.getBaseType() != null) {
nodeType = nodeType.getBaseType();
return schemaContext.findModule(nodeType.getQName().getModule()).orElse(null);
}
- return SchemaContextUtil.findParentModule(schemaContext, schemaNode);
+ return findParentModule(schemaContext, schemaNode);
}
private static final Pattern STRIP_PATTERN = Pattern.compile("\\[[^\\[\\]]*\\]");
* @return string representation of xPath without conditions
*/
@VisibleForTesting
- static String stripConditionsFromXPathString(final RevisionAwareXPath pathStatement) {
- return STRIP_PATTERN.matcher(pathStatement.toString()).replaceAll("");
- }
-
- /**
- * Extracts the base type of leaf schema node until it reach concrete type of TypeDefinition.
- *
- * @param node
- * a node representing LeafSchemaNode
- * @return concrete type definition of node value
- */
- private static TypeDefinition<?> typeDefinition(final LeafSchemaNode node) {
- TypeDefinition<?> baseType = node.getType();
- while (baseType.getBaseType() != null) {
- baseType = baseType.getBaseType();
- }
- return baseType;
- }
-
- /**
- * Extracts the base type of leaf schema node until it reach concrete type of TypeDefinition.
- *
- * @param node
- * a node representing LeafListSchemaNode
- * @return concrete type definition of node value
- */
- private static TypeDefinition<?> typeDefinition(final LeafListSchemaNode node) {
- TypeDefinition<?> baseType = node.getType();
- while (baseType.getBaseType() != null) {
- baseType = baseType.getBaseType();
- }
- return baseType;
+ static String stripConditionsFromXPathString(final PathExpression pathStatement) {
+ return STRIP_PATTERN.matcher(pathStatement.getOriginalString()).replaceAll("");
}
/**
* @return concrete type definition of node value
*/
private static TypeDefinition<?> typeDefinition(final DataSchemaNode node) {
- if (node instanceof LeafListSchemaNode) {
- return typeDefinition((LeafListSchemaNode) node);
- } else if (node instanceof LeafSchemaNode) {
- return typeDefinition((LeafSchemaNode) node);
- } else {
- throw new IllegalArgumentException("Unhandled parameter type: " + node);
+ checkArgument(node instanceof TypedDataSchemaNode, "Unhandled parameter type %s", node);
+
+ TypeDefinition<?> current = ((TypedDataSchemaNode) node).getType();
+ // TODO: don't we have a utility for this?
+ TypeDefinition<?> base = current.getBaseType();
+ while (base != null) {
+ current = base;
+ base = current.getBaseType();
}
+ return current;
}
}
Code Review / yangtools.git / blobdiff