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