2 * Copyright (c) 2014 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.sal.connect.netconf.schema.mapping;
10 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS;
11 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_URI;
12 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
14 import com.google.common.annotations.VisibleForTesting;
15 import com.google.common.base.Preconditions;
16 import com.google.common.collect.ImmutableSet;
17 import com.google.common.collect.ImmutableSet.Builder;
18 import com.google.common.collect.Maps;
19 import com.google.common.collect.Multimap;
20 import com.google.common.collect.Multimaps;
21 import java.io.IOException;
22 import java.net.URISyntaxException;
23 import java.time.Instant;
24 import java.util.Collection;
25 import java.util.Collections;
28 import javax.xml.parsers.ParserConfigurationException;
29 import javax.xml.stream.XMLStreamException;
30 import javax.xml.transform.dom.DOMResult;
31 import javax.xml.transform.dom.DOMSource;
32 import org.opendaylight.mdsal.dom.api.DOMActionResult;
33 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
34 import org.opendaylight.mdsal.dom.api.DOMEvent;
35 import org.opendaylight.mdsal.dom.api.DOMNotification;
36 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
37 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
38 import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
39 import org.opendaylight.netconf.api.NetconfMessage;
40 import org.opendaylight.netconf.api.xml.MissingNameSpaceException;
41 import org.opendaylight.netconf.api.xml.XmlElement;
42 import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
43 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
44 import org.opendaylight.netconf.sal.connect.util.MessageCounter;
45 import org.opendaylight.yangtools.yang.common.QName;
46 import org.opendaylight.yangtools.yang.common.Revision;
47 import org.opendaylight.yangtools.yang.common.RpcError;
48 import org.opendaylight.yangtools.yang.common.YangConstants;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
50 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
51 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
52 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
53 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
54 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
55 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
56 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
57 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
58 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
59 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
60 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
61 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
62 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
63 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
64 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
65 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
66 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
67 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
68 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
69 import org.slf4j.Logger;
70 import org.slf4j.LoggerFactory;
71 import org.w3c.dom.Document;
72 import org.w3c.dom.Element;
73 import org.xml.sax.SAXException;
75 public class NetconfMessageTransformer implements MessageTransformer<NetconfMessage> {
77 private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageTransformer.class);
79 private final SchemaContext schemaContext;
80 private final BaseSchema baseSchema;
81 private final MessageCounter counter;
82 private final Map<QName, RpcDefinition> mappedRpcs;
83 private final Multimap<QName, NotificationDefinition> mappedNotifications;
84 private final boolean strictParsing;
85 private final Set<ActionDefinition> actions;
87 public NetconfMessageTransformer(final SchemaContext schemaContext, final boolean strictParsing) {
88 this(schemaContext, strictParsing, BaseSchema.BASE_NETCONF_CTX);
91 public NetconfMessageTransformer(final SchemaContext schemaContext, final boolean strictParsing,
92 final BaseSchema baseSchema) {
93 this.counter = new MessageCounter();
94 this.schemaContext = schemaContext;
95 this.mappedRpcs = Maps.uniqueIndex(schemaContext.getOperations(), SchemaNode::getQName);
96 this.actions = getActions();
97 this.mappedNotifications = Multimaps.index(schemaContext.getNotifications(),
98 node -> node.getQName().withoutRevision());
99 this.baseSchema = baseSchema;
100 this.strictParsing = strictParsing;
104 Set<ActionDefinition> getActions() {
105 Builder<ActionDefinition> builder = ImmutableSet.builder();
106 for (DataSchemaNode dataSchemaNode : schemaContext.getChildNodes()) {
107 if (dataSchemaNode instanceof ActionNodeContainer) {
108 findAction(dataSchemaNode, builder);
111 return builder.build();
114 private void findAction(final DataSchemaNode dataSchemaNode, final Builder<ActionDefinition> builder) {
115 if (dataSchemaNode instanceof ActionNodeContainer) {
116 final ActionNodeContainer containerSchemaNode = (ActionNodeContainer) dataSchemaNode;
117 for (ActionDefinition actionDefinition : containerSchemaNode.getActions()) {
118 builder.add(actionDefinition);
121 if (dataSchemaNode instanceof DataNodeContainer) {
122 for (DataSchemaNode innerDataSchemaNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) {
123 findAction(innerDataSchemaNode, builder);
129 public synchronized DOMNotification toNotification(final NetconfMessage message) {
130 final Map.Entry<Instant, XmlElement> stripped = NetconfMessageTransformUtil.stripNotification(message);
131 final QName notificationNoRev;
133 notificationNoRev = QName.create(
134 stripped.getValue().getNamespace(), stripped.getValue().getName()).withoutRevision();
135 } catch (final MissingNameSpaceException e) {
136 throw new IllegalArgumentException(
137 "Unable to parse notification " + message + ", cannot find namespace", e);
139 final Collection<NotificationDefinition> notificationDefinitions = mappedNotifications.get(notificationNoRev);
140 Preconditions.checkArgument(notificationDefinitions.size() > 0,
141 "Unable to parse notification %s, unknown notification. Available notifications: %s",
142 notificationDefinitions, mappedNotifications.keySet());
144 final NotificationDefinition mostRecentNotification = getMostRecentNotification(notificationDefinitions);
146 final ContainerSchemaNode notificationAsContainerSchemaNode =
147 NetconfMessageTransformUtil.createSchemaForNotification(mostRecentNotification);
149 final Element element = stripped.getValue().getDomElement();
150 final ContainerNode content;
152 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
153 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
154 final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext,
155 notificationAsContainerSchemaNode, strictParsing);
156 xmlParser.traverse(new DOMSource(element));
157 content = (ContainerNode) resultHolder.getResult();
158 } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
159 | SAXException | UnsupportedOperationException e) {
160 throw new IllegalArgumentException(String.format("Failed to parse notification %s", element), e);
162 return new NetconfDeviceNotification(content, stripped.getKey());
165 private static NotificationDefinition getMostRecentNotification(
166 final Collection<NotificationDefinition> notificationDefinitions) {
167 return Collections.max(notificationDefinitions, (o1, o2) ->
168 Revision.compare(o1.getQName().getRevision(), o2.getQName().getRevision()));
172 public NetconfMessage toRpcRequest(final SchemaPath rpc, final NormalizedNode<?, ?> payload) {
173 // In case no input for rpc is defined, we can simply construct the payload here
174 final QName rpcQName = rpc.getLastComponent();
176 // Determine whether a base netconf operation is being invoked
177 // and also check if the device exposed model for base netconf.
178 // If no, use pre built base netconf operations model
179 final boolean needToUseBaseCtx = mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName);
180 final Map<QName, RpcDefinition> currentMappedRpcs;
181 if (needToUseBaseCtx) {
182 currentMappedRpcs = baseSchema.getMappedRpcs();
184 currentMappedRpcs = mappedRpcs;
187 final RpcDefinition mappedRpc = Preconditions.checkNotNull(currentMappedRpcs.get(rpcQName),
188 "Unknown rpc %s, available rpcs: %s", rpcQName, currentMappedRpcs.keySet());
189 if (mappedRpc.getInput().getChildNodes().isEmpty()) {
190 return new NetconfMessage(NetconfMessageTransformUtil
191 .prepareDomResultForRpcRequest(rpcQName, counter).getNode().getOwnerDocument());
194 Preconditions.checkNotNull(payload, "Transforming an rpc with input: %s, payload cannot be null", rpcQName);
196 Preconditions.checkArgument(payload instanceof ContainerNode,
197 "Transforming an rpc with input: %s, payload has to be a container, but was: %s", rpcQName, payload);
198 // Set the path to the input of rpc for the node stream writer
199 final SchemaPath rpcInput = rpc.createChild(YangConstants.operationInputQName(rpcQName.getModule()));
200 final DOMResult result = NetconfMessageTransformUtil.prepareDomResultForRpcRequest(rpcQName, counter);
203 // If the schema context for netconf device does not contain model for base netconf operations,
204 // use default pre build context with just the base model
205 // This way operations like lock/unlock are supported even if the source for base model was not provided
206 SchemaContext ctx = needToUseBaseCtx ? baseSchema.getSchemaContext() : schemaContext;
207 NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result, rpcInput, ctx);
208 } catch (final XMLStreamException | IOException | IllegalStateException e) {
209 throw new IllegalStateException("Unable to serialize " + rpcInput, e);
212 final Document node = result.getNode().getOwnerDocument();
214 return new NetconfMessage(node);
218 public NetconfMessage toActionRequest(final SchemaPath action, final DOMDataTreeIdentifier domDataTreeIdentifier,
219 final NormalizedNode<?, ?> payload) {
220 ActionDefinition actionDefinition = null;
221 for (ActionDefinition actionDef : actions) {
222 if (actionDef.getPath().getLastComponent().equals(action.getLastComponent())) {
223 actionDefinition = actionDef;
226 Preconditions.checkNotNull(actionDefinition, "Action does not exist: %s", action.getLastComponent());
228 final ContainerSchemaNode inputDef = actionDefinition.getInput();
229 if (inputDef.getChildNodes().isEmpty()) {
230 return new NetconfMessage(NetconfMessageTransformUtil.prepareDomResultForActionRequest(
231 DataSchemaContextTree.from(schemaContext), domDataTreeIdentifier, action, counter,
232 actionDefinition.getQName().getLocalName()).getNode().getOwnerDocument());
235 Preconditions.checkNotNull(payload, "Transforming an action with input: %s, payload cannot be null",
236 action.getLastComponent());
237 Preconditions.checkArgument(payload instanceof ContainerNode,
238 "Transforming an rpc with input: %s, payload has to be a container, but was: %s",
239 action.getLastComponent(), payload);
241 // Set the path to the input of action for the node stream writer
242 final DOMResult result = NetconfMessageTransformUtil.prepareDomResultForActionRequest(
243 DataSchemaContextTree.from(schemaContext), domDataTreeIdentifier, inputDef.getPath(), counter,
244 actionDefinition.getQName().getLocalName());
247 NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result, inputDef.getPath(),
249 } catch (final XMLStreamException | IOException | IllegalStateException e) {
250 throw new IllegalStateException("Unable to serialize " + action, e);
253 final Document node = result.getNode().getOwnerDocument();
255 return new NetconfMessage(node);
258 private static boolean isBaseOrNotificationRpc(final QName rpc) {
259 return rpc.getNamespace().equals(NETCONF_URI)
260 || rpc.getNamespace().equals(IETF_NETCONF_NOTIFICATIONS.getNamespace())
261 || rpc.getNamespace().equals(NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME.getNamespace());
265 public synchronized DOMRpcResult toRpcResult(final NetconfMessage message, final SchemaPath rpc) {
266 final NormalizedNode<?, ?> normalizedNode;
267 final QName rpcQName = rpc.getLastComponent();
268 if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpcQName)) {
269 final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
270 final ContainerSchemaNode schemaForDataRead =
271 NetconfMessageTransformUtil.createSchemaForDataRead(schemaContext);
272 final ContainerNode dataNode;
275 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
276 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
277 final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext, schemaForDataRead,
279 xmlParser.traverse(new DOMSource(xmlData));
280 dataNode = (ContainerNode) resultHolder.getResult();
281 } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
283 throw new IllegalArgumentException(String.format("Failed to parse data response %s", xmlData), e);
286 normalizedNode = Builders.containerBuilder()
287 .withNodeIdentifier(new YangInstanceIdentifier
288 .NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME))
289 .withChild(dataNode).build();
292 Map<QName, RpcDefinition> currentMappedRpcs = mappedRpcs;
294 // Determine whether a base netconf operation is being invoked
295 // and also check if the device exposed model for base netconf.
296 // If no, use pre built base netconf operations model
297 final boolean needToUseBaseCtx = mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName);
298 if (needToUseBaseCtx) {
299 currentMappedRpcs = baseSchema.getMappedRpcs();
302 final RpcDefinition rpcDefinition = currentMappedRpcs.get(rpcQName);
303 Preconditions.checkArgument(rpcDefinition != null,
304 "Unable to parse response of %s, the rpc is unknown", rpcQName);
306 // In case no input for rpc is defined, we can simply construct the payload here
307 normalizedNode = parseResult(message, rpcDefinition);
309 return new DefaultDOMRpcResult(normalizedNode);
313 public DOMActionResult toActionResult(final SchemaPath action, final NetconfMessage message) {
314 ActionDefinition actionDefinition = null;
315 for (ActionDefinition actionDef : actions) {
316 if (actionDef.getPath().getLastComponent().equals(action.getLastComponent())) {
317 actionDefinition = actionDef;
320 Preconditions.checkNotNull(actionDefinition, "Action does not exist: %s", action);
321 ContainerNode normalizedNode = (ContainerNode) parseResult(message, actionDefinition);
323 if (normalizedNode == null) {
324 return new SimpleDOMActionResult(Collections.<RpcError>emptyList());
326 return new SimpleDOMActionResult(normalizedNode, Collections.<RpcError>emptyList());
330 private NormalizedNode<?, ?> parseResult(final NetconfMessage message,
331 final OperationDefinition operationDefinition) {
332 if (operationDefinition.getOutput().getChildNodes().isEmpty()) {
333 Preconditions.checkArgument(XmlElement.fromDomDocument(
334 message.getDocument()).getOnlyChildElementWithSameNamespaceOptionally("ok").isPresent(),
335 "Unexpected content in response of rpc: %s, %s", operationDefinition.getQName(), message);
338 final Element element = message.getDocument().getDocumentElement();
340 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
341 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
342 final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext,
343 operationDefinition.getOutput(), strictParsing);
344 xmlParser.traverse(new DOMSource(element));
345 return resultHolder.getResult();
346 } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
348 throw new IllegalArgumentException(String.format("Failed to parse RPC response %s", element), e);
353 static class NetconfDeviceNotification implements DOMNotification, DOMEvent {
354 private final ContainerNode content;
355 private final SchemaPath schemaPath;
356 private final Instant eventTime;
358 NetconfDeviceNotification(final ContainerNode content, final Instant eventTime) {
359 this.content = content;
360 this.eventTime = eventTime;
361 this.schemaPath = toPath(content.getNodeType());
365 public SchemaPath getType() {
370 public ContainerNode getBody() {
375 public Instant getEventInstant() {