*/
package org.opendaylight.yangtools.yang.model.util;
-import com.google.common.base.Function;
-import com.google.common.base.Preconditions;
+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.Splitter;
import com.google.common.collect.Iterables;
+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 org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
-import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
+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.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.ListSchemaNode;
+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.ModuleImport;
import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
+import org.opendaylight.yangtools.yang.model.api.NotificationNodeContainer;
+import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
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.TypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
+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.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);
* 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 return
+ * (i.e. contains <code>null</code> values) the method will throw
* IllegalArgumentException.
*
- * @throws IllegalArgumentException
- *
* @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.
*/
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");
+ checkArgument(context != null, "Schema Context reference cannot be NULL");
+ checkArgument(schemaPath != null, "Schema Path reference cannot be NULL");
final Iterable<QName> prefixedPath = schemaPath.getPathFromRoot();
if (prefixedPath == null) {
* method will return specified Data Schema Node, otherwise the operation
* will fail and method will return <code>null</code>.
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param module
* Non-conditional Revision Aware XPath, or <code>null</code> if the
* DataSchemaNode is not present in Schema Context.
*/
- 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");
-
- String strXPath = nonCondXPath.toString();
+ // 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.
+ public static SchemaNode findDataSchemaNode(final SchemaContext context, final Module module,
+ final RevisionAwareXPath nonCondXPath) {
+ checkArgument(context != null, "Schema Context reference cannot be NULL");
+ checkArgument(module != null, "Module reference cannot be NULL");
+ 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");
+ checkArgument(strXPath.indexOf('[') == -1, "Revision Aware XPath may not contain a condition");
if (nonCondXPath.isAbsolute()) {
- List<QName> qnamedPath = xpathToQNamePath(context, module, strXPath);
- if (qnamedPath != null) {
- return findNodeInSchemaContext(context, qnamedPath);
- }
+ final List<QName> path = xpathToQNamePath(context, module, strXPath);
+
+ // 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(path);
+ return pureData.isPresent() ? pureData.get() : findNodeInSchemaContext(context, path);
}
}
return null;
* the method will return specified Data Schema Node, otherwise the
* operation will fail and method will return <code>null</code>.
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param module
* given relative Revision Aware XPath, otherwise will return
* <code>null</code>.
*/
+ // 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.
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");
-
- SchemaPath actualNodePath = actualSchemaNode.getPath();
+ checkArgument(context != null, "Schema Context reference cannot be NULL");
+ checkArgument(module != null, "Module reference cannot be NULL");
+ checkArgument(actualSchemaNode != null, "Actual Schema Node reference cannot be NULL");
+ checkArgument(relativeXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
+ 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) {
- Iterable<QName> qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode);
+ final Iterable<QName> qnamePath = resolveRelativeXPath(context, module, relativeXPath, actualSchemaNode);
- if (qnamePath != null) {
- return findNodeInSchemaContext(context, 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);
}
return null;
}
* If Schema Context or Schema Node contains <code>null</code> references
* the method will throw IllegalArgumentException
*
- * @throws IllegalArgumentException
- *
* @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 returns
- * <code>null</code>
+ * @return Yang Module for specified Schema Context and Schema Node, if Schema Node is NOT present, the method will
+ * return <code>null</code>
*/
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 = Iterables.getFirst(schemaNode.getPath().getPathTowardsRoot(), null);
- Preconditions.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.findModuleByNamespaceAndRevision(qname.getNamespace(), qname.getRevision());
+ checkArgument(context != null, "Schema Context reference cannot be NULL!");
+ checkArgument(schemaNode != null, "Schema Node cannot be NULL!");
+ checkState(schemaNode.getPath() != null, "Schema Path for Schema Node is not set properly (Schema Path is "
+ + "NULL)");
+
+ final QName qname = schemaNode.getPath().getLastComponent();
+ 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);
}
public static SchemaNode findNodeInSchemaContext(final SchemaContext context, final Iterable<QName> path) {
final QName current = path.iterator().next();
LOG.trace("Looking up module {} in context {}", current, path);
- final Module module = context.findModuleByNamespaceAndRevision(current.getNamespace(), current.getRevision());
- if (module == null) {
+ final Optional<Module> module = context.findModule(current.getModule());
+ if (!module.isPresent()) {
LOG.debug("Module {} not found", current);
return null;
}
- return findNodeInModule(module, path);
+ return findNodeInModule(module.get(), path);
}
- private static SchemaNode findNodeInModule(final Module module, final Iterable<QName> path) {
- final QName current = path.iterator().next();
-
- LOG.trace("Looking for data container {} in module {}", current, module);
- SchemaNode parent = module.getDataChildByName(current);
- if (parent != null) {
- final SchemaNode ret = findNode((DataSchemaNode) parent, nextLevel(path));
- if (ret != null) {
- return ret;
+ /**
+ * Returns NotificationDefinition from Schema Context.
+ *
+ * @param schema SchemaContext in which lookup should be performed.
+ * @param path Schema Path of notification
+ * @return Notification schema or null, if notification is not present in schema context.
+ */
+ @Beta
+ 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 null;
+ }
- LOG.trace("Looking for RPC {} in module {}", current, module);
- parent = getRpcByName(module, current);
- if (parent != null) {
- final SchemaNode ret = findNodeInRpc((RpcDefinition) parent, nextLevel(path));
- if (ret != null) {
- return ret;
+ /**
+ * Returns RPC Input or Output Data container from RPC definition.
+ *
+ * @param schema SchemaContext in which lookup should be performed.
+ * @param path Schema path of RPC input/output data container
+ * @return Notification schema or null, if notification is not present in schema context.
+ */
+ @Beta
+ public static @Nullable ContainerSchemaNode 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();
+ checkArgument(it.hasNext(), "Rpc must have QName.");
+ final QName rpcName = it.next();
+ 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())) {
+ return SchemaNodeUtils.getRpcDataSchema(potential, inOrOut);
}
}
+ return null;
+ }
- LOG.trace("Looking for notification {} in module {}", current, module);
- parent = getNotificationByName(module, current);
- if (parent != null) {
- final SchemaNode ret = findNodeInNotification((NotificationDefinition) parent, nextLevel(path));
- if (ret != null) {
- return ret;
- }
- }
+ /**
+ * Extract the identifiers of all modules and submodules which were used to create a particular SchemaContext.
+ *
+ * @param context SchemaContext to be examined
+ * @return Set of ModuleIdentifiers.
+ */
+ public static Set<SourceIdentifier> getConstituentModuleIdentifiers(final SchemaContext context) {
+ final Set<SourceIdentifier> ret = new HashSet<>();
+
+ for (Module module : context.getModules()) {
+ ret.add(moduleToIdentifier(module));
- LOG.trace("Looking for grouping {} in module {}", current, module);
- parent = getGroupingByName(module, current);
- if (parent != null) {
- final SchemaNode ret = findNodeInGrouping((GroupingDefinition) parent, nextLevel(path));
- if (ret != null) {
- return ret;
+ for (Module submodule : module.getSubmodules()) {
+ ret.add(moduleToIdentifier(submodule));
}
}
- LOG.debug("No node matching {} found in module {}", path, module);
- return null;
+ return ret;
}
- private static SchemaNode findNodeInGrouping(final GroupingDefinition grouping, final Iterable<QName> path) {
- final QName current = Iterables.getFirst(path, null);
- if (current == null) {
- LOG.debug("Found grouping {}", grouping);
- return grouping;
- }
+ private static SourceIdentifier moduleToIdentifier(final Module module) {
+ return RevisionSourceIdentifier.create(module.getName(), module.getRevision());
+ }
+
+ private static SchemaNode findNodeInModule(final Module module, final Iterable<QName> path) {
+ checkArgument(module != null, "Parent reference cannot be NULL");
+ checkArgument(path != null, "Path reference cannot be NULL");
- LOG.trace("Looking for path {} in grouping {}", path, grouping);
- final DataSchemaNode node = grouping.getDataChildByName(current);
- if (node == null) {
- LOG.debug("No node matching {} found in grouping {}", current, grouping);
+ if (!path.iterator().hasNext()) {
+ LOG.debug("No node matching {} found in node {}", path, module);
return null;
}
- return findNode(node, nextLevel(path));
- }
+ final QName current = path.iterator().next();
+ LOG.trace("Looking for node {} in module {}", current, module);
- private static SchemaNode findNodeInRpc(final RpcDefinition rpc, final Iterable<QName> path) {
- final QName current = Iterables.getFirst(path, null);
- if (current == null) {
- LOG.debug("Found RPC {}", rpc);
- return rpc;
- }
-
- LOG.trace("Looking for path {} in rpc {}", path, rpc);
- switch (current.getLocalName()) {
- case "input":
- return findNode(rpc.getInput(), nextLevel(path));
- case "output":
- return findNode(rpc.getOutput(), nextLevel(path));
- default:
- LOG.debug("Invalid component {} of path {} in RPC {}", current, path, rpc);
- return null;
- }
- }
+ SchemaNode foundNode = null;
+ final Iterable<QName> nextPath = nextLevel(path);
- private static SchemaNode findNodeInNotification(final NotificationDefinition ntf, final Iterable<QName> path) {
- final QName current = Iterables.getFirst(path, null);
- if (current == null) {
- LOG.debug("Found notification {}", ntf);
- return ntf;
+ foundNode = module.getDataChildByName(current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
}
- LOG.trace("Looking for path {} in notification {}", path, ntf);
- DataSchemaNode node = ntf.getDataChildByName(current);
- if (node == null) {
- LOG.debug("No node matching {} found in notification {}", current, ntf);
- return null;
+ if (foundNode == null) {
+ foundNode = getGroupingByName(module, current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
}
- return findNode(node, nextLevel(path));
- }
+ if (foundNode == null) {
+ foundNode = getRpcByName(module, current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
+ }
- private static SchemaNode findNode(final ChoiceNode parent, final Iterable<QName> path) {
- final QName current = Iterables.getFirst(path, null);
- if (current == null) {
- return parent;
+ if (foundNode == null) {
+ foundNode = getNotificationByName(module, current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
}
- ChoiceCaseNode node = parent.getCaseNodeByName(current);
- if (node != null) {
- return findNodeInCase(node, nextLevel(path));
+
+ if (foundNode == null) {
+ LOG.debug("No node matching {} found in node {}", path, module);
}
- return null;
+
+ return foundNode;
+
}
- private static SchemaNode findNode(final ContainerSchemaNode parent, final Iterable<QName> path) {
- final QName current = Iterables.getFirst(path, null);
- if (current == null) {
- return parent;
- }
+ private static SchemaNode findNodeIn(final SchemaNode parent, final Iterable<QName> path) {
+ checkArgument(parent != null, "Parent reference cannot be NULL");
+ checkArgument(path != null, "Path reference cannot be NULL");
- final DataSchemaNode node = parent.getDataChildByName(current);
- if (node == null) {
- LOG.debug("Failed to find {} in parent {}", path, parent);
+ if (!path.iterator().hasNext()) {
+ LOG.debug("No node matching {} found in node {}", path, parent);
return null;
}
- return findNode(node, nextLevel(path));
- }
+ final QName current = path.iterator().next();
+ LOG.trace("Looking for node {} in node {}", current, parent);
+
+ SchemaNode foundNode = null;
+ final Iterable<QName> nextPath = nextLevel(path);
+
+ if (parent instanceof DataNodeContainer) {
+ final DataNodeContainer parentDataNodeContainer = (DataNodeContainer) parent;
- private static SchemaNode findNode(final ListSchemaNode parent, final Iterable<QName> path) {
- final QName current = Iterables.getFirst(path, null);
- if (current == null) {
- return parent;
+ foundNode = parentDataNodeContainer.getDataChildByName(current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
+
+ if (foundNode == null) {
+ foundNode = getGroupingByName(parentDataNodeContainer, current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
+ }
}
- DataSchemaNode node = parent.getDataChildByName(current);
- if (node == null) {
- LOG.debug("Failed to find {} in parent {}", path, parent);
- return null;
+ if (foundNode == null && parent instanceof ActionNodeContainer) {
+ foundNode = ((ActionNodeContainer) parent).getActions().stream()
+ .filter(act -> current.equals(act.getQName())).findFirst().orElse(null);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
}
- return findNode(node, nextLevel(path));
- }
- private static SchemaNode findNode(final DataSchemaNode parent, final Iterable<QName> path) {
- final SchemaNode node;
- if (!Iterables.isEmpty(path)) {
- if (parent instanceof ContainerSchemaNode) {
- node = findNode((ContainerSchemaNode) parent, path);
- } else if (parent instanceof ListSchemaNode) {
- node = findNode((ListSchemaNode) parent, path);
- } else if (parent instanceof ChoiceNode) {
- node = findNode((ChoiceNode) parent, path);
- } else {
- throw new IllegalArgumentException(
- String.format("Path nesting violation in parent %s path %s", parent, path));
+ 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);
}
- } else {
- node = parent;
}
- if (node == null) {
- LOG.debug("Failed to find {} in parent {}", path, parent);
- return null;
+ if (foundNode == null && parent instanceof OperationDefinition) {
+ final OperationDefinition parentRpcDefinition = (OperationDefinition) parent;
+
+ if (current.getLocalName().equals("input")) {
+ foundNode = parentRpcDefinition.getInput();
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
+ }
+
+ if (current.getLocalName().equals("output")) {
+ foundNode = parentRpcDefinition.getOutput();
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
+ }
+
+ if (foundNode == null) {
+ foundNode = getGroupingByName(parentRpcDefinition, current);
+ if (foundNode != null && nextPath.iterator().hasNext()) {
+ foundNode = findNodeIn(foundNode, nextPath);
+ }
+ }
}
- return node;
- }
- private static SchemaNode findNodeInCase(final ChoiceCaseNode parent, final Iterable<QName> path) {
- final QName current = Iterables.getFirst(path, null);
- if (current == null) {
- return parent;
+ if (foundNode == null && parent instanceof ChoiceSchemaNode) {
+ foundNode = ((ChoiceSchemaNode) parent).getCaseNodeByName(current);
+
+ 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 CaseSchemaNode caseNode : ((ChoiceSchemaNode) parent).getCases().values()) {
+ final DataSchemaNode maybeChild = caseNode.getDataChildByName(current);
+ if (maybeChild != null) {
+ foundNode = findNodeIn(maybeChild, nextPath);
+ break;
+ }
+ }
+ }
}
- DataSchemaNode node = parent.getDataChildByName(current);
- if (node == null) {
- LOG.debug("Failed to find {} in parent {}", path, parent);
- return null;
+ if (foundNode == null) {
+ LOG.debug("No node matching {} found in node {}", path, parent);
}
- return findNode(node, nextLevel(path));
+
+ return foundNode;
+
+ }
+
+ private static Iterable<QName> nextLevel(final Iterable<QName> path) {
+ return Iterables.skip(path, 1);
}
private static RpcDefinition getRpcByName(final Module module, final QName name) {
- for (RpcDefinition rpc : module.getRpcs()) {
+ for (final RpcDefinition rpc : module.getRpcs()) {
if (rpc.getQName().equals(name)) {
return rpc;
}
return null;
}
- private static Iterable<QName> nextLevel(final Iterable<QName> path) {
- return Iterables.skip(path, 1);
- }
-
private static NotificationDefinition getNotificationByName(final Module module, final QName name) {
- for (NotificationDefinition notification : module.getNotifications()) {
+ for (final NotificationDefinition notification : module.getNotifications()) {
if (notification.getQName().equals(name)) {
return notification;
}
return null;
}
- private static GroupingDefinition getGroupingByName(final Module module, final QName name) {
- for (GroupingDefinition grouping : module.getGroupings()) {
+ private static GroupingDefinition getGroupingByName(final DataNodeContainer dataNodeContainer, final QName name) {
+ for (final GroupingDefinition grouping : dataNodeContainer.getGroupings()) {
+ if (grouping.getQName().equals(name)) {
+ return grouping;
+ }
+ }
+ return null;
+ }
+
+ private static GroupingDefinition getGroupingByName(final OperationDefinition rpc, final QName name) {
+ for (final GroupingDefinition grouping : rpc.getGroupings()) {
if (grouping.getQName().equals(name)) {
return grouping;
}
* If Schema Context, Parent Module or XPath string contains
* <code>null</code> values, the method will throws IllegalArgumentException
*
- * @throws IllegalArgumentException
- *
* @param context
* Schema Context
* @param parentModule
* @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) {
- 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");
-
- List<QName> path = new LinkedList<QName>();
- for (String pathComponent : SLASH_SPLITTER.split(xpath)) {
+ private static List<QName> xpathToQNamePath(final SchemaContext context, final Module parentModule,
+ final String xpath) {
+ // FIXME: 3.0.0: this should throw NPE, not IAE
+ checkArgument(context != null, "Schema Context reference cannot be NULL");
+ checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
+ checkArgument(xpath != null, "XPath string reference cannot be NULL");
+
+ final List<QName> path = new LinkedList<>();
+ for (final String pathComponent : SLASH_SPLITTER.split(xpath)) {
if (!pathComponent.isEmpty()) {
path.add(stringPathPartToQName(context, parentModule, pathComponent));
}
* If Schema Context, Parent Module or Prefixed Path Part refers to
* <code>null</code> the method will throw IllegalArgumentException
*
- * @throws 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
*/
- private static QName stringPathPartToQName(final SchemaContext context, final Module parentModule, final String prefixedPathPart) {
- 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!");
+ private static QName stringPathPartToQName(final SchemaContext context, final Module parentModule,
+ final String prefixedPathPart) {
+ // FIXME: 3.0.0: this should throw NPE, not IAE
+ checkArgument(context != null, "Schema Context reference cannot be NULL");
+ checkArgument(parentModule != null, "Parent Module reference cannot be NULL");
+ checkArgument(prefixedPathPart != null, "Prefixed Path Part cannot be NULL!");
if (prefixedPathPart.indexOf(':') != -1) {
final Iterator<String> prefixedName = COLON_SPLITTER.split(prefixedPathPart).iterator();
final String modulePrefix = prefixedName.next();
- Module module = resolveModuleForPrefix(context, parentModule, modulePrefix);
- Preconditions.checkArgument(module != null, "Failed to resolve xpath: no module found for prefix %s in module %s",
+ final Module module = resolveModuleForPrefix(context, parentModule, modulePrefix);
+ checkArgument(module != null, "Failed to resolve xpath: no module found for prefix %s in module %s",
modulePrefix, parentModule.getName());
- // FIXME: Module should have a QNameModule handle
- return QName.create(module.getNamespace(), module.getRevision(), prefixedName.next());
- } else {
- return QName.create(parentModule.getNamespace(), parentModule.getRevision(), prefixedPathPart);
+ return QName.create(module.getQNameModule(), prefixedName.next());
}
+
+ return QName.create(parentModule.getNamespace(), parentModule.getRevision(), 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>
+ * If Schema Context, Module or Prefix are referring to {@code null} the method will throw IllegalArgumentException.
*
- * @throws IllegalArgumentException
- *
- * @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>
+ * @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
*/
- private static Module resolveModuleForPrefix(final SchemaContext context, final Module module, final String prefix) {
- 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");
+ private static Module resolveModuleForPrefix(final SchemaContext context, final Module module,
+ final String prefix) {
+ // FIXME: 3.0.0: this should throw NPE, not IAE
+ checkArgument(context != null, "Schema Context reference cannot be NULL");
+ checkArgument(module != null, "Module reference cannot be NULL");
+ checkArgument(prefix != null, "Prefix string cannot be NULL");
if (prefix.equals(module.getPrefix())) {
return module;
}
- Set<ModuleImport> imports = module.getImports();
- for (ModuleImport mi : imports) {
+ final Set<ModuleImport> imports = module.getImports();
+ for (final ModuleImport mi : imports) {
if (prefix.equals(mi.getPrefix())) {
- return context.findModuleByName(mi.getModuleName(), mi.getRevision());
+ return context.findModule(mi.getModuleName(), mi.getRevision()).orElse(null);
}
}
return null;
}
/**
- * @throws IllegalArgumentException
+ * Resolve a relative XPath into a set of QNames.
*
* @param context
* Schema Context
* Yang Module
* @param relativeXPath
* Non conditional Revision Aware Relative XPath
- * @param leafrefSchemaPath
- * Schema Path for Leafref
+ * @param actualSchemaNode
+ * actual schema node
* @return list of QName
+ * @throws IllegalArgumentException if any arguments are null
*/
private static Iterable<QName> resolveRelativeXPath(final SchemaContext context, final Module module,
- final RevisionAwareXPath relativeXPath, final SchemaNode leafrefParentNode) {
- 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(leafrefParentNode.getPath() != null,
+ final RevisionAwareXPath relativeXPath, final SchemaNode actualSchemaNode) {
+ // FIXME: 3.0.0: this should throw NPE, not IAE
+ checkArgument(context != null, "Schema Context reference cannot be NULL");
+ checkArgument(module != null, "Module reference cannot be NULL");
+ checkArgument(relativeXPath != null, "Non Conditional Revision Aware XPath cannot be NULL");
+ checkState(!relativeXPath.isAbsolute(), "Revision Aware XPath MUST be relative i.e. MUST contains ../, "
+ + "for non relative Revision Aware XPath use findDataSchemaNode method");
+ checkState(actualSchemaNode.getPath() != null,
"Schema Path reference for Leafref cannot be NULL");
final Iterable<String> xpaths = SLASH_SPLITTER.split(relativeXPath.toString());
// 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 (Iterator<String> it = xpaths.iterator(); it.hasNext() && it.next().contains(".."); ) {
+ for (final Iterator<String> it = xpaths.iterator(); it.hasNext() && it.next().contains(".."); ) {
++colCount;
}
- final Iterable<QName> parent = leafrefParentNode.getPath().getPathFromRoot();
- return Iterables.concat(Iterables.limit(parent, Iterables.size(parent) - colCount),
- Iterables.transform(Iterables.skip(xpaths, colCount), new Function<String, QName>() {
- @Override
- public QName apply(final String input) {
- return stringPathPartToQName(context, module, input);
- }
- }));
+ final Iterable<QName> schemaNodePath = actualSchemaNode.getPath().getPathFromRoot();
+
+ 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)));
+ }
+ return Iterables.concat(schemaNodePath,
+ Iterables.transform(Iterables.skip(xpaths, colCount),
+ input -> stringPathPartToQName(context, module, input)));
+ }
+
+ /**
+ * Extracts the base type of node on which schema node points to. If target node is again of type
+ * LeafrefTypeDefinition, methods will be call recursively until it reach concrete type definition.
+ *
+ * @param typeDefinition
+ * type of node which will be extracted
+ * @param schemaContext
+ * Schema Context
+ * @param schema
+ * Schema Node
+ * @return recursively found type definition this leafref is pointing to or null if the xpath is incorrect (null
+ * is there to preserve backwards compatibility)
+ */
+ 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 DataSchemaNode dataSchemaNode;
+ if (pathStatement.isAbsolute()) {
+ SchemaNode baseSchema = schema;
+ while (baseSchema instanceof DerivableSchemaNode) {
+ final Optional<? extends SchemaNode> basePotential = ((DerivableSchemaNode) baseSchema).getOriginal();
+ if (basePotential.isPresent()) {
+ baseSchema = basePotential.get();
+ } else {
+ break;
+ }
+ }
+
+ Module parentModule = findParentModuleOfReferencingType(schemaContext, baseSchema);
+ dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext, parentModule,
+ pathStatement);
+ } else {
+ Module parentModule = findParentModule(schemaContext, schema);
+ dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNodeForRelativeXPath(schemaContext,
+ parentModule, schema, pathStatement);
+ }
+
+ // FIXME this is just to preserve backwards compatibility since yangtools do not mind wrong leafref xpaths
+ // and current expected behaviour for such cases is to just use pure string
+ // This should throw an exception about incorrect XPath in leafref
+ if (dataSchemaNode == null) {
+ return null;
+ }
+
+ final TypeDefinition<?> targetTypeDefinition = typeDefinition(dataSchemaNode);
+
+ if (targetTypeDefinition instanceof LeafrefTypeDefinition) {
+ return getBaseTypeForLeafRef((LeafrefTypeDefinition) targetTypeDefinition, schemaContext, dataSchemaNode);
+ }
+
+ return targetTypeDefinition;
+ }
+
+ /**
+ * Returns base type for {@code typeDefinition} which belongs to module specified via {@code qname}. This handle
+ * the case when leafref type isn't specified as type substatement of leaf or leaf-list but is defined in other
+ * module as typedef which is then imported to referenced module.
+ *
+ * <p>
+ * Because {@code typeDefinition} is definied via typedef statement, only absolute path is meaningful.
+ */
+ 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()) {
+ return null;
+ }
+
+ final Optional<Module> parentModule = schemaContext.findModule(qname.getModule());
+ checkArgument(parentModule.isPresent(), "Failed to find parent module for %s", qname);
+
+ final DataSchemaNode dataSchemaNode = (DataSchemaNode) SchemaContextUtil.findDataSchemaNode(schemaContext,
+ parentModule.get(), strippedPathStatement);
+ final TypeDefinition<?> targetTypeDefinition = typeDefinition(dataSchemaNode);
+ if (targetTypeDefinition instanceof LeafrefTypeDefinition) {
+ return getBaseTypeForLeafRef((LeafrefTypeDefinition) targetTypeDefinition, schemaContext, dataSchemaNode);
+ }
+
+ return targetTypeDefinition;
+ }
+
+ private static Module findParentModuleOfReferencingType(final SchemaContext schemaContext,
+ final SchemaNode schemaNode) {
+ checkArgument(schemaContext != null, "Schema Context reference cannot be NULL!");
+ checkArgument(schemaNode instanceof TypedDataSchemaNode, "Unsupported node %s", schemaNode);
+
+ 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);
+ }
+
+ private static final Pattern STRIP_PATTERN = Pattern.compile("\\[[^\\[\\]]*\\]");
+
+ /**
+ * Removes conditions from xPath pointed to target node.
+ *
+ * @param pathStatement
+ * xPath to target node
+ * @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;
+ }
+
+ /**
+ * Gets the base type of DataSchemaNode value.
+ *
+ * @param node
+ * a node representing DataSchemaNode
+ * @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);
+ }
}
}