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