netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/schema/mapping/BaseRpcSchemalessTransformer.java

   1 /*
   2  * Copyright (c) 2016 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 com.google.common.base.Preconditions;
  11 import java.io.IOException;
  12 import java.util.Map;
  13 import javax.xml.stream.XMLStreamException;
  14 import javax.xml.transform.dom.DOMResult;
  15 import javax.xml.transform.dom.DOMSource;
  16 import org.opendaylight.mdsal.dom.api.DOMNotification;
  17 import org.opendaylight.mdsal.dom.api.DOMRpcResult;
  18 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  19 import org.opendaylight.netconf.api.NetconfMessage;
  20 import org.opendaylight.netconf.api.xml.XmlElement;
  21 import org.opendaylight.netconf.api.xml.XmlUtil;
  22 import org.opendaylight.netconf.sal.connect.api.MessageTransformer;
  23 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  24 import org.opendaylight.netconf.sal.connect.util.MessageCounter;
  25 import org.opendaylight.yangtools.yang.common.QName;
  26 import org.opendaylight.yangtools.yang.common.YangConstants;
  27 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  28 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  31 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  32 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  35 import org.w3c.dom.Document;
  36 import org.w3c.dom.Element;
  37
  38 /**
  39  * Transforms base netconf RPCs.
  40  */
  41 public class BaseRpcSchemalessTransformer implements MessageTransformer<NetconfMessage> {
  42
  43     private static final Map<QName, RpcDefinition> MAPPED_RPCS = BaseSchema.BASE_NETCONF_CTX.getMappedRpcs();
  44     private static final SchemaContext SCHEMA_CONTEXT = BaseSchema.BASE_NETCONF_CTX.getSchemaContext();
  45
  46     private final MessageCounter counter;
  47
  48     public BaseRpcSchemalessTransformer(final MessageCounter counter) {
  49         this.counter = counter;
  50     }
  51
  52     @Override
  53     public DOMNotification toNotification(final NetconfMessage message) {
  54         throw new UnsupportedOperationException("Notifications not supported.");
  55     }
  56
  57     @Override
  58     public NetconfMessage toRpcRequest(final SchemaPath rpc, final NormalizedNode<?, ?> payload) {
  59         // In case no input for rpc is defined, we can simply construct the payload here
  60         final QName rpcQName = rpc.getLastComponent();
  61
  62         final RpcDefinition mappedRpc = Preconditions.checkNotNull(MAPPED_RPCS.get(rpcQName),
  63             "Unknown rpc %s, available rpcs: %s", rpcQName, MAPPED_RPCS.keySet());
  64         final DOMResult domResult = NetconfMessageTransformUtil.prepareDomResultForRpcRequest(rpcQName, counter);
  65         if (mappedRpc.getInput().getChildNodes().isEmpty()) {
  66             return new NetconfMessage(domResult.getNode().getOwnerDocument());
  67         }
  68
  69         Preconditions.checkNotNull(payload, "Transforming an rpc with input: %s, payload cannot be null", rpcQName);
  70         Preconditions.checkArgument(payload instanceof ContainerNode,
  71                 "Transforming an rpc with input: %s, payload has to be a container, but was: %s", rpcQName, payload);
  72
  73         // Set the path to the input of rpc for the payload stream writer
  74         final SchemaPath inputPath = rpc.createChild(YangConstants.operationInputQName(rpcQName.getModule()));
  75         final DOMResult result = domResult;
  76
  77         try {
  78             NetconfMessageTransformUtil.writeNormalizedRpc((ContainerNode) payload, result,
  79                     inputPath, SCHEMA_CONTEXT);
  80         } catch (final XMLStreamException | IOException | IllegalStateException e) {
  81             throw new IllegalStateException("Unable to serialize " + inputPath, e);
  82         }
  83
  84         final Document node = result.getNode().getOwnerDocument();
  85
  86         return new NetconfMessage(node);
  87     }
  88
  89     @Override
  90     public DOMRpcResult toRpcResult(final NetconfMessage message, final SchemaPath rpc) {
  91         final NormalizedNode<?, ?> normalizedNode;
  92         final QName rpcQName = rpc.getLastComponent();
  93         if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpcQName)) {
  94             final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
  95             final Document data = XmlUtil.newDocument();
  96             data.appendChild(data.importNode(xmlData, true));
  97             AnyXmlNode xmlDataNode = Builders.anyXmlBuilder()
  98                     .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
  99                     .withValue(new DOMSource(data))
 100                     .build();
 101
 102             normalizedNode = Builders.containerBuilder()
 103                     .withNodeIdentifier(new YangInstanceIdentifier
 104                             .NodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_QNAME))
 105                     .withChild(xmlDataNode).build();
 106         } else {
 107             //other base rpcs don't have any output, we can simply construct the payload here
 108             Preconditions.checkArgument(isOkPresent(message.getDocument()),
 109                     "Unexpected content in response of rpc: %s, %s", rpc.getLastComponent(), message);
 110             normalizedNode = null;
 111
 112         }
 113         return new DefaultDOMRpcResult(normalizedNode);
 114     }
 115
 116     // FIXME this should go to some util class
 117     static boolean isOkPresent(final Document doc) {
 118         return XmlElement.fromDomDocument(doc).getOnlyChildElementWithSameNamespaceOptionally("ok").isPresent();
 119     }
 120 }