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 com.google.common.collect.ImmutableMap;
  12 import java.io.IOException;
  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.DOMRpcResult;
  17 import org.opendaylight.mdsal.dom.spi.DefaultDOMRpcResult;
  18 import org.opendaylight.netconf.api.NetconfMessage;
  19 import org.opendaylight.netconf.api.xml.XmlElement;
  20 import org.opendaylight.netconf.api.xml.XmlUtil;
  21 import org.opendaylight.netconf.sal.connect.api.RpcTransformer;
  22 import org.opendaylight.netconf.sal.connect.netconf.util.NetconfMessageTransformUtil;
  23 import org.opendaylight.netconf.sal.connect.util.MessageCounter;
  24 import org.opendaylight.yangtools.yang.common.QName;
  25 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.DOMSourceAnyxmlNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.Builders;
  29 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
  30 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  32 import org.w3c.dom.Document;
  33 import org.w3c.dom.Element;
  34
  35 /**
  36  * Transforms base netconf RPCs.
  37  */
  38 public class BaseRpcSchemalessTransformer implements RpcTransformer {
  39     private final ImmutableMap<QName, ? extends RpcDefinition> mappedRpcs;
  40     private final EffectiveModelContext modelContext;
  41     private final MessageCounter counter;
  42
  43     public BaseRpcSchemalessTransformer(final BaseNetconfSchemas baseSchemas, final MessageCounter counter) {
  44         final BaseSchema baseSchema = baseSchemas.getBaseSchema();
  45         mappedRpcs = baseSchema.getMappedRpcs();
  46         modelContext = baseSchema.getEffectiveModelContext();
  47         this.counter = counter;
  48     }
  49
  50     @Override
  51     public NetconfMessage toRpcRequest(final QName rpc, final NormalizedNode payload) {
  52         // In case no input for rpc is defined, we can simply construct the payload here
  53
  54         final RpcDefinition mappedRpc = Preconditions.checkNotNull(mappedRpcs.get(rpc),
  55             "Unknown rpc %s, available rpcs: %s", rpc, mappedRpcs.keySet());
  56         final DOMResult domResult = NetconfMessageTransformUtil.prepareDomResultForRpcRequest(rpc, counter);
  57         if (mappedRpc.getInput().getChildNodes().isEmpty()) {
  58             return new NetconfMessage(domResult.getNode().getOwnerDocument());
  59         }
  60
  61         Preconditions.checkNotNull(payload, "Transforming an rpc with input: %s, payload cannot be null", rpc);
  62         Preconditions.checkArgument(payload instanceof ContainerNode,
  63                 "Transforming an rpc with input: %s, payload has to be a container, but was: %s", rpc, payload);
  64
  65         final DOMResult result = domResult;
  66         try {
  67             NetconfMessageTransformUtil.writeNormalizedOperationInput((ContainerNode) payload, result, Absolute.of(rpc),
  68                 modelContext);
  69         } catch (final XMLStreamException | IOException | IllegalStateException e) {
  70             throw new IllegalStateException("Unable to serialize input of " + rpc, e);
  71         }
  72
  73         final Document node = result.getNode().getOwnerDocument();
  74
  75         return new NetconfMessage(node);
  76     }
  77
  78     @Override
  79     public DOMRpcResult toRpcResult(final NetconfMessage message, final QName rpc) {
  80         final ContainerNode normalizedNode;
  81         if (NetconfMessageTransformUtil.isDataRetrievalOperation(rpc)) {
  82             final Element xmlData = NetconfMessageTransformUtil.getDataSubtree(message.getDocument());
  83             final Document data = XmlUtil.newDocument();
  84             data.appendChild(data.importNode(xmlData, true));
  85             DOMSourceAnyxmlNode xmlDataNode = Builders.anyXmlBuilder()
  86                     .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_DATA_NODEID)
  87                     .withValue(new DOMSource(data))
  88                     .build();
  89
  90             normalizedNode = Builders.containerBuilder()
  91                     .withNodeIdentifier(NetconfMessageTransformUtil.NETCONF_RPC_REPLY_NODEID)
  92                     .withChild(xmlDataNode).build();
  93         } else {
  94             //other base rpcs don't have any output, we can simply construct the payload here
  95             Preconditions.checkArgument(isOkPresent(message.getDocument()),
  96                     "Unexpected content in response of rpc: %s, %s", rpc, message);
  97             normalizedNode = null;
  98
  99         }
 100         return new DefaultDOMRpcResult(normalizedNode);
 101     }
 102
 103     // FIXME this should go to some util class
 104     static boolean isOkPresent(final Document doc) {
 105         return XmlElement.fromDomDocument(doc).getOnlyChildElementWithSameNamespaceOptionally("ok").isPresent();
 106     }
 107 }