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%2Fget%2FAbstractGet.java;h=8b9462a86784c51dc70ec12de98d6397872ce3ab;hb=b232bff0cc70ea857263d325d2eafdc52b8effe8;hp=e04766a1d71c295fca7958d921cb68d64121345e;hpb=cf359f8bdd996bb8344112d8cd2e36fd17f7585a;p=netconf.git diff --git a/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/get/AbstractGet.java b/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/get/AbstractGet.java index e04766a1d7..8b9462a867 100644 --- a/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/get/AbstractGet.java +++ b/netconf/mdsal-netconf-connector/src/main/java/org/opendaylight/netconf/mdsal/connector/ops/get/AbstractGet.java @@ -5,45 +5,41 @@ * 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.get; +import static com.google.common.base.Preconditions.checkArgument; + import com.google.common.annotations.VisibleForTesting; -import com.google.common.base.Optional; -import com.google.common.base.Throwables; -import com.google.common.collect.Iterables; import java.io.IOException; +import java.util.Optional; 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.netconf.api.DocumentedException; +import org.opendaylight.netconf.api.xml.XmlElement; import org.opendaylight.netconf.api.xml.XmlNetconfConstants; import org.opendaylight.netconf.mdsal.connector.CurrentSchemaContext; import org.opendaylight.netconf.mdsal.connector.ops.Datastore; import org.opendaylight.netconf.util.mapping.AbstractSingletonNetconfOperation; +import org.opendaylight.yangtools.yang.common.ErrorSeverity; +import org.opendaylight.yangtools.yang.common.ErrorTag; +import org.opendaylight.yangtools.yang.common.ErrorType; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; -import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; 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.api.schema.stream.NormalizedNodeWriter; +import org.opendaylight.yangtools.yang.data.api.schema.stream.YangInstanceIdentifierWriter; import org.opendaylight.yangtools.yang.data.codec.xml.XMLStreamNormalizedNodeStreamWriter; -import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes; -import org.opendaylight.yangtools.yang.model.api.SchemaContext; -import org.opendaylight.yangtools.yang.model.api.SchemaPath; +import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; -public abstract class AbstractGet extends AbstractSingletonNetconfOperation { +// FIXME: seal when we have JDK17+ +abstract class AbstractGet extends AbstractSingletonNetconfOperation { private static final XMLOutputFactory XML_OUTPUT_FACTORY; - private static final YangInstanceIdentifier ROOT = YangInstanceIdentifier.EMPTY; private static final String FILTER = "filter"; static { @@ -51,68 +47,72 @@ public abstract class AbstractGet extends AbstractSingletonNetconfOperation { XML_OUTPUT_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, true); } - protected final CurrentSchemaContext schemaContext; + private final CurrentSchemaContext schemaContext; private final FilterContentValidator validator; - public AbstractGet(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext) { + AbstractGet(final String netconfSessionIdForReporting, final CurrentSchemaContext schemaContext) { super(netconfSessionIdForReporting); this.schemaContext = schemaContext; - this.validator = new FilterContentValidator(schemaContext); + validator = new FilterContentValidator(schemaContext); } - protected Node transformNormalizedNode(final Document document, final NormalizedNode data, - final YangInstanceIdentifier dataRoot) { + // FIXME: throw a DocumentedException + private Node transformNormalizedNode(final Document document, final NormalizedNode data, + final YangInstanceIdentifier dataRoot) { final DOMResult result = new DOMResult(document.createElement(XmlNetconfConstants.DATA_KEY)); - final XMLStreamWriter xmlWriter = getXmlStreamWriter(result); + final EffectiveModelContext currentContext = schemaContext.getCurrentContext(); final NormalizedNodeStreamWriter nnStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(xmlWriter, - schemaContext.getCurrentContext(), getSchemaPath(dataRoot)); + currentContext); - final NormalizedNodeWriter nnWriter = NormalizedNodeWriter.forStreamWriter(nnStreamWriter, true); + try { + if (dataRoot.isEmpty()) { + writeRoot(nnStreamWriter, data); + } else { + write(nnStreamWriter, currentContext, dataRoot.coerceParent(), data); + } + } catch (IOException e) { + // FIXME: throw DocumentedException + throw new IllegalStateException(e); + } - writeRootElement(xmlWriter, nnWriter, (ContainerNode) data); return result.getNode(); } - private XMLStreamWriter getXmlStreamWriter(final DOMResult result) { - try { - return XML_OUTPUT_FACTORY.createXMLStreamWriter(result); - } catch (final XMLStreamException e) { - throw new RuntimeException(e); + private static void write(final NormalizedNodeStreamWriter nnStreamWriter, + final EffectiveModelContext currentContext, final YangInstanceIdentifier parent, final NormalizedNode data) + throws IOException { + try (var yiidWriter = YangInstanceIdentifierWriter.open(nnStreamWriter, currentContext, parent)) { + try (var nnWriter = NormalizedNodeWriter.forStreamWriter(nnStreamWriter, true)) { + nnWriter.write(data); + } } } - private SchemaPath getSchemaPath(final YangInstanceIdentifier dataRoot) { - return SchemaPath.create( - Iterables.transform(dataRoot.getPathArguments(), PathArgument::getNodeType), dataRoot.equals(ROOT)); - } + private static void writeRoot(final NormalizedNodeStreamWriter nnStreamWriter, final NormalizedNode data) + throws IOException { + checkArgument(data instanceof ContainerNode, "Unexpected root data %s", data); - private void writeRootElement(final XMLStreamWriter xmlWriter, final NormalizedNodeWriter nnWriter, - final ContainerNode data) { - try { - if (data.getNodeType().equals(SchemaContext.NAME)) { - for (final DataContainerChild child : data.getValue()) { - nnWriter.write(child); - } - } else { - nnWriter.write(data); + try (var nnWriter = NormalizedNodeWriter.forStreamWriter(nnStreamWriter, true)) { + for (var child : ((ContainerNode) data).body()) { + nnWriter.write(child); } - nnWriter.flush(); - xmlWriter.flush(); - } catch (XMLStreamException | IOException e) { - Throwables.propagate(e); } } - protected Element serializeNodeWithParentStructure(final Document document, final YangInstanceIdentifier dataRoot, - final NormalizedNode node) { - if (!dataRoot.equals(ROOT)) { - return (Element) transformNormalizedNode(document, - ImmutableNodes.fromInstanceId(schemaContext.getCurrentContext(), dataRoot, node), - ROOT); + private static XMLStreamWriter getXmlStreamWriter(final DOMResult result) { + try { + return XML_OUTPUT_FACTORY.createXMLStreamWriter(result); + } catch (final XMLStreamException e) { + // FIXME: throw DocumentedException + throw new IllegalStateException(e); } - return (Element) transformNormalizedNode(document, node, ROOT); + } + + final Element serializeNodeWithParentStructure(final Document document, final YangInstanceIdentifier dataRoot, + final NormalizedNode node) { + return (Element) transformNormalizedNode(document, node, dataRoot); } /** @@ -124,21 +124,22 @@ public abstract class AbstractGet extends AbstractSingletonNetconfOperation { * container in the response. If filter is not present we want to read the entire datastore - return ROOT. * @throws DocumentedException if not possible to get identifier from filter */ - protected Optional getDataRootFromFilter(final XmlElement operationElement) + final Optional getDataRootFromFilter(final XmlElement operationElement) throws DocumentedException { - final Optional filterElement = operationElement.getOnlyChildElementOptionally(FILTER); - if (filterElement.isPresent()) { - if (filterElement.get().getChildElements().size() == 0) { - return Optional.absent(); - } - return Optional.of(getInstanceIdentifierFromFilter(filterElement.get())); + final var optFilterElement = operationElement.getOnlyChildElementOptionally(FILTER); + if (optFilterElement.isEmpty()) { + return Optional.of(YangInstanceIdentifier.empty()); } - return Optional.of(ROOT); + final var filterElement = optFilterElement.orElseThrow(); + if (filterElement.getChildElements().isEmpty()) { + return Optional.empty(); + } + return Optional.of(getInstanceIdentifierFromFilter(filterElement)); } @VisibleForTesting - protected YangInstanceIdentifier getInstanceIdentifierFromFilter(final XmlElement filterElement) + protected final YangInstanceIdentifier getInstanceIdentifierFromFilter(final XmlElement filterElement) throws DocumentedException { if (filterElement.getChildElements().size() != 1) { @@ -161,7 +162,7 @@ public abstract class AbstractGet extends AbstractSingletonNetconfOperation { try { validateInputRpc(xml, operationName); } catch (final DocumentedException e) { - throw new DocumentedException("Incorrect RPC: " + e.getMessage(), e.getErrorType(), e.getErrorTag(), + throw new DocumentedException("Incorrect RPC: " + e.getMessage(), e, e.getErrorType(), e.getErrorTag(), e.getErrorSeverity(), e.getErrorInfo()); } @@ -169,8 +170,8 @@ public abstract class AbstractGet extends AbstractSingletonNetconfOperation { try { sourceDatastore = parseSource(xml); } catch (final DocumentedException e) { - throw new DocumentedException("Get-config source attribute error: " + e.getMessage(), e.getErrorType(), - e.getErrorTag(), e.getErrorSeverity(), e.getErrorInfo()); + throw new DocumentedException("Get-config source attribute error: " + e.getMessage(), e, + e.getErrorType(), e.getErrorTag(), e.getErrorSeverity(), e.getErrorInfo()); } return new GetConfigExecution(sourceDatastore); @@ -178,11 +179,9 @@ public abstract class AbstractGet extends AbstractSingletonNetconfOperation { private static Optional parseSource(final XmlElement xml) throws DocumentedException { final Optional sourceElement = xml.getOnlyChildElementOptionally(XmlNetconfConstants.SOURCE_KEY, - XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0); - - return sourceElement.isPresent() - ? Optional.of(Datastore.valueOf(sourceElement.get().getOnlyChildElement().getName())) - : Optional.absent(); + XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0); + return sourceElement.isEmpty() ? Optional.empty() + : Optional.of(Datastore.valueOf(sourceElement.orElseThrow().getOnlyChildElement().getName())); } private static void validateInputRpc(final XmlElement xml, final String operationName) throws @@ -194,7 +193,5 @@ public abstract class AbstractGet extends AbstractSingletonNetconfOperation { public Optional getDatastore() { return datastore; } - } - }