netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/util/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.sal.connect.netconf.util;
   9
  10 import static org.opendaylight.netconf.util.NetconfUtil.NETCONF_DATA_QNAME;
  11 import static org.opendaylight.netconf.util.NetconfUtil.NETCONF_QNAME;
  12
  13 import com.google.common.base.Preconditions;
  14 import com.google.common.collect.ImmutableList;
  15 import com.google.common.collect.ImmutableMap;
  16 import java.io.IOException;
  17 import java.net.URI;
  18 import java.time.Instant;
  19 import java.time.format.DateTimeParseException;
  20 import java.util.AbstractMap.SimpleEntry;
  21 import java.util.ArrayDeque;
  22 import java.util.Collection;
  23 import java.util.Deque;
  24 import java.util.Iterator;
  25 import java.util.List;
  26 import java.util.Locale;
  27 import java.util.Map;
  28 import java.util.Map.Entry;
  29 import java.util.Optional;
  30 import javax.xml.stream.XMLStreamException;
  31 import javax.xml.stream.XMLStreamWriter;
  32 import javax.xml.transform.dom.DOMResult;
  33 import javax.xml.transform.dom.DOMSource;
  34 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  35 import org.opendaylight.netconf.api.DocumentedException;
  36 import org.opendaylight.netconf.api.FailedNetconfMessage;
  37 import org.opendaylight.netconf.api.ModifyAction;
  38 import org.opendaylight.netconf.api.NetconfDocumentedException;
  39 import org.opendaylight.netconf.api.NetconfMessage;
  40 import org.opendaylight.netconf.api.xml.XmlElement;
  41 import org.opendaylight.netconf.api.xml.XmlUtil;
  42 import org.opendaylight.netconf.notifications.NetconfNotification;
  43 import org.opendaylight.netconf.sal.connect.util.MessageCounter;
  44 import org.opendaylight.netconf.util.NetconfUtil;
  45 import org.opendaylight.netconf.util.NodeContainerProxy;
  46 import org.opendaylight.netconf.util.messages.NetconfMessageUtil;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.edit.config.input.EditContent;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
  51 import org.opendaylight.yangtools.rfc7952.data.api.NormalizedMetadata;
  52 import org.opendaylight.yangtools.rfc7952.data.util.ImmutableNormalizedMetadata;
  53 import org.opendaylight.yangtools.rfc7952.data.util.ImmutableNormalizedMetadata.Builder;
  54 import org.opendaylight.yangtools.yang.common.QName;
  55 import org.opendaylight.yangtools.yang.common.RpcError;
  56 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
  57 import org.opendaylight.yangtools.yang.common.RpcResult;
  58 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  59 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  60 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  61 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  62 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  63 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  64 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  65 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  66 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  67 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  68 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  69 import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  70 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  71 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  72 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaOrderedNormalizedNodeWriter;
  73 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
  74 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  75 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  76 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  77 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  78 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  79 import org.slf4j.Logger;
  80 import org.slf4j.LoggerFactory;
  81 import org.w3c.dom.Document;
  82 import org.w3c.dom.Element;
  83
  84 public final class NetconfMessageTransformUtil {
  85
  86     private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageTransformUtil.class);
  87
  88     public static final String MESSAGE_ID_PREFIX = "m";
  89     public static final String MESSAGE_ID_ATTR = "message-id";
  90
  91     public static final QName CREATE_SUBSCRIPTION_RPC_QNAME =
  92             QName.create(CreateSubscriptionInput.QNAME, "create-subscription").intern();
  93     private static final String SUBTREE = "subtree";
  94
  95     // Blank document used for creation of new DOM nodes
  96     private static final Document BLANK_DOCUMENT = XmlUtil.newDocument();
  97     public static final String EVENT_TIME = "eventTime";
  98
  99     private NetconfMessageTransformUtil() {
 100
 101     }
 102
 103     public static final QName IETF_NETCONF_MONITORING =
 104             QName.create(NetconfState.QNAME, "ietf-netconf-monitoring").intern();
 105     public static final QName GET_DATA_QNAME = QName.create(IETF_NETCONF_MONITORING, "data").intern();
 106     public static final QName GET_SCHEMA_QNAME = QName.create(IETF_NETCONF_MONITORING, "get-schema").intern();
 107     public static final QName IETF_NETCONF_MONITORING_SCHEMA_FORMAT =
 108             QName.create(IETF_NETCONF_MONITORING, "format").intern();
 109     public static final QName IETF_NETCONF_MONITORING_SCHEMA_LOCATION =
 110             QName.create(IETF_NETCONF_MONITORING, "location").intern();
 111     public static final QName IETF_NETCONF_MONITORING_SCHEMA_IDENTIFIER =
 112             QName.create(IETF_NETCONF_MONITORING, "identifier").intern();
 113     public static final QName IETF_NETCONF_MONITORING_SCHEMA_VERSION =
 114             QName.create(IETF_NETCONF_MONITORING, "version").intern();
 115     public static final QName IETF_NETCONF_MONITORING_SCHEMA_NAMESPACE =
 116             QName.create(IETF_NETCONF_MONITORING, "namespace").intern();
 117
 118     public static final QName IETF_NETCONF_NOTIFICATIONS =
 119             QName.create(NetconfCapabilityChange.QNAME, "ietf-netconf-notifications").intern();
 120
 121     public static final URI NETCONF_URI = NETCONF_QNAME.getNamespace();
 122
 123     public static final NodeIdentifier NETCONF_DATA_NODEID = NodeIdentifier.create(NETCONF_DATA_QNAME);
 124
 125     public static final QName NETCONF_RPC_REPLY_QNAME = QName.create(NETCONF_QNAME, "rpc-reply").intern();
 126     public static final NodeIdentifier NETCONF_RPC_REPLY_NODEID = NodeIdentifier.create(NETCONF_RPC_REPLY_QNAME);
 127
 128     public static final QName NETCONF_OK_QNAME = QName.create(NETCONF_QNAME, "ok").intern();
 129     public static final QName NETCONF_ERROR_OPTION_QNAME = QName.create(NETCONF_QNAME, "error-option").intern();
 130     public static final NodeIdentifier NETCONF_ERROR_OPTION_NODEID = NodeIdentifier.create(NETCONF_ERROR_OPTION_QNAME);
 131     public static final QName NETCONF_RUNNING_QNAME = QName.create(NETCONF_QNAME, "running").intern();
 132     public static final QName NETCONF_SOURCE_QNAME = QName.create(NETCONF_QNAME, "source").intern();
 133     public static final NodeIdentifier NETCONF_SOURCE_NODEID = NodeIdentifier.create(NETCONF_SOURCE_QNAME);
 134     public static final QName NETCONF_CANDIDATE_QNAME = QName.create(NETCONF_QNAME, "candidate").intern();
 135     public static final QName NETCONF_TARGET_QNAME = QName.create(NETCONF_QNAME, "target").intern();
 136     public static final NodeIdentifier NETCONF_TARGET_NODEID = NodeIdentifier.create(NETCONF_TARGET_QNAME);
 137     public static final QName NETCONF_CONFIG_QNAME = QName.create(NETCONF_QNAME, "config").intern();
 138     public static final NodeIdentifier NETCONF_CONFIG_NODEID = NodeIdentifier.create(NETCONF_CONFIG_QNAME);
 139
 140     public static final QName NETCONF_COMMIT_QNAME = QName.create(NETCONF_QNAME, "commit").intern();
 141     public static final SchemaPath NETCONF_COMMIT_PATH = toPath(NETCONF_COMMIT_QNAME);
 142     public static final QName NETCONF_VALIDATE_QNAME = QName.create(NETCONF_QNAME, "validate").intern();
 143     public static final NodeIdentifier NETCONF_VALIDATE_NODEID = NodeIdentifier.create(NETCONF_VALIDATE_QNAME);
 144     public static final SchemaPath NETCONF_VALIDATE_PATH = toPath(NETCONF_VALIDATE_QNAME);
 145     public static final QName NETCONF_COPY_CONFIG_QNAME = QName.create(NETCONF_QNAME, "copy-config").intern();
 146     public static final NodeIdentifier NETCONF_COPY_CONFIG_NODEID = NodeIdentifier.create(NETCONF_COPY_CONFIG_QNAME);
 147     public static final SchemaPath NETCONF_COPY_CONFIG_PATH = toPath(NETCONF_COPY_CONFIG_QNAME);
 148
 149     public static final QName NETCONF_OPERATION_QNAME = QName.create(NETCONF_QNAME, "operation").intern();
 150     private static final QName NETCONF_OPERATION_QNAME_LEGACY = NETCONF_OPERATION_QNAME.withoutRevision().intern();
 151     public static final QName NETCONF_DEFAULT_OPERATION_QNAME =
 152             QName.create(NETCONF_OPERATION_QNAME, "default-operation").intern();
 153     public static final NodeIdentifier NETCONF_DEFAULT_OPERATION_NODEID =
 154             NodeIdentifier.create(NETCONF_DEFAULT_OPERATION_QNAME);
 155     public static final QName NETCONF_EDIT_CONFIG_QNAME = QName.create(NETCONF_QNAME, "edit-config").intern();
 156     public static final NodeIdentifier NETCONF_EDIT_CONFIG_NODEID = NodeIdentifier.create(NETCONF_EDIT_CONFIG_QNAME);
 157     public static final SchemaPath NETCONF_EDIT_CONFIG_PATH = toPath(NETCONF_EDIT_CONFIG_QNAME);
 158     public static final QName NETCONF_GET_CONFIG_QNAME = QName.create(NETCONF_QNAME, "get-config");
 159     public static final NodeIdentifier NETCONF_GET_CONFIG_NODEID = NodeIdentifier.create(NETCONF_GET_CONFIG_QNAME);
 160     public static final SchemaPath NETCONF_GET_CONFIG_PATH = toPath(NETCONF_GET_CONFIG_QNAME);
 161     public static final QName NETCONF_DISCARD_CHANGES_QNAME = QName.create(NETCONF_QNAME, "discard-changes");
 162     public static final SchemaPath NETCONF_DISCARD_CHANGES_PATH = toPath(NETCONF_DISCARD_CHANGES_QNAME);
 163     public static final QName NETCONF_TYPE_QNAME = QName.create(NETCONF_QNAME, "type").intern();
 164     public static final QName NETCONF_FILTER_QNAME = QName.create(NETCONF_QNAME, "filter").intern();
 165     public static final QName NETCONF_GET_QNAME = QName.create(NETCONF_QNAME, "get").intern();
 166     public static final NodeIdentifier NETCONF_GET_NODEID = NodeIdentifier.create(NETCONF_GET_QNAME);
 167     public static final SchemaPath NETCONF_GET_PATH = toPath(NETCONF_GET_QNAME);
 168     public static final QName NETCONF_RPC_QNAME = QName.create(NETCONF_QNAME, "rpc").intern();
 169     public static final QName YANG_QNAME = null;
 170     public static final URI NETCONF_ACTION_NAMESPACE = URI.create("urn:ietf:params:xml:ns:yang:1");
 171     public static final String NETCONF_ACTION = "action";
 172
 173     public static final URI NETCONF_ROLLBACK_ON_ERROR_URI = URI
 174             .create("urn:ietf:params:netconf:capability:rollback-on-error:1.0");
 175     public static final String ROLLBACK_ON_ERROR_OPTION = "rollback-on-error";
 176
 177     public static final URI NETCONF_CANDIDATE_URI = URI
 178             .create("urn:ietf:params:netconf:capability:candidate:1.0");
 179
 180     public static final URI NETCONF_NOTIFICATONS_URI = URI
 181             .create("urn:ietf:params:netconf:capability:notification:1.0");
 182
 183     public static final URI NETCONF_RUNNING_WRITABLE_URI = URI
 184             .create("urn:ietf:params:netconf:capability:writable-running:1.0");
 185
 186     public static final QName NETCONF_LOCK_QNAME = QName.create(NETCONF_QNAME, "lock").intern();
 187     public static final NodeIdentifier NETCONF_LOCK_NODEID = NodeIdentifier.create(NETCONF_LOCK_QNAME);
 188     public static final SchemaPath NETCONF_LOCK_PATH = toPath(NETCONF_LOCK_QNAME);
 189     public static final QName NETCONF_UNLOCK_QNAME = QName.create(NETCONF_QNAME, "unlock").intern();
 190     public static final NodeIdentifier NETCONF_UNLOCK_NODEID = NodeIdentifier.create(NETCONF_UNLOCK_QNAME);
 191     public static final SchemaPath NETCONF_UNLOCK_PATH = toPath(NETCONF_UNLOCK_QNAME);
 192
 193     public static final NodeIdentifier EDIT_CONTENT_NODEID = NodeIdentifier.create(EditContent.QNAME);
 194
 195     // Discard changes message
 196     public static final ContainerNode DISCARD_CHANGES_RPC_CONTENT = Builders.containerBuilder()
 197             .withNodeIdentifier(NodeIdentifier.create(NETCONF_DISCARD_CHANGES_QNAME)).build();
 198
 199     // Commit changes message
 200     public static final ContainerNode COMMIT_RPC_CONTENT = Builders.containerBuilder()
 201             .withNodeIdentifier(NodeIdentifier.create(NETCONF_COMMIT_QNAME)).build();
 202
 203     // Get message
 204     public static final ContainerNode GET_RPC_CONTENT = Builders.containerBuilder()
 205             .withNodeIdentifier(NETCONF_GET_NODEID).build();
 206
 207     // Create-subscription changes message
 208     public static final ContainerNode CREATE_SUBSCRIPTION_RPC_CONTENT = Builders.containerBuilder()
 209             .withNodeIdentifier(NodeIdentifier.create(CREATE_SUBSCRIPTION_RPC_QNAME)).build();
 210
 211     public static final SchemaPath CREATE_SUBSCRIPTION_RPC_PATH = toPath(CREATE_SUBSCRIPTION_RPC_QNAME);
 212
 213     public static final NodeIdentifier NETCONF_FILTER_NODEID = NodeIdentifier.create(NETCONF_FILTER_QNAME);
 214
 215     public static final DataContainerChild<?, ?> EMPTY_FILTER;
 216
 217     static {
 218         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(),
 219                 Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString()));
 220         element.setAttributeNS(NETCONF_FILTER_QNAME.getNamespace().toString(),
 221                 NETCONF_TYPE_QNAME.getLocalName(), SUBTREE);
 222
 223         EMPTY_FILTER = Builders.anyXmlBuilder().withNodeIdentifier(NETCONF_FILTER_NODEID)
 224                 .withValue(new DOMSource(element)).build();
 225     }
 226
 227     public static DataContainerChild<?, ?> toFilterStructure(final YangInstanceIdentifier identifier,
 228                                                              final SchemaContext ctx) {
 229         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(),
 230                 Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString()));
 231         element.setAttributeNS(NETCONF_FILTER_QNAME.getNamespace().toString(), NETCONF_TYPE_QNAME.getLocalName(),
 232                 SUBTREE);
 233
 234         try {
 235             NetconfUtil.writeFilter(identifier, new DOMResult(element), SchemaPath.ROOT, ctx);
 236         } catch (IOException | XMLStreamException e) {
 237             throw new IllegalStateException("Unable to serialize filter element for path " + identifier, e);
 238         }
 239
 240         return Builders.anyXmlBuilder().withNodeIdentifier(NETCONF_FILTER_NODEID).withValue(new DOMSource(element))
 241                 .build();
 242     }
 243
 244     public static void checkValidReply(final NetconfMessage input, final NetconfMessage output)
 245             throws NetconfDocumentedException {
 246         final String inputMsgId = input.getDocument().getDocumentElement().getAttribute(MESSAGE_ID_ATTR);
 247         final String outputMsgId = output.getDocument().getDocumentElement().getAttribute(MESSAGE_ID_ATTR);
 248
 249         if (!inputMsgId.equals(outputMsgId)) {
 250             final Map<String, String> errorInfo = ImmutableMap.<String, String>builder()
 251                     .put("actual-message-id", outputMsgId)
 252                     .put("expected-message-id", inputMsgId)
 253                     .build();
 254
 255             throw new NetconfDocumentedException("Response message contained unknown \"message-id\"",
 256                     null, NetconfDocumentedException.ErrorType.PROTOCOL,
 257                     NetconfDocumentedException.ErrorTag.BAD_ATTRIBUTE,
 258                     NetconfDocumentedException.ErrorSeverity.ERROR, errorInfo);
 259         }
 260     }
 261
 262     public static void checkSuccessReply(final NetconfMessage output) throws NetconfDocumentedException {
 263         if (NetconfMessageUtil.isErrorMessage(output)) {
 264             throw NetconfDocumentedException.fromXMLDocument(output.getDocument());
 265         }
 266     }
 267
 268     public static RpcError toRpcError(final NetconfDocumentedException ex) {
 269         final StringBuilder infoBuilder = new StringBuilder();
 270         final Map<String, String> errorInfo = ex.getErrorInfo();
 271         if (errorInfo != null) {
 272             for (final Entry<String, String> e : errorInfo.entrySet()) {
 273                 infoBuilder.append('<').append(e.getKey()).append('>').append(e.getValue())
 274                         .append("</").append(e.getKey()).append('>');
 275
 276             }
 277         }
 278
 279         final ErrorSeverity severity = toRpcErrorSeverity(ex.getErrorSeverity());
 280         return severity == ErrorSeverity.ERROR
 281                 ? RpcResultBuilder.newError(toRpcErrorType(ex.getErrorType()), ex.getErrorTag().getTagValue(),
 282                         ex.getLocalizedMessage(), null, infoBuilder.toString(), ex.getCause())
 283                 : RpcResultBuilder.newWarning(
 284                         toRpcErrorType(ex.getErrorType()), ex.getErrorTag().getTagValue(),
 285                         ex.getLocalizedMessage(), null, infoBuilder.toString(), ex.getCause());
 286     }
 287
 288     private static ErrorSeverity toRpcErrorSeverity(final NetconfDocumentedException.ErrorSeverity severity) {
 289         switch (severity) {
 290             case WARNING:
 291                 return RpcError.ErrorSeverity.WARNING;
 292             default:
 293                 return RpcError.ErrorSeverity.ERROR;
 294         }
 295     }
 296
 297     private static RpcError.ErrorType toRpcErrorType(final NetconfDocumentedException.ErrorType type) {
 298         switch (type) {
 299             case PROTOCOL:
 300                 return RpcError.ErrorType.PROTOCOL;
 301             case RPC:
 302                 return RpcError.ErrorType.RPC;
 303             case TRANSPORT:
 304                 return RpcError.ErrorType.TRANSPORT;
 305             default:
 306                 return RpcError.ErrorType.APPLICATION;
 307         }
 308     }
 309
 310     public static NodeIdentifier toId(final PathArgument qname) {
 311         return qname instanceof NodeIdentifier ? (NodeIdentifier) qname : toId(qname.getNodeType());
 312     }
 313
 314     public static NodeIdentifier toId(final QName nodeType) {
 315         return new NodeIdentifier(nodeType);
 316     }
 317
 318     public static Element getDataSubtree(final Document doc) {
 319         return (Element) doc.getElementsByTagNameNS(NETCONF_URI.toString(), "data").item(0);
 320     }
 321
 322     public static boolean isDataRetrievalOperation(final QName rpc) {
 323         return NETCONF_URI.equals(rpc.getNamespace())
 324                 && (NETCONF_GET_CONFIG_QNAME.getLocalName().equals(rpc.getLocalName())
 325                 || NETCONF_GET_QNAME.getLocalName().equals(rpc.getLocalName()));
 326     }
 327
 328     public static ContainerSchemaNode createSchemaForDataRead(final SchemaContext schemaContext) {
 329         return new NodeContainerProxy(NETCONF_DATA_QNAME, schemaContext.getChildNodes());
 330     }
 331
 332     public static ContainerSchemaNode createSchemaForNotification(final NotificationDefinition next) {
 333         return new NodeContainerProxy(next.getQName(), next.getChildNodes(), next.getAvailableAugmentations());
 334     }
 335
 336     @Deprecated
 337     public static ContainerNode wrap(final QName name, final DataContainerChild<?, ?>... node) {
 338         return wrap(toId(name), node);
 339     }
 340
 341     public static ContainerNode wrap(final NodeIdentifier name, final DataContainerChild<?, ?>... node) {
 342         return Builders.containerBuilder().withNodeIdentifier(name).withValue(ImmutableList.copyOf(node)).build();
 343     }
 344
 345     public static DOMSourceAnyxmlNode createEditConfigAnyxml(
 346             final SchemaContext ctx, final YangInstanceIdentifier dataPath,
 347             final Optional<ModifyAction> operation,
 348             final Optional<NormalizedNode<?, ?>> lastChildOverride) {
 349         final NormalizedNode<?, ?> configContent;
 350         final NormalizedMetadata metadata;
 351         if (dataPath.isEmpty()) {
 352             Preconditions.checkArgument(lastChildOverride.isPresent(),
 353                     "Data has to be present when creating structure for top level element");
 354             Preconditions.checkArgument(lastChildOverride.get() instanceof DataContainerChild<?, ?>,
 355                     "Data has to be either container or a list node when creating structure for top level element, "
 356                             + "but was: %s", lastChildOverride.get());
 357             configContent = lastChildOverride.get();
 358             metadata = null;
 359         } else {
 360             configContent = ImmutableNodes.fromInstanceId(ctx, dataPath, lastChildOverride);
 361             metadata = operation.map(oper -> leafMetadata(dataPath, oper)).orElse(null);
 362         }
 363
 364         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_CONFIG_QNAME.getLocalName(),
 365                 Optional.of(NETCONF_CONFIG_QNAME.getNamespace().toString()));
 366
 367         try {
 368             NetconfUtil.writeNormalizedNode(configContent, metadata, new DOMResult(element), SchemaPath.ROOT, ctx);
 369         } catch (IOException | XMLStreamException e) {
 370             throw new IllegalStateException("Unable to serialize edit config content element for path " + dataPath, e);
 371         }
 372
 373         return Builders.anyXmlBuilder().withNodeIdentifier(NETCONF_CONFIG_NODEID).withValue(new DOMSource(element))
 374                 .build();
 375     }
 376
 377     private static NormalizedMetadata leafMetadata(final YangInstanceIdentifier path, final ModifyAction oper) {
 378         final List<PathArgument> args = path.getPathArguments();
 379         final Deque<Builder> builders = new ArrayDeque<>(args.size());
 380
 381         // Step one: open builders
 382         for (PathArgument arg : args) {
 383             builders.push(ImmutableNormalizedMetadata.builder().withIdentifier(arg));
 384         }
 385
 386         // Step two: set the top builder's metadata
 387         builders.peek().withAnnotation(NETCONF_OPERATION_QNAME_LEGACY, oper.toString().toLowerCase(Locale.US));
 388
 389         // Step three: build the tree
 390         while (true) {
 391             final ImmutableNormalizedMetadata currentMeta = builders.pop().build();
 392             final Builder parent = builders.peek();
 393             if (parent != null) {
 394                 parent.withChild(currentMeta);
 395             } else {
 396                 return currentMeta;
 397             }
 398         }
 399     }
 400
 401     public static DataContainerChild<?, ?> createEditConfigStructure(final SchemaContext ctx,
 402             final YangInstanceIdentifier dataPath, final Optional<ModifyAction> operation,
 403             final Optional<NormalizedNode<?, ?>> lastChildOverride) {
 404         return Builders.choiceBuilder().withNodeIdentifier(EDIT_CONTENT_NODEID)
 405                 .withChild(createEditConfigAnyxml(ctx, dataPath, operation, lastChildOverride)).build();
 406     }
 407
 408     public static SchemaPath toPath(final QName rpc) {
 409         return SchemaPath.ROOT.createChild(rpc);
 410     }
 411
 412     public static Map.Entry<Instant, XmlElement> stripNotification(final NetconfMessage message) {
 413         final XmlElement xmlElement = XmlElement.fromDomDocument(message.getDocument());
 414         final List<XmlElement> childElements = xmlElement.getChildElements();
 415         Preconditions.checkArgument(childElements.size() == 2, "Unable to parse notification %s, unexpected format."
 416                 + "\nExpected 2 childElements, actual childElements size is %s", message, childElements.size());
 417
 418         final XmlElement eventTimeElement;
 419         final XmlElement notificationElement;
 420
 421         if (childElements.get(0).getName().equals(EVENT_TIME)) {
 422             eventTimeElement = childElements.get(0);
 423             notificationElement = childElements.get(1);
 424         } else if (childElements.get(1).getName().equals(EVENT_TIME)) {
 425             eventTimeElement = childElements.get(1);
 426             notificationElement = childElements.get(0);
 427         } else {
 428             throw new IllegalArgumentException("Notification payload does not contain " + EVENT_TIME + " " + message);
 429         }
 430
 431         try {
 432             return new SimpleEntry<>(
 433                     NetconfNotification.RFC3339_DATE_PARSER.apply(eventTimeElement.getTextContent()).toInstant(),
 434                     notificationElement);
 435         } catch (final DocumentedException e) {
 436             throw new IllegalArgumentException("Notification payload does not contain " + EVENT_TIME + " " + message,
 437                     e);
 438         } catch (final DateTimeParseException e) {
 439             LOG.warn("Unable to parse event time from {}. Setting time to {}", eventTimeElement,
 440                     NetconfNotification.UNKNOWN_EVENT_TIME, e);
 441             return new SimpleEntry<>(NetconfNotification.UNKNOWN_EVENT_TIME.toInstant(),
 442                     notificationElement);
 443         }
 444     }
 445
 446     public static DOMResult prepareDomResultForRpcRequest(final QName rpcQName, final MessageCounter counter) {
 447         final Document document = XmlUtil.newDocument();
 448         final Element rpcNS =
 449                 document.createElementNS(NETCONF_RPC_QNAME.getNamespace().toString(), NETCONF_RPC_QNAME.getLocalName());
 450         // set msg id
 451         rpcNS.setAttribute(MESSAGE_ID_ATTR, counter.getNewMessageId(MESSAGE_ID_PREFIX));
 452         final Element elementNS = document.createElementNS(rpcQName.getNamespace().toString(), rpcQName.getLocalName());
 453         rpcNS.appendChild(elementNS);
 454         document.appendChild(rpcNS);
 455         return new DOMResult(elementNS);
 456     }
 457
 458     public static DOMResult prepareDomResultForActionRequest(final DataSchemaContextTree dataSchemaContextTree,
 459             final DOMDataTreeIdentifier domDataTreeIdentifier, final SchemaPath actionSchemaPath,
 460             final MessageCounter counter, final QName action) {
 461         final Document document = XmlUtil.newDocument();
 462         final Element rpcNS =
 463                 document.createElementNS(NETCONF_RPC_QNAME.getNamespace().toString(), NETCONF_RPC_QNAME.getLocalName());
 464         // set msg id
 465         rpcNS.setAttribute(MESSAGE_ID_ATTR, counter.getNewMessageId(MESSAGE_ID_PREFIX));
 466
 467         final Element actionNS = document.createElementNS(NETCONF_ACTION_NAMESPACE.toString(), NETCONF_ACTION);
 468         final DataSchemaContextNode<?> rootSchemaContextNode = dataSchemaContextTree.getRoot();
 469         final Element actionData = prepareActionData(rootSchemaContextNode, actionNS,
 470                 domDataTreeIdentifier.getRootIdentifier().getPathArguments().iterator(), document);
 471
 472         final Element specificActionElement =
 473                 document.createElementNS(action.getNamespace().toString(), action.getLocalName());
 474         actionData.appendChild(specificActionElement);
 475         rpcNS.appendChild(actionNS);
 476         document.appendChild(rpcNS);
 477         return new DOMResult(specificActionElement);
 478     }
 479
 480     private static Element prepareActionData(final DataSchemaContextNode<?> currentParentSchemaNode,
 481             final Element actionNS, final Iterator<PathArgument> iterator, final Document document) {
 482         if (iterator.hasNext()) {
 483             final PathArgument next = iterator.next();
 484
 485             final DataSchemaContextNode<?> current = currentParentSchemaNode.getChild(next);
 486             Preconditions.checkArgument(current != null, "Invalid input: schema for argument %s not found", next);
 487
 488             if (current.isMixin()) {
 489                 return prepareActionData(current, actionNS, iterator, document);
 490             }
 491
 492             final QName actualNS = next.getNodeType();
 493             final Element actualElement = document.createElementNS(actualNS.getNamespace().toString(),
 494                     actualNS.getLocalName());
 495             if (next instanceof NodeWithValue) {
 496                 actualElement.setNodeValue(((NodeWithValue) next).getValue().toString());
 497             } else if (next instanceof NodeIdentifierWithPredicates) {
 498                 for (Entry<QName, Object> entry : ((NodeIdentifierWithPredicates) next).entrySet()) {
 499                     final Element entryElement = document.createElementNS(entry.getKey().getNamespace().toString(),
 500                             entry.getKey().getLocalName());
 501                     entryElement.setTextContent(entry.getValue().toString());
 502                     entryElement.setNodeValue(entry.getValue().toString());
 503                     actualElement.appendChild(entryElement);
 504                 }
 505             }
 506             actionNS.appendChild(actualElement);
 507             return prepareActionData(current, actualElement, iterator, document);
 508         } else {
 509             return actionNS;
 510         }
 511     }
 512
 513     @SuppressWarnings("checkstyle:IllegalCatch")
 514     public static void writeNormalizedRpc(final ContainerNode normalized, final DOMResult result,
 515                                           final SchemaPath schemaPath,
 516                                           final SchemaContext baseNetconfCtx) throws IOException, XMLStreamException {
 517         final XMLStreamWriter writer = NetconfUtil.XML_FACTORY.createXMLStreamWriter(result);
 518         try {
 519             try (NormalizedNodeStreamWriter normalizedNodeStreamWriter =
 520                     XMLStreamNormalizedNodeStreamWriter.create(writer, baseNetconfCtx, schemaPath)) {
 521                 try (SchemaOrderedNormalizedNodeWriter normalizedNodeWriter =
 522                         new SchemaOrderedNormalizedNodeWriter(normalizedNodeStreamWriter, baseNetconfCtx, schemaPath)) {
 523                     final Collection<DataContainerChild<?, ?>> value = normalized.getValue();
 524                     normalizedNodeWriter.write(value);
 525                     normalizedNodeWriter.flush();
 526                 }
 527             }
 528         } finally {
 529             try {
 530                 writer.close();
 531             } catch (final Exception e) {
 532                 LOG.warn("Unable to close resource properly", e);
 533             }
 534         }
 535     }
 536
 537     public static RpcResult<NetconfMessage> toRpcResult(final FailedNetconfMessage message) {
 538         return RpcResultBuilder.<NetconfMessage>failed()
 539                 .withRpcError(
 540                         toRpcError(
 541                                 new NetconfDocumentedException(
 542                                         message.getException().getMessage(),
 543                                         DocumentedException.ErrorType.APPLICATION,
 544                                         DocumentedException.ErrorTag.MALFORMED_MESSAGE,
 545                                         DocumentedException.ErrorSeverity.ERROR)))
 546                 .build();
 547     }
 548 }