opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/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.controller.sal.connect.netconf.util;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.ImmutableMap;
  13 import com.google.common.collect.Iterables;
  14 import com.google.common.collect.Lists;
  15 import java.io.IOException;
  16 import java.net.URI;
  17 import java.util.AbstractMap;
  18 import java.util.Collections;
  19 import java.util.Map;
  20 import java.util.Map.Entry;
  21 import javax.xml.stream.XMLOutputFactory;
  22 import javax.xml.stream.XMLStreamException;
  23 import javax.xml.stream.XMLStreamWriter;
  24 import javax.xml.transform.dom.DOMResult;
  25 import javax.xml.transform.dom.DOMSource;
  26 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  27 import org.opendaylight.controller.netconf.api.NetconfMessage;
  28 import org.opendaylight.controller.netconf.util.messages.NetconfMessageUtil;
  29 import org.opendaylight.controller.netconf.util.xml.XmlUtil;
  30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.edit.config.input.EditContent;
  31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput;
  32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState;
  33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.notifications.rev120206.NetconfCapabilityChange;
  34 import org.opendaylight.yangtools.yang.common.QName;
  35 import org.opendaylight.yangtools.yang.common.RpcError;
  36 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
  37 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
  38 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  39 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  40 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  41 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  42 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  43 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  44 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  45 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeWriter;
  46 import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder;
  50 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  51 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  52 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  53 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56 import org.w3c.dom.Document;
  57 import org.w3c.dom.Element;
  58
  59 public class NetconfMessageTransformUtil {
  60
  61     private static final Logger LOG= LoggerFactory.getLogger(NetconfMessageTransformUtil.class);
  62
  63     public static final String MESSAGE_ID_ATTR = "message-id";
  64     public static final XMLOutputFactory XML_FACTORY;
  65
  66     static {
  67         XML_FACTORY = XMLOutputFactory.newFactory();
  68         XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false);
  69     }
  70
  71     public static final QName CREATE_SUBSCRIPTION_RPC_QNAME = QName.cachedReference(QName.create(CreateSubscriptionInput.QNAME, "create-subscription"));
  72     private static final String SUBTREE = "subtree";
  73
  74     // Blank document used for creation of new DOM nodes
  75     private static final Document BLANK_DOCUMENT = XmlUtil.newDocument();
  76     public static final String EVENT_TIME = "eventTime";
  77
  78     private NetconfMessageTransformUtil() {}
  79
  80     public static final QName IETF_NETCONF_MONITORING = QName.create(NetconfState.QNAME, "ietf-netconf-monitoring");
  81     public static final QName GET_DATA_QNAME = QName.create(IETF_NETCONF_MONITORING, "data");
  82     public static final QName GET_SCHEMA_QNAME = QName.create(IETF_NETCONF_MONITORING, "get-schema");
  83     public static final QName IETF_NETCONF_MONITORING_SCHEMA_FORMAT = QName.create(IETF_NETCONF_MONITORING, "format");
  84     public static final QName IETF_NETCONF_MONITORING_SCHEMA_LOCATION = QName.create(IETF_NETCONF_MONITORING, "location");
  85     public static final QName IETF_NETCONF_MONITORING_SCHEMA_IDENTIFIER = QName.create(IETF_NETCONF_MONITORING, "identifier");
  86     public static final QName IETF_NETCONF_MONITORING_SCHEMA_VERSION = QName.create(IETF_NETCONF_MONITORING, "version");
  87     public static final QName IETF_NETCONF_MONITORING_SCHEMA_NAMESPACE = QName.create(IETF_NETCONF_MONITORING, "namespace");
  88
  89     public static final QName IETF_NETCONF_NOTIFICATIONS = QName.create(NetconfCapabilityChange.QNAME, "ietf-netconf-notifications");
  90
  91     public static URI NETCONF_URI = URI.create("urn:ietf:params:xml:ns:netconf:base:1.0");
  92     public static QName NETCONF_QNAME = QName.create(NETCONF_URI.toString(), "2011-06-01", "netconf");
  93     public static QName NETCONF_DATA_QNAME = QName.create(NETCONF_QNAME, "data");
  94     public static QName NETCONF_RPC_REPLY_QNAME = QName.create(NETCONF_QNAME, "rpc-reply");
  95     public static QName NETCONF_OK_QNAME = QName.create(NETCONF_QNAME, "ok");
  96     public static QName NETCONF_ERROR_OPTION_QNAME = QName.create(NETCONF_QNAME, "error-option");
  97     public static QName NETCONF_RUNNING_QNAME = QName.create(NETCONF_QNAME, "running");
  98     public static QName NETCONF_SOURCE_QNAME = QName.create(NETCONF_QNAME, "source");
  99     public static QName NETCONF_CANDIDATE_QNAME = QName.create(NETCONF_QNAME, "candidate");
 100     public static QName NETCONF_TARGET_QNAME = QName.create(NETCONF_QNAME, "target");
 101     public static QName NETCONF_CONFIG_QNAME = QName.create(NETCONF_QNAME, "config");
 102     public static QName NETCONF_COMMIT_QNAME = QName.create(NETCONF_QNAME, "commit");
 103     public static QName NETCONF_VALIDATE_QNAME = QName.create(NETCONF_QNAME, "validate");
 104     public static QName NETCONF_COPY_CONFIG_QNAME = QName.create(NETCONF_QNAME, "copy-config");
 105     public static QName NETCONF_OPERATION_QNAME = QName.create(NETCONF_QNAME, "operation");
 106     public static QName NETCONF_DEFAULT_OPERATION_QNAME = QName.create(NETCONF_OPERATION_QNAME, "default-operation");
 107     public static QName NETCONF_EDIT_CONFIG_QNAME = QName.create(NETCONF_QNAME, "edit-config");
 108     public static QName NETCONF_GET_CONFIG_QNAME = QName.create(NETCONF_QNAME, "get-config");
 109     public static QName NETCONF_DISCARD_CHANGES_QNAME = QName.create(NETCONF_QNAME, "discard-changes");
 110     public static QName NETCONF_TYPE_QNAME = QName.create(NETCONF_QNAME, "type");
 111     public static QName NETCONF_FILTER_QNAME = QName.create(NETCONF_QNAME, "filter");
 112     public static QName NETCONF_GET_QNAME = QName.create(NETCONF_QNAME, "get");
 113     public static QName NETCONF_RPC_QNAME = QName.create(NETCONF_QNAME, "rpc");
 114
 115     public static URI NETCONF_ROLLBACK_ON_ERROR_URI = URI
 116             .create("urn:ietf:params:netconf:capability:rollback-on-error:1.0");
 117     public static String ROLLBACK_ON_ERROR_OPTION = "rollback-on-error";
 118
 119     public static URI NETCONF_CANDIDATE_URI = URI
 120             .create("urn:ietf:params:netconf:capability:candidate:1.0");
 121
 122     public static URI NETCONF_NOTIFICATONS_URI = URI
 123             .create("urn:ietf:params:netconf:capability:notification:1.0");
 124
 125     public static URI NETCONF_RUNNING_WRITABLE_URI = URI
 126             .create("urn:ietf:params:netconf:capability:writable-running:1.0");
 127
 128     public static QName NETCONF_LOCK_QNAME = QName.create(NETCONF_QNAME, "lock");
 129     public static QName NETCONF_UNLOCK_QNAME = QName.create(NETCONF_QNAME, "unlock");
 130
 131     // Discard changes message
 132     public static final ContainerNode DISCARD_CHANGES_RPC_CONTENT =
 133             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NETCONF_DISCARD_CHANGES_QNAME)).build();
 134
 135     // Commit changes message
 136     public static final ContainerNode COMMIT_RPC_CONTENT =
 137             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NETCONF_COMMIT_QNAME)).build();
 138
 139     // Get message
 140     public static final ContainerNode GET_RPC_CONTENT =
 141             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(NETCONF_GET_QNAME)).build();
 142
 143     // Create-subscription changes message
 144     public static final ContainerNode CREATE_SUBSCRIPTION_RPC_CONTENT =
 145             Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(CREATE_SUBSCRIPTION_RPC_QNAME)).build();
 146
 147     public static final DataContainerChild<?, ?> EMPTY_FILTER;
 148
 149     static {
 150         final NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, DOMSource, AnyXmlNode> anyXmlBuilder = Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_FILTER_QNAME));
 151         anyXmlBuilder.withAttributes(Collections.singletonMap(NETCONF_TYPE_QNAME, SUBTREE));
 152
 153         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(), Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString()));
 154         element.setAttributeNS(NETCONF_FILTER_QNAME.getNamespace().toString(), NETCONF_TYPE_QNAME.getLocalName(), "subtree");
 155
 156         anyXmlBuilder.withValue(new DOMSource(element));
 157
 158         EMPTY_FILTER = anyXmlBuilder.build();
 159     }
 160
 161     public static DataContainerChild<?, ?> toFilterStructure(final YangInstanceIdentifier identifier, final SchemaContext ctx) {
 162         final NormalizedNodeAttrBuilder<YangInstanceIdentifier.NodeIdentifier, DOMSource, AnyXmlNode> anyXmlBuilder = Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_FILTER_QNAME));
 163         anyXmlBuilder.withAttributes(Collections.singletonMap(NETCONF_TYPE_QNAME, SUBTREE));
 164
 165         final NormalizedNode<?, ?> filterContent = ImmutableNodes.fromInstanceId(ctx, identifier);
 166
 167         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(), Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString()));
 168         element.setAttributeNS(NETCONF_FILTER_QNAME.getNamespace().toString(), NETCONF_TYPE_QNAME.getLocalName(), "subtree");
 169
 170         try {
 171             writeNormalizedNode(filterContent, new DOMResult(element), SchemaPath.ROOT, ctx);
 172         } catch (IOException | XMLStreamException e) {
 173             throw new IllegalStateException("Unable to serialize filter element for path " + identifier, e);
 174         }
 175         anyXmlBuilder.withValue(new DOMSource(element));
 176
 177         return anyXmlBuilder.build();
 178     }
 179
 180     public static void checkValidReply(final NetconfMessage input, final NetconfMessage output)
 181             throws NetconfDocumentedException {
 182         final String inputMsgId = input.getDocument().getDocumentElement().getAttribute(MESSAGE_ID_ATTR);
 183         final String outputMsgId = output.getDocument().getDocumentElement().getAttribute(MESSAGE_ID_ATTR);
 184
 185         if(inputMsgId.equals(outputMsgId) == false) {
 186             final Map<String,String> errorInfo = ImmutableMap.<String,String>builder()
 187                     .put( "actual-message-id", outputMsgId )
 188                     .put( "expected-message-id", inputMsgId )
 189                     .build();
 190
 191             throw new NetconfDocumentedException( "Response message contained unknown \"message-id\"",
 192                     null, NetconfDocumentedException.ErrorType.protocol,
 193                     NetconfDocumentedException.ErrorTag.bad_attribute,
 194                     NetconfDocumentedException.ErrorSeverity.error, errorInfo );
 195         }
 196     }
 197
 198     public static void checkSuccessReply(final NetconfMessage output) throws NetconfDocumentedException {
 199         if(NetconfMessageUtil.isErrorMessage(output)) {
 200             throw NetconfDocumentedException.fromXMLDocument(output.getDocument());
 201         }
 202     }
 203
 204     public static RpcError toRpcError( final NetconfDocumentedException ex ) {
 205         final StringBuilder infoBuilder = new StringBuilder();
 206         final Map<String, String> errorInfo = ex.getErrorInfo();
 207         if(errorInfo != null) {
 208             for( final Entry<String,String> e: errorInfo.entrySet() ) {
 209                 infoBuilder.append( '<' ).append( e.getKey() ).append( '>' ).append( e.getValue() )
 210                 .append( "</" ).append( e.getKey() ).append( '>' );
 211
 212             }
 213         }
 214
 215         final ErrorSeverity severity = toRpcErrorSeverity( ex.getErrorSeverity() );
 216         return severity == ErrorSeverity.ERROR ?
 217                 RpcResultBuilder.newError(
 218                         toRpcErrorType( ex.getErrorType() ), ex.getErrorTag().getTagValue(),
 219                         ex.getLocalizedMessage(), null, infoBuilder.toString(), ex.getCause() ) :
 220                             RpcResultBuilder.newWarning(
 221                                     toRpcErrorType( ex.getErrorType() ), ex.getErrorTag().getTagValue(),
 222                                     ex.getLocalizedMessage(), null, infoBuilder.toString(), ex.getCause() );
 223     }
 224
 225     private static ErrorSeverity toRpcErrorSeverity( final NetconfDocumentedException.ErrorSeverity severity ) {
 226         switch( severity ) {
 227         case warning:
 228             return RpcError.ErrorSeverity.WARNING;
 229         default:
 230             return RpcError.ErrorSeverity.ERROR;
 231         }
 232     }
 233
 234     private static RpcError.ErrorType toRpcErrorType(final NetconfDocumentedException.ErrorType type) {
 235         switch( type ) {
 236         case protocol:
 237             return RpcError.ErrorType.PROTOCOL;
 238         case rpc:
 239             return RpcError.ErrorType.RPC;
 240         case transport:
 241             return RpcError.ErrorType.TRANSPORT;
 242         default:
 243             return RpcError.ErrorType.APPLICATION;
 244         }
 245     }
 246
 247     public static YangInstanceIdentifier.NodeIdentifier toId(final YangInstanceIdentifier.PathArgument qname) {
 248         return toId(qname.getNodeType());
 249     }
 250
 251     public static YangInstanceIdentifier.NodeIdentifier toId(final QName nodeType) {
 252         return new YangInstanceIdentifier.NodeIdentifier(nodeType);
 253     }
 254
 255     public static Element getDataSubtree(final Document doc) {
 256         return (Element) doc.getElementsByTagNameNS(NETCONF_URI.toString(), "data").item(0);
 257     }
 258
 259     public static boolean isDataRetrievalOperation(final QName rpc) {
 260         return NETCONF_URI.equals(rpc.getNamespace())
 261                 && (rpc.getLocalName().equals(NETCONF_GET_CONFIG_QNAME.getLocalName()) || rpc.getLocalName().equals(
 262                         NETCONF_GET_QNAME.getLocalName()));
 263     }
 264
 265     public static ContainerSchemaNode createSchemaForDataRead(final SchemaContext schemaContext) {
 266         final QName config = QName.create(NETCONF_EDIT_CONFIG_QNAME, "data");
 267         return new NodeContainerProxy(config, schemaContext.getChildNodes());
 268     }
 269
 270     public static ContainerSchemaNode createSchemaForNotification(final NotificationDefinition next) {
 271         return new NodeContainerProxy(next.getQName(), next.getChildNodes(), next.getAvailableAugmentations());
 272     }
 273
 274     public static ContainerNode wrap(final QName name, final DataContainerChild<?, ?>... node) {
 275         return Builders.containerBuilder().withNodeIdentifier(toId(name)).withValue(Lists.newArrayList(node)).build();
 276     }
 277
 278     public static DataContainerChild<?, ?> createEditConfigStructure(final SchemaContext ctx, final YangInstanceIdentifier dataPath,
 279                                                                      final Optional<ModifyAction> operation, final Optional<NormalizedNode<?, ?>> lastChildOverride) {
 280         final NormalizedNode<?, ?> configContent;
 281
 282         if(Iterables.isEmpty(dataPath.getPathArguments())) {
 283             Preconditions.checkArgument(lastChildOverride.isPresent(), "Data has to be present when creating structure for top level element");
 284             Preconditions.checkArgument(lastChildOverride.get() instanceof DataContainerChild<?, ?>,
 285                     "Data has to be either container or a list node when creating structure for top level element, but was: %s", lastChildOverride.get());
 286             configContent = lastChildOverride.get();
 287         } else {
 288             final Entry<QName, ModifyAction> modifyOperation =
 289                     operation.isPresent() ? new AbstractMap.SimpleEntry<>(NETCONF_OPERATION_QNAME, operation.get()) : null;
 290             configContent = ImmutableNodes.fromInstanceId(ctx, dataPath, lastChildOverride, Optional.fromNullable(modifyOperation));
 291         }
 292
 293         final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_CONFIG_QNAME.getLocalName(), Optional.of(NETCONF_CONFIG_QNAME.getNamespace().toString()));
 294         try {
 295             writeNormalizedNode(configContent, new DOMResult(element), SchemaPath.ROOT, ctx);
 296         } catch (IOException | XMLStreamException e) {
 297             throw new IllegalStateException("Unable to serialize edit config content element for path " + dataPath, e);
 298         }
 299         final DOMSource value = new DOMSource(element);
 300
 301         return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)).withChild(
 302                 Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_CONFIG_QNAME)).withValue(value).build()).build();
 303     }
 304
 305     public static SchemaPath toPath(final QName rpc) {
 306         return SchemaPath.create(true, rpc);
 307     }
 308
 309     // FIXME similar code is in netconf-notifications-impl , DRY
 310     public static void writeNormalizedNode(final NormalizedNode<?, ?> normalized, final DOMResult result, final SchemaPath schemaPath, final SchemaContext context)
 311             throws IOException, XMLStreamException {
 312         NormalizedNodeWriter normalizedNodeWriter = null;
 313         NormalizedNodeStreamWriter normalizedNodeStreamWriter = null;
 314         XMLStreamWriter writer = null;
 315         try {
 316             writer = XML_FACTORY.createXMLStreamWriter(result);
 317             normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath);
 318             normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter);
 319
 320             normalizedNodeWriter.write(normalized);
 321
 322             normalizedNodeWriter.flush();
 323         } finally {
 324             try {
 325                 if(normalizedNodeWriter != null) {
 326                     normalizedNodeWriter.close();
 327                 }
 328                 if(normalizedNodeStreamWriter != null) {
 329                     normalizedNodeStreamWriter.close();
 330                 }
 331                 if(writer != null) {
 332                     writer.close();
 333                 }
 334             } catch (final Exception e) {
 335                 LOG.warn("Unable to close resource properly", e);
 336             }
 337         }
 338     }
 339 }