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