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.client.mdsal.impl;
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.netconf.common.mdsal.NormalizedDataUtil.NETCONF_DATA_QNAME;
12 import static org.opendaylight.netconf.common.mdsal.NormalizedDataUtil.NETCONF_QNAME;
14 import com.google.common.base.Preconditions;
15 import com.google.common.collect.ImmutableList;
16 import java.io.IOException;
17 import java.time.Instant;
18 import java.time.format.DateTimeParseException;
19 import java.util.ArrayDeque;
20 import java.util.Collection;
21 import java.util.Iterator;
22 import java.util.List;
24 import java.util.Map.Entry;
25 import java.util.Optional;
26 import javax.xml.stream.XMLStreamException;
27 import javax.xml.stream.XMLStreamWriter;
28 import javax.xml.transform.dom.DOMResult;
29 import javax.xml.transform.dom.DOMSource;
30 import org.eclipse.jdt.annotation.NonNull;
31 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
32 import org.opendaylight.netconf.api.DocumentedException;
33 import org.opendaylight.netconf.api.EffectiveOperation;
34 import org.opendaylight.netconf.api.messages.NetconfMessage;
35 import org.opendaylight.netconf.api.messages.NotificationMessage;
36 import org.opendaylight.netconf.api.xml.XmlElement;
37 import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
38 import org.opendaylight.netconf.api.xml.XmlUtil;
39 import org.opendaylight.netconf.common.mdsal.NormalizedDataUtil;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.edit.config.input.EditContent;
41 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
42 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
44 import org.opendaylight.yangtools.yang.common.QName;
45 import org.opendaylight.yangtools.yang.common.XMLNamespace;
46 import org.opendaylight.yangtools.yang.common.YangConstants;
47 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
49 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
50 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
51 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
52 import org.opendaylight.yangtools.yang.data.api.schema.AnyxmlNode;
53 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
54 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
55 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
56 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedMetadata;
57 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
58 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
59 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
60 import org.opendaylight.yangtools.yang.data.api.schema.stream.YangInstanceIdentifierWriter;
61 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
62 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
63 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedMetadata;
64 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
65 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizationResultHolder;
66 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaOrderedNormalizedNodeWriter;
67 import org.opendaylight.yangtools.yang.data.util.DataSchemaContext;
68 import org.opendaylight.yangtools.yang.data.util.DataSchemaContext.PathMixin;
69 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
70 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
71 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
72 import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
73 import org.slf4j.Logger;
74 import org.slf4j.LoggerFactory;
75 import org.w3c.dom.Document;
76 import org.w3c.dom.Element;
78 public final class NetconfMessageTransformUtil {
79 private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageTransformUtil.class);
81 public static final String MESSAGE_ID_PREFIX = "m";
83 public static final @NonNull QName CREATE_SUBSCRIPTION_RPC_QNAME =
84 QName.create(CreateSubscriptionInput.QNAME, "create-subscription").intern();
85 private static final String SUBTREE = "subtree";
87 // Blank document used for creation of new DOM nodes
88 private static final Document BLANK_DOCUMENT = XmlUtil.newDocument();
90 public static final @NonNull QName IETF_NETCONF_MONITORING =
91 QName.create(NetconfState.QNAME, "ietf-netconf-monitoring").intern();
92 public static final @NonNull QName GET_DATA_QNAME = QName.create(IETF_NETCONF_MONITORING, "data").intern();
93 public static final @NonNull QName GET_SCHEMA_QNAME = QName.create(IETF_NETCONF_MONITORING, "get-schema").intern();
94 public static final @NonNull QName IETF_NETCONF_MONITORING_SCHEMA_FORMAT =
95 QName.create(IETF_NETCONF_MONITORING, "format").intern();
96 public static final @NonNull QName IETF_NETCONF_MONITORING_SCHEMA_LOCATION =
97 QName.create(IETF_NETCONF_MONITORING, "location").intern();
98 public static final @NonNull QName IETF_NETCONF_MONITORING_SCHEMA_IDENTIFIER =
99 QName.create(IETF_NETCONF_MONITORING, "identifier").intern();
100 public static final @NonNull QName IETF_NETCONF_MONITORING_SCHEMA_VERSION =
101 QName.create(IETF_NETCONF_MONITORING, "version").intern();
102 public static final @NonNull QName IETF_NETCONF_MONITORING_SCHEMA_NAMESPACE =
103 QName.create(IETF_NETCONF_MONITORING, "namespace").intern();
105 public static final @NonNull QName IETF_NETCONF_NOTIFICATIONS =
106 QName.create(NetconfCapabilityChange.QNAME, "ietf-netconf-notifications").intern();
108 public static final XMLNamespace NETCONF_URI = NETCONF_QNAME.getNamespace();
110 public static final @NonNull NodeIdentifier NETCONF_DATA_NODEID = NodeIdentifier.create(NETCONF_DATA_QNAME);
112 public static final @NonNull QName NETCONF_RPC_REPLY_QNAME =
113 QName.create(NETCONF_QNAME, XmlNetconfConstants.RPC_REPLY_KEY).intern();
114 public static final @NonNull NodeIdentifier NETCONF_RPC_REPLY_NODEID =
115 NodeIdentifier.create(NETCONF_RPC_REPLY_QNAME);
117 public static final @NonNull QName NETCONF_OK_QNAME = QName.create(NETCONF_QNAME, XmlNetconfConstants.OK).intern();
118 public static final @NonNull QName NETCONF_ERROR_OPTION_QNAME =
119 QName.create(NETCONF_QNAME, "error-option").intern();
120 public static final @NonNull NodeIdentifier NETCONF_ERROR_OPTION_NODEID =
121 NodeIdentifier.create(NETCONF_ERROR_OPTION_QNAME);
122 public static final @NonNull QName NETCONF_RUNNING_QNAME = QName.create(NETCONF_QNAME, "running").intern();
123 public static final @NonNull NodeIdentifier NETCONF_RUNNING_NODEID = NodeIdentifier.create(NETCONF_RUNNING_QNAME);
124 public static final @NonNull QName NETCONF_SOURCE_QNAME = QName.create(NETCONF_QNAME, "source").intern();
125 public static final @NonNull NodeIdentifier NETCONF_SOURCE_NODEID = NodeIdentifier.create(NETCONF_SOURCE_QNAME);
126 public static final @NonNull QName NETCONF_CANDIDATE_QNAME = QName.create(NETCONF_QNAME, "candidate").intern();
127 public static final @NonNull NodeIdentifier NETCONF_CANDIDATE_NODEID =
128 NodeIdentifier.create(NETCONF_CANDIDATE_QNAME);
129 public static final @NonNull QName NETCONF_TARGET_QNAME = QName.create(NETCONF_QNAME, "target").intern();
130 public static final @NonNull NodeIdentifier NETCONF_TARGET_NODEID = NodeIdentifier.create(NETCONF_TARGET_QNAME);
131 public static final @NonNull QName NETCONF_CONFIG_QNAME = QName.create(NETCONF_QNAME, "config").intern();
132 public static final @NonNull NodeIdentifier NETCONF_CONFIG_NODEID = NodeIdentifier.create(NETCONF_CONFIG_QNAME);
134 public static final @NonNull QName NETCONF_COMMIT_QNAME = QName.create(NETCONF_QNAME, "commit").intern();
135 public static final @NonNull Absolute NETCONF_COMMIT_PATH = toPath(NETCONF_COMMIT_QNAME);
136 public static final @NonNull QName NETCONF_VALIDATE_QNAME = QName.create(NETCONF_QNAME, "validate").intern();
137 public static final @NonNull NodeIdentifier NETCONF_VALIDATE_NODEID = NodeIdentifier.create(NETCONF_VALIDATE_QNAME);
138 public static final @NonNull Absolute NETCONF_VALIDATE_PATH = toPath(NETCONF_VALIDATE_QNAME);
139 public static final @NonNull QName NETCONF_COPY_CONFIG_QNAME = QName.create(NETCONF_QNAME, "copy-config").intern();
140 public static final @NonNull NodeIdentifier NETCONF_COPY_CONFIG_NODEID =
141 NodeIdentifier.create(NETCONF_COPY_CONFIG_QNAME);
142 public static final @NonNull Absolute NETCONF_COPY_CONFIG_PATH = toPath(NETCONF_COPY_CONFIG_QNAME);
144 public static final @NonNull QName NETCONF_OPERATION_QNAME = QName.create(NETCONF_QNAME, "operation").intern();
145 private static final @NonNull QName NETCONF_OPERATION_QNAME_LEGACY =
146 NETCONF_OPERATION_QNAME.withoutRevision().intern();
147 public static final @NonNull QName NETCONF_DEFAULT_OPERATION_QNAME =
148 QName.create(NETCONF_OPERATION_QNAME, "default-operation").intern();
149 public static final @NonNull NodeIdentifier NETCONF_DEFAULT_OPERATION_NODEID =
150 NodeIdentifier.create(NETCONF_DEFAULT_OPERATION_QNAME);
151 public static final @NonNull QName NETCONF_EDIT_CONFIG_QNAME = QName.create(NETCONF_QNAME, "edit-config").intern();
152 public static final @NonNull NodeIdentifier NETCONF_EDIT_CONFIG_NODEID =
153 NodeIdentifier.create(NETCONF_EDIT_CONFIG_QNAME);
154 public static final @NonNull Absolute NETCONF_EDIT_CONFIG_PATH = toPath(NETCONF_EDIT_CONFIG_QNAME);
155 public static final @NonNull QName NETCONF_GET_CONFIG_QNAME =
156 QName.create(NETCONF_QNAME, XmlNetconfConstants.GET_CONFIG).intern();
157 public static final @NonNull NodeIdentifier NETCONF_GET_CONFIG_NODEID =
158 NodeIdentifier.create(NETCONF_GET_CONFIG_QNAME);
159 public static final @NonNull Absolute NETCONF_GET_CONFIG_PATH = toPath(NETCONF_GET_CONFIG_QNAME);
160 public static final @NonNull QName NETCONF_DISCARD_CHANGES_QNAME = QName.create(NETCONF_QNAME, "discard-changes");
161 public static final @NonNull Absolute NETCONF_DISCARD_CHANGES_PATH = toPath(NETCONF_DISCARD_CHANGES_QNAME);
162 public static final @NonNull QName NETCONF_TYPE_QNAME = QName.create(NETCONF_QNAME, "type").intern();
163 public static final @NonNull QName NETCONF_FILTER_QNAME = QName.create(NETCONF_QNAME, "filter").intern();
164 public static final @NonNull QName NETCONF_GET_QNAME =
165 QName.create(NETCONF_QNAME, XmlNetconfConstants.GET).intern();
166 public static final @NonNull NodeIdentifier NETCONF_GET_NODEID = NodeIdentifier.create(NETCONF_GET_QNAME);
167 public static final @NonNull Absolute NETCONF_GET_PATH = toPath(NETCONF_GET_QNAME);
168 public static final @NonNull QName NETCONF_RPC_QNAME =
169 QName.create(NETCONF_QNAME, XmlNetconfConstants.RPC_KEY).intern();
171 public static final @NonNull QName NETCONF_LOCK_QNAME = QName.create(NETCONF_QNAME, "lock").intern();
172 public static final @NonNull NodeIdentifier NETCONF_LOCK_NODEID = NodeIdentifier.create(NETCONF_LOCK_QNAME);
173 public static final @NonNull Absolute NETCONF_LOCK_PATH = toPath(NETCONF_LOCK_QNAME);
174 public static final @NonNull QName NETCONF_UNLOCK_QNAME = QName.create(NETCONF_QNAME, "unlock").intern();
175 public static final @NonNull NodeIdentifier NETCONF_UNLOCK_NODEID = NodeIdentifier.create(NETCONF_UNLOCK_QNAME);
176 public static final @NonNull Absolute NETCONF_UNLOCK_PATH = toPath(NETCONF_UNLOCK_QNAME);
178 public static final @NonNull NodeIdentifier EDIT_CONTENT_NODEID = NodeIdentifier.create(EditContent.QNAME);
180 // Discard changes message
181 public static final @NonNull ContainerNode DISCARD_CHANGES_RPC_CONTENT = Builders.containerBuilder()
182 .withNodeIdentifier(NodeIdentifier.create(NETCONF_DISCARD_CHANGES_QNAME)).build();
184 // Commit changes message
185 public static final @NonNull ContainerNode COMMIT_RPC_CONTENT = Builders.containerBuilder()
186 .withNodeIdentifier(NodeIdentifier.create(NETCONF_COMMIT_QNAME)).build();
189 public static final @NonNull ContainerNode GET_RPC_CONTENT = Builders.containerBuilder()
190 .withNodeIdentifier(NETCONF_GET_NODEID).build();
192 // Create-subscription changes message
193 public static final @NonNull ContainerNode CREATE_SUBSCRIPTION_RPC_CONTENT = Builders.containerBuilder()
194 .withNodeIdentifier(NodeIdentifier.create(CREATE_SUBSCRIPTION_RPC_QNAME)).build();
196 public static final @NonNull Absolute CREATE_SUBSCRIPTION_RPC_PATH = toPath(CREATE_SUBSCRIPTION_RPC_QNAME);
198 public static final @NonNull NodeIdentifier NETCONF_FILTER_NODEID = NodeIdentifier.create(NETCONF_FILTER_QNAME);
200 public static final @NonNull AnyxmlNode<?> EMPTY_FILTER = buildFilterStructure(getNetconfFilterElement());
202 private NetconfMessageTransformUtil() {
207 * Creation of the subtree filter structure using {@link YangInstanceIdentifier} path.
209 * @param identifier parent path / query
210 * @param ctx mountpoint schema context
211 * @return created DOM structure with subtree filter
213 public static AnyxmlNode<?> toFilterStructure(final YangInstanceIdentifier identifier,
214 final EffectiveModelContext ctx) {
215 final Element element = getNetconfFilterElement();
217 NormalizedDataUtil.writeFilter(identifier, new DOMResult(element), ctx, null);
218 } catch (IOException | XMLStreamException e) {
219 throw new IllegalStateException("Unable to serialize filter element for path " + identifier, e);
221 return buildFilterStructure(element);
225 * Creation of the subtree filter structure using list of parent {@link YangInstanceIdentifier}
226 * and specific selection fields. Field paths are relative to parent query path.
228 * @param fieldsFilters list of: parent path and selection fields
229 * @param ctx mountpoint schema context
230 * @return created DOM structure with subtree filter
232 public static AnyxmlNode<?> toFilterStructure(final List<FieldsFilter> fieldsFilters,
233 final EffectiveModelContext ctx) {
234 Preconditions.checkState(!fieldsFilters.isEmpty(), "An empty list of subtree filters is not allowed");
235 final Element element = getNetconfFilterElement();
237 for (final FieldsFilter filter : fieldsFilters) {
239 NormalizedDataUtil.writeFilter(filter.path(), new DOMResult(element), ctx, null, filter.fields());
240 } catch (IOException | XMLStreamException e) {
241 throw new IllegalStateException(String.format(
242 "Unable to serialize filter element for path %s with fields: %s",
243 filter.path(), filter.fields()), e);
246 return buildFilterStructure(element);
249 private static Element getNetconfFilterElement() {
250 final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(),
251 Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString()));
252 element.setAttributeNS(NETCONF_FILTER_QNAME.getNamespace().toString(), NETCONF_TYPE_QNAME.getLocalName(),
257 private static AnyxmlNode<?> buildFilterStructure(final Element element) {
258 return Builders.anyXmlBuilder()
259 .withNodeIdentifier(NETCONF_FILTER_NODEID)
260 .withValue(new DOMSource(element))
264 public static NodeIdentifier toId(final PathArgument arg) {
265 return arg instanceof NodeIdentifier nodeId ? nodeId : toId(arg.getNodeType());
268 public static NodeIdentifier toId(final QName nodeType) {
269 return new NodeIdentifier(nodeType);
272 public static Element getDataSubtree(final Document doc) {
273 return (Element) doc.getElementsByTagNameNS(NETCONF_URI.toString(), "data").item(0);
276 public static boolean isDataRetrievalOperation(final QName rpc) {
277 return NETCONF_URI.equals(rpc.getNamespace())
278 && (NETCONF_GET_CONFIG_QNAME.getLocalName().equals(rpc.getLocalName())
279 || NETCONF_GET_QNAME.getLocalName().equals(rpc.getLocalName()));
283 public static @NonNull ContainerNode wrap(final QName name, final DataContainerChild... node) {
284 return wrap(toId(name), node);
287 public static @NonNull ContainerNode wrap(final NodeIdentifier name, final DataContainerChild... node) {
288 return Builders.containerBuilder().withNodeIdentifier(name).withValue(ImmutableList.copyOf(node)).build();
292 * Create edit-config structure to invoke {@code operation} with {@code lastChildOverride} data on {@code dataPath}.
294 * @param ctx {@link EffectiveModelContext} device's model context
295 * @param dataPath {@link YangInstanceIdentifier} path to data in device's data-store
296 * @param operation Optional of {@link EffectiveOperation} action to be invoked
297 * @param lastChildOverride Optional of {@code NormalizedNode} data on which action will be invoked
298 * @return {@link DOMSourceAnyxmlNode} containing edit-config structure
300 public static DOMSourceAnyxmlNode createEditConfigAnyxml(
301 final EffectiveModelContext ctx, final YangInstanceIdentifier dataPath,
302 final Optional<EffectiveOperation> operation, final Optional<NormalizedNode> lastChildOverride) {
303 if (dataPath.isEmpty()) {
304 final var override = lastChildOverride.orElseThrow(() -> new IllegalArgumentException(
305 "Data has to be present when creating structure for top level element"));
306 Preconditions.checkArgument(override instanceof DataContainerChild,
307 "Data has to be either container or a list node when creating structure for top level element, "
308 + "but was: %s", override);
311 final var element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_CONFIG_QNAME.getLocalName(),
312 Optional.of(NETCONF_CONFIG_QNAME.getNamespace().toString()));
313 final var metadata = operation.map(o -> leafMetadata(dataPath, o)).orElse(null);
315 if (lastChildOverride.isPresent()) {
316 // TODO do not transform this into result and then to xml, rework the whole pipeline to directly write
319 final var parentPath = dataPath.isEmpty() ? dataPath : dataPath.coerceParent();
320 var result = new NormalizationResultHolder();
321 try (var streamWriter = ImmutableNormalizedNodeStreamWriter.from(result)) {
322 try (var iidWriter = YangInstanceIdentifierWriter.open(streamWriter, ctx, parentPath);
323 var nnWriter = NormalizedNodeWriter.forStreamWriter(streamWriter)) {
324 nnWriter.write(lastChildOverride.orElseThrow());
327 NormalizedDataUtil.writeNormalizedNode(result.getResult().data(), metadata, new DOMResult(element), ctx,
330 NormalizedDataUtil.writeNormalizedNode(dataPath, metadata, new DOMResult(element), ctx, null);
332 } catch (final IOException | XMLStreamException e) {
333 throw new IllegalStateException("Unable to serialize edit config content element for path " + dataPath, e);
336 return Builders.anyXmlBuilder().withNodeIdentifier(NETCONF_CONFIG_NODEID).withValue(new DOMSource(element))
340 private static NormalizedMetadata leafMetadata(final YangInstanceIdentifier path, final EffectiveOperation oper) {
341 record BuilderAndArg(ImmutableNormalizedMetadata.Builder builder, PathArgument arg) {
343 requireNonNull(builder);
348 final var args = path.getPathArguments();
349 final var builders = new ArrayDeque<BuilderAndArg>(args.size());
351 // Step one: open builders
352 for (PathArgument arg : args) {
353 builders.push(new BuilderAndArg(ImmutableNormalizedMetadata.builder(), arg));
356 // Step two: set the top builder's metadata
357 builders.peek().builder.withAnnotation(NETCONF_OPERATION_QNAME_LEGACY, oper.xmlValue());
359 // Step three: build the tree
361 final var current = builders.pop();
362 final var currentMeta = current.builder.build();
363 final var parent = builders.peek();
364 if (parent != null) {
365 parent.builder.withChild(current.arg, currentMeta);
372 public static DataContainerChild createEditConfigStructure(final EffectiveModelContext ctx,
373 final YangInstanceIdentifier dataPath, final Optional<EffectiveOperation> operation,
374 final Optional<NormalizedNode> lastChildOverride) {
375 return Builders.choiceBuilder().withNodeIdentifier(EDIT_CONTENT_NODEID)
376 .withChild(createEditConfigAnyxml(ctx, dataPath, operation, lastChildOverride)).build();
379 public static @NonNull Absolute toPath(final QName rpc) {
380 return Absolute.of(rpc);
383 public static Map.Entry<Instant, XmlElement> stripNotification(final NetconfMessage message) {
384 final XmlElement xmlElement = XmlElement.fromDomDocument(message.getDocument());
385 final List<XmlElement> childElements = xmlElement.getChildElements();
386 Preconditions.checkArgument(childElements.size() == 2, "Unable to parse notification %s, unexpected format."
387 + "\nExpected 2 childElements, actual childElements size is %s", message, childElements.size());
389 final XmlElement eventTimeElement;
390 final XmlElement notificationElement;
392 if (childElements.get(0).getName().equals(XmlNetconfConstants.EVENT_TIME)) {
393 eventTimeElement = childElements.get(0);
394 notificationElement = childElements.get(1);
395 } else if (childElements.get(1).getName().equals(XmlNetconfConstants.EVENT_TIME)) {
396 eventTimeElement = childElements.get(1);
397 notificationElement = childElements.get(0);
399 throw new IllegalArgumentException(
400 "Notification payload does not contain " + XmlNetconfConstants.EVENT_TIME + " " + message);
405 NotificationMessage.RFC3339_DATE_PARSER.apply(eventTimeElement.getTextContent()),
406 notificationElement);
407 } catch (final DocumentedException e) {
408 throw new IllegalArgumentException(
409 "Notification payload does not contain " + XmlNetconfConstants.EVENT_TIME + " " + message, e);
410 } catch (final DateTimeParseException e) {
411 LOG.warn("Unable to parse event time from {}. Setting time to {}", eventTimeElement,
412 NotificationMessage.UNKNOWN_EVENT_TIME, e);
413 return Map.entry(NotificationMessage.UNKNOWN_EVENT_TIME, notificationElement);
417 public static DOMResult prepareDomResultForRpcRequest(final QName rpcQName, final MessageCounter counter) {
418 final Document document = XmlUtil.newDocument();
419 final Element rpcNS =
420 document.createElementNS(NETCONF_RPC_QNAME.getNamespace().toString(), NETCONF_RPC_QNAME.getLocalName());
422 rpcNS.setAttribute(XmlNetconfConstants.MESSAGE_ID, counter.getNewMessageId(MESSAGE_ID_PREFIX));
423 final Element elementNS = document.createElementNS(rpcQName.getNamespace().toString(), rpcQName.getLocalName());
424 rpcNS.appendChild(elementNS);
425 document.appendChild(rpcNS);
426 return new DOMResult(elementNS);
429 public static DOMResult prepareDomResultForActionRequest(final DataSchemaContextTree dataSchemaContextTree,
430 final DOMDataTreeIdentifier domDataTreeIdentifier, final MessageCounter counter, final QName action) {
431 final Document document = XmlUtil.newDocument();
432 final Element rpcNS =
433 document.createElementNS(NETCONF_RPC_QNAME.getNamespace().toString(), NETCONF_RPC_QNAME.getLocalName());
435 rpcNS.setAttribute(XmlNetconfConstants.MESSAGE_ID, counter.getNewMessageId(MESSAGE_ID_PREFIX));
437 final Element actionNS = document.createElementNS(YangConstants.RFC6020_YANG_NAMESPACE_STRING, "action");
438 final DataSchemaContext rootSchemaContextNode = dataSchemaContextTree.getRoot();
439 final Element actionData = prepareActionData(rootSchemaContextNode, actionNS,
440 domDataTreeIdentifier.getRootIdentifier().getPathArguments().iterator(), document);
442 final Element specificActionElement =
443 document.createElementNS(action.getNamespace().toString(), action.getLocalName());
444 actionData.appendChild(specificActionElement);
445 rpcNS.appendChild(actionNS);
446 document.appendChild(rpcNS);
447 return new DOMResult(specificActionElement);
450 private static Element prepareActionData(final DataSchemaContext currentParentSchemaNode,
451 final Element actionNS, final Iterator<PathArgument> iterator, final Document document) {
452 if (iterator.hasNext()) {
453 final PathArgument next = iterator.next();
455 final DataSchemaContext current = currentParentSchemaNode instanceof DataSchemaContext.Composite composite
456 ? composite.childByArg(next) : null;
457 Preconditions.checkArgument(current != null, "Invalid input: schema for argument %s not found", next);
459 if (current instanceof PathMixin) {
460 return prepareActionData(current, actionNS, iterator, document);
463 final QName actualNS = next.getNodeType();
464 final Element actualElement = document.createElementNS(actualNS.getNamespace().toString(),
465 actualNS.getLocalName());
466 if (next instanceof NodeWithValue) {
467 actualElement.setNodeValue(((NodeWithValue<?>) next).getValue().toString());
468 } else if (next instanceof NodeIdentifierWithPredicates) {
469 for (Entry<QName, Object> entry : ((NodeIdentifierWithPredicates) next).entrySet()) {
470 final Element entryElement = document.createElementNS(entry.getKey().getNamespace().toString(),
471 entry.getKey().getLocalName());
472 entryElement.setTextContent(entry.getValue().toString());
473 entryElement.setNodeValue(entry.getValue().toString());
474 actualElement.appendChild(entryElement);
477 actionNS.appendChild(actualElement);
478 return prepareActionData(current, actualElement, iterator, document);
484 public static void writeNormalizedOperationInput(final ContainerNode normalized, final DOMResult result,
485 final Absolute operationPath, final EffectiveModelContext baseNetconfCtx)
486 throws IOException, XMLStreamException {
487 final var stack = SchemaInferenceStack.of(baseNetconfCtx, operationPath);
488 stack.enterSchemaTree(YangConstants.operationInputQName(operationPath.lastNodeIdentifier().getModule()));
489 final var inputInference = stack.toSchemaTreeInference();
491 final XMLStreamWriter writer = NormalizedDataUtil.XML_FACTORY.createXMLStreamWriter(result);
493 try (NormalizedNodeStreamWriter normalizedNodeStreamWriter =
494 XMLStreamNormalizedNodeStreamWriter.create(writer, inputInference)) {
495 try (SchemaOrderedNormalizedNodeWriter normalizedNodeWriter =
496 new SchemaOrderedNormalizedNodeWriter(normalizedNodeStreamWriter, inputInference)) {
497 final Collection<DataContainerChild> value = normalized.body();
498 normalizedNodeWriter.write(value);
499 normalizedNodeWriter.flush();
505 } catch (final XMLStreamException e) {
506 LOG.warn("Unable to close resource properly", e);