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 java.io.IOException;
12 import java.net.URISyntaxException;
13 import java.util.Collection;
15 import java.util.Optional;
16 import java.util.concurrent.ExecutionException;
17 import javax.xml.stream.XMLOutputFactory;
18 import javax.xml.stream.XMLStreamException;
19 import javax.xml.stream.XMLStreamWriter;
20 import javax.xml.transform.dom.DOMResult;
21 import javax.xml.transform.dom.DOMSource;
22 import org.eclipse.jdt.annotation.Nullable;
23 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
24 import org.opendaylight.mdsal.dom.api.DOMRpcService;
25 import org.opendaylight.netconf.api.DocumentedException;
26 import org.opendaylight.netconf.api.DocumentedException.ErrorSeverity;
27 import org.opendaylight.netconf.api.DocumentedException.ErrorTag;
28 import org.opendaylight.netconf.api.DocumentedException.ErrorType;
29 import org.opendaylight.netconf.api.NetconfDocumentedException;
30 import org.opendaylight.netconf.api.xml.XmlElement;
31 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
32 import org.opendaylight.netconf.api.xml.XmlUtil;
33 import org.opendaylight.netconf.mapping.api.HandlingPriority;
34 import org.opendaylight.netconf.mapping.api.NetconfOperationChainedExecution;
35 import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext;
36 import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation;
37 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
39 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
40 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
41 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
42 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
43 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
44 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
45 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaOrderedNormalizedNodeWriter;
46 import org.opendaylight.yangtools.yang.model.api.InputSchemaNode;
47 import org.opendaylight.yangtools.yang.model.api.Module;
48 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
50 import org.slf4j.Logger;
51 import org.slf4j.LoggerFactory;
52 import org.w3c.dom.Attr;
53 import org.w3c.dom.Document;
54 import org.w3c.dom.Element;
55 import org.w3c.dom.Node;
56 import org.w3c.dom.NodeList;
57 import org.xml.sax.SAXException;
59 public class RuntimeRpc extends AbstractSingletonNetconfOperation {
61 private static final Logger LOG = LoggerFactory.getLogger(RuntimeRpc.class);
63 private static final XMLOutputFactory XML_OUTPUT_FACTORY;
66 XML_OUTPUT_FACTORY = XMLOutputFactory.newFactory();
67 XML_OUTPUT_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE);
70 private final CurrentSchemaContext schemaContext;
71 private final DOMRpcService rpcService;
73 public RuntimeRpc(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext,
74 final DOMRpcService rpcService) {
75 super(netconfSessionIdForReporting);
76 this.schemaContext = schemaContext;
77 this.rpcService = rpcService;
81 protected HandlingPriority canHandle(final String netconfOperationName, final String namespace) {
82 final URI namespaceURI = createNsUri(namespace);
83 final Optional<? extends Module> module = getModule(namespaceURI);
85 if (module.isEmpty()) {
86 LOG.debug("Cannot handle rpc: {}, {}", netconfOperationName, namespace);
87 return HandlingPriority.CANNOT_HANDLE;
90 getRpcDefinitionFromModule(module.get(), namespaceURI, netconfOperationName);
91 return HandlingPriority.HANDLE_WITH_DEFAULT_PRIORITY;
96 protected String getOperationName() {
97 throw new UnsupportedOperationException("Runtime rpc does not have a stable name");
100 private static URI createNsUri(final String namespace) {
101 // May throw IllegalArgumentException, but that should never happen, as the namespace comes from parsed XML
102 return URI.create(namespace);
105 //this returns module with the newest revision if more then 1 module with same namespace is found
106 private Optional<? extends Module> getModule(final URI namespaceURI) {
107 return schemaContext.getCurrentContext().findModules(namespaceURI).stream().findFirst();
110 private static Optional<RpcDefinition> getRpcDefinitionFromModule(final Module module, final URI namespaceURI,
112 for (final RpcDefinition rpcDef : module.getRpcs()) {
113 if (rpcDef.getQName().getNamespace().equals(namespaceURI)
114 && rpcDef.getQName().getLocalName().equals(name)) {
115 return Optional.of(rpcDef);
118 return Optional.empty();
122 protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement)
123 throws DocumentedException {
125 final String netconfOperationName = operationElement.getName();
126 final String netconfOperationNamespace;
128 netconfOperationNamespace = operationElement.getNamespace();
129 } catch (final DocumentedException e) {
130 LOG.debug("Cannot retrieve netconf operation namespace from message due to ", e);
131 throw new DocumentedException("Cannot retrieve netconf operation namespace from message", e,
132 ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE, ErrorSeverity.ERROR);
135 final URI namespaceURI = createNsUri(netconfOperationNamespace);
136 final Optional<? extends Module> moduleOptional = getModule(namespaceURI);
138 if (moduleOptional.isEmpty()) {
139 throw new DocumentedException("Unable to find module in Schema Context with namespace and name : "
140 + namespaceURI + " " + netconfOperationName + schemaContext.getCurrentContext(),
141 ErrorType.APPLICATION, ErrorTag.BAD_ELEMENT, ErrorSeverity.ERROR);
144 final Optional<RpcDefinition> rpcDefinitionOptional = getRpcDefinitionFromModule(moduleOptional.get(),
145 namespaceURI, netconfOperationName);
147 if (rpcDefinitionOptional.isEmpty()) {
148 throw new DocumentedException(
149 "Unable to find RpcDefinition with namespace and name : "
150 + namespaceURI + " " + netconfOperationName,
151 ErrorType.APPLICATION, ErrorTag.BAD_ELEMENT, ErrorSeverity.ERROR);
154 final RpcDefinition rpcDefinition = rpcDefinitionOptional.get();
155 final ContainerNode inputNode = rpcToNNode(operationElement, rpcDefinition.getInput());
157 final DOMRpcResult result;
159 result = rpcService.invokeRpc(rpcDefinition.getQName(), inputNode).get();
160 } catch (final InterruptedException | ExecutionException e) {
161 throw DocumentedException.wrap(e);
163 if (result.getResult() == null) {
164 return XmlUtil.createElement(document, XmlNetconfConstants.OK,
165 Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0));
167 return (Element) transformNormalizedNode(document, result.getResult(), rpcDefinition.getOutput().getPath());
171 public Document handle(final Document requestMessage,
172 final NetconfOperationChainedExecution subsequentOperation) throws DocumentedException {
174 final XmlElement requestElement = getRequestElementWithCheck(requestMessage);
176 final Document document = XmlUtil.newDocument();
178 final XmlElement operationElement = requestElement.getOnlyChildElement();
179 final Map<String, Attr> attributes = requestElement.getAttributes();
181 final Element response = handle(document, operationElement, subsequentOperation);
182 final Element rpcReply = XmlUtil.createElement(document, XmlNetconfConstants.RPC_REPLY_KEY,
183 Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0));
185 if (XmlElement.fromDomElement(response).hasNamespace()) {
186 rpcReply.appendChild(response);
188 final NodeList list = response.getChildNodes();
189 if (list.getLength() == 0) {
190 rpcReply.appendChild(response);
192 while (list.getLength() != 0) {
193 rpcReply.appendChild(list.item(0));
198 for (final Attr attribute : attributes.values()) {
199 rpcReply.setAttributeNode((Attr) document.importNode(attribute, true));
201 document.appendChild(rpcReply);
205 private Node transformNormalizedNode(final Document document, final NormalizedNode<?, ?> data,
206 final SchemaPath rpcOutputPath) {
207 final DOMResult result = new DOMResult(document.createElement(XmlNetconfConstants.RPC_REPLY_KEY));
209 final XMLStreamWriter xmlWriter = getXmlStreamWriter(result);
211 final NormalizedNodeStreamWriter nnStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter,
212 schemaContext.getCurrentContext(), rpcOutputPath);
214 final SchemaOrderedNormalizedNodeWriter nnWriter =
215 new SchemaOrderedNormalizedNodeWriter(nnStreamWriter, schemaContext.getCurrentContext(), rpcOutputPath);
217 writeRootElement(xmlWriter, nnWriter, (ContainerNode) data);
219 nnStreamWriter.close();
221 } catch (IOException | XMLStreamException e) {
222 LOG.warn("Error while closing streams", e);
225 return result.getNode();
228 private static XMLStreamWriter getXmlStreamWriter(final DOMResult result) {
230 return XML_OUTPUT_FACTORY.createXMLStreamWriter(result);
231 } catch (final XMLStreamException e) {
232 throw new RuntimeException(e);
236 private static void writeRootElement(final XMLStreamWriter xmlWriter,
237 final SchemaOrderedNormalizedNodeWriter nnWriter, final ContainerNode data) {
239 final Collection<DataContainerChild<?, ?>> value = data.getValue();
240 nnWriter.write(value);
243 } catch (XMLStreamException | IOException e) {
244 throw new RuntimeException(e);
249 * Parses xml element rpc input into normalized node or null if rpc does not take any input.
251 * @param element rpc xml element
252 * @param input input container schema node, or null if rpc does not take any input
253 * @return parsed rpc into normalized node, or null if input schema is null
255 private @Nullable ContainerNode rpcToNNode(final XmlElement element,
256 final @Nullable InputSchemaNode input) throws DocumentedException {
257 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
258 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
259 final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext.getCurrentContext(), input);
262 xmlParser.traverse(new DOMSource(element.getDomElement()));
263 } catch (final XMLStreamException | URISyntaxException | IOException | SAXException ex) {
264 throw new NetconfDocumentedException("Error parsing input: " + ex.getMessage(), ex, ErrorType.PROTOCOL,
265 ErrorTag.MALFORMED_MESSAGE, ErrorSeverity.ERROR);
268 return (ContainerNode) resultHolder.getResult();