X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-netconf-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fsal%2Fconnect%2Fnetconf%2Futil%2FNetconfMessageTransformUtil.java;h=ca1531b896b70eaa5bc050dcea76b307ccb766b6;hb=e433e0aa67cc6d144cd3d8d6117de864eb7ebf97;hp=20085bb275cbb9bd5960357d7dba4138cae2b805;hpb=8ce853c0627e829d40fe18e550bc807efbcbafee;p=controller.git diff --git a/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/util/NetconfMessageTransformUtil.java b/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/util/NetconfMessageTransformUtil.java index 20085bb275..ca1531b896 100644 --- a/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/util/NetconfMessageTransformUtil.java +++ b/opendaylight/md-sal/sal-netconf-connector/src/main/java/org/opendaylight/controller/sal/connect/netconf/util/NetconfMessageTransformUtil.java @@ -12,14 +12,21 @@ import com.google.common.base.Preconditions; import com.google.common.collect.ImmutableMap; import com.google.common.collect.Iterables; import com.google.common.collect.Lists; -import com.google.common.collect.Sets; +import java.io.IOException; import java.net.URI; +import java.util.AbstractMap; import java.util.Collections; import java.util.Map; import java.util.Map.Entry; +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.netconf.api.NetconfDocumentedException; import org.opendaylight.controller.netconf.api.NetconfMessage; import org.opendaylight.controller.netconf.util.messages.NetconfMessageUtil; +import org.opendaylight.controller.netconf.util.xml.XmlUtil; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.base._1._0.rev110601.edit.config.input.EditContent; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.netconf.notification._1._0.rev080714.CreateSubscriptionInput; import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.netconf.monitoring.rev101004.NetconfState; @@ -30,27 +37,44 @@ import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity; import org.opendaylight.yangtools.yang.common.RpcResultBuilder; import org.opendaylight.yangtools.yang.data.api.ModifyAction; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; +import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode; 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.impl.codec.xml.XMLStreamNormalizedNodeStreamWriter; import org.opendaylight.yangtools.yang.data.impl.schema.Builders; -import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder; +import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes; +import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeAttrBuilder; import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode; -import org.opendaylight.yangtools.yang.model.api.DataNodeContainer; -import org.opendaylight.yangtools.yang.model.api.DataSchemaNode; import org.opendaylight.yangtools.yang.model.api.NotificationDefinition; -import org.opendaylight.yangtools.yang.model.api.RpcDefinition; import org.opendaylight.yangtools.yang.model.api.SchemaContext; import org.opendaylight.yangtools.yang.model.api.SchemaPath; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.Element; public class NetconfMessageTransformUtil { + private static final Logger LOG= LoggerFactory.getLogger(NetconfMessageTransformUtil.class); + public static final String MESSAGE_ID_ATTR = "message-id"; + public static final XMLOutputFactory XML_FACTORY; + + static { + XML_FACTORY = XMLOutputFactory.newFactory(); + XML_FACTORY.setProperty(XMLOutputFactory.IS_REPAIRING_NAMESPACES, false); + } + public static final QName CREATE_SUBSCRIPTION_RPC_QNAME = QName.cachedReference(QName.create(CreateSubscriptionInput.QNAME, "create-subscription")); private static final String SUBTREE = "subtree"; + // Blank document used for creation of new DOM nodes + private static final Document BLANK_DOCUMENT = XmlUtil.newDocument(); + public static final String EVENT_TIME = "eventTime"; + private NetconfMessageTransformUtil() {} public static final QName IETF_NETCONF_MONITORING = QName.create(NetconfState.QNAME, "ietf-netconf-monitoring"); @@ -121,13 +145,22 @@ public class NetconfMessageTransformUtil { Builders.containerBuilder().withNodeIdentifier(new YangInstanceIdentifier.NodeIdentifier(CREATE_SUBSCRIPTION_RPC_QNAME)).build(); public static DataContainerChild toFilterStructure(final YangInstanceIdentifier identifier, final SchemaContext ctx) { - final DataContainerNodeAttrBuilder filterBuilder = Builders.containerBuilder().withNodeIdentifier(toId(NETCONF_FILTER_QNAME)); - filterBuilder.withAttributes(Collections.singletonMap(NETCONF_TYPE_QNAME, SUBTREE)); + final NormalizedNodeAttrBuilder anyXmlBuilder = Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_FILTER_QNAME)); + anyXmlBuilder.withAttributes(Collections.singletonMap(NETCONF_TYPE_QNAME, SUBTREE)); + + final NormalizedNode filterContent = ImmutableNodes.fromInstanceId(ctx, identifier); - if (Iterables.isEmpty(identifier.getPathArguments()) == false) { - filterBuilder.withChild((DataContainerChild) InstanceIdToNodes.serialize(ctx, identifier)); + final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(), Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString())); + element.setAttributeNS(NETCONF_FILTER_QNAME.getNamespace().toString(), NETCONF_TYPE_QNAME.getLocalName(), "subtree"); + + try { + writeNormalizedNode(filterContent, new DOMResult(element), SchemaPath.ROOT, ctx); + } catch (IOException | XMLStreamException e) { + throw new IllegalStateException("Unable to serialize filter element for path " + identifier, e); } - return filterBuilder.build(); + anyXmlBuilder.withValue(new DOMSource(element)); + + return anyXmlBuilder.build(); } public static void checkValidReply(final NetconfMessage input, final NetconfMessage output) @@ -215,168 +248,78 @@ public class NetconfMessageTransformUtil { NETCONF_GET_QNAME.getLocalName())); } - public static boolean isDataEditOperation(final QName rpc) { - return NETCONF_URI.equals(rpc.getNamespace()) - && rpc.getLocalName().equals(NETCONF_EDIT_CONFIG_QNAME.getLocalName()); - } - - /** - * Creates artificial schema node for edit-config rpc. This artificial schema looks like: - *
-     * {@code
-     * rpc
-     *   edit-config
-     *     config
-     *         // All schema nodes from remote schema
-     *     config
-     *   edit-config
-     * rpc
-     * }
-     * 
- * - * This makes the translation of rpc edit-config request(especially the config node) - * to xml use schema which is crucial for some types of nodes e.g. identity-ref. - */ - public static DataNodeContainer createSchemaForEdit(final SchemaContext schemaContext) { - final QName config = QName.create(NETCONF_EDIT_CONFIG_QNAME, "config"); - final QName editConfig = QName.create(NETCONF_EDIT_CONFIG_QNAME, "edit-config"); - final NodeContainerProxy configProxy = new NodeContainerProxy(config, schemaContext.getChildNodes()); - final NodeContainerProxy editConfigProxy = new NodeContainerProxy(editConfig, Sets.newHashSet(configProxy)); - return new NodeContainerProxy(NETCONF_RPC_QNAME, Sets.newHashSet(editConfigProxy)); - } - public static ContainerSchemaNode createSchemaForDataRead(final SchemaContext schemaContext) { final QName config = QName.create(NETCONF_EDIT_CONFIG_QNAME, "data"); return new NodeContainerProxy(config, schemaContext.getChildNodes()); } - public static ContainerSchemaNode createSchemaForNotification(final NotificationDefinition next) { return new NodeContainerProxy(next.getQName(), next.getChildNodes(), next.getAvailableAugmentations()); } - /** - * Creates artificial schema node for edit-config rpc. This artificial schema looks like: - *
-     * {@code
-     * rpc
-     *   get
-     *     filter
-     *         // All schema nodes from remote schema
-     *     filter
-     *   get
-     * rpc
-     * }
-     * 
- * - * This makes the translation of rpc get request(especially the config node) - * to xml use schema which is crucial for some types of nodes e.g. identity-ref. - */ - public static DataNodeContainer createSchemaForGet(final SchemaContext schemaContext) { - final QName filter = QName.create(NETCONF_GET_QNAME, "filter"); - final QName get = QName.create(NETCONF_GET_QNAME, "get"); - final NodeContainerProxy configProxy = new NodeContainerProxy(filter, schemaContext.getChildNodes()); - final NodeContainerProxy editConfigProxy = new NodeContainerProxy(get, Sets.newHashSet(configProxy)); - return new NodeContainerProxy(NETCONF_RPC_QNAME, Sets.newHashSet(editConfigProxy)); - } - - /** - * Creates artificial schema node for get rpc. This artificial schema looks like: - *
-     * {@code
-     * rpc
-     *   get-config
-     *     filter
-     *         // All schema nodes from remote schema
-     *     filter
-     *   get-config
-     * rpc
-     * }
-     * 
- * - * This makes the translation of rpc get-config request(especially the config node) - * to xml use schema which is crucial for some types of nodes e.g. identity-ref. - */ - public static DataNodeContainer createSchemaForGetConfig(final SchemaContext schemaContext) { - final QName filter = QName.create(NETCONF_GET_CONFIG_QNAME, "filter"); - final QName getConfig = QName.create(NETCONF_GET_CONFIG_QNAME, "get-config"); - final NodeContainerProxy configProxy = new NodeContainerProxy(filter, schemaContext.getChildNodes()); - final NodeContainerProxy editConfigProxy = new NodeContainerProxy(getConfig, Sets.newHashSet(configProxy)); - return new NodeContainerProxy(NETCONF_RPC_QNAME, Sets.newHashSet(editConfigProxy)); - } - - public static Optional findSchemaForRpc(final QName rpcName, final SchemaContext schemaContext) { - Preconditions.checkNotNull(rpcName); - Preconditions.checkNotNull(schemaContext); - - for (final RpcDefinition rpcDefinition : schemaContext.getOperations()) { - if(rpcDefinition.getQName().equals(rpcName)) { - return Optional.of(rpcDefinition); - } - } - - return Optional.absent(); - } - - /** - * Creates artificial schema node for schema defined rpc. This artificial schema looks like: - *
-     * {@code
-     * rpc
-     *   rpc-name
-     *      // All schema nodes from remote schema
-     *   rpc-name
-     * rpc
-     * }
-     * 
- * - * This makes the translation of schema defined rpc request - * to xml use schema which is crucial for some types of nodes e.g. identity-ref. - */ - public static DataNodeContainer createSchemaForRpc(final RpcDefinition rpcDefinition) { - final NodeContainerProxy rpcBodyProxy = new NodeContainerProxy(rpcDefinition.getQName(), rpcDefinition.getInput().getChildNodes()); - return new NodeContainerProxy(NETCONF_RPC_QNAME, Sets.newHashSet(rpcBodyProxy)); - } - public static ContainerNode wrap(final QName name, final DataContainerChild... node) { return Builders.containerBuilder().withNodeIdentifier(toId(name)).withValue(Lists.newArrayList(node)).build(); } public static DataContainerChild createEditConfigStructure(final SchemaContext ctx, final YangInstanceIdentifier dataPath, final Optional operation, final Optional> lastChildOverride) { - // TODO The config element inside the EditContent should be AnyXml not Container, but AnyXml is based on outdated API + final NormalizedNode configContent; + if(Iterables.isEmpty(dataPath.getPathArguments())) { Preconditions.checkArgument(lastChildOverride.isPresent(), "Data has to be present when creating structure for top level element"); Preconditions.checkArgument(lastChildOverride.get() instanceof DataContainerChild, "Data has to be either container or a list node when creating structure for top level element, but was: %s", lastChildOverride.get()); - return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)).withChild( - wrap(NETCONF_CONFIG_QNAME, ((DataContainerChild) lastChildOverride.get()))).build(); + configContent = lastChildOverride.get(); } else { - return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)).withChild( - wrap(NETCONF_CONFIG_QNAME, (DataContainerChild) InstanceIdToNodes.serialize(ctx, dataPath, lastChildOverride, operation))).build(); + final Entry modifyOperation = + operation.isPresent() ? new AbstractMap.SimpleEntry<>(NETCONF_OPERATION_QNAME, operation.get()) : null; + configContent = ImmutableNodes.fromInstanceId(ctx, dataPath, lastChildOverride, Optional.fromNullable(modifyOperation)); } - } - public static void addPredicatesToCompositeNodeBuilder(final Map predicates, - final DataContainerNodeAttrBuilder builder) { - for (final Map.Entry entry : predicates.entrySet()) { - builder.withChild(Builders.leafBuilder().withNodeIdentifier(toId(entry.getKey())).withValue(entry.getValue()).build()); + final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_CONFIG_QNAME.getLocalName(), Optional.of(NETCONF_CONFIG_QNAME.getNamespace().toString())); + try { + writeNormalizedNode(configContent, new DOMResult(element), SchemaPath.ROOT, ctx); + } catch (IOException | XMLStreamException e) { + throw new IllegalStateException("Unable to serialize edit config content element for path " + dataPath, e); } - } + final DOMSource value = new DOMSource(element); - public static Map getPredicates(final YangInstanceIdentifier.PathArgument arg) { - Map predicates = Collections.emptyMap(); - if (arg instanceof YangInstanceIdentifier.NodeIdentifierWithPredicates) { - predicates = ((YangInstanceIdentifier.NodeIdentifierWithPredicates) arg).getKeyValues(); - } - return predicates; + return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)).withChild( + Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_CONFIG_QNAME)).withValue(value).build()).build(); } public static SchemaPath toPath(final QName rpc) { return SchemaPath.create(true, rpc); } - public static String modifyOperationToXmlString(final ModifyAction operation) { - return operation.name().toLowerCase(); + // FIXME similar code is in netconf-notifications-impl , DRY + public static void writeNormalizedNode(final NormalizedNode normalized, final DOMResult result, final SchemaPath schemaPath, final SchemaContext context) + throws IOException, XMLStreamException { + NormalizedNodeWriter normalizedNodeWriter = null; + NormalizedNodeStreamWriter normalizedNodeStreamWriter = null; + XMLStreamWriter writer = null; + try { + writer = XML_FACTORY.createXMLStreamWriter(result); + normalizedNodeStreamWriter = XMLStreamNormalizedNodeStreamWriter.create(writer, context, schemaPath); + normalizedNodeWriter = NormalizedNodeWriter.forStreamWriter(normalizedNodeStreamWriter); + + normalizedNodeWriter.write(normalized); + + normalizedNodeWriter.flush(); + } finally { + try { + if(normalizedNodeWriter != null) { + normalizedNodeWriter.close(); + } + if(normalizedNodeStreamWriter != null) { + normalizedNodeStreamWriter.close(); + } + if(writer != null) { + writer.close(); + } + } catch (final Exception e) { + LOG.warn("Unable to close resource properly", e); + } + } } }