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