X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=netconf%2Fsal-netconf-connector%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fnetconf%2Fsal%2Fconnect%2Fnetconf%2Futil%2FNetconfMessageTransformUtil.java;h=ea7abe2f74291eec22fa1848dc6575c700634407;hb=34d2b57747bd297fbe1be8f4a2b9175d03cbf266;hp=4726b7aaa7f5a23a877682f2ccefa8b00d1f633f;hpb=65e3ef6c3f9697a80fbdd7654fcce97cc3cd207e;p=netconf.git diff --git a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/util/NetconfMessageTransformUtil.java b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/util/NetconfMessageTransformUtil.java index 4726b7aaa7..ea7abe2f74 100644 --- a/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/util/NetconfMessageTransformUtil.java +++ b/netconf/sal-netconf-connector/src/main/java/org/opendaylight/netconf/sal/connect/netconf/util/NetconfMessageTransformUtil.java @@ -16,8 +16,8 @@ import java.net.URI; import java.time.format.DateTimeParseException; import java.util.AbstractMap; import java.util.Collection; -import java.util.Collections; import java.util.Date; +import java.util.Iterator; import java.util.List; import java.util.Map; import java.util.Map.Entry; @@ -25,12 +25,13 @@ 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.XmlElement; -import org.opendaylight.controller.config.util.xml.XmlUtil; +import org.opendaylight.mdsal.dom.api.DOMDataTreeIdentifier; +import org.opendaylight.netconf.api.DocumentedException; import org.opendaylight.netconf.api.FailedNetconfMessage; import org.opendaylight.netconf.api.NetconfDocumentedException; import org.opendaylight.netconf.api.NetconfMessage; +import org.opendaylight.netconf.api.xml.XmlElement; +import org.opendaylight.netconf.api.xml.XmlUtil; import org.opendaylight.netconf.notifications.NetconfNotification; import org.opendaylight.netconf.sal.connect.util.MessageCounter; import org.opendaylight.netconf.util.NetconfUtil; @@ -47,6 +48,8 @@ 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.YangInstanceIdentifier.NodeIdentifier; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue; import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument; import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode; import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode; @@ -67,7 +70,7 @@ import org.slf4j.LoggerFactory; import org.w3c.dom.Document; import org.w3c.dom.Element; -public class NetconfMessageTransformUtil { +public final class NetconfMessageTransformUtil { private static final Logger LOG = LoggerFactory.getLogger(NetconfMessageTransformUtil.class); @@ -107,27 +110,44 @@ public class NetconfMessageTransformUtil { public static final URI NETCONF_URI = NETCONF_QNAME.getNamespace(); public static final QName NETCONF_DATA_QNAME = QName.create(NETCONF_QNAME, "data").intern(); + public static final NodeIdentifier NETCONF_DATA_NODEID = NodeIdentifier.create(NETCONF_DATA_QNAME); + public static final QName NETCONF_RPC_REPLY_QNAME = QName.create(NETCONF_QNAME, "rpc-reply").intern(); public static final QName NETCONF_OK_QNAME = QName.create(NETCONF_QNAME, "ok").intern(); public static final QName NETCONF_ERROR_OPTION_QNAME = QName.create(NETCONF_QNAME, "error-option").intern(); + public static final NodeIdentifier NETCONF_ERROR_OPTION_NODEID = NodeIdentifier.create(NETCONF_ERROR_OPTION_QNAME); public static final QName NETCONF_RUNNING_QNAME = QName.create(NETCONF_QNAME, "running").intern(); public static final QName NETCONF_SOURCE_QNAME = QName.create(NETCONF_QNAME, "source").intern(); + public static final NodeIdentifier NETCONF_SOURCE_NODEID = NodeIdentifier.create(NETCONF_SOURCE_QNAME); public static final QName NETCONF_CANDIDATE_QNAME = QName.create(NETCONF_QNAME, "candidate").intern(); public static final QName NETCONF_TARGET_QNAME = QName.create(NETCONF_QNAME, "target").intern(); + public static final NodeIdentifier NETCONF_TARGET_NODEID = NodeIdentifier.create(NETCONF_TARGET_QNAME); public static final QName NETCONF_CONFIG_QNAME = QName.create(NETCONF_QNAME, "config").intern(); + public static final NodeIdentifier NETCONF_CONFIG_NODEID = NodeIdentifier.create(NETCONF_CONFIG_QNAME); + public static final QName NETCONF_COMMIT_QNAME = QName.create(NETCONF_QNAME, "commit").intern(); public static final QName NETCONF_VALIDATE_QNAME = QName.create(NETCONF_QNAME, "validate").intern(); + public static final NodeIdentifier NETCONF_VALIDATE_NODEID = NodeIdentifier.create(NETCONF_VALIDATE_QNAME); public static final QName NETCONF_COPY_CONFIG_QNAME = QName.create(NETCONF_QNAME, "copy-config").intern(); + public static final NodeIdentifier NETCONF_COPY_CONFIG_NODEID = NodeIdentifier.create(NETCONF_COPY_CONFIG_QNAME); + public static final QName NETCONF_OPERATION_QNAME = QName.create(NETCONF_QNAME, "operation").intern(); public static final QName NETCONF_DEFAULT_OPERATION_QNAME = QName.create(NETCONF_OPERATION_QNAME, "default-operation").intern(); + public static final NodeIdentifier NETCONF_DEFAULT_OPERATION_NODEID = + NodeIdentifier.create(NETCONF_DEFAULT_OPERATION_QNAME); public static final QName NETCONF_EDIT_CONFIG_QNAME = QName.create(NETCONF_QNAME, "edit-config").intern(); + public static final NodeIdentifier NETCONF_EDIT_CONFIG_NODEID = NodeIdentifier.create(NETCONF_EDIT_CONFIG_QNAME); public static final QName NETCONF_GET_CONFIG_QNAME = QName.create(NETCONF_QNAME, "get-config"); public static final QName NETCONF_DISCARD_CHANGES_QNAME = QName.create(NETCONF_QNAME, "discard-changes"); public static final QName NETCONF_TYPE_QNAME = QName.create(NETCONF_QNAME, "type").intern(); public static final QName NETCONF_FILTER_QNAME = QName.create(NETCONF_QNAME, "filter").intern(); public static final QName NETCONF_GET_QNAME = QName.create(NETCONF_QNAME, "get").intern(); + public static final NodeIdentifier NETCONF_GET_NODEID = NodeIdentifier.create(NETCONF_GET_QNAME); public static final QName NETCONF_RPC_QNAME = QName.create(NETCONF_QNAME, "rpc").intern(); + public static final QName YANG_QNAME = null; + public static final URI NETCONF_ACTION_NAMESPACE = URI.create("urn:ietf:params:xml:ns:yang:1"); + public static final String NETCONF_ACTION = "action"; public static final URI NETCONF_ROLLBACK_ON_ERROR_URI = URI .create("urn:ietf:params:netconf:capability:rollback-on-error:1.0"); @@ -143,30 +163,37 @@ public class NetconfMessageTransformUtil { .create("urn:ietf:params:netconf:capability:writable-running:1.0"); public static final QName NETCONF_LOCK_QNAME = QName.create(NETCONF_QNAME, "lock").intern(); + public static final NodeIdentifier NETCONF_LOCK_NODEID = NodeIdentifier.create(NETCONF_LOCK_QNAME); public static final QName NETCONF_UNLOCK_QNAME = QName.create(NETCONF_QNAME, "unlock").intern(); + public static final NodeIdentifier NETCONF_UNLOCK_NODEID = NodeIdentifier.create(NETCONF_UNLOCK_QNAME); + + public static final NodeIdentifier EDIT_CONTENT_NODEID = NodeIdentifier.create(EditContent.QNAME); // Discard changes message - public static final ContainerNode DISCARD_CHANGES_RPC_CONTENT = - Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(NETCONF_DISCARD_CHANGES_QNAME)).build(); + public static final ContainerNode DISCARD_CHANGES_RPC_CONTENT = Builders.containerBuilder() + .withNodeIdentifier(NodeIdentifier.create(NETCONF_DISCARD_CHANGES_QNAME)).build(); // Commit changes message - public static final ContainerNode COMMIT_RPC_CONTENT = - Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(NETCONF_COMMIT_QNAME)).build(); + public static final ContainerNode COMMIT_RPC_CONTENT = Builders.containerBuilder() + .withNodeIdentifier(NodeIdentifier.create(NETCONF_COMMIT_QNAME)).build(); // Get message - public static final ContainerNode GET_RPC_CONTENT = - Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(NETCONF_GET_QNAME)).build(); + public static final ContainerNode GET_RPC_CONTENT = Builders.containerBuilder() + .withNodeIdentifier(NodeIdentifier.create(NETCONF_GET_QNAME)).build(); // Create-subscription changes message - public static final ContainerNode CREATE_SUBSCRIPTION_RPC_CONTENT = - Builders.containerBuilder().withNodeIdentifier(new NodeIdentifier(CREATE_SUBSCRIPTION_RPC_QNAME)).build(); + public static final ContainerNode CREATE_SUBSCRIPTION_RPC_CONTENT = Builders.containerBuilder() + .withNodeIdentifier(NodeIdentifier.create(CREATE_SUBSCRIPTION_RPC_QNAME)).build(); + + private static final NodeIdentifier NETCONF_FILTER_NODEID = NodeIdentifier.create(NETCONF_FILTER_QNAME); + private static final Map SUBTREE_FILTER_ATTRIBUTES = ImmutableMap.of(NETCONF_TYPE_QNAME, SUBTREE); public static final DataContainerChild EMPTY_FILTER; static { final NormalizedNodeAttrBuilder anyXmlBuilder = - Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_FILTER_QNAME)); - anyXmlBuilder.withAttributes(Collections.singletonMap(NETCONF_TYPE_QNAME, SUBTREE)); + Builders.anyXmlBuilder().withNodeIdentifier(NETCONF_FILTER_NODEID) + .withAttributes(SUBTREE_FILTER_ATTRIBUTES); final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(), Optional.of(NETCONF_FILTER_QNAME.getNamespace().toString())); @@ -180,10 +207,8 @@ public class NetconfMessageTransformUtil { public static DataContainerChild toFilterStructure(final YangInstanceIdentifier identifier, final SchemaContext ctx) { - final NormalizedNodeAttrBuilder anyXmlBuilder = - Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_FILTER_QNAME)); - anyXmlBuilder.withAttributes(Collections.singletonMap(NETCONF_TYPE_QNAME, SUBTREE)); - + final NormalizedNodeAttrBuilder anyXmlBuilder = Builders.anyXmlBuilder() + .withNodeIdentifier(NETCONF_FILTER_NODEID).withAttributes(SUBTREE_FILTER_ATTRIBUTES); final NormalizedNode filterContent = ImmutableNodes.fromInstanceId(ctx, identifier); final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_FILTER_QNAME.getLocalName(), @@ -268,7 +293,7 @@ public class NetconfMessageTransformUtil { } public static NodeIdentifier toId(final PathArgument qname) { - return toId(qname.getNodeType()); + return qname instanceof NodeIdentifier ? (NodeIdentifier) qname : toId(qname.getNodeType()); } public static NodeIdentifier toId(final QName nodeType) { @@ -312,8 +337,8 @@ public class NetconfMessageTransformUtil { } else { final Entry modifyOperation = operation.isPresent() ? new AbstractMap.SimpleEntry<>(NETCONF_OPERATION_QNAME, operation.get()) : null; - configContent = ImmutableNodes - .fromInstanceId(ctx, dataPath, lastChildOverride, Optional.fromNullable(modifyOperation)); + configContent = ImmutableNodes.fromInstanceId(ctx, dataPath, lastChildOverride.toJavaUtil(), + java.util.Optional.ofNullable(modifyOperation)); } final Element element = XmlUtil.createElement(BLANK_DOCUMENT, NETCONF_CONFIG_QNAME.getLocalName(), @@ -323,15 +348,15 @@ public class NetconfMessageTransformUtil { } catch (IOException | XMLStreamException e) { throw new IllegalStateException("Unable to serialize edit config content element for path " + dataPath, e); } - final DOMSource value = new DOMSource(element); - return Builders.anyXmlBuilder().withNodeIdentifier(toId(NETCONF_CONFIG_QNAME)).withValue(value).build(); + return Builders.anyXmlBuilder().withNodeIdentifier(NETCONF_CONFIG_NODEID).withValue(new DOMSource(element)) + .build(); } public static DataContainerChild createEditConfigStructure( final SchemaContext ctx, final YangInstanceIdentifier dataPath, final Optional operation, final Optional> lastChildOverride) { - return Builders.choiceBuilder().withNodeIdentifier(toId(EditContent.QNAME)) + return Builders.choiceBuilder().withNodeIdentifier(EDIT_CONTENT_NODEID) .withChild(createEditConfigAnyxml(ctx, dataPath, operation, lastChildOverride)).build(); } @@ -363,7 +388,8 @@ public class NetconfMessageTransformUtil { NetconfNotification.RFC3339_DATE_PARSER.apply(eventTimeElement.getTextContent()), notificationElement); } catch (final DocumentedException e) { - throw new IllegalArgumentException("Notification payload does not contain " + EVENT_TIME + " " + message); + throw new IllegalArgumentException("Notification payload does not contain " + EVENT_TIME + " " + message, + e); } catch (final DateTimeParseException e) { LOG.warn("Unable to parse event time from {}. Setting time to {}", eventTimeElement, NetconfNotification.UNKNOWN_EVENT_TIME, e); @@ -383,6 +409,51 @@ public class NetconfMessageTransformUtil { return new DOMResult(elementNS); } + public static DOMResult prepareDomResultForActionRequest(DOMDataTreeIdentifier domDataTreeIdentifier, + final SchemaPath actionSchemaPath, final MessageCounter counter, String action) { + final Document document = XmlUtil.newDocument(); + final Element rpcNS = + document.createElementNS(NETCONF_RPC_QNAME.getNamespace().toString(), NETCONF_RPC_QNAME.getLocalName()); + // set msg id + rpcNS.setAttribute(MESSAGE_ID_ATTR, counter.getNewMessageId(MESSAGE_ID_PREFIX)); + + final Element actionNS = document.createElementNS(NETCONF_ACTION_NAMESPACE.toString(), NETCONF_ACTION); + + final Element actionData = prepareActionData(actionNS, + domDataTreeIdentifier.getRootIdentifier().getPathArguments().iterator(), document); + + Element specificActionElement = document.createElement(action); + actionData.appendChild(specificActionElement); + rpcNS.appendChild(actionNS); + document.appendChild(rpcNS); + return new DOMResult(specificActionElement); + } + + private static Element prepareActionData(Element actionNS, Iterator iterator, Document document) { + if (iterator.hasNext()) { + PathArgument next = iterator.next(); + final QName actualNS = next.getNodeType(); + + final Element actualElement = document.createElementNS(actualNS.getNamespace().toString(), + actualNS.getLocalName()); + if (next instanceof NodeWithValue) { + actualElement.setNodeValue(((NodeWithValue) next).getValue().toString()); + } else if (next instanceof NodeIdentifierWithPredicates) { + for (Entry entry : ((NodeIdentifierWithPredicates) next).getKeyValues().entrySet()) { + final Element entryElement = document.createElementNS(entry.getKey().getNamespace().toString(), + entry.getKey().getLocalName()); + entryElement.setTextContent(entry.getValue().toString()); + entryElement.setNodeValue(entry.getValue().toString()); + actualElement.appendChild(entryElement); + } + } + actionNS.appendChild(actualElement); + return prepareActionData(actualElement, iterator, document); + } else { + return actionNS; + } + } + @SuppressWarnings("checkstyle:IllegalCatch") public static void writeNormalizedRpc(final ContainerNode normalized, final DOMResult result, final SchemaPath schemaPath,