summaryrefslogtreecommitdiffstats
path: root/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/virtualization/LibvirtVirtualMachine.java
diff options
context:
space:
mode:
Diffstat (limited to 'core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/virtualization/LibvirtVirtualMachine.java')
-rw-r--r--core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/virtualization/LibvirtVirtualMachine.java50
1 files changed, 50 insertions, 0 deletions
diff --git a/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/virtualization/LibvirtVirtualMachine.java b/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/virtualization/LibvirtVirtualMachine.java
index 781bd938..32b99d66 100644
--- a/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/virtualization/LibvirtVirtualMachine.java
+++ b/core/modules/qemu/runvirt-plugin-qemu/src/main/java/org/openslx/runvirt/virtualization/LibvirtVirtualMachine.java
@@ -3,20 +3,45 @@ package org.openslx.runvirt.virtualization;
import org.libvirt.Domain;
import org.libvirt.LibvirtException;
+/**
+ * Representation of a Libvirt virtual machine.
+ *
+ * @author Manuel Bentele
+ * @version 1.0
+ */
public class LibvirtVirtualMachine
{
+ /**
+ * Libvirt virtualization configuration of the virtual machine.
+ */
private Domain domain;
+ /**
+ * Creates a new Libvirt virtual machine specified by a virtualization configuration.
+ *
+ * @param vm Libvirt virtualization configuration to specify the Libvirt virtual machine.
+ */
LibvirtVirtualMachine( Domain vm )
{
this.domain = vm;
}
+ /**
+ * Returns the Libvirt virtualization configuration of the Libvirt virtual machine.
+ *
+ * @return Libvirt virtualization configuration of the Libvirt virtual machine.
+ */
public Domain getLibvirtDomain()
{
return this.domain;
}
+ /**
+ * Checks if the Libvirt virtual machine is running.
+ *
+ * @return state of the Libvirt virtual machine whether it is running or not.
+ * @throws LibvirtVirtualMachineException failed to check if Libvirt machine is running or not.
+ */
public boolean isRunning() throws LibvirtVirtualMachineException
{
int state = 0;
@@ -30,6 +55,11 @@ public class LibvirtVirtualMachine
return ( state == 0 ) ? false : true;
}
+ /**
+ * Starts the Libvirt virtual machine.
+ *
+ * @throws LibvirtVirtualMachineException failed to start the Libvirt virtual machine.
+ */
public void start() throws LibvirtVirtualMachineException
{
if ( !this.isRunning() ) {
@@ -41,6 +71,11 @@ public class LibvirtVirtualMachine
}
}
+ /**
+ * Stops the Libvirt virtual machine.
+ *
+ * @throws LibvirtVirtualMachineException failed to stop the Libvirt virtual machine.
+ */
public void stop() throws LibvirtVirtualMachineException
{
if ( this.isRunning() ) {
@@ -52,6 +87,11 @@ public class LibvirtVirtualMachine
}
}
+ /**
+ * Suspends the Libvirt virtual machine.
+ *
+ * @throws LibvirtVirtualMachineException failed to suspend the Libvirt virtual machine.
+ */
public void suspend() throws LibvirtVirtualMachineException
{
try {
@@ -61,6 +101,11 @@ public class LibvirtVirtualMachine
}
}
+ /**
+ * Resumes the Libvirt virtual machine.
+ *
+ * @throws LibvirtVirtualMachineException faild to resume the Libvirt virtual machine.
+ */
public void resume() throws LibvirtVirtualMachineException
{
try {
@@ -70,6 +115,11 @@ public class LibvirtVirtualMachine
}
}
+ /**
+ * Reboot the Libvirt virtual machine.
+ *
+ * @throws LibvirtVirtualMachineException failed to reboot the Libvirt virtual machine.
+ */
public void reboot() throws LibvirtVirtualMachineException
{
try {