import org.opendaylight.yangtools.yang.data.api.CompositeNode;
import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeIdentifierWithPredicates;
+import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.NodeWithValue;
import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier.PathArgument;
+import org.opendaylight.yangtools.yang.data.api.ModifyAction;
import org.opendaylight.yangtools.yang.data.api.Node;
import org.opendaylight.yangtools.yang.data.api.SimpleNode;
import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
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.NodeList;
private static final Logger logger = LoggerFactory.getLogger(XmlDocumentUtils.class);
+ /**
+ * Converts Data DOM structure to XML Document for specified XML Codec Provider and corresponding
+ * Data Node Container schema. The CompositeNode data parameter enters as root of Data DOM tree and will
+ * be transformed to root in XML Document. Each element of Data DOM tree is compared against specified Data
+ * Node Container Schema and transformed accordingly.
+ *
+ * @param data Data DOM root element
+ * @param schema Data Node Container Schema
+ * @param codecProvider XML Codec Provider
+ * @return new instance of XML Document
+ * @throws UnsupportedDataTypeException
+ */
public static Document toDocument(CompositeNode data, DataNodeContainer schema, XmlCodecProvider codecProvider)
throws UnsupportedDataTypeException {
Preconditions.checkNotNull(data);
Preconditions.checkNotNull(schema);
+ Document doc = getDocument();
+
+ if (schema instanceof ContainerSchemaNode || schema instanceof ListSchemaNode) {
+ doc.appendChild(createXmlRootElement(doc, data, (SchemaNode) schema, codecProvider));
+ return doc;
+ } else {
+ throw new UnsupportedDataTypeException(
+ "Schema can be ContainerSchemaNode or ListSchemaNode. Other types are not supported yet.");
+ }
+ }
+
+ public static Document getDocument() {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
Document doc = null;
try {
DocumentBuilder bob = dbf.newDocumentBuilder();
doc = bob.newDocument();
} catch (ParserConfigurationException e) {
- return null;
+ throw new RuntimeException(e);
}
+ return doc;
+ }
- if (schema instanceof ContainerSchemaNode || schema instanceof ListSchemaNode) {
- doc.appendChild(createXmlRootElement(doc, data, (SchemaNode) schema, codecProvider));
- return doc;
- } else {
- throw new UnsupportedDataTypeException(
- "Schema can be ContainerSchemaNode or ListSchemaNode. Other types are not supported yet.");
+ /**
+ * Converts Data DOM structure to XML Document for specified XML Codec Provider. The CompositeNode
+ * data parameter enters as root of Data DOM tree and will be transformed to root in XML Document. The child
+ * nodes of Data Tree are transformed accordingly.
+ *
+ * @param data Data DOM root element
+ * @param codecProvider XML Codec Provider
+ * @return new instance of XML Document
+ * @throws UnsupportedDataTypeException
+ */
+ public static Document toDocument(CompositeNode data, XmlCodecProvider codecProvider)
+ throws UnsupportedDataTypeException {
+ Preconditions.checkNotNull(data);
+
+ DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
+ dbf.setNamespaceAware(true);
+ Document doc = null;
+ try {
+ DocumentBuilder bob = dbf.newDocumentBuilder();
+ doc = bob.newDocument();
+ } catch (ParserConfigurationException e) {
+ return null;
}
+
+ doc.appendChild(createXmlRootElement(doc, data, null, codecProvider));
+ return doc;
}
private static Element createXmlRootElement(Document doc, Node<?> data, SchemaNode schema,
return itemEl;
}
- private static Element createElementFor(Document doc, Node<?> data) {
+ public static Element createElementFor(Document doc, Node<?> data) {
QName dataType = data.getNodeType();
Element ret;
if (dataType.getNamespace() != null) {
public static void writeValueByType(Element element, SimpleNode<?> node, TypeDefinition<?> type,
DataSchemaNode schema, XmlCodecProvider codecProvider) {
- TypeDefinition<?> baseType = resolveBaseTypeFrom(type);
+ Object nodeValue = node.getValue();
+
+ writeValueByType(element, type, codecProvider, nodeValue);
+ }
+
+ public static void writeValueByType(Element element, TypeDefinition<?> type, XmlCodecProvider codecProvider, Object nodeValue) {
+ TypeDefinition<?> baseType = resolveBaseTypeFrom(type);
if (baseType instanceof IdentityrefTypeDefinition) {
- if (node.getValue() instanceof QName) {
- QName value = (QName) node.getValue();
+ if (nodeValue instanceof QName) {
+ QName value = (QName) nodeValue;
String prefix = "x";
if (value.getPrefix() != null && !value.getPrefix().isEmpty()) {
prefix = value.getPrefix();
element.setAttribute("xmlns:" + prefix, value.getNamespace().toString());
element.setTextContent(prefix + ":" + value.getLocalName());
} else {
- Object value = node.getValue();
+ Object value = nodeValue;
logger.debug("Value of {}:{} is not instance of QName but is {}", baseType.getQName().getNamespace(),
baseType.getQName().getLocalName(), value != null ? value.getClass() : "null");
if (value != null) {
}
}
} else if (baseType instanceof InstanceIdentifierTypeDefinition) {
- if (node.getValue() instanceof InstanceIdentifier) {
+ if (nodeValue instanceof InstanceIdentifier) {
// Map< key = namespace, value = prefix>
Map<String, String> prefixes = new HashMap<>();
- InstanceIdentifier instanceIdentifier = (InstanceIdentifier) node.getValue();
+ InstanceIdentifier instanceIdentifier = (InstanceIdentifier) nodeValue;
StringBuilder textContent = new StringBuilder();
for (PathArgument pathArgument : instanceIdentifier.getPath()) {
textContent.append("/");
textContent.append("'");
textContent.append("]");
}
+ } else if (pathArgument instanceof NodeWithValue) {
+ textContent.append("[.='");
+ textContent.append(((NodeWithValue)pathArgument).getValue());
+ textContent.append("'");
+ textContent.append("]");
}
}
element.setTextContent(textContent.toString());
} else {
- Object value = node.getValue();
+ Object value = nodeValue;
logger.debug("Value of {}:{} is not instance of InstanceIdentifier but is {}", baseType.getQName()
.getNamespace(), //
baseType.getQName().getLocalName(), value != null ? value.getClass() : "null");
}
}
} else {
- if (node.getValue() != null) {
+ if (nodeValue != null) {
final TypeDefinitionAwareCodec<Object, ?> codec = codecProvider.codecFor(baseType);
if (codec != null) {
try {
- final String text = codec.serialize(node.getValue());
+ final String text = codec.serialize(nodeValue);
element.setTextContent(text);
} catch (ClassCastException e) {
- logger.error("Provided node did not have type required by mapping. Using stream instead.", e);
- element.setTextContent(String.valueOf(node.getValue()));
+ logger.error("Provided node value {} did not have type {} required by mapping. Using stream instead.", nodeValue, baseType, e);
+ element.setTextContent(String.valueOf(nodeValue));
}
} else {
logger.error("Failed to find codec for {}, falling back to using stream", baseType);
- element.setTextContent(String.valueOf(node.getValue()));
+ element.setTextContent(String.valueOf(nodeValue));
}
}
}
return node.toInstance();
}
- private static QName qNameFromElement(Element xmlElement) {
+ public static QName qNameFromElement(Element xmlElement) {
String namespace = xmlElement.getNamespaceURI();
String localName = xmlElement.getLocalName();
return QName.create(namespace != null ? URI.create(namespace) : null, null, localName);
} else {
value = xmlElement.getTextContent();
}
- return new SimpleNodeTOImpl<Object>(schema.getQName(), null, value);
+
+ Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
+ return new SimpleNodeTOImpl<>(schema.getQName(), null, value, modifyAction.orNull());
}
private static Node<?> toSimpleNodeWithType(Element xmlElement, LeafListSchemaNode schema,
} else {
value = xmlElement.getTextContent();
}
- return new SimpleNodeTOImpl<Object>(schema.getQName(), null, value);
+
+ Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
+ return new SimpleNodeTOImpl<>(schema.getQName(), null, value, modifyAction.orNull());
}
private static Node<?> toCompositeNodeWithSchema(Element xmlElement, QName qName, DataNodeContainer schema,
XmlCodecProvider codecProvider) {
List<Node<?>> values = toDomNodes(xmlElement, Optional.fromNullable(schema.getChildNodes()));
- return ImmutableCompositeNode.create(qName, values);
+ Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
+ return ImmutableCompositeNode.create(qName, values, modifyAction.orNull());
+ }
+
+ public static final QName OPERATION_ATTRIBUTE_QNAME = QName.create(URI.create("urn:ietf:params:xml:ns:netconf:base:1.0"), null, "operation");
+
+ public static Optional<ModifyAction> getModifyOperationFromAttributes(Element xmlElement) {
+ Attr attributeNodeNS = xmlElement.getAttributeNodeNS(OPERATION_ATTRIBUTE_QNAME.getNamespace().toString(), OPERATION_ATTRIBUTE_QNAME.getLocalName());
+ if(attributeNodeNS == null)
+ return Optional.absent();
+
+ ModifyAction action = ModifyAction.fromXmlValue(attributeNodeNS.getValue());
+ Preconditions.checkArgument(action.isOnElementPermitted(), "Unexpected operation %s on %s", action, xmlElement);
+
+ return Optional.of(action);
}
private static void checkQName(Element xmlElement, QName qName) {
checkState(qName.getLocalName().equals(xmlElement.getLocalName()));
}
- private static final Optional<DataSchemaNode> findFirstSchema(QName qname, Set<DataSchemaNode> dataSchemaNode) {
+ public static final Optional<DataSchemaNode> findFirstSchema(QName qname, Set<DataSchemaNode> dataSchemaNode) {
if (dataSchemaNode != null && !dataSchemaNode.isEmpty() && qname != null) {
for (DataSchemaNode dsn : dataSchemaNode) {
if (qname.isEqualWithoutRevision(dsn.getQName())) {
});
}
-
+
/**
* Converts XML Document containing notification data from Netconf device to
* Data DOM Nodes. <br>
* begins in element which is equal to notifications name defined in
* corresponding yang model. Rest of notification metadata are obfuscated,
* thus Data DOM contains only pure notification body.
- *
+ *
* @param document
* XML Document containing notification body
* @param notifications
Code Review / yangtools.git / blobdiff