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