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