diff options
author | Manuel Bentele | 2021-05-14 14:39:33 +0200 |
---|---|---|
committer | Manuel Bentele | 2021-05-14 14:39:33 +0200 |
commit | 4ee74c1bdcd21ad6f0152c5806a3eca0f0700b69 (patch) | |
tree | 966ad53135c02ee4f27429cec96e7026750f80e3 /core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/configuration/TransformationSpecificQemuSerialDevices.java | |
parent | [qemu] Rename VmMetaData classes (diff) | |
download | mltk-4ee74c1bdcd21ad6f0152c5806a3eca0f0700b69.tar.gz mltk-4ee74c1bdcd21ad6f0152c5806a3eca0f0700b69.tar.xz mltk-4ee74c1bdcd21ad6f0152c5806a3eca0f0700b69.zip |
[qemu] Document configuration transformations and Libvirt QEMU hypervisor
Diffstat (limited to 'core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/configuration/TransformationSpecificQemuSerialDevices.java')
-rw-r--r-- | core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/configuration/TransformationSpecificQemuSerialDevices.java | 58 |
1 files changed, 53 insertions, 5 deletions
diff --git a/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/configuration/TransformationSpecificQemuSerialDevices.java b/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/configuration/TransformationSpecificQemuSerialDevices.java index 5c4509d7..1cd3c9b0 100644 --- a/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/configuration/TransformationSpecificQemuSerialDevices.java +++ b/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/plugin/qemu/configuration/TransformationSpecificQemuSerialDevices.java @@ -13,15 +13,51 @@ import org.openslx.virtualization.configuration.VirtualizationConfigurationQemuU import org.openslx.virtualization.configuration.transformation.TransformationException; import org.openslx.virtualization.configuration.transformation.TransformationSpecific; -public class TransformationSpecificQemuSerialDevices extends TransformationSpecific<Domain, CommandLineArgs, LibvirtHypervisorQemu> +/** + * Specific serial device transformation for Libvirt/QEMU virtualization configurations. + * + * @author Manuel Bentele + * @version 1.0 + */ +public class TransformationSpecificQemuSerialDevices + extends TransformationSpecific<Domain, CommandLineArgs, LibvirtHypervisorQemu> { - private static final String FILTER_NAME = "Serial devices"; + /** + * Name of the configuration transformation. + */ + private static final String NAME = "Serial devices"; + /** + * Creates a new serial device transformation for Libvirt/QEMU virtualization configurations. + * + * @param hypervisor Libvirt/QEMU hypervisor. + */ public TransformationSpecificQemuSerialDevices( LibvirtHypervisorQemu hypervisor ) { - super( TransformationSpecificQemuSerialDevices.FILTER_NAME, hypervisor ); + super( TransformationSpecificQemuSerialDevices.NAME, hypervisor ); } + /** + * Validates a virtualization configuration and input arguments for this transformation. + * + * @param config virtualization configuration for the validation. + * @param args input arguments for the validation. + * @throws TransformationException validation has failed. + */ + private void validateInputs( Domain config, CommandLineArgs args ) throws TransformationException + { + if ( config == null || args == null ) { + throw new TransformationException( "Virtualization configuration or input arguments are missing!" ); + } + } + + /** + * Returns all serial devices from a virtualization configuration that link to a host system's + * serial device. + * + * @param config virtualization configuration. + * @return all serial devices that link to a host system's serial device. + */ private ArrayList<Serial> getSerialDevDevices( Domain config ) { final ArrayList<Serial> devices = config.getSerialDevices(); @@ -30,7 +66,15 @@ public class TransformationSpecificQemuSerialDevices extends TransformationSpeci return devices.stream().filter( byDeviceTypeDev ).collect( Collectors.toCollection( ArrayList::new ) ); } - private void filterSerialDevice( Domain config, String fileName, int index ) throws TransformationException + /** + * Transforms a serial device in a virtualization configuration selected by its {@code index}. + * + * @param config virtualization configuration for the transformation. + * @param fileName path to the serial device file on the host system. + * @param index number of the serial device in the virtualization configuration that is selected. + * @throws TransformationException transformation has failed. + */ + private void transformSerialDevice( Domain config, String fileName, int index ) throws TransformationException { final ArrayList<Serial> devices = this.getSerialDevDevices( config ); final Serial device = VirtualizationConfigurationQemuUtils.getArrayIndex( devices, index ); @@ -58,7 +102,11 @@ public class TransformationSpecificQemuSerialDevices extends TransformationSpeci @Override public void transform( Domain config, CommandLineArgs args ) throws TransformationException { - this.filterSerialDevice( config, args.getVmDeviceSerial0(), 0 ); + // validate configuration and input arguments + this.validateInputs( config, args ); + + // alter serial device + this.transformSerialDevice( config, args.getVmDeviceSerial0(), 0 ); // remove all additional serial devices final ArrayList<Serial> devices = this.getSerialDevDevices( config ); |