https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/CONTROLLER-185 controller <p>The call fails at checkArgument() below. “inputContainer” is null.</p> <p>public RpcResult&lt;CompositeNode&gt; invokeRpc(QName rpc, CompositeNode input) {<br/> CompositeNode inputContainer = input.getFirstCompositeByName(QName.create(rpc,"input"));<br/> checkArgument(inputContainer != null, "Rpc payload must contain input element”);</p> <p>Debugging deeper, I found that MutableCompositeNodeTOImpl could not find “children” in nodeMap. The key “QName" in the NodeMap is different than the key “children” used to lookup. <br/> public List&lt;CompositeNode&gt; getCompositesByName(QName children) {<br/> List&lt;Node&lt;?&gt;&gt; toFilter = getNodeMap().get(children);</p> <p>The QName sent by remote rpc router looks like:<br/> {<br/> namespace: "urn:opendaylight:flow:service"<br/> localname: "input"<br/> prefix: ""<br/> formattedRevision: null<br/> revision: null<br/> }</p> <p>While the key for flow service in NodeMap looks like:<br/> {<br/> namespace: "urn:opendaylight:flow:service"<br/> localname: "input"<br/> prefix: "flow"<br/> formattedRevision: "2013-08-19"<br/> revision: "Mon Aug 19 00:00:00 GMT-08:00 2013"<br/> }</p> <p>My RESTConf payload is:<br/> &lt;?xml version="1.0" encoding="UTF-8" standalone="no"?&gt;<br/> &lt;flow xmlns="urn:opendaylight:flow:inventory"&gt;<br/> &lt;priority&gt;5&lt;/priority&gt;<br/> &lt;flow-name&gt;Foo&lt;/flow-name&gt;<br/> &lt;match&gt;<br/> &lt;ethernet-match&gt;<br/> &lt;ethernet-type&gt;<br/> &lt;type&gt;2048&lt;/type&gt;<br/> &lt;/ethernet-type&gt;<br/> &lt;/ethernet-match&gt;<br/> &lt;ipv4-destination&gt;10.0.10.2/24&lt;/ipv4-destination&gt;<br/> &lt;/match&gt;<br/> &lt;id&gt;4&lt;/id&gt;<br/> &lt;table_id&gt;4&lt;/table_id&gt;<br/> &lt;instructions&gt;<br/> &lt;instruction&gt;<br/> &lt;order&gt;0&lt;/order&gt;<br/> &lt;apply-actions&gt;<br/> &lt;action&gt;<br/> &lt;order&gt;0&lt;/order&gt;<br/> &lt;dec-nw-ttl/&gt;<br/> &lt;/action&gt;<br/> &lt;/apply-actions&gt;<br/> &lt;/instruction&gt;<br/> &lt;/instructions&gt;<br/> &lt;/flow&gt;</p> <p>The payload that I get in remote rpc router is<br/> &lt;add-flow xmlns="urn:opendaylight:flow:service"&gt;<br/> &lt;input&gt;<br/> &lt;transaction-uri&gt;BA-7&lt;/transaction-uri&gt;<br/> &lt;table_id&gt;4&lt;/table_id&gt;<br/> &lt;priority&gt;5&lt;/priority&gt;<br/> &lt;node&gt;<br/> /(urn:opendaylight:inventory?revision=2013-08-19)nodes/(urn:opendaylight:inventory?revision=2013-08-19)node[</p> {(urn:opendaylight:inventory?revision=2013-08-19)id=openflow:1} <p>]<br/> &lt;/node&gt;<br/> &lt;match&gt;<br/> &lt;ipv4-destination&gt;10.0.10.2/24&lt;/ipv4-destination&gt;<br/> &lt;ethernet-match&gt;<br/> &lt;ethernet-type&gt;<br/> &lt;type&gt;2048&lt;/type&gt;<br/> &lt;/ethernet-type&gt;<br/> &lt;/ethernet-match&gt;<br/> &lt;/match&gt;<br/> &lt;instructions&gt;<br/> &lt;instruction&gt;<br/> &lt;order&gt;0&lt;/order&gt;<br/> &lt;apply-actions&gt;<br/> &lt;action&gt;<br/> &lt;order&gt;0&lt;/order&gt;<br/> &lt;dec-nw-ttl/&gt;<br/> &lt;/action&gt;<br/> &lt;/apply-actions&gt;<br/> &lt;/instruction&gt;<br/> &lt;/instructions&gt;<br/> &lt;flow-table&gt;<br/> /(urn:opendaylight:inventory?revision=2013-08-19)nodes/(urn:opendaylight:inventory?revision=2013-08-19)node[</p> {(urn:opendaylight:inventory?revision=2013-08-19)id=openflow:1} <p>]/(urn:opendaylight:flow:inventory?revision=2013-08-19)table[</p> {(urn:opendaylight:flow:inventory?revision=2013-08-19)id=4} <p>]<br/> &lt;/flow-table&gt;<br/> &lt;flow-ref&gt;<br/> /(urn:opendaylight:inventory?revision=2013-08-19)nodes/(urn:opendaylight:inventory?revision=2013-08-19)node[</p> {(urn:opendaylight:inventory?revision=2013-08-19)id=openflow:1} <p>]/(urn:opendaylight:flow:inventory?revision=2013-08-19)table[</p> {(urn:opendaylight:flow:inventory?revision=2013-08-19)id=4} <p>]/(urn:opendaylight:flow:inventory?revision=2013-08-19)flow[</p> {(urn:opendaylight:flow:inventory?revision=2013-08-19)id=4} <p>]<br/> &lt;/flow-ref&gt;<br/> &lt;flow-name&gt;Foo&lt;/flow-name&gt;<br/> &lt;/input&gt;<br/> &lt;/add-flow&gt;</p> <p>Operating System: All<br/> Platform: All</p> CONTROLLER-185

BI Broker fails to serve remote rpc call

Bug Verified Done Maros Marsalek Abhishek Kumar Mon, 24 Feb 2014 19:13:49 +0000 Tue, 25 Jul 2023 08:23:09 +0000 Tue, 29 Jul 2014 16:27:14 +0000 mdsal 0 4 <p>The contract of MD-SAL requires QNames always contain information according to the schema: this means namespace, revision, local-name.</p> <p>If this is not present, MD-SAL could not distinguish between two different revisions and thus do the correct processing.</p> <p>ZeroMQ should send QNames with revision, also all data upstreamed to MD-SAL<br/> should contain revision information. Otherwise MD-SAL is not able to process that.</p> <p>If you are using w3c Document as payload and XmlDocumentUtils to convert it to yang data - consider using SchemaService from ProviderContext to learn the schema, and then use corresponding methods<br/> from XmlDocumentUtils which takes DataSchemaNode or SchemaContext as argument for normalization (and verification)of XmlDocument.</p> <p>Abhishek please provide additional information which serialization / deserialization method are you using.</p> <p>Tony,</p> <p>Ser/DSer code is in this class:<br/> org.opendaylight.controller.sal.connector.remoterpc.util.XmlUtils</p> <p>Let me know if this is not appropriate.</p> <p>Copy/Pasting the code:</p> <p> public static String compositeNodeToXml(CompositeNode cNode){<br/> if (cNode == null) return new String();</p> <p> Document domTree = NodeUtils.buildShadowDomTree(cNode);<br/> StringWriter writer = new StringWriter();<br/> try </p> { TransformerFactory tf = TransformerFactory.newInstance(); Transformer transformer = tf.newTransformer(); transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes"); transformer.transform(new DOMSource(domTree), new StreamResult(writer)); } <p> catch (TransformerException e) </p> { _logger.error("Error during translation of Document to OutputStream", e); } <p> return writer.toString();<br/> }</p> <p> public static CompositeNode xmlToCompositeNode(String xml){<br/> if (xml==null || xml.length()==0) return null;</p> <p> Node&lt;?&gt; dataTree;<br/> try </p> { dataTree = XmlTreeBuilder.buildDataTree(new ByteArrayInputStream(xml.getBytes())); } <p> catch (XMLStreamException e) </p> { _logger.error("Error during building data tree from XML", e); return null; } <p> if (dataTree == null) </p> { _logger.error("data tree is null"); return null; } <p> if (dataTree instanceof SimpleNode) </p> { _logger.error("RPC XML was resolved as SimpleNode"); return null; } <p> return (CompositeNode) dataTree;<br/> }</p> <p>Hi Tony,</p> <p>We followed your suggestions in the <a href="https://jira.opendaylight.org/browse/CONTROLLER-185" title="BI Broker fails to serve remote rpc call" class="issue-link" data-issue-key="CONTROLLER-185"><del>CONTROLLER-185</del></a> notes to use XMLDocumentUtil methods for serialization, deserialization. We first get the ProviderSession, then get SchemaService from it, and get SchemaContext from the SchemaService.<br/> We tried using following methods</p> <p>public static Document toDocument(CompositeNode data, DataNodeContainer schema, XmlCodecProvider codecProvider) (for converting CompositeNode to XML Document, and that works fine</p> <p>But other way round we used following method, as that was the only suitable option</p> <p>public static Node&lt;?&gt; toDomNode(Element xmlElement, Optional&lt;DataSchemaNode&gt; schema,<br/> Optional&lt;XmlCodecProvider&gt; codecProvider) {</p> <p>But it seems this method at<br/> checkQName(xmlElement, schema.getQName());</p> <p>Since the qName of both parameters are not equal. Following is the code which calls respective methods of XMLDocumentUtils, see the red highlighted lines. We need your guidance on how to proceed further, or is there any other method from XMLDocumentUtils that you had in mind?<br/> We saw that toCompositeNodeWithSchema is private and can't be used.</p> <p>/*</p> <ul> <li>Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.<br/> *</li> <li>This program and the accompanying materials are made available under the</li> <li>terms of the Eclipse Public License v1.0 which accompanies this distribution,</li> <li>and is available at <a href="http://www.eclipse.org/legal/epl-v10.html" class="external-link" target="_blank" rel="nofollow noopener">http://www.eclipse.org/legal/epl-v10.html</a><br/> */</li> </ul> <p>package org.opendaylight.controller.sal.connector.remoterpc.util;</p> <p>import java.io.IOException;<br/> import javax.xml.parsers.ParserConfigurationException;<br/> import javax.activation.UnsupportedDataTypeException;<br/> import org.opendaylight.yangtools.yang.data.api.CompositeNode;<br/> import org.opendaylight.yangtools.yang.data.api.Node;<br/> import org.opendaylight.yangtools.yang.data.api.SimpleNode;<br/> import org.opendaylight.yangtools.yang.data.impl.NodeUtils;<br/> import org.opendaylight.yangtools.yang.data.impl.XmlTreeBuilder;<br/> import org.opendaylight.yangtools.yang.data.impl.codec.xml.XmlDocumentUtils;<br/> import org.opendaylight.yangtools.yang.model.api.SchemaContext;<br/> import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;<br/> import org.opendaylight.controller.netconf.util.xml.XmlUtil;<br/> import org.slf4j.Logger;<br/> import org.slf4j.LoggerFactory;<br/> import org.w3c.dom.Document;<br/> import org.xml.sax.InputSource;<br/> import javax.xml.stream.XMLStreamException;<br/> import javax.xml.transform.OutputKeys;<br/> import javax.xml.transform.Transformer;<br/> import javax.xml.transform.TransformerException;<br/> import javax.xml.transform.TransformerFactory;<br/> import javax.xml.transform.dom.DOMSource;<br/> import javax.xml.transform.stream.StreamResult;<br/> import java.io.ByteArrayInputStream;<br/> import java.io.StringWriter;<br/> import org.xml.sax.SAXException;<br/> import java.io.StringReader;<br/> import com.google.common.base.Optional;<br/> public class XmlUtils {</p> <p> private static final Logger _logger = LoggerFactory.getLogger(XmlUtils.class);</p> <p> public static String compositeNodeToXml(CompositeNode cNode, SchemaContext schemaContext){<br/> if (cNode == null) return new String();</p> <p> //Document domTree = NodeUtils.buildShadowDomTree(cNode);<br/> Document domTree = null;<br/> try </p> { domTree = XmlDocumentUtils.toDocument(cNode, schemaContext, XmlDocumentUtils.defaultValueCodecProvider()); } <p> catch (UnsupportedDataTypeException e) </p> { _logger.error("Error during translation of CompositeNode to Document", e); } <p> StringWriter writer = new StringWriter();<br/> try </p> { TransformerFactory tf = TransformerFactory.newInstance(); Transformer transformer = tf.newTransformer(); transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes"); transformer.transform(new DOMSource(domTree), new StreamResult(writer)); } <p> catch (TransformerException e) </p> { _logger.error("Error during translation of Document to OutputStream", e); } <p> _logger.debug("compositeNodeToXml " + writer.toString());</p> <p> return writer.toString();</p> <p> }</p> <p> public static CompositeNode xmlToCompositeNode(String xml, SchemaContext schemaContext){<br/> if (xml==null || xml.length()==0) return null;</p> <p> Node&lt;?&gt; dataTree = null;<br/> try </p> { Document doc = null; doc = XmlUtil.readXmlToDocument(xml); _logger.debug("vaishali xmlToCompositeNode Document is " + xml ); dataTree = XmlDocumentUtils.toDomNode(doc.getDocumentElement(), Optional.&lt;DataSchemaNode&gt;of(schemaContext), Optional.of(XmlDocumentUtils.defaultValueCodecProvider())); } <p> catch (SAXException e) </p> { _logger.error("Error during building data tree from XML", e); } catch (IOException e) { _logger.error("Error during building data tree from XML", e); } <p> _logger.debug("xmlToCompositeNode " + dataTree.toString());<br/> return (CompositeNode) dataTree;<br/> }<br/> }</p> <p>Thanks,<br/> Vaishali</p> <p>Using SchemaContext only payload is assumed to be data tree, not RPC one.</p> <p>You may want to search SchemaContext for definition of that RPC<br/> and then getInput/getOutput from Rpc Definition and pass that as an<br/> argument to xml serialization/deserialization - so the XmlDocumentUtils<br/> knows that your data needs to comform to that specific RPC definition<br/> not global data tree definition.</p> <p>Offending component was removed.</p> <p>Reopening the defect. I am trying to use it in RPC clustering.</p> <p>Tony, </p> <p>The comments you mentioned, i tried to use them like following</p> <p> public static String inputCompositeNodeToXml(CompositeNode cNode, SchemaContext schemaContext){<br/> if (cNode == null) return new String();</p> <p> //Document domTree = NodeUtils.buildShadowDomTree(cNode);<br/> Document domTree = null;<br/> try {<br/> Set&lt;RpcDefinition&gt; rpcs = schemaContext.getOperations();<br/> for(RpcDefinition rpc : rpcs) {<br/> if(rpc.getQName().equals(cNode.getNodeType()))</p> { domTree = XmlDocumentUtils.toDocument(cNode, rpc.getInput(), XmlDocumentUtils.defaultValueCodecProvider()); break; } <p> }</p> <p> } catch (UnsupportedDataTypeException e) </p> { LOG.error("Error during translation of CompositeNode to Document", e); } <p> return domTransformer(domTree);<br/> }</p> <p>public static CompositeNode inputXmlToCompositeNode(QName rpc, String xml, SchemaContext schemaContext){<br/> if (xml==null || xml.length()==0) return null;</p> <p> Node&lt;?&gt; dataTree = null;<br/> try {</p> <p> Document doc = XmlUtil.readXmlToDocument(xml);<br/> LOG.debug("xmlToCompositeNode Document is " + xml );<br/> Set&lt;RpcDefinition&gt; rpcs = schemaContext.getOperations();<br/> for(RpcDefinition rpcDef : rpcs) {<br/> if(rpcDef.getQName().equals(rpc))</p> { dataTree = XmlDocumentUtils.toDomNode(doc.getDocumentElement(), Optional.&lt;DataSchemaNode&gt;of(rpcDef.getInput()), Optional.of(XmlDocumentUtils.defaultValueCodecProvider())); break; } <p> }<br/> } catch (SAXException e) </p> { LOG.error("Error during building data tree from XML", e); } catch (IOException e) { LOG.error("Error during building data tree from XML", e); } <p> LOG.debug("xmlToCompositeNode " + dataTree.toString());<br/> return (CompositeNode) dataTree;<br/> }</p> <p>It works fine while node to xml conversation and give me output, something like this</p> <p>&lt;add-flow xmlns="urn:opendaylight:flow:service"&gt;&lt;input&gt;&lt;flow-name&gt;Foo&lt;/flow-name&gt;&lt;flow-ref&gt;(urn:opendaylight:inventory?revision=2013-08-19)nodes/(urn:opendaylight:inventory?revision=2013-08-19)node[</p> {(urn:opendaylight:inventory?revision=2013-08-19)id=openflow:249485023638597} <p>]/(urn:opendaylight:flow:inventory?revision=2013-08-19)table[</p> {(urn:opendaylight:flow:inventory?revision=2013-08-19)id=3} <p>]/(urn:opendaylight:flow:inventory?revision=2013-08-19)flow[</p> {(urn:opendaylight:flow:inventory?revision=2013-08-19)id=155} <p>]&lt;/flow-ref&gt;&lt;flow-table&gt;(urn:opendaylight:inventory?revision=2013-08-19)nodes/(urn:opendaylight:inventory?revision=2013-08-19)node[</p> {(urn:opendaylight:inventory?revision=2013-08-19)id=openflow:249485023638597} <p>]/(urn:opendaylight:flow:inventory?revision=2013-08-19)table[</p> {(urn:opendaylight:flow:inventory?revision=2013-08-19)id=3} <p>]&lt;/flow-table&gt;&lt;instructions&gt;&lt;instruction&gt;&lt;apply-actions&gt;&lt;action&gt;&lt;dec-nw-ttl/&gt;&lt;order&gt;0&lt;/order&gt;&lt;/action&gt;&lt;/apply-actions&gt;&lt;order&gt;0&lt;/order&gt;&lt;/instruction&gt;&lt;/instructions&gt;&lt;match&gt;&lt;ethernet-match&gt;&lt;ethernet-type&gt;&lt;type&gt;2048&lt;/type&gt;&lt;/ethernet-type&gt;&lt;/ethernet-match&gt;&lt;ipv4-destination&gt;10.0.0.2/24&lt;/ipv4-destination&gt;&lt;/match&gt;&lt;node&gt;(urn:opendaylight:inventory?revision=2013-08-19)nodes/(urn:opendaylight:inventory?revision=2013-08-19)node[</p> {(urn:opendaylight:inventory?revision=2013-08-19)id=openflow:249485023638597} <p>]&lt;/node&gt;&lt;priority&gt;2&lt;/priority&gt;&lt;table_id&gt;3&lt;/table_id&gt;&lt;transaction-uri&gt;DOM-1&lt;/transaction-uri&gt;&lt;/input&gt;&lt;/add-flow&gt;</p> <p>But it still throws illegalArgument Exception when converting xml to DomNode on the second node.</p> <p>Hi,</p> <p>I have added a test to transform the input for an RPC using XmlDocumentUtils (I also tried the xml you provided):</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/9380/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/9380/</a></p> <p>It worked fine so could you please provide the exact data you are transforming ? And could you also provide your code (as a gerrit draft or give me a pointer) that I can reproduce and debug the issue ?</p> <p>Actually, CompositeNode to XML transformation works fine for me also, its the other way around, which does not work fine. When i try to convert XML to composite node, it does create the Node, but the values inside instance identifier are not converted based on type, they are always String. </p> <p>Say in Add flow RPC, i have table id in flow-ref instanceidentifier, which should get converted to Short type, but it always gives me String</p> <p>I see.</p> <p>I have fixed the issue in the commit I posted (there is also a test to prove it):</p> <p><a href="https://git.opendaylight.org/gerrit/#/c/9380/" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/#/c/9380/</a></p> <p>Could you please verify ? Setting state to: waiting for review</p> <p>There was a problem when using derived type of instance identifier, but it is fixed now.</p> <p>Thanks for your fix, this works now for normal use case.</p> <p> there was one special case for which it won't work, I have a fix for that, i'll try to put patch for same.</p> Blocks CONTROLLER-294 Development External issue ID 461 External issue URL Priority Rank 0|i02iu7: