plugins/netconf-client-mdsal/src/main/java/org/opendaylight/netconf/client/mdsal/impl/NetconfMessageTransformUtil.java

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