Package io.lighty.codecs

Class XmlNodeConverter

java.lang.Object

io.lighty.codecs.XmlNodeConverter

All Implemented Interfaces:

NodeConverter

public class XmlNodeConverter
extends Object
implements NodeConverter

The implementation of NodeConverter which serializes and deserializes binding independent representation into/from XML representation.

See Also:

JsonNodeConverter

Constructor Summary

Constructors

Constructor	Description
XmlNodeConverter(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)	The only constructor will create an instance of XmlNodeConverter with the given SchemaContext.

Method Summary

Modifier and Type	Method	Description
static void	closeQuietly(XMLStreamReader xmlStreamReader)	This method is similar to the Closeables.closeQuietly(Reader) or other 'closeQuietly methods.
org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>	deserialize(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode, Reader inputData)	This method deserializes the provided XML string representation (via Reader) interface into NormalizedNodes.
Writer	serializeData(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)	This method serializes the given NormalizedNode into its XML string representation.
Writer	serializeRpc(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode, org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)	This method serializes the input or output of a RPC given as NormalizedNode representation into XML string representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlNodeConverter

public XmlNodeConverter(org.opendaylight.yangtools.yang.model.api.SchemaContext schemaContext)

The only constructor will create an instance of XmlNodeConverter with the given SchemaContext. This schema context will be used for proper RPC and Node resolution

Parameters:

schemaContext - initial schema context

Method Detail

serializeData

public Writer serializeData(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode,
                            org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)
                     throws SerializationException

This method serializes the given NormalizedNode into its XML string representation.

Specified by:

serializeData in interface NodeConverter

Parameters:

schemaNode - the parent schema node where the nodes exist

normalizedNode - NormalizedNode to be serialized

Returns:

StringWriter implementation of Writer is returned

Throws:

SerializationException - if it was not possible to serialize the normalized nodes into XML

See Also:

NodeConverter.serializeData(SchemaNode, NormalizedNode)

serializeRpc

public Writer serializeRpc(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode,
                           org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> normalizedNode)
                    throws SerializationException

This method serializes the input or output of a RPC given as NormalizedNode representation into XML string representation.

To obtain correct SchemaNode use ConverterUtils.loadRpc(SchemaContext, QName) method.

Specified by:

serializeRpc in interface NodeConverter

Parameters:

schemaNode - input or output SchemaNode

normalizedNode - NormalizedNode representation of input or output

Returns:

XML string representation of provided BI nodes. It utilizes the StringWriter

Throws:

SerializationException - may be thrown if there was a problem during serialization

See Also:

ConverterUtils.rpcAsInput(XmlElement), ConverterUtils.rpcAsOutput(XmlElement), ConverterUtils.getRpcQName(XmlElement)

deserialize

public org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?> deserialize(org.opendaylight.yangtools.yang.model.api.SchemaNode schemaNode,
                                                                                             Reader inputData)
                                                                                      throws SerializationException

This method deserializes the provided XML string representation (via Reader) interface into NormalizedNodes. During deserialization of RPC input and output a proper SchemaNode (given for input or output) must be passed. This may be obtained via ConverterUtils.loadRpc(SchemaContext, QName).

Specified by:

deserialize in interface NodeConverter

Parameters:

schemaNode - parent schema node which contains information about the input data

inputData - XML input

Returns:

an Optional representation of NormalizedNode. If the deserialization process finished incorrectly an empty value will be present

Throws:

SerializationException - if it was not possible to deserialize the input data

IllegalArgumentException - if a problem occurs during reading the input

See Also:

ConverterUtils.loadRpc(SchemaContext, QName), ConverterUtils.rpcAsInput(XmlElement), ConverterUtils.rpcAsOutput(XmlElement)

closeQuietly

public static void closeQuietly(XMLStreamReader xmlStreamReader)

This method is similar to the Closeables.closeQuietly(Reader) or other 'closeQuietly methods. It takes the XMLStreamReader as parameter checks for null and tries to close it while consuming the IOException. If the IOException occurs it will be logged.

Parameters:

xmlStreamReader - the given XMLStreamReader may be null