* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
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;
-import javax.annotation.Nullable;
+import java.util.Optional;
+import java.util.concurrent.ExecutionException;
import javax.xml.stream.XMLOutputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.dom.DOMResult;
-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;
-import org.opendaylight.controller.config.util.xml.DocumentedException.ErrorType;
-import org.opendaylight.controller.config.util.xml.XmlElement;
-import org.opendaylight.controller.config.util.xml.XmlMappingConstants;
-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 javax.xml.transform.dom.DOMSource;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.mdsal.dom.api.DOMRpcResult;
+import org.opendaylight.mdsal.dom.api.DOMRpcService;
+import org.opendaylight.netconf.api.DocumentedException;
+import org.opendaylight.netconf.api.DocumentedException.ErrorSeverity;
+import org.opendaylight.netconf.api.DocumentedException.ErrorTag;
+import org.opendaylight.netconf.api.DocumentedException.ErrorType;
+import org.opendaylight.netconf.api.NetconfDocumentedException;
+import org.opendaylight.netconf.api.xml.XmlElement;
import org.opendaylight.netconf.api.xml.XmlNetconfConstants;
+import org.opendaylight.netconf.api.xml.XmlUtil;
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.mapping.AbstractSingletonNetconfOperation;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
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.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.data.impl.schema.transform.dom.DomUtils;
-import org.opendaylight.yangtools.yang.data.impl.schema.transform.dom.parser.DomToNormalizedNodeParserFactory;
-import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
import org.opendaylight.yangtools.yang.model.api.SchemaPath;
+import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
+import org.opendaylight.yangtools.yang.model.util.SchemaInferenceStack;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
-import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
+import org.xml.sax.SAXException;
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;
@Override
protected HandlingPriority canHandle(final String netconfOperationName, final String namespace) {
- final URI namespaceURI = createNsUri(namespace);
- final Optional<Module> module = getModule(namespaceURI);
+ final XMLNamespace namespaceURI = createNsUri(namespace);
+ final Optional<? extends Module> module = getModule(namespaceURI);
- if (!module.isPresent()) {
+ if (module.isEmpty()) {
LOG.debug("Cannot handle rpc: {}, {}", netconfOperationName, namespace);
return HandlingPriority.CANNOT_HANDLE;
}
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 XMLNamespace createNsUri(final String namespace) {
+ // May throw IllegalArgumentException, but that should never happen, as the namespace comes from parsed XML
+ return XMLNamespace.of(namespace);
}
//this returns module with the newest revision if more then 1 module with same namespace is found
- private Optional<Module> getModule(final URI namespaceURI) {
- return Optional.fromNullable(schemaContext.getCurrentContext().findModuleByNamespaceAndRevision(namespaceURI, null));
+ private Optional<? extends Module> getModule(final XMLNamespace namespace) {
+ return schemaContext.getCurrentContext().findModules(namespace).stream().findFirst();
}
- private Optional<RpcDefinition> getRpcDefinitionFromModule(Module module, URI namespaceURI, String name) {
- for (RpcDefinition rpcDef : module.getRpcs()) {
- if (rpcDef.getQName().getNamespace().equals(namespaceURI)
- && rpcDef.getQName().getLocalName().equals(name)) {
+ private static Optional<RpcDefinition> getRpcDefinitionFromModule(final Module module, final XMLNamespace namespace,
+ final String name) {
+ for (final RpcDefinition rpcDef : module.getRpcs()) {
+ if (rpcDef.getQName().getNamespace().equals(namespace) && rpcDef.getQName().getLocalName().equals(name)) {
return Optional.of(rpcDef);
}
}
- return Optional.absent();
+ return Optional.empty();
}
@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<Module> moduleOptional = getModule(namespaceURI);
+ final XMLNamespace namespaceURI = createNsUri(netconfOperationNamespace);
+ final Optional<? extends Module> 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);
+ if (moduleOptional.isEmpty()) {
+ 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<RpcDefinition> rpcDefinitionOptional = getRpcDefinitionFromModule(moduleOptional.get(), namespaceURI, netconfOperationName);
+ final Optional<RpcDefinition> 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);
+ if (rpcDefinitionOptional.isEmpty()) {
+ 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();
- final SchemaPath schemaPath = SchemaPath.create(Collections.singletonList(rpcDefinition.getQName()), true);
- final NormalizedNode<?, ?> inputNode = rpcToNNode(operationElement, rpcDefinition.getInput());
+ final ContainerNode inputNode = rpcToNNode(operationElement, rpcDefinition);
- final CheckedFuture<DOMRpcResult, DOMRpcException> rpcFuture = rpcService.invokeRpc(schemaPath, inputNode);
+ final DOMRpcResult result;
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 (Element) transformNormalizedNode(document, result.getResult(), rpcDefinition.getOutput().getPath());
- } catch (DOMRpcException e) {
+ result = rpcService.invokeRpc(rpcDefinition.getQName(), inputNode).get();
+ } catch (final InterruptedException | ExecutionException e) {
throw DocumentedException.wrap(e);
}
+ if (result.getResult() == null) {
+ return XmlUtil.createElement(document, XmlNetconfConstants.OK,
+ Optional.of(XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0));
+ }
+ return transformNormalizedNode(document, result.getResult(), rpcDefinition.getOutput().getPath());
}
@Override
final Map<String, Attr> 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, XmlNetconfConstants.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();
}
}
- for (Attr attribute : attributes.values()) {
+ for (final Attr attribute : attributes.values()) {
rpcReply.setAttributeNode((Attr) document.importNode(attribute, true));
}
document.appendChild(rpcReply);
return document;
}
- private Node transformNormalizedNode(final Document document, final NormalizedNode<?, ?> data, final SchemaPath rpcOutputPath) {
- final DOMResult result = new DOMResult(document.createElement(XmlMappingConstants.RPC_REPLY_KEY));
+ private Element transformNormalizedNode(final Document document, final NormalizedNode data,
+ final SchemaPath rpcOutputPath) {
+ final DOMResult result = new DOMResult(document.createElement(XmlNetconfConstants.RPC_REPLY_KEY));
final XMLStreamWriter xmlWriter = getXmlStreamWriter(result);
LOG.warn("Error while closing streams", e);
}
- return result.getNode();
+ return (Element) 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) {
}
}
- private void writeRootElement(final XMLStreamWriter xmlWriter, final SchemaOrderedNormalizedNodeWriter nnWriter, final ContainerNode data) {
+ private static void writeRootElement(final XMLStreamWriter xmlWriter,
+ final SchemaOrderedNormalizedNodeWriter nnWriter, final ContainerNode data) {
try {
- Collection<DataContainerChild<?, ?>> value = (Collection) data.getValue();
- nnWriter.write(value);
+ nnWriter.write(data.body());
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 rpcDefinition 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
*/
- @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 @Nullable ContainerNode rpcToNNode(final XmlElement element,
+ final RpcDefinition rpcDefinition) throws DocumentedException {
+ final NormalizedNodeResult resultHolder = new NormalizedNodeResult();
+ final NormalizedNodeStreamWriter writer = ImmutableNormalizedNodeStreamWriter.from(resultHolder);
+ final XmlParserStream xmlParser = XmlParserStream.create(writer, SchemaInferenceStack.of(
+ schemaContext.getCurrentContext(),
+ Absolute.of(rpcDefinition.getQName(), rpcDefinition.getInput().getQName())).toInference());
+
+ try {
+ xmlParser.traverse(new DOMSource(element.getDomElement()));
+ } catch (final XMLStreamException | URISyntaxException | IOException | SAXException ex) {
+ throw new NetconfDocumentedException("Error parsing input: " + ex.getMessage(), ex, ErrorType.PROTOCOL,
+ ErrorTag.MALFORMED_MESSAGE, ErrorSeverity.ERROR);
+ }
+ return (ContainerNode) resultHolder.getResult();
+ }
}
Code Review / netconf.git / blobdiff