Add parallel and serial devices to Libvirt domain XML documents

5 files changed, 389 insertions, 1 deletions

diff --git a/src/main/java/org/openslx/libvirt/domain/Domain.java b/src/main/java/org/openslx/libvirt/domain/Domain.java
index ca3df77..e399340 100644
--- a/src/main/java/org/openslx/libvirt/domain/Domain.java
+++ b/src/main/java/org/openslx/libvirt/domain/Domain.java
@@ -28,6 +28,8 @@ import org.openslx.libvirt.domain.device.Hostdev;
 import org.openslx.libvirt.domain.device.Interface;
 import org.openslx.libvirt.domain.device.InterfaceBridge;
 import org.openslx.libvirt.domain.device.InterfaceNetwork;
+import org.openslx.libvirt.domain.device.Parallel;
+import org.openslx.libvirt.domain.device.Serial;
 import org.openslx.libvirt.domain.device.Sound;
 import org.openslx.libvirt.domain.device.Video;
 import org.openslx.libvirt.xml.LibvirtXmlDocument;
@@ -854,6 +856,28 @@ public class Domain extends LibvirtXmlDocument
 	}
 
 	/**
+	 * Returns list of virtual machine parallel port devices specified in the Libvirt domain XML
+	 * document.
+	 * 
+	 * @return list of virtual machine parallel port devices.
+	 */
+	public ArrayList<Parallel> getParallelDevices()
+	{
+		return Domain.filterDevices( Parallel.class, this.getDevices() );
+	}
+
+	/**
+	 * Returns list of virtual machine serial port devices specified in the Libvirt domain XML
+	 * document.
+	 * 
+	 * @return list of virtual machine serial port devices.
+	 */
+	public ArrayList<Serial> getSerialDevices()
+	{
+		return Domain.filterDevices( Serial.class, this.getDevices() );
+	}
+
+	/**
 	 * Returns list of virtual machine sound devices specified in the Libvirt domain XML document.
 	 * 
 	 * @return list of virtual machine sound devices.
@@ -1087,6 +1111,26 @@ public class Domain extends LibvirtXmlDocument
 	}
 
 	/**
+	 * Adds a virtual machine parallel port device to the Libvirt domain XML document.
+	 *
+	 * @return reference to the added parallel port device if creation was successful.
+	 */
+	public Parallel addParallelDevice()
+	{
+		return Parallel.class.cast( this.addDevice( new Parallel() ) );
+	}
+
+	/**
+	 * Adds a virtual machine serial port device to the Libvirt domain XML document.
+	 *
+	 * @return reference to the added serial port device if creation was successful.
+	 */
+	public Serial addSerialDevice()
+	{
+		return Serial.class.cast( this.addDevice( new Serial() ) );
+	}
+
+	/**
 	 * Adds a virtual machine sound device to the Libvirt domain XML document.
 	 *
 	 * @return reference to the added sound device if creation was successful.
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Device.java b/src/main/java/org/openslx/libvirt/domain/device/Device.java
index 5c26c55..b7403cd 100644
--- a/src/main/java/org/openslx/libvirt/domain/device/Device.java
+++ b/src/main/java/org/openslx/libvirt/domain/device/Device.java
@@ -86,6 +86,12 @@ public class Device extends LibvirtXmlNode
 		} else if ( device instanceof Graphics ) {
 			LibvirtXmlNode xmlNode = Device.createDeviceElement( xmlParentNode, Type.GRAPHICS );
 			createdDevice = Graphics.createInstance( Graphics.class.cast( device ), xmlNode );
+		} else if ( device instanceof Parallel ) {
+			LibvirtXmlNode xmlNode = Device.createDeviceElement( xmlParentNode, Type.PARALLEL );
+			createdDevice = Parallel.createInstance( xmlNode );
+		} else if ( device instanceof Serial ) {
+			LibvirtXmlNode xmlNode = Device.createDeviceElement( xmlParentNode, Type.SERIAL );
+			createdDevice = Serial.createInstance( xmlNode );
 		} else if ( device instanceof Sound ) {
 			LibvirtXmlNode xmlNode = Device.createDeviceElement( xmlParentNode, Type.SOUND );
 			createdDevice = Sound.createInstance( xmlNode );
@@ -134,6 +140,12 @@ public class Device extends LibvirtXmlNode
 			case GRAPHICS:
 				device = Graphics.newInstance( xmlNode );
 				break;
+			case PARALLEL:
+				device = Parallel.newInstance( xmlNode );
+				break;
+			case SERIAL:
+				device = Serial.newInstance( xmlNode );
+				break;
 			case SOUND:
 				device = Sound.newInstance( xmlNode );
 				break;
@@ -160,6 +172,8 @@ public class Device extends LibvirtXmlNode
 		HOSTDEV   ( "hostdev" ),
 		INTERFACE ( "interface" ),
 		GRAPHICS  ( "graphics" ),
+		PARALLEL  ( "parallel" ),
+		SERIAL    ( "serial" ),
 		SOUND     ( "sound" ),
 		VIDEO     ( "video" );
 		// @formatter:on
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Parallel.java b/src/main/java/org/openslx/libvirt/domain/device/Parallel.java
new file mode 100644
index 0000000..7db60ca
--- /dev/null
+++ b/src/main/java/org/openslx/libvirt/domain/device/Parallel.java
@@ -0,0 +1,158 @@
+package org.openslx.libvirt.domain.device;
+
+import org.openslx.libvirt.xml.LibvirtXmlNode;
+
+/**
+ * A parallel port device node in a Libvirt domain XML document.
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
+public class Parallel extends Device
+{
+	/**
+	 * Creates an empty parallel port device.
+	 */
+	public Parallel()
+	{
+		super();
+	}
+
+	/**
+	 * Creates a parallel port device representing an existing Libvirt XML parallel port device
+	 * element.
+	 * 
+	 * @param xmlNode existing Libvirt XML parallel port device element.
+	 */
+	public Parallel( LibvirtXmlNode xmlNode )
+	{
+		super( xmlNode );
+	}
+
+	/**
+	 * Returns the type of the parallel port device.
+	 * 
+	 * @return type of the parallel port device.
+	 */
+	public Type getType()
+	{
+		final String type = this.getXmlElementAttributeValue( "type" );
+		return Type.fromString( type );
+	}
+
+	/**
+	 * Sets the type for the parallel port device.
+	 * 
+	 * @param type type for the parallel port device.
+	 */
+	public void setType( Type type )
+	{
+		this.setXmlElementAttributeValue( "type", type.toString() );
+	}
+
+	/**
+	 * Returns the source of the parallel port device.
+	 * 
+	 * @return source of the parallel port device.
+	 */
+	public String getSource()
+	{
+		return this.getXmlElementAttributeValue( "source", "path" );
+	}
+
+	/**
+	 * Sets the source for the parallel port device.
+	 * 
+	 * @param source source for the parallel port device.
+	 */
+	public void setSource( String source )
+	{
+		this.setXmlElementAttributeValue( "source", "path", source );
+	}
+
+	/**
+	 * Creates a non-existent parallel port device as Libvirt XML parallel port device element.
+	 * 
+	 * @param xmlNode Libvirt XML node of the Libvirt XML parallel port device that is created.
+	 * @return created parallel port device instance.
+	 */
+	public static Parallel createInstance( LibvirtXmlNode xmlNode )
+	{
+		return Parallel.newInstance( xmlNode );
+	}
+
+	/**
+	 * Creates a parallel port device representing an existing Libvirt XML parallel port device
+	 * element.
+	 * 
+	 * @param xmlNode existing Libvirt XML parallel port device element.
+	 * @return parallel port device instance.
+	 */
+	public static Parallel newInstance( LibvirtXmlNode xmlNode )
+	{
+		return new Parallel( xmlNode );
+	}
+
+	/**
+	 * Type of parallel port device.
+	 * 
+	 * @author Manuel Bentele
+	 * @version 1.0
+	 */
+	public enum Type
+	{
+		// @formatter:off
+		DEV      ( "dev" ),
+		FILE     ( "file" ),
+		PIPE     ( "pipe" ),
+		UNIX     ( "unix" ),
+		TCP      ( "tcp" ),
+		UDP      ( "udp" ),
+		NULL     ( "null" ),
+		STDIO    ( "stdio" ),
+		VC       ( "vc" ),
+		PTY      ( "pty" ),
+		SPICEVMC ( "spicevmc" ),
+		SPICEPORT( "spiceport" ),
+		NMDM     ( "nmdm" );
+		// @formatter:on
+
+		/**
+		 * Name of the parallel port device type.
+		 */
+		private String type;
+
+		/**
+		 * Creates parallel port device type.
+		 * 
+		 * @param type valid name of the parallel port device type in a Libvirt domain XML document.
+		 */
+		Type( String type )
+		{
+			this.type = type;
+		}
+
+		@Override
+		public String toString()
+		{
+			return this.type;
+		}
+
+		/**
+		 * Creates parallel port device type from its name with error check.
+		 * 
+		 * @param type name of the parallel port device type in a Libvirt domain XML document.
+		 * @return valid parallel port device type.
+		 */
+		public static Type fromString( String type )
+		{
+			for ( Type t : Type.values() ) {
+				if ( t.type.equalsIgnoreCase( type ) ) {
+					return t;
+				}
+			}
+
+			return null;
+		}
+	}
+}
diff --git a/src/main/java/org/openslx/libvirt/domain/device/Serial.java b/src/main/java/org/openslx/libvirt/domain/device/Serial.java
new file mode 100644
index 0000000..54be26e
--- /dev/null
+++ b/src/main/java/org/openslx/libvirt/domain/device/Serial.java
@@ -0,0 +1,156 @@
+package org.openslx.libvirt.domain.device;
+
+import org.openslx.libvirt.xml.LibvirtXmlNode;
+
+/**
+ * A serial port device node in a Libvirt domain XML document.
+ * 
+ * @author Manuel Bentele
+ * @version 1.0
+ */
+public class Serial extends Device
+{
+	/**
+	 * Creates an empty serial port device.
+	 */
+	public Serial()
+	{
+		super();
+	}
+
+	/**
+	 * Creates a serial port device representing an existing Libvirt XML serial port device element.
+	 * 
+	 * @param xmlNode existing Libvirt XML serial port device element.
+	 */
+	public Serial( LibvirtXmlNode xmlNode )
+	{
+		super( xmlNode );
+	}
+
+	/**
+	 * Returns the type of the serial port device.
+	 * 
+	 * @return type of the serial port device.
+	 */
+	public Type getType()
+	{
+		final String type = this.getXmlElementAttributeValue( "type" );
+		return Type.fromString( type );
+	}
+
+	/**
+	 * Sets the type for the serial port device.
+	 * 
+	 * @param type type for the serial port device.
+	 */
+	public void setType( Type type )
+	{
+		this.setXmlElementAttributeValue( "type", type.toString() );
+	}
+
+	/**
+	 * Returns the source of the serial port device.
+	 * 
+	 * @return source of the serial port device.
+	 */
+	public String getSource()
+	{
+		return this.getXmlElementAttributeValue( "source", "path" );
+	}
+
+	/**
+	 * Sets the source for the serial port device.
+	 * 
+	 * @param source source for the serial port device.
+	 */
+	public void setSource( String source )
+	{
+		this.setXmlElementAttributeValue( "source", "path", source );
+	}
+
+	/**
+	 * Creates a non-existent serial port device as Libvirt XML serial port device element.
+	 * 
+	 * @param xmlNode Libvirt XML node of the Libvirt XML serial port device that is created.
+	 * @return created serial port device instance.
+	 */
+	public static Serial createInstance( LibvirtXmlNode xmlNode )
+	{
+		return Serial.newInstance( xmlNode );
+	}
+
+	/**
+	 * Creates a serial port device representing an existing Libvirt XML serial port device element.
+	 * 
+	 * @param xmlNode existing Libvirt XML serial port device element.
+	 * @return serial port device instance.
+	 */
+	public static Serial newInstance( LibvirtXmlNode xmlNode )
+	{
+		return new Serial( xmlNode );
+	}
+
+	/**
+	 * Type of serial port device.
+	 * 
+	 * @author Manuel Bentele
+	 * @version 1.0
+	 */
+	public enum Type
+	{
+		// @formatter:off
+		DEV      ( "dev" ),
+		FILE     ( "file" ),
+		PIPE     ( "pipe" ),
+		UNIX     ( "unix" ),
+		TCP      ( "tcp" ),
+		UDP      ( "udp" ),
+		NULL     ( "null" ),
+		STDIO    ( "stdio" ),
+		VC       ( "vc" ),
+		PTY      ( "pty" ),
+		SPICEVMC ( "spicevmc" ),
+		SPICEPORT( "spiceport" ),
+		NMDM     ( "nmdm" );
+		// @formatter:on
+
+		/**
+		 * Name of the serial port device type.
+		 */
+		private String type;
+
+		/**
+		 * Creates serial port device type.
+		 * 
+		 * @param type valid name of the serial port device type in a Libvirt domain XML document.
+		 */
+		Type( String type )
+		{
+			this.type = type;
+		}
+
+		@Override
+		public String toString()
+		{
+			return this.type;
+		}
+
+		/**
+		 * Creates serial port device type from its name with error check.
+		 * 
+		 * @param type name of the serial port device type in a Libvirt domain XML document.
+		 * @return valid serial port device type.
+		 */
+		public static Type fromString( String type )
+		{
+			for ( Type t : Type.values() ) {
+				if ( t.type.equalsIgnoreCase( type ) ) {
+					return t;
+				}
+			}
+
+			return null;
+		}
+	}
+}
diff --git a/src/test/java/org/openslx/libvirt/domain/DomainTest.java b/src/test/java/org/openslx/libvirt/domain/DomainTest.java
index 1712b68..b4e0187 100644
--- a/src/test/java/org/openslx/libvirt/domain/DomainTest.java
+++ b/src/test/java/org/openslx/libvirt/domain/DomainTest.java
@@ -302,7 +302,7 @@ public class DomainTest
 	public void testGetDevices()
 	{
 		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm.xml" );
-		assertEquals( 21, vm.getDevices().size() );
+		assertEquals( 22, vm.getDevices().size() );
 	}
 
 	@Test
@@ -346,6 +346,22 @@ public class DomainTest
 	}
 
 	@Test
+	@DisplayName( "Get all VM parallel port devices from libvirt XML file" )
+	public void testGetParallelDevices()
+	{
+		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm.xml" );
+		assertEquals( 0, vm.getParallelDevices().size() );
+	}
+
+	@Test
+	@DisplayName( "Get all VM serial port devices from libvirt XML file" )
+	public void testGetSerialDevices()
+	{
+		Domain vm = this.newDomainInstance( "qemu-kvm_default-ubuntu-20-04-vm.xml" );
+		assertEquals( 1, vm.getSerialDevices().size() );
+	}
+
+	@Test
 	@DisplayName( "Get all VM sound devices from libvirt XML file" )
 	public void testGetSoundDevices()
 	{