org.lightningj.lnd.wrapper

Class XMLParser

java.lang.Object

org.lightningj.lnd.wrapper.XMLParser

Direct Known Subclasses:

V1XMLParser

public abstract class XMLParser
extends java.lang.Object

Class containing help methods to marshall and unmarshall XML data to messages. Created by Philip Vendil.

Constructor Summary

Constructors

Constructor and Description
XMLParser()

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getJAXBClassPath()
protected jakarta.xml.bind.JAXBContext	getJAXBContext()
protected jakarta.xml.bind.Marshaller	getMarshaller()
protected jakarta.xml.bind.Marshaller	getPrettyPrintMarshaller()
javax.xml.validation.Schema	getSchema() Loads related XSD schema into Schema object.
protected abstract java.lang.String[]	getSchemaLocations()
protected jakarta.xml.bind.Unmarshaller	getUnmarshaller()
protected abstract java.lang.String	getVersion()
byte[]	marshall(Message message) Method to convert a Message into byte array.
byte[]	marshall(Message message, boolean prettyPrint) Method to convert a Message into byte array with option to have the output formatted into indented (pretty print) format.
Message	unmarshall(byte[] xmlData) Method to unmarshall a byte[] xml document into a Message.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLParser

public XMLParser()

Method Detail

getVersion

protected abstract java.lang.String getVersion()

Returns:

return the version of the related Lnd API.

getSchemaLocations

protected abstract java.lang.String[] getSchemaLocations()

Returns:

the resource locations of the related schemas.

getJAXBClassPath

protected abstract java.lang.String getJAXBClassPath()

Returns:

the JAXB class path used for JAXBContext separated with ':'

unmarshall

public Message unmarshall(byte[] xmlData)
                   throws jakarta.xml.bind.JAXBException

Method to unmarshall a byte[] xml document into a Message.

When unmarshalling is the supplied data validated against XSD Schema.

Parameters:

xmlData - the XML data to convert into Message Object

Returns:

the converted message object.

Throws:

jakarta.xml.bind.JAXBException - if problems occurred converting the object from XML to Message.

marshall

public byte[] marshall(Message message)
                throws jakarta.xml.bind.JAXBException,
                       java.lang.IllegalArgumentException

Method to convert a Message into byte array.

Parameters:

message - the message to convert into XML data

Returns:

byte array XML representation (UTF-8).

Throws:

jakarta.xml.bind.JAXBException - if problems occurred converting the object from message into XML data.

java.lang.IllegalArgumentException - if supplied message was null or otherwise illegal

marshall

public byte[] marshall(Message message,
                       boolean prettyPrint)
                throws jakarta.xml.bind.JAXBException,
                       java.lang.IllegalArgumentException

Method to convert a Message into byte array with option to have the output formatted into indented (pretty print) format.

Parameters:

message - the message to convert into XML data.

prettyPrint - if the XML output should be in pretty print format.

Returns:

byte array XML representation (UTF-8).

Throws:

jakarta.xml.bind.JAXBException - if problems occurred converting the object from message into XML data.

java.lang.IllegalArgumentException - if supplied message was null or otherwise illegal

getSchema

public javax.xml.validation.Schema getSchema()
                                      throws org.xml.sax.SAXException

Loads related XSD schema into Schema object.

Returns:

generated schema used for validation of XML objects.

Throws:

org.xml.sax.SAXException - if loading of schema failed.

getJAXBContext

protected jakarta.xml.bind.JAXBContext getJAXBContext()
                                               throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

getUnmarshaller

protected jakarta.xml.bind.Unmarshaller getUnmarshaller()
                                                 throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

getMarshaller

protected jakarta.xml.bind.Marshaller getMarshaller()
                                             throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException

getPrettyPrintMarshaller

protected jakarta.xml.bind.Marshaller getPrettyPrintMarshaller()
                                                        throws jakarta.xml.bind.JAXBException

Throws:

jakarta.xml.bind.JAXBException