import static com.google.common.base.Preconditions.checkState;
-import com.google.common.base.Function;
-import com.google.common.base.Objects;
-import com.google.common.base.Optional;
-import com.google.common.base.Preconditions;
-import com.google.common.base.Strings;
-import com.google.common.collect.ImmutableList;
-
import java.net.URI;
import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
-
import javax.activation.UnsupportedDataTypeException;
+import javax.annotation.Nonnull;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.dom.DOMResult;
-
import org.opendaylight.yangtools.yang.common.QName;
import org.opendaylight.yangtools.yang.data.api.AttributesContainer;
import org.opendaylight.yangtools.yang.data.api.CompositeNode;
-import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier;
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.api.schema.NormalizedNode;
import org.opendaylight.yangtools.yang.data.impl.ImmutableCompositeNode;
import org.opendaylight.yangtools.yang.data.impl.SimpleNodeTOImpl;
import org.opendaylight.yangtools.yang.data.impl.codec.TypeDefinitionAwareCodec;
-import org.opendaylight.yangtools.yang.data.impl.util.CompositeNodeBuilder;
+import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
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.SchemaNode;
import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
import org.opendaylight.yangtools.yang.model.api.type.IdentityrefTypeDefinition;
-import org.opendaylight.yangtools.yang.model.api.type.InstanceIdentifierTypeDefinition;
+import org.opendaylight.yangtools.yang.model.api.type.LeafrefTypeDefinition;
+import org.opendaylight.yangtools.yang.model.util.InstanceIdentifierType;
+import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Attr;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
+import com.google.common.base.Function;
+import com.google.common.base.Objects;
+import com.google.common.base.Optional;
+import com.google.common.base.Preconditions;
+import com.google.common.base.Strings;
+import com.google.common.collect.ImmutableList;
+
public class XmlDocumentUtils {
private static class ElementWithSchemaContext {
Element element;
}
}
- public static final QName OPERATION_ATTRIBUTE_QNAME = QName.create(URI.create("urn:ietf:params:xml:ns:netconf:base:1.0"), null, "operation");
- private static final Logger logger = LoggerFactory.getLogger(XmlDocumentUtils.class);
+ public static final QName OPERATION_ATTRIBUTE_QNAME = QName.create(SchemaContext.NAME, "operation");
+ private static final QName RPC_REPLY_QNAME = QName.create(SchemaContext.NAME, "rpc-reply");
+ private static final Logger LOG = LoggerFactory.getLogger(XmlDocumentUtils.class);
private static final XMLOutputFactory FACTORY = XMLOutputFactory.newFactory();
- private static final XmlCodecProvider DEFAULT_XML_VALUE_CODEC_PROVIDER = new XmlCodecProvider() {
- @Override
- public TypeDefinitionAwareCodec<Object, ? extends TypeDefinition<?>> codecFor(final TypeDefinition<?> baseType) {
- return TypeDefinitionAwareCodec.from(baseType);
- }
- };
/**
* Converts Data DOM structure to XML Document for specified XML Codec Provider and corresponding
* Node Container Schema and transformed accordingly.
*
* @param data Data DOM root element
- * @param schema Data Node Container Schema
+ * @param schemaNode Data Node Container Schema
* @param codecProvider XML Codec Provider
* @return new instance of XML Document
* @throws UnsupportedDataTypeException
+ *
+ * @deprecated Use {@link #toDocument(org.opendaylight.yangtools.yang.data.api.CompositeNode, com.google.common.base.Optional, org.opendaylight.yangtools.yang.model.api.DataNodeContainer, XmlCodecProvider)} instead.
+ * The whole schema context allows for proper serialization of leafrefs.
+ */
+ public static Document toDocument(final CompositeNode data, final DataNodeContainer schemaNode, final XmlCodecProvider codecProvider)
+ throws UnsupportedDataTypeException {
+ return toDocument(data, Optional.<SchemaContext>absent(), schemaNode, codecProvider);
+ }
+
+ /**
+ * Serializes data DOM node into a w3c DOM document. Whole schema context is used to resolve leafref elements.
+ *
+ * @param data Data DOM root element
+ * @param schemaContext Entire schema context for correct leafref resolution
+ * @param schema Data Node Container Schema
+ * @param codecProvider XML Codec Provider
+ * @return serialized w3c DOM document
+ * @throws UnsupportedDataTypeException
*/
- public static Document toDocument(final CompositeNode data, final DataNodeContainer schema, final XmlCodecProvider codecProvider)
+ public static Document toDocument(final CompositeNode data, final SchemaContext schemaContext, final DataNodeContainer schemaNode, final XmlCodecProvider codecProvider)
+ throws UnsupportedDataTypeException {
+ return toDocument(data, Optional.of(schemaContext), schemaNode, codecProvider);
+ }
+
+ private static Document toDocument(final CompositeNode data, final Optional<SchemaContext> schemaContext, final DataNodeContainer schema, final XmlCodecProvider codecProvider)
throws UnsupportedDataTypeException {
Preconditions.checkNotNull(data);
Preconditions.checkNotNull(schema);
throw new UnsupportedDataTypeException("Schema can be ContainerSchemaNode or ListSchemaNode. Other types are not supported yet.");
}
- final DOMResult result = new DOMResult();
+ final DOMResult result = new DOMResult(getDocument());
try {
final XMLStreamWriter writer = FACTORY.createXMLStreamWriter(result);
- XmlStreamUtils.create(codecProvider).writeDocument(writer, data, (SchemaNode)schema);
+ XmlStreamUtils xmlStreamUtils = schemaContext.isPresent() ? XmlStreamUtils.create(codecProvider, schemaContext.get()) : XmlStreamUtils.create(codecProvider);
+ xmlStreamUtils.writeDocument(writer, data, (SchemaNode) schema);
writer.close();
return (Document)result.getNode();
} catch (XMLStreamException e) {
- logger.error("Failed to serialize data {}", data, e);
+ LOG.error("Failed to serialize data {}", data, e);
return null;
}
}
* @throws UnsupportedDataTypeException
*/
public static Document toDocument(final CompositeNode data, final XmlCodecProvider codecProvider) {
- final DOMResult result = new DOMResult();
+ final DOMResult result = new DOMResult(getDocument());
try {
final XMLStreamWriter writer = FACTORY.createXMLStreamWriter(result);
XmlStreamUtils.create(codecProvider).writeDocument(writer, data);
writer.close();
return (Document)result.getNode();
} catch (XMLStreamException e) {
- logger.error("Failed to serialize data {}", data, e);
+ LOG.error("Failed to serialize data {}", data, e);
return null;
}
}
return createElementFor(doc, data.getNodeType(), data);
}
- public static void writeValueByType(final Element element, final SimpleNode<?> node, final TypeDefinition<?> type,
- final DataSchemaNode schema, final XmlCodecProvider codecProvider) {
-
- Object nodeValue = node.getValue();
-
- writeValueByType(element, type, codecProvider, nodeValue);
- }
-
- public static void writeValueByType(final Element element, final TypeDefinition<?> type, final XmlCodecProvider codecProvider, final Object nodeValue) {
- TypeDefinition<?> baseType = resolveBaseTypeFrom(type);
- if (baseType instanceof IdentityrefTypeDefinition) {
- 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 = 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) {
- element.setTextContent(String.valueOf(value));
- }
- }
- } else if (baseType instanceof InstanceIdentifierTypeDefinition) {
- if (nodeValue instanceof InstanceIdentifier) {
- InstanceIdentifierForXmlCodec.serialize((InstanceIdentifier)nodeValue,element);
- } else {
- 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");
- if (value != null) {
- element.setTextContent(String.valueOf(value));
- }
- }
- } else {
- if (nodeValue != null) {
- final TypeDefinitionAwareCodec<Object, ?> codec = codecProvider.codecFor(baseType);
- if (codec != null) {
- try {
- final String text = codec.serialize(nodeValue);
- element.setTextContent(text);
- } catch (ClassCastException e) {
- 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(nodeValue));
- }
- }
- }
- }
-
- public final static TypeDefinition<?> resolveBaseTypeFrom(final TypeDefinition<?> type) {
- TypeDefinition<?> superType = type;
- while (superType.getBaseType() != null) {
- superType = superType.getBaseType();
- }
- return superType;
+ public static Node<?> toDomNode(final Element xmlElement, final Optional<DataSchemaNode> schema,
+ final Optional<XmlCodecProvider> codecProvider) {
+ return toDomNode(xmlElement, schema, codecProvider, Optional.<SchemaContext>absent());
}
public static Node<?> toDomNode(final Element xmlElement, final Optional<DataSchemaNode> schema,
- final Optional<XmlCodecProvider> codecProvider) {
+ final Optional<XmlCodecProvider> codecProvider, final Optional<SchemaContext> schemaContext) {
if (schema.isPresent()) {
- return toNodeWithSchema(xmlElement, schema.get(), codecProvider.or(DEFAULT_XML_VALUE_CODEC_PROVIDER));
+ if(schemaContext.isPresent()) {
+ return toNodeWithSchema(xmlElement, schema.get(), codecProvider.or(XmlUtils.DEFAULT_XML_CODEC_PROVIDER), schemaContext.get());
+ } else {
+ return toNodeWithSchema(xmlElement, schema.get(), codecProvider.or(XmlUtils.DEFAULT_XML_CODEC_PROVIDER));
+ }
}
return toDomNode(xmlElement);
}
- public static CompositeNode fromElement(final Element xmlElement) {
- CompositeNodeBuilder<ImmutableCompositeNode> node = ImmutableCompositeNode.builder();
- node.setQName(qNameFromElement(xmlElement));
-
- return node.toInstance();
- }
-
public static QName qNameFromElement(final Element xmlElement) {
String namespace = xmlElement.getNamespaceURI();
String localName = xmlElement.getLocalName();
return toSimpleNodeWithType(xmlElement, (LeafSchemaNode) schema, codecProvider,schemaCtx);
} else if (schema instanceof LeafListSchemaNode) {
return toSimpleNodeWithType(xmlElement, (LeafListSchemaNode) schema, codecProvider,schemaCtx);
+ } else if (schema instanceof AnyXmlSchemaNode) {
+ return toDomNode(xmlElement);
}
return null;
}
protected static Node<?> toSimpleNodeWithType(final Element xmlElement, final LeafSchemaNode schema,
final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
- TypeDefinitionAwareCodec<? extends Object, ? extends TypeDefinition<?>> codec = codecProvider.codecFor(schema.getType());
- String text = xmlElement.getTextContent();
- Object value = null;
- if (codec != null) {
- value = codec.deserialize(text);
- }
-
- if (schema.getType() instanceof org.opendaylight.yangtools.yang.model.util.InstanceIdentifier) {
- value = InstanceIdentifierForXmlCodec.deserialize(xmlElement,schemaCtx);
- } else if(schema.getType() instanceof IdentityrefTypeDefinition){
- value = InstanceIdentifierForXmlCodec.toIdentity(xmlElement.getTextContent(), xmlElement, schemaCtx);
- }
-
- if (value == null) {
- value = xmlElement.getTextContent();
- }
-
+ final Object value = resolveValueFromSchemaType(xmlElement, schema, schema.getType(), codecProvider, schemaCtx);
Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
return new SimpleNodeTOImpl<>(schema.getQName(), null, value, modifyAction.orNull());
}
private static Node<?> toSimpleNodeWithType(final Element xmlElement, final LeafListSchemaNode schema,
final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
- TypeDefinitionAwareCodec<? extends Object, ? extends TypeDefinition<?>> codec = codecProvider.codecFor(schema.getType());
- String text = xmlElement.getTextContent();
- Object value = null;
- if (codec != null) {
- value = codec.deserialize(text);
- }
- if (schema.getType() instanceof org.opendaylight.yangtools.yang.model.util.InstanceIdentifier) {
- value = InstanceIdentifierForXmlCodec.deserialize(xmlElement,schemaCtx);
- }
- if (value == null) {
- value = xmlElement.getTextContent();
- }
-
+ final Object value = resolveValueFromSchemaType(xmlElement, schema, schema.getType(), codecProvider, schemaCtx);
Optional<ModifyAction> modifyAction = getModifyOperationFromAttributes(xmlElement);
return new SimpleNodeTOImpl<>(schema.getQName(), null, value, modifyAction.orNull());
}
+ private static Object resolveValueFromSchemaType(final Element xmlElement, final DataSchemaNode schema, final TypeDefinition<?> type,
+ final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
+
+ TypeDefinition<?> baseType = XmlUtils.resolveBaseTypeFrom(type);
+ if (baseType instanceof LeafrefTypeDefinition) {
+ final LeafrefTypeDefinition leafrefTypeDefinition = (LeafrefTypeDefinition) baseType;
+ baseType = SchemaContextUtil.getBaseTypeForLeafRef(leafrefTypeDefinition, schemaCtx, schema);
+ }
+
+ final String text = xmlElement.getTextContent();
+ final Object value;
+
+ if (baseType instanceof InstanceIdentifierType) {
+ value = InstanceIdentifierForXmlCodec.deserialize(xmlElement, schemaCtx);
+ } else if (baseType instanceof IdentityrefTypeDefinition) {
+ value = InstanceIdentifierForXmlCodec.toIdentity(text, xmlElement, schemaCtx);
+ } else {
+ final TypeDefinitionAwareCodec<?, ?> codec = codecProvider.codecFor(baseType);
+ if (codec == null) {
+ LOG.info("No codec for schema {}, falling back to text", schema);
+ value = text;
+ } else {
+ value = codec.deserialize(text);
+ }
+ }
+ return value;
+ }
+
private static Node<?> toCompositeNodeWithSchema(final Element xmlElement, final QName qName, final DataNodeContainer schema,
final XmlCodecProvider codecProvider,final SchemaContext schemaCtx) {
List<Node<?>> values = toDomNodes(xmlElement, Optional.fromNullable(schema.getChildNodes()),schemaCtx);
}
private static void checkQName(final Element xmlElement, final QName qName) {
- checkState(Objects.equal(xmlElement.getNamespaceURI(), qName.getNamespace().toString()));
- checkState(qName.getLocalName().equals(xmlElement.getLocalName()));
+ checkState(Objects.equal(xmlElement.getNamespaceURI(), qName.getNamespace().toString()), "Not equal: %s to: %s for: %s and: %s", qName.getNamespace(), xmlElement.getNamespaceURI(), qName, xmlElement);
+ checkState(qName.getLocalName().equals(xmlElement.getLocalName()), "Not equal: %s to: %s for: %s and: %s", qName.getLocalName(), xmlElement.getLocalName(), qName, xmlElement);
}
- public static final Optional<DataSchemaNode> findFirstSchema(final QName qname, final Set<DataSchemaNode> dataSchemaNode) {
- if (dataSchemaNode != null && !dataSchemaNode.isEmpty() && qname != null) {
+ public static final Optional<DataSchemaNode> findFirstSchema(final QName qname, final Iterable<DataSchemaNode> dataSchemaNode) {
+ if (dataSchemaNode != null && qname != null) {
for (DataSchemaNode dsn : dataSchemaNode) {
if (qname.isEqualWithoutRevision(dsn.getQName())) {
return Optional.<DataSchemaNode> of(dsn);
return ImmutableCompositeNode.create(qname, values.build());
}
- public static List<Node<?>> toDomNodes(final Element element, final Optional<Set<DataSchemaNode>> context,final SchemaContext schemaCtx) {
- return forEachChild(element.getChildNodes(),schemaCtx, new Function<ElementWithSchemaContext, Optional<Node<?>>>() {
+ public static List<Node<?>> toDomNodes(final Element element, final Optional<? extends Iterable<DataSchemaNode>> context, final SchemaContext schemaCtx) {
+ return forEachChild(element.getChildNodes(), schemaCtx, new Function<ElementWithSchemaContext, Optional<Node<?>>>() {
@Override
- public Optional<Node<?>> apply(final ElementWithSchemaContext input) {
+ public Optional<Node<?>> apply(final @Nonnull ElementWithSchemaContext input) {
if (context.isPresent()) {
+ Preconditions.checkNotNull(input);
QName partialQName = qNameFromElement(input.getElement());
Optional<DataSchemaNode> schemaNode = findFirstSchema(partialQName, context.get());
if (schemaNode.isPresent()) {
- return Optional.<Node<?>> fromNullable(//
- toNodeWithSchema(input.getElement(), schemaNode.get(), DEFAULT_XML_VALUE_CODEC_PROVIDER,input.getSchemaContext()));
+ return Optional.<Node<?>> fromNullable(
+ toNodeWithSchema(input.getElement(), schemaNode.get(), XmlUtils.DEFAULT_XML_CODEC_PROVIDER, input.getSchemaContext()));
}
}
return Optional.<Node<?>> fromNullable(toDomNode(input.getElement()));
}
});
-
}
- public static List<Node<?>> toDomNodes(final Element element, final Optional<Set<DataSchemaNode>> context) {
- return toDomNodes(element,context,null);
+ public static List<Node<?>> toDomNodes(final Element element, final Optional<? extends Iterable<DataSchemaNode>> context) {
+ return toDomNodes(element, context, null);
}
/**
final Optional<NotificationDefinition> notificationDef = findNotification(partialQName,
notifications.get());
if (notificationDef.isPresent()) {
- final Set<DataSchemaNode> dataNodes = notificationDef.get().getChildNodes();
+ final Iterable<DataSchemaNode> dataNodes = notificationDef.get().getChildNodes();
final List<Node<?>> domNodes = toDomNodes(childElement,
- Optional.<Set<DataSchemaNode>> fromNullable(dataNodes),schemaCtx);
+ Optional.<Iterable<DataSchemaNode>> fromNullable(dataNodes),schemaCtx);
return ImmutableCompositeNode.create(notificationDef.get().getQName(), domNodes);
}
}
return null;
}
+ /**
+ * Transforms XML Document representing Rpc output body into Composite Node structure based on Rpc definition
+ * within given Schema Context. The transformation is based on Rpc Definition which is defined in provided Schema Context.
+ * If Rpc Definition is missing from given Schema Context the method will return <code>null</code>
+ *
+ * @param document XML Document containing Output RPC message
+ * @param rpcName Rpc QName
+ * @param context Schema Context
+ * @return Rpc message in Composite Node data structures if Rpc definition is present within provided Schema Context, otherwise
+ * returns <code>null</code>
+ */
+ public static CompositeNode rpcReplyToDomNodes(final Document document, final QName rpcName,
+ final SchemaContext context) {
+ Preconditions.checkNotNull(document);
+ Preconditions.checkNotNull(rpcName);
+ Preconditions.checkNotNull(context);
+
+ Optional<RpcDefinition> rpcDefinition = findRpc(rpcName, context);
+ if (rpcDefinition.isPresent()) {
+ RpcDefinition rpc = rpcDefinition.get();
+
+ final Collection<DataSchemaNode> outputNode = rpc.getOutput() != null ? rpc.getOutput().getChildNodes() : null;
+ final Element rpcReplyElement = document.getDocumentElement();
+ final QName partialQName = qNameFromElement(rpcReplyElement);
+
+ if (RPC_REPLY_QNAME.equals(partialQName)) {
+ final List<Node<?>> domNodes = toDomNodes(rpcReplyElement, Optional.fromNullable(outputNode), context);
+ QName qName = rpc.getOutput() != null ? rpc.getOutput().getQName() : QName.cachedReference(QName.create(rpcName, "output"));
+ List<Node<?>> rpcOutNodes = Collections.<Node<?>>singletonList(ImmutableCompositeNode.create(
+ qName, domNodes));
+ return ImmutableCompositeNode.create(rpcName, rpcOutNodes);
+ }
+ }
+ return null;
+ }
+
+ /**
+ * Method searches given schema context for Rpc Definition with given QName.
+ * Returns Rpc Definition if is present within given Schema Context, otherwise returns Optional.absent().
+ *
+ * @param rpc Rpc QName
+ * @param context Schema Context
+ * @return Rpc Definition if is present within given Schema Context, otherwise returns Optional.absent().
+ */
+ private static Optional<RpcDefinition> findRpc(final QName rpc, final SchemaContext context) {
+ Preconditions.checkNotNull(rpc);
+ Preconditions.checkNotNull(context);
+ for (final RpcDefinition rpcDefinition : context.getOperations()) {
+ if ((rpcDefinition != null) && rpc.equals(rpcDefinition.getQName())) {
+ return Optional.of(rpcDefinition);
+ }
+ }
+ return Optional.absent();
+ }
+
public static CompositeNode notificationToDomNodes(final Document document,
final Optional<Set<NotificationDefinition>> notifications) {
return notificationToDomNodes(document, notifications,null);
}
public static final XmlCodecProvider defaultValueCodecProvider() {
- return DEFAULT_XML_VALUE_CODEC_PROVIDER;
+ return XmlUtils.DEFAULT_XML_CODEC_PROVIDER;
}
}
Code Review / yangtools.git / blobdiff