From 10567e0145ce651c327267d8f4ea31d82bc7e239 Mon Sep 17 00:00:00 2001 From: Manuel Bentele Date: Fri, 29 Jan 2021 12:22:05 +0100 Subject: Add base classes and utilites to represent Libvirt XML documents --- .../openslx/libvirt/xml/LibvirtXmlDocument.java | 374 +++++++++++++++++++++ 1 file changed, 374 insertions(+) create mode 100644 src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java (limited to 'src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java') diff --git a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java new file mode 100644 index 0000000..abab162 --- /dev/null +++ b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java @@ -0,0 +1,374 @@ +package org.openslx.libvirt.xml; + +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.io.InputStream; +import java.io.StringWriter; + +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.transform.Source; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerConfigurationException; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.dom.DOMSource; +import javax.xml.transform.stream.StreamResult; +import javax.xml.transform.stream.StreamSource; + +import org.apache.commons.io.IOUtils; +import org.w3c.dom.Document; +import org.xml.sax.InputSource; +import org.xml.sax.SAXException; + +/** + * A generic representation of a Libvirt XML file. + * + * @implNote Base class to derive the representation of specific Libvirt XML files. + * + * @author Manuel Bentele + * @version 1.0 + */ +public abstract class LibvirtXmlDocument implements LibvirtXmlSerializable, LibvirtXmlValidatable +{ + /** + * Document builder to parse Libvirt XML document from file. + */ + private DocumentBuilder domBuilder = null; + + /** + * Representation of a Libvirt XML document. + */ + private Document xmlDocument = null; + + /** + * XML transformer to transform Libvirt XML document to a file. + */ + private Transformer xmlTransformer = null; + + /** + * XML root node of the Libvirt XML document. + */ + private LibvirtXmlNode rootXmlNode = null; + + /** + * RNG schema validator to validate the Libvirt XML document content. + */ + private LibvirtXmlSchemaValidator rngValidator = null; + + /** + * Creates and initializes XML context to create and transform a Libvirt XML file from/to a file. + * + * @param rngSchema RNG schema to validate the Libvirt XML document content. + * + * @throws LibvirtXmlDocumentException error occured during setup of the XML context to read and + * write from/to a Libvirt XML file. + */ + private void createXmlContext( Source rngSchema ) throws LibvirtXmlDocumentException + { + // used for XML input + try { + DocumentBuilderFactory domFactory = DocumentBuilderFactory.newInstance(); + domFactory.setIgnoringElementContentWhitespace( true ); + domFactory.setNamespaceAware( true ); + this.domBuilder = domFactory.newDocumentBuilder(); + } catch ( ParserConfigurationException e ) { + String errorMsg = new String( "Setting up XML context for reading from the Libvirt XML document failed." ); + throw new LibvirtXmlDocumentException( errorMsg ); + } + + // used for XML output + try { + // use hack to load specific transformer factory implementation for XSLT + System.setProperty( TransformerFactory.class.getName(), + "org.apache.xalan.processor.TransformerFactoryImpl" ); + + // create XML transformer factory to create XML transformer with specific indentation + TransformerFactory transformerFactory = TransformerFactory.newInstance(); + + // create XML transformer and apply settings for output XML transformation + InputStream xslOutputSchemaStream = LibvirtXmlResources.getLibvirtXsl( "xml-output-transformation.xsl" ); + StreamSource xslOutputSchema = new StreamSource( xslOutputSchemaStream ); + this.xmlTransformer = transformerFactory.newTransformer( xslOutputSchema ); + } catch ( TransformerConfigurationException e ) { + String errorMsg = new String( "Setting up XML context for writing to the Libvirt XML document failed." ); + throw new LibvirtXmlDocumentException( errorMsg ); + } + + // used for XML validation with RNG schema files + if ( rngSchema != null ) { + try { + this.rngValidator = new LibvirtXmlSchemaValidator( rngSchema ); + } catch ( SAXException e ) { + String errorMsg = new String( "Setting up XML context for validating to the Libvirt XML document failed." ); + e.printStackTrace(); + throw new LibvirtXmlDocumentException( errorMsg ); + } + } + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link String}. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( String xml ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this( xml, null ); + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link String}. + * @param rngSchema RNG schema to validate XML content. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( String xml, Source rngSchema ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this.createXmlContext( rngSchema ); + this.fromXml( xml ); + this.validateXml(); + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link File}. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( File xml ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this( xml, null ); + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link File}. + * @param rngSchema RNG schema to validate XML content. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( File xml, Source rngSchema ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this.createXmlContext( rngSchema ); + this.fromXml( xml ); + this.validateXml(); + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link InputStream}. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( InputStream xml ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this( xml, null ); + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link InputStream}. + * @param rngSchema RNG schema to validate XML content. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( InputStream xml, Source rngSchema ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this.createXmlContext( rngSchema ); + this.fromXml( xml ); + this.validateXml(); + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link InputSource}. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( InputSource xml ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this( xml, null ); + } + + /** + * Creates a Libvirt XML document from a given XML content. + * + * @param xml XML content as {@link InputSource}. + * @param rngSchema RNG schema to validate XML content. + * + * @throws LibvirtXmlDocumentException creation of XML context failed. + * @throws LibvirtXmlSerializationException serialization of the XML content failed. + * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. + */ + public LibvirtXmlDocument( InputSource xml, Source rngSchema ) + throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException + { + this.createXmlContext( rngSchema ); + this.fromXml( xml ); + this.validateXml(); + } + + /** + * Returns the XML root node of the Libvirt XML document. + * + * @return root node of the Libvirt XML document. + */ + public LibvirtXmlNode getRootXmlNode() + { + return this.rootXmlNode; + } + + @Override + public void fromXml( String xml ) throws LibvirtXmlSerializationException + { + try { + this.xmlDocument = this.domBuilder.parse( xml ); + this.xmlDocument.getDocumentElement().normalize(); + } catch ( SAXException e ) { + e.printStackTrace(); + } catch ( IOException e ) { + e.printStackTrace(); + } + + this.rootXmlNode = new LibvirtXmlNode( this.xmlDocument, this.xmlDocument.getDocumentElement() ); + } + + @Override + public void fromXml( File xml ) throws LibvirtXmlSerializationException + { + try { + this.xmlDocument = this.domBuilder.parse( xml ); + this.xmlDocument.getDocumentElement().normalize(); + } catch ( SAXException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } catch ( IOException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } + + this.rootXmlNode = new LibvirtXmlNode( this.xmlDocument, this.xmlDocument.getDocumentElement() ); + } + + @Override + public void fromXml( InputStream xml ) throws LibvirtXmlSerializationException + { + try { + this.xmlDocument = this.domBuilder.parse( xml ); + this.xmlDocument.getDocumentElement().normalize(); + } catch ( SAXException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } catch ( IOException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } + + this.rootXmlNode = new LibvirtXmlNode( this.xmlDocument, this.xmlDocument.getDocumentElement() ); + } + + @Override + public void fromXml( InputSource xml ) throws LibvirtXmlSerializationException + { + try { + this.xmlDocument = this.domBuilder.parse( xml ); + this.xmlDocument.getDocumentElement().normalize(); + } catch ( SAXException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } catch ( IOException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } + + this.rootXmlNode = new LibvirtXmlNode( this.xmlDocument, this.xmlDocument.getDocumentElement() ); + } + + @Override + @SuppressWarnings( "deprecation" ) + public String toXml() throws LibvirtXmlSerializationException + { + StringWriter xmlWriter = null; + String xml = null; + + try { + xmlWriter = new StringWriter(); + DOMSource source = new DOMSource( this.xmlDocument ); + StreamResult xmlString = new StreamResult( xmlWriter ); + this.xmlTransformer.transform( source, xmlString ); + xml = xmlWriter.toString() + System.lineSeparator(); + xmlWriter.close(); + } catch ( TransformerException | IOException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } finally { + IOUtils.closeQuietly( xmlWriter ); + } + + return xml; + } + + @Override + @SuppressWarnings( "deprecation" ) + public void toXml( File xml ) throws LibvirtXmlSerializationException + { + FileWriter xmlWriter = null; + + try { + xmlWriter = new FileWriter( xml ); + DOMSource source = new DOMSource( this.xmlDocument ); + StreamResult xmlStream = new StreamResult( xmlWriter ); + this.xmlTransformer.transform( source, xmlStream ); + xmlWriter.append( System.lineSeparator() ); + xmlWriter.close(); + } catch ( TransformerException | IOException e ) { + throw new LibvirtXmlSerializationException( e.getLocalizedMessage() ); + } finally { + IOUtils.closeQuietly( xmlWriter ); + } + } + + @Override + public void validateXml() throws LibvirtXmlValidationException + { + if ( this.rngValidator != null ) { + this.rngValidator.validate( this.xmlDocument ); + } + } + + @Override + public String toString() + { + try { + return this.toXml(); + } catch ( LibvirtXmlSerializationException e ) { + return null; + } + } +} -- cgit v1.2.3-55-g7522 From 4317a82d74d8b8518a5dbb6b3675aec3f912802e Mon Sep 17 00:00:00 2001 From: Manuel Bentele Date: Sat, 30 Jan 2021 12:00:35 +0100 Subject: Add automatic RelaxNG schema validation for Libvirt domain XML documents --- src/main/java/org/openslx/libvirt/domain/Domain.java | 9 +++++---- src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java | 11 +++++------ .../org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java | 7 +++---- .../java/org/openslx/libvirt/xml/LibvirtXmlDocumentTest.java | 10 ++++------ 4 files changed, 17 insertions(+), 20 deletions(-) (limited to 'src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java') diff --git a/src/main/java/org/openslx/libvirt/domain/Domain.java b/src/main/java/org/openslx/libvirt/domain/Domain.java index 35cd012..4e15ec1 100644 --- a/src/main/java/org/openslx/libvirt/domain/Domain.java +++ b/src/main/java/org/openslx/libvirt/domain/Domain.java @@ -33,6 +33,7 @@ import org.openslx.libvirt.domain.device.Video; import org.openslx.libvirt.xml.LibvirtXmlDocument; import org.openslx.libvirt.xml.LibvirtXmlDocumentException; import org.openslx.libvirt.xml.LibvirtXmlNode; +import org.openslx.libvirt.xml.LibvirtXmlResources; import org.openslx.libvirt.xml.LibvirtXmlSerializationException; import org.openslx.libvirt.xml.LibvirtXmlValidationException; import org.w3c.dom.Node; @@ -61,7 +62,7 @@ public class Domain extends LibvirtXmlDocument public Domain( String xml ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { - super( xml ); + super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) ); } /** @@ -76,7 +77,7 @@ public class Domain extends LibvirtXmlDocument public Domain( File xml ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { - super( xml ); + super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) ); } /** @@ -92,7 +93,7 @@ public class Domain extends LibvirtXmlDocument public Domain( InputStream xml ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { - super( xml ); + super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) ); } /** @@ -108,7 +109,7 @@ public class Domain extends LibvirtXmlDocument public Domain( InputSource xml ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { - super( xml ); + super( xml, LibvirtXmlResources.getLibvirtRng( "domain.rng" ) ); } /** diff --git a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java index abab162..8fe642b 100644 --- a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java +++ b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlDocument.java @@ -9,7 +9,6 @@ import java.io.StringWriter; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; -import javax.xml.transform.Source; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerConfigurationException; import javax.xml.transform.TransformerException; @@ -66,7 +65,7 @@ public abstract class LibvirtXmlDocument implements LibvirtXmlSerializable, Libv * @throws LibvirtXmlDocumentException error occured during setup of the XML context to read and * write from/to a Libvirt XML file. */ - private void createXmlContext( Source rngSchema ) throws LibvirtXmlDocumentException + private void createXmlContext( InputStream rngSchema ) throws LibvirtXmlDocumentException { // used for XML input try { @@ -134,7 +133,7 @@ public abstract class LibvirtXmlDocument implements LibvirtXmlSerializable, Libv * @throws LibvirtXmlSerializationException serialization of the XML content failed. * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. */ - public LibvirtXmlDocument( String xml, Source rngSchema ) + public LibvirtXmlDocument( String xml, InputStream rngSchema ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { this.createXmlContext( rngSchema ); @@ -167,7 +166,7 @@ public abstract class LibvirtXmlDocument implements LibvirtXmlSerializable, Libv * @throws LibvirtXmlSerializationException serialization of the XML content failed. * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. */ - public LibvirtXmlDocument( File xml, Source rngSchema ) + public LibvirtXmlDocument( File xml, InputStream rngSchema ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { this.createXmlContext( rngSchema ); @@ -200,7 +199,7 @@ public abstract class LibvirtXmlDocument implements LibvirtXmlSerializable, Libv * @throws LibvirtXmlSerializationException serialization of the XML content failed. * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. */ - public LibvirtXmlDocument( InputStream xml, Source rngSchema ) + public LibvirtXmlDocument( InputStream xml, InputStream rngSchema ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { this.createXmlContext( rngSchema ); @@ -233,7 +232,7 @@ public abstract class LibvirtXmlDocument implements LibvirtXmlSerializable, Libv * @throws LibvirtXmlSerializationException serialization of the XML content failed. * @throws LibvirtXmlValidationException XML content is not a valid Libvirt XML. */ - public LibvirtXmlDocument( InputSource xml, Source rngSchema ) + public LibvirtXmlDocument( InputSource xml, InputStream rngSchema ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { this.createXmlContext( rngSchema ); diff --git a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java index 01e8adb..e074948 100644 --- a/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java +++ b/src/main/java/org/openslx/libvirt/xml/LibvirtXmlSchemaValidator.java @@ -8,7 +8,6 @@ import java.io.InputStream; import java.io.Reader; import javax.xml.XMLConstants; -import javax.xml.transform.Source; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerException; import javax.xml.transform.TransformerFactory; @@ -200,7 +199,7 @@ public class LibvirtXmlSchemaValidator * @param rngSchema * @throws SAXException */ - public LibvirtXmlSchemaValidator( Source rngSchema ) throws SAXException + public LibvirtXmlSchemaValidator( InputStream rngSchema ) throws SAXException { this.createValidationContext( rngSchema ); } @@ -212,7 +211,7 @@ public class LibvirtXmlSchemaValidator * * @throws SAXException Loading, creation and processing of rngSchema has failed. */ - private void createValidationContext( Source rngSchema ) throws SAXException + private void createValidationContext( InputStream rngSchema ) throws SAXException { // use hack to load specific schema factory implementation for RelaxNG schemas System.setProperty( SchemaFactory.class.getName() + ":" + XMLConstants.RELAXNG_NS_URI, @@ -224,7 +223,7 @@ public class LibvirtXmlSchemaValidator // create schema factory to be able to create a RelaxNG schema validator SchemaFactory factory = SchemaFactory.newInstance( XMLConstants.RELAXNG_NS_URI ); factory.setResourceResolver( schemaResolver ); - Schema schema = factory.newSchema( rngSchema ); + Schema schema = factory.newSchema( new StreamSource( rngSchema ) ); // create the RelaxNG schema validator this.rngSchemaValidator = schema.newValidator(); diff --git a/src/test/java/org/openslx/libvirt/xml/LibvirtXmlDocumentTest.java b/src/test/java/org/openslx/libvirt/xml/LibvirtXmlDocumentTest.java index 1b6e5a5..75b934e 100644 --- a/src/test/java/org/openslx/libvirt/xml/LibvirtXmlDocumentTest.java +++ b/src/test/java/org/openslx/libvirt/xml/LibvirtXmlDocumentTest.java @@ -9,11 +9,9 @@ import static org.junit.jupiter.api.Assertions.fail; import java.io.File; import java.io.IOException; +import java.io.InputStream; import java.nio.charset.StandardCharsets; -import javax.xml.transform.Source; -import javax.xml.transform.stream.StreamSource; - import org.apache.commons.io.FileUtils; import org.apache.log4j.Level; import org.apache.log4j.LogManager; @@ -30,7 +28,7 @@ class LibvirtXmlDocumentStub extends LibvirtXmlDocument super( xml ); } - public LibvirtXmlDocumentStub( File xml, Source rngSchema ) + public LibvirtXmlDocumentStub( File xml, InputStream rngSchema ) throws LibvirtXmlDocumentException, LibvirtXmlSerializationException, LibvirtXmlValidationException { super( xml, rngSchema ); @@ -70,8 +68,8 @@ public class LibvirtXmlDocumentTest try { File xmlFile = LibvirtXmlTestResources.getLibvirtXmlFile( xmlFileName ); - Source rngSchemaSource = new StreamSource( LibvirtXmlResources.getLibvirtRng( rngSchemaFileName ) ); - document = new LibvirtXmlDocumentStub( xmlFile, rngSchemaSource ); + InputStream rngSchema = LibvirtXmlResources.getLibvirtRng( rngSchemaFileName ); + document = new LibvirtXmlDocumentStub( xmlFile, rngSchema ); } catch ( LibvirtXmlDocumentException | LibvirtXmlSerializationException e ) { String errorMsg = new String( "Cannot prepare requested Libvirt XML file from the resources folder" ); fail( errorMsg ); -- cgit v1.2.3-55-g7522