2 * Copyright (c) 2018 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 org.opendaylight.netconf.api.xml.XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0;
12 import java.io.IOException;
14 import java.net.URISyntaxException;
15 import java.nio.charset.StandardCharsets;
16 import java.nio.file.Files;
17 import java.nio.file.Path;
18 import java.nio.file.Paths;
19 import java.util.List;
20 import java.util.Optional;
21 import java.util.concurrent.ExecutionException;
22 import javax.xml.stream.XMLOutputFactory;
23 import javax.xml.stream.XMLStreamException;
24 import javax.xml.stream.XMLStreamWriter;
25 import javax.xml.transform.dom.DOMResult;
26 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
27 import org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction;
28 import org.opendaylight.netconf.api.DocumentedException;
29 import org.opendaylight.netconf.api.DocumentedException.ErrorSeverity;
30 import org.opendaylight.netconf.api.DocumentedException.ErrorTag;
31 import org.opendaylight.netconf.api.DocumentedException.ErrorType;
32 import org.opendaylight.netconf.api.xml.XmlElement;
33 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
34 import org.opendaylight.netconf.api.xml.XmlUtil;
35 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
36 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
37 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
38 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
40 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
41 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
42 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
43 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
44 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
45 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
46 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
47 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
48 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
50 import org.w3c.dom.Document;
51 import org.w3c.dom.Element;
52 import org.w3c.dom.Node;
54 public final class CopyConfig extends AbstractEdit {
55 private static final String OPERATION_NAME = "copy-config";
56 private static final String SOURCE_KEY = "source";
57 private static final XMLOutputFactory XML_OUTPUT_FACTORY;
60 XML_OUTPUT_FACTORY = XMLOutputFactory.newFactory();
61 XML_OUTPUT_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
64 // Top-level "data" node without child nodes
65 private static final ContainerNode EMPTY_ROOT_NODE = Builders.containerBuilder()
66 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(SchemaContext.NAME)).build();
68 private final TransactionProvider transactionProvider;
70 public CopyConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
71 final TransactionProvider transactionProvider) {
72 super(netconfSessionIdForReporting, schemaContext);
73 this.transactionProvider = transactionProvider;
77 protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
78 throws DocumentedException {
79 final XmlElement targetElement = extractTargetElement(operationElement, OPERATION_NAME);
80 final String target = targetElement.getName();
81 if (Datastore.running.toString().equals(target)) {
82 throw new DocumentedException("edit-config on running datastore is not supported",
84 ErrorTag.OPERATION_NOT_SUPPORTED,
86 } else if (Datastore.candidate.toString().equals(target)) {
87 copyToCandidate(operationElement);
88 } else if (URL_KEY.equals(target)) {
89 copyToUrl(targetElement, operationElement);
91 throw new DocumentedException("Unsupported target: " + target,
96 return document.createElement(XmlNetconfConstants.OK);
99 private void copyToCandidate(final XmlElement operationElement)
100 throws DocumentedException {
101 final XmlElement source = getSourceElement(operationElement);
102 final List<XmlElement> configElements = getConfigElement(source).getChildElements();
104 // <copy-config>, unlike <edit-config>, always replaces entire configuration,
105 // so remove old configuration first:
106 final DOMDataTreeReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
107 rwTx.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.empty(), EMPTY_ROOT_NODE);
109 // Then create nodes present in the <config> element:
110 for (final XmlElement element : configElements) {
111 final String ns = element.getNamespace();
112 final DataSchemaNode schemaNode = getSchemaNodeFromNamespace(ns, element);
113 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
114 parseIntoNormalizedNode(schemaNode, element, ImmutableNormalizedNodeStreamWriter.from(resultHolder));
115 final NormalizedNode<?, ?> data = resultHolder.getResult();
116 final YangInstanceIdentifier path = YangInstanceIdentifier.create(data.getIdentifier());
117 // Doing merge instead of put to support top-level list:
118 rwTx.merge(LogicalDatastoreType.CONFIGURATION, path, data);
122 private static XmlElement getSourceElement(final XmlElement parent) throws DocumentedException {
123 final Optional<XmlElement> sourceElement = parent.getOnlyChildElementOptionally(SOURCE_KEY);
124 if (!sourceElement.isPresent()) {
125 throw new DocumentedException("<source> element is missing",
126 DocumentedException.ErrorType.PROTOCOL,
127 DocumentedException.ErrorTag.MISSING_ELEMENT,
128 DocumentedException.ErrorSeverity.ERROR);
131 return sourceElement.get();
134 private void copyToUrl(final XmlElement urlElement, final XmlElement operationElement) throws DocumentedException {
135 final String url = urlElement.getTextContent();
136 if (!url.startsWith("file:")) {
137 throw new DocumentedException("Unsupported <url> protocol: " + url,
139 ErrorTag.OPERATION_NOT_SUPPORTED,
140 ErrorSeverity.ERROR);
143 // Read data from datastore:
144 final XmlElement source = getSourceElement(operationElement).getOnlyChildElement();
145 final ContainerNode data = readData(source);
147 // Transform NN to XML:
148 final Document document = operationElement.getDomElement().getOwnerDocument();
149 final Node node = transformNormalizedNode(document, data);
152 final String xml = XmlUtil.toString((Element) node);
154 final Path file = Paths.get(new URI(url));
155 Files.write(file, xml.getBytes(StandardCharsets.UTF_8));
156 } catch (URISyntaxException | IllegalArgumentException e) {
157 throw new DocumentedException("Invalid URI: " + url, e,
159 ErrorTag.INVALID_VALUE,
160 ErrorSeverity.ERROR);
161 } catch (IOException e) {
162 throw new DocumentedException("Failed to write : " + url, e,
163 ErrorType.APPLICATION,
164 ErrorTag.OPERATION_FAILED,
165 ErrorSeverity.ERROR);
169 private ContainerNode readData(final XmlElement source) throws DocumentedException {
170 final Datastore sourceDatastore = getDatastore(source);
171 final DOMDataTreeReadWriteTransaction rwTx = getTransaction(sourceDatastore);
172 final YangInstanceIdentifier dataRoot = YangInstanceIdentifier.empty();
174 final Optional<NormalizedNode<?, ?>> normalizedNodeOptional = rwTx.read(
175 LogicalDatastoreType.CONFIGURATION, dataRoot).get();
176 if (sourceDatastore == Datastore.running) {
177 transactionProvider.abortRunningTransaction(rwTx);
179 return (ContainerNode) normalizedNodeOptional.get();
180 } catch (InterruptedException | ExecutionException e) {
181 throw new IllegalStateException("Unable to read data " + dataRoot, e);
185 private static Datastore getDatastore(final XmlElement source) throws DocumentedException {
187 return Datastore.valueOf(source.getName());
188 } catch (IllegalArgumentException e) {
189 throw new DocumentedException("Unsupported source for <url> target", e,
191 ErrorTag.OPERATION_NOT_SUPPORTED,
192 ErrorSeverity.ERROR);
196 private DOMDataTreeReadWriteTransaction getTransaction(final Datastore datastore) throws DocumentedException {
197 if (datastore == Datastore.candidate) {
198 return transactionProvider.getOrCreateTransaction();
199 } else if (datastore == Datastore.running) {
200 return transactionProvider.createRunningTransaction();
202 throw new DocumentedException("Incorrect Datastore: ", ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT,
203 ErrorSeverity.ERROR);
206 private Node transformNormalizedNode(final Document document, final ContainerNode data) {
207 final Element configElement = document.createElementNS(URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, CONFIG_KEY);
208 final DOMResult result = new DOMResult(configElement);
210 final XMLStreamWriter xmlWriter = XML_OUTPUT_FACTORY.createXMLStreamWriter(result);
211 final NormalizedNodeStreamWriter nnStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter,
212 schemaContext.getCurrentContext(), SchemaPath.ROOT);
214 final NormalizedNodeWriter nnWriter = NormalizedNodeWriter.forStreamWriter(nnStreamWriter, true);
215 for (DataContainerChild<? extends YangInstanceIdentifier.PathArgument, ?> child : data.getValue()) {
216 nnWriter.write(child);
220 } catch (XMLStreamException | IOException e) {
221 throw new RuntimeException(e);
223 return result.getNode();
227 protected String getOperationName() {
228 return OPERATION_NAME;