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.xml.XmlElement;
30 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
31 import org.opendaylight.netconf.api.xml.XmlUtil;
32 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
33 import org.opendaylight.netconf.mdsal.connector.TransactionProvider;
34 import org.opendaylight.yangtools.yang.common.ErrorSeverity;
35 import org.opendaylight.yangtools.yang.common.ErrorTag;
36 import org.opendaylight.yangtools.yang.common.ErrorType;
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.SchemaContext;
48 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
49 import org.w3c.dom.Document;
50 import org.w3c.dom.Element;
51 import org.w3c.dom.Node;
53 public final class CopyConfig extends AbstractEdit {
54 private static final String OPERATION_NAME = "copy-config";
55 private static final String SOURCE_KEY = "source";
56 private static final XMLOutputFactory XML_OUTPUT_FACTORY;
59 XML_OUTPUT_FACTORY = XMLOutputFactory.newFactory();
60 XML_OUTPUT_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true);
63 // Top-level "data" node without child nodes
64 private static final ContainerNode EMPTY_ROOT_NODE = Builders.containerBuilder()
65 .withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(SchemaContext.NAME)).build();
67 private final TransactionProvider transactionProvider;
69 public CopyConfig(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
70 final TransactionProvider transactionProvider) {
71 super(netconfSessionIdForReporting, schemaContext);
72 this.transactionProvider = transactionProvider;
76 protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
77 throws DocumentedException {
78 final XmlElement targetElement = extractTargetElement(operationElement, OPERATION_NAME);
79 final String target = targetElement.getName();
80 if (Datastore.running.toString().equals(target)) {
81 throw new DocumentedException("edit-config on running datastore is not supported",
82 ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED, ErrorSeverity.ERROR);
83 } else if (Datastore.candidate.toString().equals(target)) {
84 copyToCandidate(operationElement);
85 } else if (URL_KEY.equals(target)) {
86 copyToUrl(targetElement, operationElement);
88 throw new DocumentedException("Unsupported target: " + target,
89 ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT, ErrorSeverity.ERROR);
91 return document.createElement(XmlNetconfConstants.OK);
94 private void copyToCandidate(final XmlElement operationElement)
95 throws DocumentedException {
96 final XmlElement source = getSourceElement(operationElement);
97 final List<XmlElement> configElements = getConfigElement(source).getChildElements();
99 // <copy-config>, unlike <edit-config>, always replaces entire configuration,
100 // so remove old configuration first:
101 final DOMDataTreeReadWriteTransaction rwTx = transactionProvider.getOrCreateTransaction();
102 rwTx.put(LogicalDatastoreType.CONFIGURATION, YangInstanceIdentifier.empty(), EMPTY_ROOT_NODE);
104 // Then create nodes present in the <config> element:
105 for (final XmlElement element : configElements) {
106 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
107 parseIntoNormalizedNode(getSchemaNodeFromNamespace(element.getNamespace(), element), element,
108 ImmutableNormalizedNodeStreamWriter.from(resultHolder));
109 final NormalizedNode data = resultHolder.getResult();
110 final YangInstanceIdentifier path = YangInstanceIdentifier.create(data.getIdentifier());
111 // Doing merge instead of put to support top-level list:
112 rwTx.merge(LogicalDatastoreType.CONFIGURATION, path, data);
116 private static XmlElement getSourceElement(final XmlElement parent) throws DocumentedException {
117 final Optional<XmlElement> sourceElement = parent.getOnlyChildElementOptionally(SOURCE_KEY);
118 if (sourceElement.isEmpty()) {
119 throw new DocumentedException("<source> element is missing",
120 ErrorType.PROTOCOL, ErrorTag.MISSING_ELEMENT, ErrorSeverity.ERROR);
123 return sourceElement.get();
126 private void copyToUrl(final XmlElement urlElement, final XmlElement operationElement) throws DocumentedException {
127 final String url = urlElement.getTextContent();
128 if (!url.startsWith("file:")) {
129 throw new DocumentedException("Unsupported <url> protocol: " + url,
130 ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED, ErrorSeverity.ERROR);
133 // Read data from datastore:
134 final XmlElement source = getSourceElement(operationElement).getOnlyChildElement();
135 final ContainerNode data = readData(source);
137 // Transform NN to XML:
138 final Document document = operationElement.getDomElement().getOwnerDocument();
139 final Node node = transformNormalizedNode(document, data);
142 final String xml = XmlUtil.toString((Element) node);
144 final Path file = Paths.get(new URI(url));
145 Files.write(file, xml.getBytes(StandardCharsets.UTF_8));
146 } catch (URISyntaxException | IllegalArgumentException e) {
147 throw new DocumentedException("Invalid URI: " + url, e,
148 ErrorType.RPC, ErrorTag.INVALID_VALUE, ErrorSeverity.ERROR);
149 } catch (IOException e) {
150 throw new DocumentedException("Failed to write : " + url, e,
151 ErrorType.APPLICATION, ErrorTag.OPERATION_FAILED, ErrorSeverity.ERROR);
155 private ContainerNode readData(final XmlElement source) throws DocumentedException {
156 final Datastore sourceDatastore = getDatastore(source);
157 final DOMDataTreeReadWriteTransaction rwTx = getTransaction(sourceDatastore);
158 final YangInstanceIdentifier dataRoot = YangInstanceIdentifier.empty();
160 final Optional<NormalizedNode> normalizedNodeOptional = rwTx.read(
161 LogicalDatastoreType.CONFIGURATION, dataRoot).get();
162 if (sourceDatastore == Datastore.running) {
163 transactionProvider.abortRunningTransaction(rwTx);
165 return (ContainerNode) normalizedNodeOptional.get();
166 } catch (InterruptedException | ExecutionException e) {
167 throw new IllegalStateException("Unable to read data " + dataRoot, e);
171 private static Datastore getDatastore(final XmlElement source) throws DocumentedException {
173 return Datastore.valueOf(source.getName());
174 } catch (IllegalArgumentException e) {
175 throw new DocumentedException("Unsupported source for <url> target", e,
176 ErrorType.PROTOCOL, ErrorTag.OPERATION_NOT_SUPPORTED, ErrorSeverity.ERROR);
180 private DOMDataTreeReadWriteTransaction getTransaction(final Datastore datastore) throws DocumentedException {
181 if (datastore == Datastore.candidate) {
182 return transactionProvider.getOrCreateTransaction();
183 } else if (datastore == Datastore.running) {
184 return transactionProvider.createRunningTransaction();
186 throw new DocumentedException("Incorrect Datastore: ", ErrorType.PROTOCOL, ErrorTag.BAD_ELEMENT,
187 ErrorSeverity.ERROR);
190 private Node transformNormalizedNode(final Document document, final ContainerNode data) {
191 final Element configElement = document.createElementNS(URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0, CONFIG_KEY);
192 final DOMResult result = new DOMResult(configElement);
194 final XMLStreamWriter xmlWriter = XML_OUTPUT_FACTORY.createXMLStreamWriter(result);
195 final NormalizedNodeStreamWriter nnStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter,
196 schemaContext.getCurrentContext(), SchemaPath.ROOT);
198 final NormalizedNodeWriter nnWriter = NormalizedNodeWriter.forStreamWriter(nnStreamWriter, true);
199 for (DataContainerChild child : data.body()) {
200 nnWriter.write(child);
204 } catch (XMLStreamException | IOException e) {
205 throw new RuntimeException(e);
207 return result.getNode();
211 protected String getOperationName() {
212 return OPERATION_NAME;