X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=netconf%2Fmdsal-netconf-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fmdsal%2Fconnector%2Fops%2FRuntimeRpc.java;h=d61c249cfd2df18181cba3d8fe01ba3d89a2d98b;hb=47c1b8e3d9835d336c79d6b4ca4e61417a05039e;hp=8ae9942f56a64462e0a276f25eb6164313d2147c;hpb=4c0c091813aea131d32dc70c5121a450eb9b7291;p=netconf.git diff --git a/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/RuntimeRpc.java b/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/RuntimeRpc.java index 8ae9942f56..d61c249cfd 100644 --- a/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/RuntimeRpc.java +++ b/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/RuntimeRpc.java @@ -9,11 +9,9 @@ package org.opendaylight.netconf.mdsal.connector.ops; import com.google.common.base.Optional; -import com.google.common.base.Throwables; import com.google.common.util.concurrent.CheckedFuture; import java.io.IOException; import java.net.URI; -import java.net.URISyntaxException; import java.util.Collection; import java.util.Collections; import java.util.Map; @@ -22,6 +20,7 @@ import javax.xml.stream.XMLOutputFactory; import javax.xml.stream.XMLStreamException; import javax.xml.stream.XMLStreamWriter; import javax.xml.transform.dom.DOMResult; +import javax.xml.transform.dom.DOMSource; import org.opendaylight.controller.config.util.xml.DocumentedException; import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorSeverity; import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorTag; @@ -32,19 +31,21 @@ import org.opendaylight.controller.config.util.xml.XmlUtil; import org.opendaylight.controller.md.sal.dom.api.DOMRpcException; import org.opendaylight.controller.md.sal.dom.api.DOMRpcResult; import org.opendaylight.controller.md.sal.dom.api.DOMRpcService; +import org.opendaylight.netconf.api.NetconfDocumentedException; import org.opendaylight.netconf.api.xml.XmlNetconfConstants; import org.opendaylight.netconf.mapping.api.HandlingPriority; import org.opendaylight.netconf.mapping.api.NetconfOperationChainedExecution; import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext; -import org.opendaylight.netconf.util.OrderedNormalizedNodeWriter; import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation; import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter; -import org.opendaylight.yangtools.yang.data.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter; -import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.DomUtils; -import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory; +import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter; +import org.opendaylight.yangtools.yang.data.codec.xml.XmlParserStream; +import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNormalizedNodeStreamWriter; +import org.opendaylight.yangtools.yang.data.impl.schema.NormalizedNodeResult; +import org.opendaylight.yangtools.yang.data.impl.schema.SchemaOrderedNormalizedNodeWriter; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; import org.opendaylight.yangtools.yang.model.api.Module; import org.opendaylight.yangtools.yang.model.api.RpcDefinition; @@ -61,17 +62,18 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { private static final Logger LOG = LoggerFactory.getLogger(RuntimeRpc.class); - private final CurrentSchemaContext schemaContext; private static final XMLOutputFactory XML_OUTPUT_FACTORY; static { XML_OUTPUT_FACTORY = XMLOutputFactory.newFactory(); - XML_OUTPUT_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true); + XML_OUTPUT_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, Boolean.TRUE); } + private final CurrentSchemaContext schemaContext; private final DOMRpcService rpcService; - public RuntimeRpc(final String netconfSessionIdForReporting, CurrentSchemaContext schemaContext, DOMRpcService rpcService) { + public RuntimeRpc(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext, + final DOMRpcService rpcService) { super(netconfSessionIdForReporting); this.schemaContext = schemaContext; this.rpcService = rpcService; @@ -97,24 +99,19 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { throw new UnsupportedOperationException("Runtime rpc does not have a stable name"); } - private URI createNsUri(final String namespace) { - final URI namespaceURI; - try { - namespaceURI = new URI(namespace); - } catch (URISyntaxException e) { - // Cannot occur, namespace in parsed XML cannot be invalid URI - throw new IllegalStateException("Unable to parse URI " + namespace, e); - } - return namespaceURI; + private static URI createNsUri(final String namespace) { + // May throw IllegalArgumentException, but that should never happen, as the namespace comes from parsed XML + return URI.create(namespace); } //this returns module with the newest revision if more then 1 module with same namespace is found private Optional getModule(final URI namespaceURI) { - return Optional.fromNullable(schemaContext.getCurrentContext().findModuleByNamespaceAndRevision(namespaceURI, null)); + return Optional.fromJavaUtil(schemaContext.getCurrentContext().findModule(namespaceURI)); } - private Optional getRpcDefinitionFromModule(Module module, URI namespaceURI, String name) { - for (RpcDefinition rpcDef : module.getRpcs()) { + private static Optional getRpcDefinitionFromModule(final Module module, final URI namespaceURI, + final String name) { + for (final RpcDefinition rpcDef : module.getRpcs()) { if (rpcDef.getQName().getNamespace().equals(namespaceURI) && rpcDef.getQName().getLocalName().equals(name)) { return Optional.of(rpcDef); @@ -124,32 +121,36 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { } @Override - protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement) throws DocumentedException { + protected Element handleWithNoSubsequentOperations(final Document document, final XmlElement operationElement) + throws DocumentedException { final String netconfOperationName = operationElement.getName(); final String netconfOperationNamespace; try { netconfOperationNamespace = operationElement.getNamespace(); - } catch (DocumentedException e) { + } catch (final DocumentedException e) { LOG.debug("Cannot retrieve netconf operation namespace from message due to ", e); - throw new DocumentedException("Cannot retrieve netconf operation namespace from message", - ErrorType.protocol, ErrorTag.unknown_namespace, ErrorSeverity.error); + throw new DocumentedException("Cannot retrieve netconf operation namespace from message", e, + ErrorType.PROTOCOL, ErrorTag.UNKNOWN_NAMESPACE, ErrorSeverity.ERROR); } final URI namespaceURI = createNsUri(netconfOperationNamespace); final Optional moduleOptional = getModule(namespaceURI); if (!moduleOptional.isPresent()) { - throw new DocumentedException("Unable to find module in Schema Context with namespace and name : " + - namespaceURI + " " + netconfOperationName + schemaContext.getCurrentContext(), - ErrorType.application, ErrorTag.bad_element, ErrorSeverity.error); + throw new DocumentedException("Unable to find module in Schema Context with namespace and name : " + + namespaceURI + " " + netconfOperationName + schemaContext.getCurrentContext(), + ErrorType.APPLICATION, ErrorTag.BAD_ELEMENT, ErrorSeverity.ERROR); } - final Optional rpcDefinitionOptional = getRpcDefinitionFromModule(moduleOptional.get(), namespaceURI, netconfOperationName); + final Optional rpcDefinitionOptional = getRpcDefinitionFromModule(moduleOptional.get(), + namespaceURI, netconfOperationName); if (!rpcDefinitionOptional.isPresent()) { - throw new DocumentedException("Unable to find RpcDefinition with namespace and name : " + namespaceURI + " " + netconfOperationName, - ErrorType.application, ErrorTag.bad_element, ErrorSeverity.error); + throw new DocumentedException( + "Unable to find RpcDefinition with namespace and name : " + + namespaceURI + " " + netconfOperationName, + ErrorType.APPLICATION, ErrorTag.BAD_ELEMENT, ErrorSeverity.ERROR); } final RpcDefinition rpcDefinition = rpcDefinitionOptional.get(); @@ -160,10 +161,11 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { try { final DOMRpcResult result = rpcFuture.checkedGet(); if (result.getResult() == null) { - return XmlUtil.createElement(document, XmlNetconfConstants.OK, Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0)); + return XmlUtil.createElement(document, XmlNetconfConstants.OK, + Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0)); } return (Element) transformNormalizedNode(document, result.getResult(), rpcDefinition.getOutput().getPath()); - } catch (DOMRpcException e) { + } catch (final DOMRpcException e) { throw DocumentedException.wrap(e); } } @@ -180,9 +182,10 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { final Map attributes = requestElement.getAttributes(); final Element response = handle(document, operationElement, subsequentOperation); - final Element rpcReply = XmlUtil.createElement(document, XmlMappingConstants.RPC_REPLY_KEY, Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0)); + final Element rpcReply = XmlUtil.createElement(document, XmlMappingConstants.RPC_REPLY_KEY, + Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0)); - if(XmlElement.fromDomElement(response).hasNamespace()) { + if (XmlElement.fromDomElement(response).hasNamespace()) { rpcReply.appendChild(response); } else { final NodeList list = response.getChildNodes(); @@ -195,15 +198,15 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { } } - for (Attr attribute : attributes.values()) { + for (final Attr attribute : attributes.values()) { rpcReply.setAttributeNode((Attr) document.importNode(attribute, true)); } document.appendChild(rpcReply); return document; } - //TODO move all occurences of this method in mdsal netconf(and xml factories) to a utility class - private Node transformNormalizedNode(final Document document, final NormalizedNode data, final SchemaPath rpcOutputPath) { + private Node transformNormalizedNode(final Document document, final NormalizedNode data, + final SchemaPath rpcOutputPath) { final DOMResult result = new DOMResult(document.createElement(XmlMappingConstants.RPC_REPLY_KEY)); final XMLStreamWriter xmlWriter = getXmlStreamWriter(result); @@ -211,7 +214,8 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { final NormalizedNodeStreamWriter nnStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, schemaContext.getCurrentContext(), rpcOutputPath); - final OrderedNormalizedNodeWriter nnWriter = new OrderedNormalizedNodeWriter(nnStreamWriter, schemaContext.getCurrentContext(), rpcOutputPath); + final SchemaOrderedNormalizedNodeWriter nnWriter = + new SchemaOrderedNormalizedNodeWriter(nnStreamWriter, schemaContext.getCurrentContext(), rpcOutputPath); writeRootElement(xmlWriter, nnWriter, (ContainerNode) data); try { @@ -224,7 +228,7 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { return result.getNode(); } - private XMLStreamWriter getXmlStreamWriter(final DOMResult result) { + private static XMLStreamWriter getXmlStreamWriter(final DOMResult result) { try { return XML_OUTPUT_FACTORY.createXMLStreamWriter(result); } catch (final XMLStreamException e) { @@ -232,29 +236,45 @@ public class RuntimeRpc extends AbstractSingletonNetconfOperation { } } - private void writeRootElement(final XMLStreamWriter xmlWriter, final OrderedNormalizedNodeWriter nnWriter, final ContainerNode data) { + private static void writeRootElement(final XMLStreamWriter xmlWriter, + final SchemaOrderedNormalizedNodeWriter nnWriter, final ContainerNode data) { try { - Collection> value = (Collection) data.getValue(); + final Collection> value = data.getValue(); nnWriter.write(value); nnWriter.flush(); xmlWriter.flush(); } catch (XMLStreamException | IOException e) { - Throwables.propagate(e); + throw new RuntimeException(e); } } /** - * Parses xml element rpc input into normalized node or null if rpc does not take any input - * @param oElement rpc xml element - * @param input input container schema node, or null if rpc does not take any input + * Parses xml element rpc input into normalized node or null if rpc does not take any input. + * + * @param element rpc xml element + * @param input input container schema node, or null if rpc does not take any input * @return parsed rpc into normalized node, or null if input schema is null */ + @SuppressWarnings("checkstyle:IllegalCatch") @Nullable - private NormalizedNode rpcToNNode(final XmlElement oElement, @Nullable final ContainerSchemaNode input) { - return input == null ? null : DomToNormalizedNodeParserFactory - .getInstance(DomUtils.defaultValueCodecProvider(), schemaContext.getCurrentContext()) - .getContainerNodeParser() - .parse(Collections.singletonList(oElement.getDomElement()), input); + private NormalizedNode rpcToNNode(final XmlElement element, @Nullable final ContainerSchemaNode input) + throws DocumentedException { + if (input == null || input.getChildNodes().isEmpty()) { + return null; + } + + final NormalizedNodeResult resultHolder = new NormalizedNodeResult(); + final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder); + final XmlParserStream xmlParser = XmlParserStream.create(writer, schemaContext.getCurrentContext(), input); + + try { + xmlParser.traverse(new DOMSource(element.getDomElement())); + } catch (final Exception ex) { + throw new NetconfDocumentedException("Error parsing input: " + ex.getMessage(), ex, ErrorType.PROTOCOL, + ErrorTag.MALFORMED_MESSAGE, ErrorSeverity.ERROR); + } + + return resultHolder.getResult(); } }