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.controller.netconf.mdsal.connector.ops;
11 import com.google.common.base.Optional;
12 import com.google.common.util.concurrent.CheckedFuture;
14 import java.net.URISyntaxException;
15 import java.util.Collections;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
18 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
19 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
20 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorSeverity;
21 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorTag;
22 import org.opendaylight.controller.netconf.api.NetconfDocumentedException.ErrorType;
23 import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
24 import org.opendaylight.controller.netconf.mdsal.connector.CurrentSchemaContext;
25 import org.opendaylight.controller.netconf.mdsal.connector.TransactionProvider;
26 import org.opendaylight.controller.netconf.util.mapping.AbstractSingletonNetconfOperation;
27 import org.opendaylight.controller.netconf.util.xml.XmlElement;
28 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
29 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
30 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
31 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
34 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils;
35 import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
36 import org.opendaylight.yangtools.yang.data.operations.DataModificationException;
37 import org.opendaylight.yangtools.yang.data.operations.DataModificationException.DataExistsException;
38 import org.opendaylight.yangtools.yang.data.operations.DataModificationException.DataMissingException;
39 import org.opendaylight.yangtools.yang.data.operations.DataOperations;
40 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
42 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
43 import org.opendaylight.yangtools.yang.model.api.Module;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46 import org.w3c.dom.Document;
47 import org.w3c.dom.Element;
48 import org.w3c.dom.NodeList;
50 public class EditConfig extends AbstractSingletonNetconfOperation {
52 private static final Logger LOG = LoggerFactory.getLogger(EditConfig.class);
54 private static final String OPERATION_NAME = "edit-config";
55 private static final String CONFIG_KEY = "config";
56 private static final String TARGET_KEY = "target";
57 private static final String DEFAULT_OPERATION_KEY = "default-operation";
60 private final CurrentSchemaContext schemaContext;
61 private final TransactionProvider transactionProvider;
63 public EditConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext, final TransactionProvider transactionProvider) {
64 super(netconfSessionIdForReporting);
65 this.schemaContext = schemaContext;
66 this.transactionProvider = transactionProvider;
70 protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement) throws NetconfDocumentedException {
71 final Datastore targetDatastore = extractTargetParameter(operationElement);
72 if (targetDatastore == Datastore.running) {
73 throw new NetconfDocumentedException("edit-config on running datastore is not supported",
75 ErrorTag.operation_not_supported,
79 final ModifyAction defaultAction = getDefaultOperation(operationElement);
81 final XmlElement configElement = getElement(operationElement, CONFIG_KEY);
83 for (XmlElement element : configElement.getChildElements()) {
84 final String ns = element.getNamespace();
85 final DataSchemaNode schemaNode = getSchemaNodeFromNamespace(ns, element).get();
86 YangInstanceIdentifier ident = YangInstanceIdentifier.of(schemaNode.getQName());
88 final NormalizedNode storedNode = readStoredNode(LogicalDatastoreType.CONFIGURATION, ident);
90 final Optional<NormalizedNode<?, ?>> newNode = modifyNode(schemaNode, element, storedNode, defaultAction);
91 final DOMDataReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
92 if (newNode.isPresent()) {
93 rwTx.put(LogicalDatastoreType.CONFIGURATION, ident, newNode.get());
95 rwTx.delete(LogicalDatastoreType.CONFIGURATION, ident);
97 } catch (final DataExistsException e) {
98 throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.protocol, ErrorTag.data_exists, ErrorSeverity.error);
99 } catch (final DataMissingException e) {
100 throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.protocol, ErrorTag.data_missing, ErrorSeverity.error);
101 } catch (final DataModificationException e) {
102 throw new NetconfDocumentedException(e.getMessage(), e, ErrorType.protocol, ErrorTag.operation_failed, ErrorSeverity.error);
106 return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.<String>absent());
109 private NormalizedNode readStoredNode(final LogicalDatastoreType logicalDatastoreType, final YangInstanceIdentifier path) throws NetconfDocumentedException{
110 final DOMDataReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
111 final CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> readFuture = rwTx.read(logicalDatastoreType, path);
113 if (readFuture.checkedGet().isPresent()) {
114 final NormalizedNode node = readFuture.checkedGet().get();
117 LOG.debug("Unable to read node : {} from {} datastore", path, logicalDatastoreType);
119 } catch (final ReadFailedException e) {
120 //only log this since DataOperations.modify will handle throwing an exception or writing the node.
121 LOG.debug("Unable to read stored data: {}", path, e);
124 //we can return null here since DataOperations.modify handles null as input
128 private Optional<DataSchemaNode> getSchemaNodeFromNamespace(final String namespace, final XmlElement element) throws NetconfDocumentedException{
129 Optional<DataSchemaNode> dataSchemaNode = Optional.absent();
131 //returns module with newest revision since findModuleByNamespace returns a set of modules and we only need the newest one
132 final Module module = schemaContext.getCurrentContext().findModuleByNamespaceAndRevision(new URI(namespace), null);
133 DataSchemaNode schemaNode = module.getDataChildByName(element.getName());
134 if (schemaNode != null) {
135 dataSchemaNode = Optional.of(module.getDataChildByName(element.getName()));
137 throw new NetconfDocumentedException("Unable to find node with namespace: " + namespace + "in module: " + module.toString(),
138 ErrorType.application,
139 ErrorTag.unknown_namespace,
140 ErrorSeverity.error);
143 } catch (URISyntaxException e) {
144 LOG.debug("Unable to create URI for namespace : {}", namespace);
147 return dataSchemaNode;
150 private Optional<NormalizedNode<?, ?>> modifyNode(final DataSchemaNode schemaNode, final XmlElement element, final NormalizedNode storedNode, final ModifyAction defaultAction) throws DataModificationException{
151 if (schemaNode instanceof ContainerSchemaNode) {
152 final ContainerNode modifiedNode =
153 DomToNormalizedNodeParserFactory
154 .getInstance(DomUtils.defaultValueCodecProvider())
155 .getContainerNodeParser()
156 .parse(Collections.singletonList(element.getDomElement()), (ContainerSchemaNode) schemaNode);
158 final Optional<ContainerNode> oNode = DataOperations.modify((ContainerSchemaNode) schemaNode, (ContainerNode) storedNode, modifiedNode, defaultAction);
159 if (!oNode.isPresent()) {
160 return Optional.absent();
163 final NormalizedNode<?,?> node = oNode.get();
164 return Optional.<NormalizedNode<?,?>>of(node);
165 } else if (schemaNode instanceof ListSchemaNode) {
166 final MapNode modifiedNode =
167 DomToNormalizedNodeParserFactory
168 .getInstance(DomUtils.defaultValueCodecProvider())
170 .parse(Collections.singletonList(element.getDomElement()), (ListSchemaNode) schemaNode);
172 final Optional<MapNode> oNode = DataOperations.modify((ListSchemaNode) schemaNode, (MapNode) storedNode, modifiedNode, defaultAction);
173 if (!oNode.isPresent()) {
174 return Optional.absent();
177 final NormalizedNode<?, ?> node = oNode.get();
178 return Optional.<NormalizedNode<?,?>>of(node);
180 //this should never happen since edit-config on any other node type should not be possible nor makes sense
181 LOG.debug("DataNode from module is not ContainerSchemaNode nor ListSchemaNode, aborting..");
182 return Optional.absent();
186 private Datastore extractTargetParameter(final XmlElement operationElement) throws NetconfDocumentedException {
187 final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(TARGET_KEY);
188 // Direct lookup instead of using XmlElement class due to performance
189 if (elementsByTagName.getLength() == 0) {
190 throw new NetconfDocumentedException("Missing target element", ErrorType.rpc, ErrorTag.missing_attribute, ErrorSeverity.error);
191 } else if (elementsByTagName.getLength() > 1) {
192 throw new NetconfDocumentedException("Multiple target elements", ErrorType.rpc, ErrorTag.unknown_attribute, ErrorSeverity.error);
194 final XmlElement targetChildNode = XmlElement.fromDomElement((Element) elementsByTagName.item(0)).getOnlyChildElement();
195 return Datastore.valueOf(targetChildNode.getName());
199 private ModifyAction getDefaultOperation(final XmlElement operationElement) throws NetconfDocumentedException {
200 final NodeList elementsByTagName = operationElement.getDomElement().getElementsByTagName(DEFAULT_OPERATION_KEY);
201 if(elementsByTagName.getLength() == 0) {
202 return ModifyAction.MERGE;
203 } else if(elementsByTagName.getLength() > 1) {
204 throw new NetconfDocumentedException("Multiple " + DEFAULT_OPERATION_KEY + " elements",
205 ErrorType.rpc, ErrorTag.unknown_attribute, ErrorSeverity.error);
207 return ModifyAction.fromXmlValue(elementsByTagName.item(0).getTextContent());
212 private XmlElement getElement(final XmlElement operationElement, String elementName) throws NetconfDocumentedException {
213 final Optional<XmlElement> childNode = operationElement.getOnlyChildElementOptionally(elementName);
214 if (!childNode.isPresent()) {
215 throw new NetconfDocumentedException(elementName + " element is missing",
217 ErrorTag.missing_element,
218 ErrorSeverity.error);
221 return childNode.get();
225 protected String getOperationName() {
226 return OPERATION_NAME;