* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.netconf.mdsal.connector.ops;
-import com.google.common.annotations.VisibleForTesting;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Strings;
-import com.google.common.collect.ImmutableMap;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.util.Iterator;
+import static java.util.Objects.requireNonNull;
+
import java.util.List;
-import java.util.ListIterator;
-import java.util.Map;
import java.util.concurrent.ExecutionException;
-import java.util.stream.Collectors;
-import javax.xml.transform.dom.DOMSource;
-import org.opendaylight.controller.config.util.xml.DocumentedException;
-import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorSeverity;
-import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorTag;
-import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorType;
-import org.opendaylight.controller.config.util.xml.XmlElement;
-import org.opendaylight.controller.config.util.xml.XmlUtil;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
-import org.opendaylight.netconf.api.NetconfDocumentedException;
+import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
+import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteOperations;
+import org.opendaylight.netconf.api.DocumentedException;
+import org.opendaylight.netconf.api.ModifyAction;
+import org.opendaylight.netconf.api.xml.XmlElement;
import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
-import org.opendaylight.netconf.mdsal.connector.ops.DataTreeChangeTracker.DataTreeChange;
-import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation;
-import org.opendaylight.yangtools.yang.common.QName;
-import org.opendaylight.yangtools.yang.data.api.ModifyAction;
+import org.opendaylight.yangtools.yang.common.ErrorSeverity;
+import org.opendaylight.yangtools.yang.common.ErrorTag;
+import org.opendaylight.yangtools.yang.common.ErrorType;
import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
-import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
-import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
-import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
-import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
+import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
-import org.opendaylight.yangtools.yang.model.api.Module;
-import org.opendaylight.yangtools.yang.model.api.SchemaNode;
-import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
-import org.w3c.dom.NodeList;
-
-public class EditConfig extends AbstractSingletonNetconfOperation {
+public final class EditConfig extends AbstractEdit {
private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
-
private static final String OPERATION_NAME = "edit-config";
- private static final String CONFIG_KEY = "config";
- private static final String TARGET_KEY = "target";
- private static final String DEFAULT_OPERATION_KEY = "default-operation";
- private final CurrentSchemaContext schemaContext;
+ private static final String DEFAULT_OPERATION = "default-operation";
+
private final TransactionProvider transactionProvider;
public EditConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
final TransactionProvider transactionProvider) {
- super(netconfSessionIdForReporting);
- this.schemaContext = schemaContext;
- this.transactionProvider = transactionProvider;
+ super(netconfSessionIdForReporting, schemaContext);
+ this.transactionProvider = requireNonNull(transactionProvider);
+ }
+
+ @Override
+ protected String getOperationName() {
+ return OPERATION_NAME;
}
@Override
protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
throws DocumentedException {
- final Datastore targetDatastore = extractTargetParameter(operationElement);
- if (targetDatastore == Datastore.running) {
+ if (Datastore.valueOf(extractTargetElement(operationElement, OPERATION_NAME).getName()) == Datastore.running) {
throw new DocumentedException("edit-config on running datastore is not supported",
- ErrorType.PROTOCOL,
- ErrorTag.OPERATION_NOT_SUPPORTED,
- ErrorSeverity.ERROR);
+ ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED, ErrorSeverity.ERROR);
}
- final ModifyAction defaultAction = getDefaultOperation(operationElement);
-
- final XmlElement configElement = getElement(operationElement, CONFIG_KEY);
-
- for (final XmlElement element : configElement.getChildElements()) {
- final String ns = element.getNamespace();
- final DataSchemaNode schemaNode = getSchemaNodeFromNamespace(ns, element).get();
-
- final DataTreeChangeTracker changeTracker = new DataTreeChangeTracker(defaultAction);
-
- parseIntoNormalizedNode(schemaNode, element, changeTracker);
- executeOperations(changeTracker);
+ final var defaultAction = getDefaultOperation(operationElement);
+ for (var element : getConfigElement(operationElement).getChildElements()) {
+ final var writer = new SplittingNormalizedNodeMetadataStreamWriter(defaultAction);
+ parseIntoNormalizedNode(getSchemaNodeFromNamespace(element.getNamespace(), element), element, writer);
+ executeOperations(writer.getDataTreeChanges());
}
- return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.absent());
+ return document.createElement(XmlNetconfConstants.OK);
}
- private void executeOperations(final DataTreeChangeTracker changeTracker) throws DocumentedException {
- final DOMDataReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
- final List<DataTreeChange> aa = changeTracker.getDataTreeChanges();
- final ListIterator<DataTreeChange> iterator = aa.listIterator(aa.size());
-
+ private void executeOperations(final List<DataTreeChange> changes) throws DocumentedException {
+ final var rwTx = transactionProvider.getOrCreateTransaction();
+ final var iterator = changes.listIterator(changes.size());
while (iterator.hasPrevious()) {
- final DataTreeChange dtc = iterator.previous();
- executeChange(rwTx, dtc);
+ executeChange(rwTx, iterator.previous());
}
}
- private void executeChange(final DOMDataReadWriteTransaction rwtx, final DataTreeChange change)
+ // FIXME: we should have proper ReadWriteOperations
+ private void executeChange(final DOMDataTreeReadWriteTransaction rwtx, final DataTreeChange change)
throws DocumentedException {
- final YangInstanceIdentifier path = YangInstanceIdentifier.create(change.getPath());
- final NormalizedNode<?, ?> changeData = change.getChangeRoot();
+ final var path = change.getPath();
+ final var changeData = change.getChangeRoot();
switch (change.getAction()) {
case NONE:
return;
break;
case CREATE:
try {
- final Optional<NormalizedNode<?, ?>> readResult =
- rwtx.read(LogicalDatastoreType.CONFIGURATION, path).get();
- if (readResult.isPresent()) {
+ // FIXME: synchronous operation: can we get a rwTx.create() with a per-operation result instead?
+ if (rwtx.exists(LogicalDatastoreType.CONFIGURATION, path).get()) {
throw new DocumentedException("Data already exists, cannot execute CREATE operation",
ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, ErrorSeverity.ERROR);
}
mergeParentMixin(rwtx, path, changeData);
rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
} catch (final InterruptedException | ExecutionException e) {
- LOG.warn("Read from datastore failed when trying to read data for create operation", change, e);
+ LOG.warn("Read from datastore failed when trying to read data for create operation {}", change, e);
}
break;
case REPLACE:
break;
case DELETE:
try {
- final Optional<NormalizedNode<?, ?>> readResult =
- rwtx.read(LogicalDatastoreType.CONFIGURATION, path).get();
- if (!readResult.isPresent()) {
+ // FIXME: synchronous operation: can we get a rwTx.delete() semantics with a per-operation result
+ // instead?
+ if (!rwtx.exists(LogicalDatastoreType.CONFIGURATION, path).get()) {
throw new DocumentedException("Data is missing, cannot execute DELETE operation",
ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, ErrorSeverity.ERROR);
}
rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
} catch (final InterruptedException | ExecutionException e) {
- LOG.warn("Read from datastore failed when trying to read data for delete operation", change, e);
+ LOG.warn("Read from datastore failed when trying to read data for delete operation {}", change, e);
}
break;
case REMOVE:
}
}
- private void mergeParentMixin(final DOMDataReadWriteTransaction rwtx, final YangInstanceIdentifier path,
- final NormalizedNode<?, ?> change) {
- final YangInstanceIdentifier parentNodeYid = path.getParent();
+ private void mergeParentMixin(final DOMDataTreeWriteOperations rwtx, final YangInstanceIdentifier path,
+ final NormalizedNode change) {
+ final var parentNodeYid = path.getParent();
if (change instanceof MapEntryNode) {
- final SchemaNode schemaNode = SchemaContextUtil.findNodeInSchemaContext(
- schemaContext.getCurrentContext(),
- parentNodeYid.getPathArguments().stream()
- // filter out identifiers not present in the schema tree
- .filter(arg -> !(arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
- .filter(arg -> !(arg instanceof YangInstanceIdentifier.AugmentationIdentifier))
- .map(YangInstanceIdentifier.PathArgument::getNodeType).collect(Collectors.toList()));
+ final var dataSchemaNode = DataSchemaContextTree.from(schemaContext.getCurrentContext())
+ .findChild(parentNodeYid)
+ .orElseThrow(() -> new IllegalStateException("Cannot find schema for " + parentNodeYid))
+ .getDataSchemaNode();
// we should have the schema node that points to the parent list now, enforce it
- Preconditions.checkState(schemaNode instanceof ListSchemaNode, "Schema node is not pointing to a list.");
-
- //merge empty ordered or unordered map
- if (((ListSchemaNode) schemaNode).isUserOrdered()) {
- final MapNode mixinNode = Builders.orderedMapBuilder()
- .withNodeIdentifier(
- new YangInstanceIdentifier.NodeIdentifier(
- parentNodeYid.getLastPathArgument().getNodeType()))
- .build();
- rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
- return;
+ if (!(dataSchemaNode instanceof ListSchemaNode listSchemaNode)) {
+ throw new IllegalStateException("Schema node is not pointing to a list");
}
- final MapNode mixinNode = Builders.mapBuilder()
- .withNodeIdentifier(
- new YangInstanceIdentifier.NodeIdentifier(
- parentNodeYid.getLastPathArgument().getNodeType()))
- .build();
- rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
- } else if (parentNodeYid.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
+ // merge empty ordered or unordered map
+ rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid,
+ (listSchemaNode.isUserOrdered() ? Builders.orderedMapBuilder() : Builders.mapBuilder())
+ .withNodeIdentifier(new NodeIdentifier(parentNodeYid.getLastPathArgument().getNodeType()))
+ .build());
+ } else if (parentNodeYid.getLastPathArgument() instanceof AugmentationIdentifier augId) {
// merge empty augmentation node
- final YangInstanceIdentifier.AugmentationIdentifier augmentationYid =
- (YangInstanceIdentifier.AugmentationIdentifier) parentNodeYid.getLastPathArgument();
- final AugmentationNode augmentationNode = Builders.augmentationBuilder()
- .withNodeIdentifier(augmentationYid).build();
- rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, augmentationNode);
- }
- }
-
- @SuppressWarnings("checkstyle:IllegalCatch")
- private NormalizedNode<?, ?> parseIntoNormalizedNode(final DataSchemaNode schemaNode, final XmlElement element,
- final DataTreeChangeTracker changeTracker) throws DocumentedException {
- if (!(schemaNode instanceof ContainerSchemaNode) && !(schemaNode instanceof ListSchemaNode)) {
- //this should never happen since edit-config on any other node type should not be possible nor makes sense
- LOG.debug("DataNode from module is not ContainerSchemaNode nor ListSchemaNode, aborting..");
- throw new UnsupportedOperationException("implement exception if parse fails");
- }
-
- final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
- final NormalizedNodeStreamWriter writer = new EditOperationNormalizedNodeStreamWriter(resultHolder,
- changeTracker);
- final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext.getCurrentContext(), schemaNode);
- try {
- xmlParser.traverse(new DOMSource(element.getDomElement()));
- } catch (final Exception ex) {
- throw new NetconfDocumentedException("Error parsing input: " + ex.getMessage(), ex, ErrorType.PROTOCOL,
- ErrorTag.MALFORMED_MESSAGE, ErrorSeverity.ERROR);
- }
-
- return resultHolder.getResult();
- }
-
- private Optional<DataSchemaNode> getSchemaNodeFromNamespace(final String namespace, final XmlElement element)
- throws DocumentedException {
- final Iterator<Module> it;
- try {
- // returns module with newest revision since findModuleByNamespace returns a set of modules and we only
- // need the newest one
- it = schemaContext.getCurrentContext().findModules(new URI(namespace)).iterator();
- } catch (final URISyntaxException e) {
- LOG.debug("Unable to create URI for namespace : {}", namespace);
- return Optional.absent();
- }
-
- if (!it.hasNext()) {
- // no module is present with this namespace
- throw new NetconfDocumentedException("Unable to find module by namespace: " + namespace,
- ErrorType.APPLICATION, ErrorTag.UNKNOWN_NAMESPACE, ErrorSeverity.ERROR);
- }
-
- final Module module = it.next();
- final java.util.Optional<DataSchemaNode> schemaNode =
- module.findDataChildByName(QName.create(module.getQNameModule(), element.getName()));
- if (!schemaNode.isPresent()) {
- if (schemaNode != null) {
- throw new DocumentedException(
- "Unable to find node with namespace: " + namespace + "in module: " + module.toString(),
- ErrorType.APPLICATION,
- ErrorTag.UNKNOWN_NAMESPACE,
- ErrorSeverity.ERROR);
- }
- }
-
- return Optional.fromJavaUtil(schemaNode);
- }
-
- private static Datastore extractTargetParameter(final XmlElement operationElement) throws DocumentedException {
- final NodeList elementsByTagName = getElementsByTagName(operationElement, TARGET_KEY);
- // Direct lookup instead of using XmlElement class due to performance
- if (elementsByTagName.getLength() == 0) {
- final Map<String, String> errorInfo = ImmutableMap.of("bad-attribute", TARGET_KEY, "bad-element",
- OPERATION_NAME);
- throw new DocumentedException("Missing target element", ErrorType.PROTOCOL, ErrorTag.MISSING_ATTRIBUTE,
- ErrorSeverity.ERROR, errorInfo);
- } else if (elementsByTagName.getLength() > 1) {
- throw new DocumentedException("Multiple target elements", ErrorType.RPC, ErrorTag.UNKNOWN_ATTRIBUTE,
- ErrorSeverity.ERROR);
- } else {
- final XmlElement targetChildNode =
- XmlElement.fromDomElement((Element) elementsByTagName.item(0)).getOnlyChildElement();
- return Datastore.valueOf(targetChildNode.getName());
+ rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, Builders.augmentationBuilder()
+ .withNodeIdentifier(augId)
+ .build());
}
}
private static ModifyAction getDefaultOperation(final XmlElement operationElement) throws DocumentedException {
- final NodeList elementsByTagName = getElementsByTagName(operationElement, DEFAULT_OPERATION_KEY);
- if (elementsByTagName.getLength() == 0) {
- return ModifyAction.MERGE;
- } else if (elementsByTagName.getLength() > 1) {
- throw new DocumentedException("Multiple " + DEFAULT_OPERATION_KEY + " elements", ErrorType.RPC,
+ final var elementsByTagName = getElementsByTagName(operationElement, DEFAULT_OPERATION);
+ return switch (elementsByTagName.getLength()) {
+ case 0 -> ModifyAction.MERGE;
+ case 1 -> ModifyAction.ofXmlValue(elementsByTagName.item(0).getTextContent());
+ default -> throw new DocumentedException("Multiple " + DEFAULT_OPERATION + " elements", ErrorType.RPC,
ErrorTag.UNKNOWN_ATTRIBUTE, ErrorSeverity.ERROR);
- } else {
- return ModifyAction.fromXmlValue(elementsByTagName.item(0).getTextContent());
- }
-
+ };
}
-
- private static XmlElement getElement(final XmlElement operationElement, final String elementName)
- throws DocumentedException {
- final Optional<XmlElement> childNode = operationElement.getOnlyChildElementOptionally(elementName);
- if (!childNode.isPresent()) {
- throw new DocumentedException(elementName + " element is missing",
- ErrorType.PROTOCOL,
- ErrorTag.MISSING_ELEMENT,
- ErrorSeverity.ERROR);
- }
-
- return childNode.get();
- }
-
- @VisibleForTesting
- static NodeList getElementsByTagName(final XmlElement operationElement, final String key) throws
- DocumentedException {
- final Element element = operationElement.getDomElement();
- final NodeList elementsByTagName;
-
- if (Strings.isNullOrEmpty(element.getPrefix())) {
- elementsByTagName = element.getElementsByTagName(key);
- } else {
- elementsByTagName = element.getElementsByTagNameNS(operationElement.getNamespace(), key);
- }
-
- return elementsByTagName;
- }
-
- @Override
- protected String getOperationName() {
- return OPERATION_NAME;
- }
-
}
Code Review / netconf.git / blobdiff