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
9 package org.opendaylight.netconf.mdsal.connector.ops;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.collect.ImmutableMap;
15 import java.net.URISyntaxException;
16 import java.util.Collections;
17 import java.util.List;
18 import java.util.ListIterator;
20 import java.util.stream.Collectors;
21 import org.opendaylight.controller.config.util.xml.DocumentedException;
22 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorSeverity;
23 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorTag;
24 import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorType;
25 import org.opendaylight.controller.config.util.xml.XmlElement;
26 import org.opendaylight.controller.config.util.xml.XmlUtil;
27 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
28 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
29 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
30 import org.opendaylight.netconf.api.NetconfDocumentedException;
31 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
32 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
33 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
34 import org.opendaylight.netconf.mdsal.connector.ops.DataTreeChangeTracker.DataTreeChange;
35 import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation;
36 import org.opendaylight.yangtools.yang.common.QName;
37 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
38 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
39 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
42 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
43 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
44 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
45 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
46 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
49 import org.opendaylight.yangtools.yang.model.api.Module;
50 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
51 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
54 import org.w3c.dom.Document;
55 import org.w3c.dom.Element;
56 import org.w3c.dom.NodeList;
58 public class EditConfig extends AbstractSingletonNetconfOperation {
60 private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
62 private static final String OPERATION_NAME = "edit-config";
63 private static final String CONFIG_KEY = "config";
64 private static final String TARGET_KEY = "target";
65 private static final String DEFAULT_OPERATION_KEY = "default-operation";
66 private final CurrentSchemaContext schemaContext;
67 private final TransactionProvider transactionProvider;
69 public EditConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
70 final TransactionProvider transactionProvider) {
71 super(netconfSessionIdForReporting);
72 this.schemaContext = schemaContext;
73 this.transactionProvider = transactionProvider;
77 protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
78 throws DocumentedException {
79 final Datastore targetDatastore = extractTargetParameter(operationElement);
80 if (targetDatastore == Datastore.running) {
81 throw new DocumentedException("edit-config on running datastore is not supported",
83 ErrorTag.OPERATION_NOT_SUPPORTED,
87 final ModifyAction defaultAction = getDefaultOperation(operationElement);
89 final XmlElement configElement = getElement(operationElement, CONFIG_KEY);
91 for (final XmlElement element : configElement.getChildElements()) {
92 final String ns = element.getNamespace();
93 final DataSchemaNode schemaNode = getSchemaNodeFromNamespace(ns, element).get();
95 final DataTreeChangeTracker changeTracker = new DataTreeChangeTracker(defaultAction);
96 final DomToNormalizedNodeParserFactory.BuildingStrategyProvider editOperationStrategyProvider =
97 new EditOperationStrategyProvider(changeTracker);
99 parseIntoNormalizedNode(schemaNode, element, editOperationStrategyProvider);
100 executeOperations(changeTracker);
103 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.absent());
106 private void executeOperations(final DataTreeChangeTracker changeTracker) throws DocumentedException {
107 final DOMDataReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
108 final List<DataTreeChange> aa = changeTracker.getDataTreeChanges();
109 final ListIterator<DataTreeChange> iterator = aa.listIterator(aa.size());
111 while (iterator.hasPrevious()) {
112 final DataTreeChange dtc = iterator.previous();
113 executeChange(rwTx, dtc);
117 private void executeChange(final DOMDataReadWriteTransaction rwtx, final DataTreeChange change)
118 throws DocumentedException {
119 final YangInstanceIdentifier path = YangInstanceIdentifier.create(change.getPath());
120 final NormalizedNode<?, ?> changeData = change.getChangeRoot();
121 switch (change.getAction()) {
125 mergeParentMixin(rwtx, path, changeData);
126 rwtx.merge(LogicalDatastoreType.CONFIGURATION, path, changeData);
130 final Optional<NormalizedNode<?, ?>> readResult =
131 rwtx.read(LogicalDatastoreType.CONFIGURATION, path).checkedGet();
132 if (readResult.isPresent()) {
133 throw new DocumentedException("Data already exists, cannot execute CREATE operation",
134 ErrorType.PROTOCOL, ErrorTag.DATA_EXISTS, ErrorSeverity.ERROR);
136 mergeParentMixin(rwtx, path, changeData);
137 rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
138 } catch (final ReadFailedException e) {
139 LOG.warn("Read from datastore failed when trying to read data for create operation", change, e);
143 mergeParentMixin(rwtx, path, changeData);
144 rwtx.put(LogicalDatastoreType.CONFIGURATION, path, changeData);
148 final Optional<NormalizedNode<?, ?>> readResult =
149 rwtx.read(LogicalDatastoreType.CONFIGURATION, path).checkedGet();
150 if (!readResult.isPresent()) {
151 throw new DocumentedException("Data is missing, cannot execute DELETE operation",
152 ErrorType.PROTOCOL, ErrorTag.DATA_MISSING, ErrorSeverity.ERROR);
154 rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
155 } catch (final ReadFailedException e) {
156 LOG.warn("Read from datastore failed when trying to read data for delete operation", change, e);
160 rwtx.delete(LogicalDatastoreType.CONFIGURATION, path);
163 LOG.warn("Unknown/not implemented operation, not executing");
167 private void mergeParentMixin(final DOMDataReadWriteTransaction rwtx, final YangInstanceIdentifier path,
168 final NormalizedNode change) {
169 final YangInstanceIdentifier parentNodeYid = path.getParent();
170 if (change instanceof MapEntryNode) {
171 final SchemaNode schemaNode = SchemaContextUtil.findNodeInSchemaContext(
172 schemaContext.getCurrentContext(),
173 parentNodeYid.getPathArguments().stream()
174 // filter out identifiers not present in the schema tree
175 .filter(arg -> !(arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates))
176 .filter(arg -> !(arg instanceof YangInstanceIdentifier.AugmentationIdentifier))
177 .map(YangInstanceIdentifier.PathArgument::getNodeType).collect(Collectors.toList()));
179 // we should have the schema node that points to the parent list now, enforce it
180 Preconditions.checkState(schemaNode instanceof ListSchemaNode, "Schema node is not pointing to a list.");
182 //merge empty ordered or unordered map
183 if (((ListSchemaNode) schemaNode).isUserOrdered()) {
184 final MapNode mixinNode = Builders.orderedMapBuilder()
186 new YangInstanceIdentifier.NodeIdentifier(
187 parentNodeYid.getLastPathArgument().getNodeType()))
189 rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
193 final MapNode mixinNode = Builders.mapBuilder()
195 new YangInstanceIdentifier.NodeIdentifier(
196 parentNodeYid.getLastPathArgument().getNodeType()))
198 rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, mixinNode);
199 } else if (parentNodeYid.getLastPathArgument() instanceof YangInstanceIdentifier.AugmentationIdentifier) {
200 // merge empty augmentation node
201 final YangInstanceIdentifier.AugmentationIdentifier augmentationYid =
202 (YangInstanceIdentifier.AugmentationIdentifier) parentNodeYid.getLastPathArgument();
203 final AugmentationNode augmentationNode = Builders.augmentationBuilder()
204 .withNodeIdentifier(augmentationYid).build();
205 rwtx.merge(LogicalDatastoreType.CONFIGURATION, parentNodeYid, augmentationNode);
209 private NormalizedNode<?, ?> parseIntoNormalizedNode(final DataSchemaNode schemaNode, final XmlElement element,
210 final DomToNormalizedNodeParserFactory.BuildingStrategyProvider editOperationStrategyProvider) {
211 if (schemaNode instanceof ContainerSchemaNode) {
212 return DomToNormalizedNodeParserFactory.getInstance(DomUtils.defaultValueCodecProvider(),
213 schemaContext.getCurrentContext(), editOperationStrategyProvider)
214 .getContainerNodeParser()
215 .parse(Collections.singletonList(element.getDomElement()), (ContainerSchemaNode) schemaNode);
216 } else if (schemaNode instanceof ListSchemaNode) {
217 return DomToNormalizedNodeParserFactory.getInstance(DomUtils.defaultValueCodecProvider(),
218 schemaContext.getCurrentContext(), editOperationStrategyProvider)
220 .parse(Collections.singletonList(element.getDomElement()), (ListSchemaNode) schemaNode);
222 //this should never happen since edit-config on any other node type should not be possible nor makes sense
223 LOG.debug("DataNode from module is not ContainerSchemaNode nor ListSchemaNode, aborting..");
225 throw new UnsupportedOperationException("implement exception if parse fails");
228 private Optional<DataSchemaNode> getSchemaNodeFromNamespace(final String namespace, final XmlElement element)
229 throws DocumentedException {
230 Optional<DataSchemaNode> dataSchemaNode = Optional.absent();
232 // returns module with newest revision since findModuleByNamespace returns a set of modules and we only
233 // need the newest one
234 final Module module =
235 schemaContext.getCurrentContext().findModuleByNamespaceAndRevision(new URI(namespace), null);
236 if (module == null) {
237 // no module is present with this namespace
238 throw new NetconfDocumentedException("Unable to find module by namespace: " + namespace,
239 ErrorType.APPLICATION, ErrorTag.UNKNOWN_NAMESPACE, ErrorSeverity.ERROR);
241 final DataSchemaNode schemaNode =
242 module.getDataChildByName(QName.create(module.getQNameModule(), element.getName()));
243 if (schemaNode != null) {
244 dataSchemaNode = Optional.of(schemaNode);
246 throw new DocumentedException(
247 "Unable to find node with namespace: " + namespace + "in module: " + module.toString(),
248 ErrorType.APPLICATION,
249 ErrorTag.UNKNOWN_NAMESPACE,
250 ErrorSeverity.ERROR);
252 } catch (final URISyntaxException e) {
253 LOG.debug("Unable to create URI for namespace : {}", namespace);
256 return dataSchemaNode;
259 private static Datastore extractTargetParameter(final XmlElement operationElement) throws DocumentedException {
260 final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(TARGET_KEY);
261 // Direct lookup instead of using XmlElement class due to performance
262 if (elementsByTagName.getLength() == 0) {
263 final Map<String, String> errorInfo = ImmutableMap.of("bad-attribute", TARGET_KEY, "bad-element",
265 throw new DocumentedException("Missing target element", ErrorType.PROTOCOL, ErrorTag.MISSING_ATTRIBUTE,
266 ErrorSeverity.ERROR, errorInfo);
267 } else if (elementsByTagName.getLength() > 1) {
268 throw new DocumentedException("Multiple target elements", ErrorType.RPC, ErrorTag.UNKNOWN_ATTRIBUTE,
269 ErrorSeverity.ERROR);
271 final XmlElement targetChildNode =
272 XmlElement.fromDomElement((Element) elementsByTagName.item(0)).getOnlyChildElement();
273 return Datastore.valueOf(targetChildNode.getName());
277 private static ModifyAction getDefaultOperation(final XmlElement operationElement) throws DocumentedException {
278 final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(DEFAULT_OPERATION_KEY);
279 if (elementsByTagName.getLength() == 0) {
280 return ModifyAction.MERGE;
281 } else if (elementsByTagName.getLength() > 1) {
282 throw new DocumentedException("Multiple " + DEFAULT_OPERATION_KEY + " elements", ErrorType.RPC,
283 ErrorTag.UNKNOWN_ATTRIBUTE, ErrorSeverity.ERROR);
285 return ModifyAction.fromXmlValue(elementsByTagName.item(0).getTextContent());
290 private static XmlElement getElement(final XmlElement operationElement, final String elementName)
291 throws DocumentedException {
292 final Optional<XmlElement> childNode = operationElement.getOnlyChildElementOptionally(elementName);
293 if (!childNode.isPresent()) {
294 throw new DocumentedException(elementName + " element is missing",
296 ErrorTag.MISSING_ELEMENT,
297 ErrorSeverity.ERROR);
300 return childNode.get();
304 protected String getOperationName() {
305 return OPERATION_NAME;