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