netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/schema/mapping/NetconfMessageTransformer.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.schema.mapping;
   9
  10 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.IETF_NETCONF_NOTIFICATIONS;
  11 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.NETCONF_URI;
  12 import static org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil.toPath;
  13
  14 import com.google.common.annotations.VisibleForTesting;
  15 import com.google.common.base.Preconditions;
  16 import com.google.common.collect.ImmutableSet;
  17 import com.google.common.collect.ImmutableSet.Builder;
  18 import com.google.common.collect.Maps;
  19 import com.google.common.collect.Multimap;
  20 import com.google.common.collect.Multimaps;
  21 import java.io.IOException;
  22 import java.net.URISyntaxException;
  23 import java.time.Instant;
  24 import java.util.Collection;
  25 import java.util.Collections;
  26 import java.util.Map;
  27 import java.util.Set;
  28 import javax.xml.parsers.ParserConfigurationException;
  29 import javax.xml.stream.XMLStreamException;
  30 import javax.xml.transform.dom.DOMResult;
  31 import javax.xml.transform.dom.DOMSource;
  32 import org.opendaylight.mdsal.dom.api.DOMActionResult;
  33 import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier;
  34 import org.opendaylight.mdsal.dom.api.DOMEvent;
  35 import org.opendaylight.mdsal.dom.api.DOMNotification;
  36 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  37 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  38 import org.opendaylight.mdsal.dom.spi.SimpleDOMActionResult;
  39 import org.opendaylight.netconf.api.NetconfMessage;
  40 import org.opendaylight.netconf.api.xml.MissingNameSpaceException;
  41 import org.opendaylight.netconf.api.xml.XmlElement;
  42 import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
  43 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  44 import org.opendaylight.netconf.sal.connect.util.MessageCounter;
  45 import org.opendaylight.yangtools.yang.common.QName;
  46 import org.opendaylight.yangtools.yang.common.Revision;
  47 import org.opendaylight.yangtools.yang.common.RpcError;
  48 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  49 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  50 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  51 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  52 import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream;
  53 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  54 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter;
  55 import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult;
  56 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  57 import org.opendaylight.yangtools.yang.model.api.ActionDefinition;
  58 import org.opendaylight.yangtools.yang.model.api.ActionNodeContainer;
  59 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  60 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  61 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  62 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  63 import org.opendaylight.yangtools.yang.model.api.OperationDefinition;
  64 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  65 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  66 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  67 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  68 import org.slf4j.Logger;
  69 import org.slf4j.LoggerFactory;
  70 import org.w3c.dom.Document;
  71 import org.w3c.dom.Element;
  72 import org.xml.sax.SAXException;
  73
  74 public class NetconfMessageTransformer implements MessageTransformer<NetconfMessage> {
  75
  76     private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageTransformer.class);
  77
  78     private final SchemaContext schemaContext;
  79     private final BaseSchema baseSchema;
  80     private final MessageCounter counter;
  81     private final Map<QName, RpcDefinition> mappedRpcs;
  82     private final Multimap<QName, NotificationDefinition> mappedNotifications;
  83     private final boolean strictParsing;
  84     private final Set<ActionDefinition> actions;
  85
  86     public NetconfMessageTransformer(final SchemaContext schemaContext, final boolean strictParsing) {
  87         this(schemaContext, strictParsing, BaseSchema.BASE_NETCONF_CTX);
  88     }
  89
  90     public NetconfMessageTransformer(final SchemaContext schemaContext, final boolean strictParsing,
  91                                      final BaseSchema baseSchema) {
  92         this.counter = new MessageCounter();
  93         this.schemaContext = schemaContext;
  94         this.mappedRpcs = Maps.uniqueIndex(schemaContext.getOperations(), SchemaNode::getQName);
  95         this.actions = getActions();
  96         this.mappedNotifications = Multimaps.index(schemaContext.getNotifications(),
  97             node -> node.getQName().withoutRevision());
  98         this.baseSchema = baseSchema;
  99         this.strictParsing = strictParsing;
 100     }
 101
 102     @VisibleForTesting
 103     Set<ActionDefinition> getActions() {
 104         Builder<ActionDefinition> builder = ImmutableSet.builder();
 105         for (DataSchemaNode dataSchemaNode : schemaContext.getChildNodes()) {
 106             if (dataSchemaNode instanceof ActionNodeContainer) {
 107                 findAction(dataSchemaNode, builder);
 108             }
 109         }
 110         return builder.build();
 111     }
 112
 113     private void findAction(final DataSchemaNode dataSchemaNode, final Builder<ActionDefinition> builder) {
 114         if (dataSchemaNode instanceof ActionNodeContainer) {
 115             final ActionNodeContainer containerSchemaNode = (ActionNodeContainer) dataSchemaNode;
 116             for (ActionDefinition actionDefinition : containerSchemaNode.getActions()) {
 117                 builder.add(actionDefinition);
 118             }
 119         }
 120         if (dataSchemaNode instanceof DataNodeContainer) {
 121             for (DataSchemaNode innerDataSchemaNode : ((DataNodeContainer) dataSchemaNode).getChildNodes()) {
 122                 findAction(innerDataSchemaNode, builder);
 123             }
 124         }
 125     }
 126
 127     @Override
 128     public synchronized DOMNotification toNotification(final NetconfMessage message) {
 129         final Map.Entry<Instant, XmlElement> stripped = NetconfMessageTransformUtil.stripNotification(message);
 130         final QName notificationNoRev;
 131         try {
 132             notificationNoRev = QName.create(
 133                     stripped.getValue().getNamespace(), stripped.getValue().getName()).withoutRevision();
 134         } catch (final MissingNameSpaceException e) {
 135             throw new IllegalArgumentException(
 136                     "Unable to parse notification " + message + ", cannot find namespace", e);
 137         }
 138         final Collection<NotificationDefinition> notificationDefinitions = mappedNotifications.get(notificationNoRev);
 139         Preconditions.checkArgument(notificationDefinitions.size() > 0,
 140                 "Unable to parse notification %s, unknown notification. Available notifications: %s",
 141                 notificationDefinitions, mappedNotifications.keySet());
 142
 143         final NotificationDefinition mostRecentNotification = getMostRecentNotification(notificationDefinitions);
 144
 145         final ContainerSchemaNode notificationAsContainerSchemaNode =
 146                 NetconfMessageTransformUtil.createSchemaForNotification(mostRecentNotification);
 147
 148         final Element element = stripped.getValue().getDomElement();
 149         final ContainerNode content;
 150         try {
 151             final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 152             final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 153             final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext,
 154                     notificationAsContainerSchemaNode, strictParsing);
 155             xmlParser.traverse(new DOMSource(element));
 156             content = (ContainerNode) resultHolder.getResult();
 157         } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
 158                 | SAXException | UnsupportedOperationException e) {
 159             throw new IllegalArgumentException(String.format("Failed to parse notification %s", element), e);
 160         }
 161         return new NetconfDeviceNotification(content, stripped.getKey());
 162     }
 163
 164     private static NotificationDefinition getMostRecentNotification(
 165             final Collection<NotificationDefinition> notificationDefinitions) {
 166         return Collections.max(notificationDefinitions, (o1, o2) ->
 167             Revision.compare(o1.getQName().getRevision(), o2.getQName().getRevision()));
 168     }
 169
 170     @Override
 171     public NetconfMessage toRpcRequest(SchemaPath rpc, final NormalizedNode<?, ?> payload) {
 172         // In case no input for rpc is defined, we can simply construct the payload here
 173         final QName rpcQName = rpc.getLastComponent();
 174         Map<QName, RpcDefinition> currentMappedRpcs = mappedRpcs;
 175
 176         // Determine whether a base netconf operation is being invoked
 177         // and also check if the device exposed model for base netconf.
 178         // If no, use pre built base netconf operations model
 179         final boolean needToUseBaseCtx = mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName);
 180         if (needToUseBaseCtx) {
 181             currentMappedRpcs = baseSchema.getMappedRpcs();
 182         }
 183
 184         Preconditions.checkNotNull(currentMappedRpcs.get(rpcQName),
 185                 "Unknown rpc %s, available rpcs: %s", rpcQName, currentMappedRpcs.keySet());
 186         if (currentMappedRpcs.get(rpcQName).getInput().getChildNodes().isEmpty()) {
 187             return new NetconfMessage(NetconfMessageTransformUtil
 188                     .prepareDomResultForRpcRequest(rpcQName, counter).getNode().getOwnerDocument());
 189         }
 190
 191         Preconditions.checkNotNull(payload, "Transforming an rpc with input: %s, payload cannot be null", rpcQName);
 192
 193         Preconditions.checkArgument(payload instanceof ContainerNode,
 194                 "Transforming an rpc with input: %s, payload has to be a container, but was: %s", rpcQName, payload);
 195         // Set the path to the input of rpc for the node stream writer
 196         rpc = rpc.createChild(QName.create(rpcQName, "input").intern());
 197         final DOMResult result = NetconfMessageTransformUtil.prepareDomResultForRpcRequest(rpcQName, counter);
 198
 199         try {
 200             // If the schema context for netconf device does not contain model for base netconf operations,
 201             // use default pre build context with just the base model
 202             // This way operations like lock/unlock are supported even if the source for base model was not provided
 203             SchemaContext ctx = needToUseBaseCtx ? baseSchema.getSchemaContext() : schemaContext;
 204             NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result, rpc, ctx);
 205         } catch (final XMLStreamException | IOException | IllegalStateException e) {
 206             throw new IllegalStateException("Unable to serialize " + rpc, e);
 207         }
 208
 209         final Document node = result.getNode().getOwnerDocument();
 210
 211         return new NetconfMessage(node);
 212     }
 213
 214     @Override
 215     public NetconfMessage toActionRequest(SchemaPath action, final DOMDataTreeIdentifier domDataTreeIdentifier,
 216             final NormalizedNode<?, ?> payload) {
 217         ActionDefinition actionDefinition = null;
 218         SchemaPath schemaPath = action;
 219         for (ActionDefinition actionDef : actions) {
 220             if (actionDef.getPath().getLastComponent().equals(action.getLastComponent())) {
 221                 actionDefinition = actionDef;
 222                 schemaPath = actionDef.getPath();
 223             }
 224         }
 225         Preconditions.checkNotNull(actionDefinition, "Action does not exist: %s", action.getLastComponent());
 226
 227         if (actionDefinition.getInput().getChildNodes().isEmpty()) {
 228             return new NetconfMessage(NetconfMessageTransformUtil.prepareDomResultForActionRequest(
 229                     DataSchemaContextTree.from(schemaContext), domDataTreeIdentifier, action, counter,
 230                     actionDefinition.getQName().getLocalName())
 231                     .getNode().getOwnerDocument());
 232         }
 233
 234         Preconditions.checkNotNull(payload, "Transforming an action with input: %s, payload cannot be null",
 235                 action.getLastComponent());
 236         Preconditions.checkArgument(payload instanceof ContainerNode,
 237                 "Transforming an rpc with input: %s, payload has to be a container, but was: %s",
 238                 action.getLastComponent(), payload);
 239         // Set the path to the input of rpc for the node stream writer
 240         action = action.createChild(QName.create(action.getLastComponent(), "input").intern());
 241         final DOMResult result = NetconfMessageTransformUtil.prepareDomResultForActionRequest(
 242                 DataSchemaContextTree.from(schemaContext), domDataTreeIdentifier, action, counter,
 243                 actionDefinition.getQName().getLocalName());
 244
 245         try {
 246             NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result,
 247                     schemaPath.createChild(QName.create(action.getLastComponent(), "input").intern()), schemaContext);
 248         } catch (final XMLStreamException | IOException | IllegalStateException e) {
 249             throw new IllegalStateException("Unable to serialize " + action, e);
 250         }
 251
 252         final Document node = result.getNode().getOwnerDocument();
 253
 254         return new NetconfMessage(node);
 255     }
 256
 257     private static boolean isBaseOrNotificationRpc(final QName rpc) {
 258         return rpc.getNamespace().equals(NETCONF_URI)
 259                 || rpc.getNamespace().equals(IETF_NETCONF_NOTIFICATIONS.getNamespace())
 260                 || rpc.getNamespace().equals(NetconfMessageTransformUtil.CREATE_SUBSCRIPTION_RPC_QNAME.getNamespace());
 261     }
 262
 263     @Override
 264     public synchronized DOMRpcResult toRpcResult(final NetconfMessage message, final SchemaPath rpc) {
 265         final NormalizedNode<?, ?> normalizedNode;
 266         final QName rpcQName = rpc.getLastComponent();
 267         if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpcQName)) {
 268             final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
 269             final ContainerSchemaNode schemaForDataRead =
 270                     NetconfMessageTransformUtil.createSchemaForDataRead(schemaContext);
 271             final ContainerNode dataNode;
 272
 273             try {
 274                 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 275                 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 276                 final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext, schemaForDataRead,
 277                         strictParsing);
 278                 xmlParser.traverse(new DOMSource(xmlData));
 279                 dataNode = (ContainerNode) resultHolder.getResult();
 280             } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
 281                     | SAXException e) {
 282                 throw new IllegalArgumentException(String.format("Failed to parse data response %s", xmlData), e);
 283             }
 284
 285             normalizedNode = Builders.containerBuilder()
 286                     .withNodeIdentifier(new YangInstanceIdentifier
 287                             .NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME))
 288                     .withChild(dataNode).build();
 289         } else {
 290
 291             Map<QName, RpcDefinition> currentMappedRpcs = mappedRpcs;
 292
 293             // Determine whether a base netconf operation is being invoked
 294             // and also check if the device exposed model for base netconf.
 295             // If no, use pre built base netconf operations model
 296             final boolean needToUseBaseCtx = mappedRpcs.get(rpcQName) == null && isBaseOrNotificationRpc(rpcQName);
 297             if (needToUseBaseCtx) {
 298                 currentMappedRpcs = baseSchema.getMappedRpcs();
 299             }
 300
 301             final RpcDefinition rpcDefinition = currentMappedRpcs.get(rpcQName);
 302             Preconditions.checkArgument(rpcDefinition != null,
 303                     "Unable to parse response of %s, the rpc is unknown", rpcQName);
 304
 305             // In case no input for rpc is defined, we can simply construct the payload here
 306             normalizedNode = parseResult(message, rpcDefinition);
 307         }
 308         return new DefaultDOMRpcResult(normalizedNode);
 309     }
 310
 311     @Override
 312     public DOMActionResult toActionResult(final SchemaPath action, final NetconfMessage message) {
 313         ActionDefinition actionDefinition = null;
 314         for (ActionDefinition actionDef : actions) {
 315             if (actionDef.getPath().getLastComponent().equals(action.getLastComponent())) {
 316                 actionDefinition = actionDef;
 317             }
 318         }
 319         Preconditions.checkNotNull(actionDefinition, "Action does not exist: %s", action);
 320         ContainerNode normalizedNode = (ContainerNode) parseResult(message, actionDefinition);
 321
 322         if (normalizedNode == null) {
 323             return new SimpleDOMActionResult(Collections.<RpcError>emptyList());
 324         } else {
 325             return new SimpleDOMActionResult(normalizedNode, Collections.<RpcError>emptyList());
 326         }
 327     }
 328
 329     private NormalizedNode<?, ?> parseResult(final NetconfMessage message,
 330             final OperationDefinition operationDefinition) {
 331         if (operationDefinition.getOutput().getChildNodes().isEmpty()) {
 332             Preconditions.checkArgument(XmlElement.fromDomDocument(
 333                 message.getDocument()).getOnlyChildElementWithSameNamespaceOptionally("ok").isPresent(),
 334                 "Unexpected content in response of rpc: %s, %s", operationDefinition.getQName(), message);
 335             return null;
 336         } else {
 337             final Element element = message.getDocument().getDocumentElement();
 338             try {
 339                 final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
 340                 final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
 341                 final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext,
 342                         operationDefinition.getOutput(), strictParsing);
 343                 xmlParser.traverse(new DOMSource(element));
 344                 return resultHolder.getResult();
 345             } catch (XMLStreamException | URISyntaxException | IOException | ParserConfigurationException
 346                     | SAXException e) {
 347                 throw new IllegalArgumentException(String.format("Failed to parse RPC response %s", element), e);
 348             }
 349         }
 350     }
 351
 352     static class NetconfDeviceNotification implements DOMNotification, DOMEvent {
 353         private final ContainerNode content;
 354         private final SchemaPath schemaPath;
 355         private final Instant eventTime;
 356
 357         NetconfDeviceNotification(final ContainerNode content, final Instant eventTime) {
 358             this.content = content;
 359             this.eventTime = eventTime;
 360             this.schemaPath = toPath(content.getNodeType());
 361         }
 362
 363         @Override
 364         public SchemaPath getType() {
 365             return schemaPath;
 366         }
 367
 368         @Override
 369         public ContainerNode getBody() {
 370             return content;
 371         }
 372
 373         @Override
 374         public Instant getEventInstant() {
 375             return eventTime;
 376         }
 377     }
 378 }