2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.netconf.mdsal.connector.ops;
10 import static java.util.Objects.requireNonNull;
12 import java.util.List;
13 import java.util.concurrent.ExecutionException;
14 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
15 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
16 import org.opendaylight.mdsal.dom.api.DOMDataTreeWriteOperations;
17 import org.opendaylight.netconf.api.DocumentedException;
18 import org.opendaylight.netconf.api.ModifyAction;
19 import org.opendaylight.netconf.api.xml.XmlElement;
20 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
21 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
22 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
23 import org.opendaylight.yangtools.yang.common.ErrorSeverity;
24 import org.opendaylight.yangtools.yang.common.ErrorTag;
25 import org.opendaylight.yangtools.yang.common.ErrorType;
26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
28 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
29 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
31 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
32 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
33 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36 import org.w3c.dom.Document;
37 import org.w3c.dom.Element;
39 public final class EditConfig extends AbstractEdit {
40 private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
41 private static final String OPERATION_NAME = "edit-config";
42 private static final String DEFAULT_OPERATION = "default-operation";
44 private final TransactionProvider transactionProvider;
46 public EditConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
47 final TransactionProvider transactionProvider) {
48 super(netconfSessionIdForReporting, schemaContext);
49 this.transactionProvider = requireNonNull(transactionProvider);
53 protected String getOperationName() {
54 return OPERATION_NAME;
58 protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
59 throws DocumentedException {
60 if (Datastore.valueOf(extractTargetElement(operationElement, OPERATION_NAME).getName()) == Datastore.running) {
61 throw new DocumentedException("edit-config on running datastore is not supported",
62 ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED, ErrorSeverity.ERROR);
65 final var defaultAction = getDefaultOperation(operationElement);
66 for (var element : getConfigElement(operationElement).getChildElements()) {
67 final var writer = new SplittingNormalizedNodeMetadataStreamWriter(defaultAction);
68 parseIntoNormalizedNode(getSchemaNodeFromNamespace(element.getNamespace(), element), element, writer);
69 executeOperations(writer.getDataTreeChanges());
72 return document.createElement(XmlNetconfConstants.OK);
75 private void executeOperations(final List<DataTreeChange> changes) throws DocumentedException {
76 final var rwTx = transactionProvider.getOrCreateTransaction();
77 final var iterator = changes.listIterator(changes.size());
78 while (iterator.hasPrevious()) {
79 executeChange(rwTx, iterator.previous());
83 // FIXME: we should have proper ReadWriteOperations
84 private void executeChange(final DOMDataTreeReadWriteTransaction rwtx, final DataTreeChange change)
85 throws DocumentedException {
86 final var path = change.getPath();
87 final var changeData = change.getChangeRoot();
88 switch (change.getAction()) {
92 mergeParentMixin(rwtx, path, changeData);
93 rwtx.merge(LogicalDatastoreType.CONFIGURATION, path, changeData);
97 // FIXME: synchronous operation: can we get a rwTx.create() with a per-operation result instead?
98 if (rwtx.exists(LogicalDatastoreType.CONFIGURATION, path).get()) {
99 throw new DocumentedException("Data already exists, cannot execute CREATE operation",
100 ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, ErrorSeverity.ERROR);
102 mergeParentMixin(rwtx, path, changeData);
103 rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
104 } catch (final InterruptedException | ExecutionException e) {
105 LOG.warn("Read from datastore failed when trying to read data for create operation {}", change, e);
109 mergeParentMixin(rwtx, path, changeData);
110 rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
114 // FIXME: synchronous operation: can we get a rwTx.delete() semantics with a per-operation result
116 if (!rwtx.exists(LogicalDatastoreType.CONFIGURATION, path).get()) {
117 throw new DocumentedException("Data is missing, cannot execute DELETE operation",
118 ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, ErrorSeverity.ERROR);
120 rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
121 } catch (final InterruptedException | ExecutionException e) {
122 LOG.warn("Read from datastore failed when trying to read data for delete operation {}", change, e);
126 rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
129 LOG.warn("Unknown/not implemented operation, not executing");
133 private void mergeParentMixin(final DOMDataTreeWriteOperations rwtx, final YangInstanceIdentifier path,
134 final NormalizedNode change) {
135 final var parentNodeYid = path.getParent();
136 if (change instanceof MapEntryNode) {
137 final var dataSchemaNode = DataSchemaContextTree.from(schemaContext.getCurrentContext())
138 .findChild(parentNodeYid)
139 .orElseThrow(() -> new IllegalStateException("Cannot find schema for " + parentNodeYid))
140 .getDataSchemaNode();
142 // we should have the schema node that points to the parent list now, enforce it
143 if (!(dataSchemaNode instanceof ListSchemaNode listSchemaNode)) {
144 throw new IllegalStateException("Schema node is not pointing to a list");
147 // merge empty ordered or unordered map
148 rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid,
149 (listSchemaNode.isUserOrdered() ? Builders.orderedMapBuilder() : Builders.mapBuilder())
150 .withNodeIdentifier(new NodeIdentifier(parentNodeYid.getLastPathArgument().getNodeType()))
152 } else if (parentNodeYid.getLastPathArgument() instanceof AugmentationIdentifier augId) {
153 // merge empty augmentation node
154 rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, Builders.augmentationBuilder()
155 .withNodeIdentifier(augId)
160 private static ModifyAction getDefaultOperation(final XmlElement operationElement) throws DocumentedException {
161 final var elementsByTagName = getElementsByTagName(operationElement, DEFAULT_OPERATION);
162 return switch (elementsByTagName.getLength()) {
163 case 0 -> ModifyAction.MERGE;
164 case 1 -> ModifyAction.ofXmlValue(elementsByTagName.item(0).getTextContent());
165 default -> throw new DocumentedException("Multiple " + DEFAULT_OPERATION + " elements", ErrorType.RPC,
166 ErrorTag.UNKNOWN_ATTRIBUTE, ErrorSeverity.ERROR);