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