Hi, On Thu, Feb 13, 2014 at 04:22:09PM +0100, Claudio Bley wrote: ACK (from a non Java expert). -- Guido

On Thu, Feb 13, 2014 at 04:22:10PM +0100, Claudio Bley wrote: ACK (from a non Java expert). -- Guido

On Thu, Feb 13, 2014 at 04:22:11PM +0100, Claudio Bley wrote: ACK (from a non Java expert). -- Guido

Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/test/java/org/libvirt/TestJavaBindings.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/test/java/org/libvirt/TestJavaBindings.java b/src/test/java/org/libvirt/TestJavaBindings.java index 9e7fa82..a25c4f3 100644 --- a/src/test/java/org/libvirt/TestJavaBindings.java +++ b/src/test/java/org/libvirt/TestJavaBindings.java @@ -27,6 +27,7 @@ public final class TestJavaBindings extends TestCase { try { conn.domainDefineXML("fail, miserably"); + fail("LibvirtException expected"); } catch (LibvirtException e) {} // ignore assertTrue("Error callback was not called", cb.error); @@ -87,6 +88,7 @@ public final class TestJavaBindings extends TestCase { // this should throw an exception try { network1.create(); + fail("LibvirtException expected"); } catch (LibvirtException e) { // eat it } -- 1.7.9.5

Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Error.java | 397 ++++++++++++++++++++++------------ 1 file changed, 262 insertions(+), 135 deletions(-) diff --git a/src/main/java/org/libvirt/Error.java b/src/main/java/org/libvirt/Error.java index ef339bd..15dd870 100644 --- a/src/main/java/org/libvirt/Error.java +++ b/src/main/java/org/libvirt/Error.java @@ -28,54 +28,104 @@ public class Error implements Serializable { } public static enum ErrorDomain { - VIR_FROM_NONE, VIR_FROM_XEN, /* Error at Xen hypervisor layer */ - VIR_FROM_XEND, /* Error at connection with xend daemon */ - VIR_FROM_XENSTORE, /* Error at connection with xen store */ - VIR_FROM_SEXPR, /* Error in the S-Expression code */ - VIR_FROM_XML, /* Error in the XML code */ - VIR_FROM_DOM, /* Error when operating on a domain */ - VIR_FROM_RPC, /* Error in the XML-RPC code */ - VIR_FROM_PROXY, /* Error in the proxy code */ - VIR_FROM_CONF, /* Error in the configuration file handling */ - VIR_FROM_QEMU, /* Error at the QEMU daemon */ - VIR_FROM_NET, /* Error when operating on a network */ - VIR_FROM_TEST, /* Error from test driver */ - VIR_FROM_REMOTE, /* Error from remote driver */ - VIR_FROM_OPENVZ, /* Error from OpenVZ driver */ - VIR_FROM_XENXM, /* Error at Xen XM layer */ - VIR_FROM_STATS_LINUX, /* Error in the Linux Stats code */ - VIR_FROM_LXC, /* Error from Linux Container driver */ - VIR_FROM_STORAGE, /* Error from storage driver */ - VIR_FROM_NETWORK, /* Error from network config */ - VIR_FROM_DOMAIN, /* Error from domain config */ - VIR_FROM_UML, /* Error at the UML driver */ - VIR_FROM_NODEDEV, /* Error from node device monitor */ - VIR_FROM_XEN_INOTIFY, /* Error from xen inotify layer */ - VIR_FROM_SECURITY, /* Error from security framework */ - VIR_FROM_VBOX, /* Error from VirtualBox driver */ - VIR_FROM_INTERFACE, /* Error when operating on an interface */ - VIR_FROM_ONE, /* Error from OpenNebula driver */ - VIR_FROM_ESX, /* Error from ESX driver */ - VIR_FROM_PHYP, /* Error from IBM power hypervisor */ - VIR_FROM_SECRET, /* Error from secret storage */ - VIR_FROM_CPU, /* Error from CPU driver */ - VIR_FROM_XENAPI, /* Error from XenAPI */ - VIR_FROM_NWFILTER, /* Error from network filter driver */ - VIR_FROM_HOOK, /* Error from Synchronous hooks */ - VIR_FROM_DOMAIN_SNAPSHOT, /* Error from domain snapshot */ - VIR_FROM_AUDIT, /* Error from auditing subsystem */ - VIR_FROM_SYSINFO, /* Error from sysinfo/SMBIOS */ - VIR_FROM_STREAMS, /* Error from I/O streams */ - VIR_FROM_VMWARE, /* Error from VMware driver */ - VIR_FROM_EVENT, /* Error from event loop impl */ - VIR_FROM_LIBXL, /* Error from libxenlight driver */ - VIR_FROM_LOCKING, /* Error from lock manager */ - VIR_FROM_HYPERV, /* Error from Hyper-V driver */ - VIR_FROM_CAPABILITIES, /* Error from capabilities */ - VIR_FROM_URI, /* Error from URI handling */ - VIR_FROM_AUTH, /* Error from auth handling */ - VIR_FROM_DBUS, /* Error from DBus */ - VIR_FROM_UNKNOWN; /* unknown error domain (must be the last entry!) */ + VIR_FROM_NONE, + /** Error at Xen hypervisor layer */ + VIR_FROM_XEN, + /** Error at connection with xend daemon */ + VIR_FROM_XEND, + /** Error at connection with xen store */ + VIR_FROM_XENSTORE, + /** Error in the S-Expression code */ + VIR_FROM_SEXPR, + /** Error in the XML code */ + VIR_FROM_XML, + /** Error when operating on a domain */ + VIR_FROM_DOM, + /** Error in the XML-RPC code */ + VIR_FROM_RPC, + /** Error in the proxy code */ + VIR_FROM_PROXY, + /** Error in the configuration file handling */ + VIR_FROM_CONF, + /** Error at the QEMU daemon */ + VIR_FROM_QEMU, + /** Error when operating on a network */ + VIR_FROM_NET, + /** Error from test driver */ + VIR_FROM_TEST, + /** Error from remote driver */ + VIR_FROM_REMOTE, + /** Error from OpenVZ driver */ + VIR_FROM_OPENVZ, + /** Error at Xen XM layer */ + VIR_FROM_XENXM, + /** Error in the Linux Stats code */ + VIR_FROM_STATS_LINUX, + /** Error from Linux Container driver */ + VIR_FROM_LXC, + /** Error from storage driver */ + VIR_FROM_STORAGE, + /** Error from network config */ + VIR_FROM_NETWORK, + /** Error from domain config */ + VIR_FROM_DOMAIN, + /** Error at the UML driver */ + VIR_FROM_UML, + /** Error from node device monitor */ + VIR_FROM_NODEDEV, + /** Error from xen inotify layer */ + VIR_FROM_XEN_INOTIFY, + /** Error from security framework */ + VIR_FROM_SECURITY, + /** Error from VirtualBox driver */ + VIR_FROM_VBOX, + /** Error when operating on an interface */ + VIR_FROM_INTERFACE, + /** Error from OpenNebula driver */ + VIR_FROM_ONE, + /** Error from ESX driver */ + VIR_FROM_ESX, + /** Error from IBM power hypervisor */ + VIR_FROM_PHYP, + /** Error from secret storage */ + VIR_FROM_SECRET, + /** Error from CPU driver */ + VIR_FROM_CPU, + /** Error from XenAPI */ + VIR_FROM_XENAPI, + /** Error from network filter driver */ + VIR_FROM_NWFILTER, + /** Error from Synchronous hooks */ + VIR_FROM_HOOK, + /** Error from domain snapshot */ + VIR_FROM_DOMAIN_SNAPSHOT, + /** Error from auditing subsystem */ + VIR_FROM_AUDIT, + /** Error from sysinfo/SMBIOS */ + VIR_FROM_SYSINFO, + /** Error from I/O streams */ + VIR_FROM_STREAMS, + /** Error from VMware driver */ + VIR_FROM_VMWARE, + /** Error from event loop impl */ + VIR_FROM_EVENT, + /** Error from libxenlight driver */ + VIR_FROM_LIBXL, + /** Error from lock manager */ + VIR_FROM_LOCKING, + /** Error from Hyper-V driver */ + VIR_FROM_HYPERV, + /** Error from capabilities */ + VIR_FROM_CAPABILITIES, + /** Error from URI handling */ + VIR_FROM_URI, + /** Error from auth handling */ + VIR_FROM_AUTH, + /** Error from DBus */ + VIR_FROM_DBUS, + + /** unknown error domain */ + VIR_FROM_UNKNOWN; // must be the last entry! protected static final ErrorDomain wrap(int value) { return safeElementAt(value, values()); @@ -101,93 +151,170 @@ public class Error implements Serializable { } public static enum ErrorNumber { - VIR_ERR_OK, VIR_ERR_INTERNAL_ERROR, /* internal error */ - VIR_ERR_NO_MEMORY, /* memory allocation failure */ - VIR_ERR_NO_SUPPORT, /* no support for this function */ - VIR_ERR_UNKNOWN_HOST, /* could not resolve hostname */ - VIR_ERR_NO_CONNECT, /* can't connect to hypervisor */ - VIR_ERR_INVALID_CONN, /* invalid connection object */ - VIR_ERR_INVALID_DOMAIN, /* invalid domain object */ - VIR_ERR_INVALID_ARG, /* invalid function argument */ - VIR_ERR_OPERATION_FAILED, /* a command to hypervisor failed */ - VIR_ERR_GET_FAILED, /* a HTTP GET command to failed */ - VIR_ERR_POST_FAILED, /* a HTTP POST command to failed */ - VIR_ERR_HTTP_ERROR, /* unexpected HTTP error code */ - VIR_ERR_SEXPR_SERIAL, /* failure to serialize an S-Expr */ - VIR_ERR_NO_XEN, /* could not open Xen hypervisor control */ - VIR_ERR_XEN_CALL, /* failure doing an hypervisor call */ - VIR_ERR_OS_TYPE, /* unknown OS type */ - VIR_ERR_NO_KERNEL, /* missing kernel information */ - VIR_ERR_NO_ROOT, /* missing root device information */ - VIR_ERR_NO_SOURCE, /* missing source device information */ - VIR_ERR_NO_TARGET, /* missing target device information */ - VIR_ERR_NO_NAME, /* missing domain name information */ - VIR_ERR_NO_OS, /* missing domain OS information */ - VIR_ERR_NO_DEVICE, /* missing domain devices information */ - VIR_ERR_NO_XENSTORE, /* could not open Xen Store control */ - VIR_ERR_DRIVER_FULL, /* too many drivers registered */ - VIR_ERR_CALL_FAILED, /* not supported by the drivers (DEPRECATED) */ - VIR_ERR_XML_ERROR, /* an XML description is not well formed or broken */ - VIR_ERR_DOM_EXIST, /* the domain already exist */ - VIR_ERR_OPERATION_DENIED, /* - * operation forbidden on read-only - * connections - */ - VIR_ERR_OPEN_FAILED, /* failed to open a conf file */ - VIR_ERR_READ_FAILED, /* failed to read a conf file */ - VIR_ERR_PARSE_FAILED, /* failed to parse a conf file */ - VIR_ERR_CONF_SYNTAX, /* failed to parse the syntax of a conf file */ - VIR_ERR_WRITE_FAILED, /* failed to write a conf file */ - VIR_ERR_XML_DETAIL, /* detail of an XML error */ - VIR_ERR_INVALID_NETWORK, /* invalid network object */ - VIR_ERR_NETWORK_EXIST, /* the network already exist */ - VIR_ERR_SYSTEM_ERROR, /* general system call failure */ - VIR_ERR_RPC, /* some sort of RPC error */ - VIR_ERR_GNUTLS_ERROR, /* error from a GNUTLS call */ - VIR_WAR_NO_NETWORK, /* failed to start network */ - VIR_ERR_NO_DOMAIN, /* domain not found or unexpectedly disappeared */ - VIR_ERR_NO_NETWORK, /* network not found */ - VIR_ERR_INVALID_MAC, /* invalid MAC address */ - VIR_ERR_AUTH_FAILED, /* authentication failed */ - VIR_ERR_INVALID_STORAGE_POOL, /* invalid storage pool object */ - VIR_ERR_INVALID_STORAGE_VOL, /* invalid storage vol object */ - VIR_WAR_NO_STORAGE, /* failed to start storage */ - VIR_ERR_NO_STORAGE_POOL, /* storage pool not found */ - VIR_ERR_NO_STORAGE_VOL, /* storage pool not found */ - VIR_WAR_NO_NODE, /* failed to start node driver */ - VIR_ERR_INVALID_NODE_DEVICE, /* invalid node device object */ - VIR_ERR_NO_NODE_DEVICE, /* node device not found */ - VIR_ERR_NO_SECURITY_MODEL, /* security model not found */ - VIR_ERR_OPERATION_INVALID, /* operation is not applicable at this time */ - VIR_WAR_NO_INTERFACE, /* failed to start interface driver */ - VIR_ERR_NO_INTERFACE, /* interface driver not running */ - VIR_ERR_INVALID_INTERFACE, /* invalid interface object */ - VIR_ERR_MULTIPLE_INTERFACES, /* more than one matching interface found */ - VIR_WAR_NO_SECRET, /* failed to start secret storage */ - VIR_ERR_INVALID_SECRET, /* invalid secret */ - VIR_ERR_NO_SECRET, /* secret not found */ - VIR_ERR_CONFIG_UNSUPPORTED, /* unsupported configuration construct */ - VIR_ERR_OPERATION_TIMEOUT, /* timeout occurred during operation */ - VIR_ERR_MIGRATE_PERSIST_FAILED, /* a migration worked, but making the - VM persist on the dest host failed */ - VIR_ERR_HOOK_SCRIPT_FAILED, /* a synchronous hook script failed */ - VIR_ERR_INVALID_DOMAIN_SNAPSHOT, /* invalid domain snapshot */ - VIR_ERR_NO_DOMAIN_SNAPSHOT, /* domain snapshot not found */ - VIR_ERR_INVALID_STREAM, /* stream pointer not valid */ - VIR_ERR_ARGUMENT_UNSUPPORTED, /* valid API use but unsupported by - the given driver */ - VIR_ERR_STORAGE_PROBE_FAILED, /* storage pool probe failed */ - VIR_ERR_STORAGE_POOL_BUILT, /* storage pool already built */ - VIR_ERR_SNAPSHOT_REVERT_RISKY, /* force was not requested for a - risky domain snapshot revert */ - VIR_ERR_OPERATION_ABORTED, /* operation on a domain was - canceled/aborted by user */ - VIR_ERR_AUTH_CANCELLED, /* authentication cancelled */ - VIR_ERR_NO_DOMAIN_METADATA, /* The metadata is not present */ - VIR_ERR_MIGRATE_UNSAFE, /* Migration is not safe */ - VIR_ERR_OVERFLOW, /* integer overflow */ - VIR_ERR_BLOCK_COPY_ACTIVE, /* action prevented by block copy job */ - VIR_ERR_UNKNOWN; /* unknown error (must be the last entry!) */ + VIR_ERR_OK, + /** internal error */ + VIR_ERR_INTERNAL_ERROR, + /** memory allocation failure */ + VIR_ERR_NO_MEMORY, + /** no support for this function */ + VIR_ERR_NO_SUPPORT, + /** could not resolve hostname */ + VIR_ERR_UNKNOWN_HOST, + /** can't connect to hypervisor */ + VIR_ERR_NO_CONNECT, + /** invalid connection object */ + VIR_ERR_INVALID_CONN, + /** invalid domain object */ + VIR_ERR_INVALID_DOMAIN, + /** invalid function argument */ + VIR_ERR_INVALID_ARG, + /** a command to hypervisor failed */ + VIR_ERR_OPERATION_FAILED, + /** a HTTP GET command to failed */ + VIR_ERR_GET_FAILED, + /** a HTTP POST command to failed */ + VIR_ERR_POST_FAILED, + /** unexpected HTTP error code */ + VIR_ERR_HTTP_ERROR, + /** failure to serialize an S-Expr */ + VIR_ERR_SEXPR_SERIAL, + /** could not open Xen hypervisor control */ + VIR_ERR_NO_XEN, + /** failure doing an hypervisor call */ + VIR_ERR_XEN_CALL, + /** unknown OS type */ + VIR_ERR_OS_TYPE, + /** missing kernel information */ + VIR_ERR_NO_KERNEL, + /** missing root device information */ + VIR_ERR_NO_ROOT, + /** missing source device information */ + VIR_ERR_NO_SOURCE, + /** missing target device information */ + VIR_ERR_NO_TARGET, + /** missing domain name information */ + VIR_ERR_NO_NAME, + /** missing domain OS information */ + VIR_ERR_NO_OS, + /** missing domain devices information */ + VIR_ERR_NO_DEVICE, + /** could not open Xen Store control */ + VIR_ERR_NO_XENSTORE, + /** too many drivers registered */ + VIR_ERR_DRIVER_FULL, + /** not supported by the drivers (DEPRECATED) */ + VIR_ERR_CALL_FAILED, + /** an XML description is not well formed or broken */ + VIR_ERR_XML_ERROR, + /** the domain already exist */ + VIR_ERR_DOM_EXIST, + /** operation forbidden on read-only connections */ + VIR_ERR_OPERATION_DENIED, + /** failed to open a conf file */ + VIR_ERR_OPEN_FAILED, + /** failed to read a conf file */ + VIR_ERR_READ_FAILED, + /** failed to parse a conf file */ + VIR_ERR_PARSE_FAILED, + /** failed to parse the syntax of a conf file */ + VIR_ERR_CONF_SYNTAX, + /** failed to write a conf file */ + VIR_ERR_WRITE_FAILED, + /** detail of an XML error */ + VIR_ERR_XML_DETAIL, + /** invalid network object */ + VIR_ERR_INVALID_NETWORK, + /** the network already exist */ + VIR_ERR_NETWORK_EXIST, + /** general system call failure */ + VIR_ERR_SYSTEM_ERROR, + /** some sort of RPC error */ + VIR_ERR_RPC, + /** error from a GNUTLS call */ + VIR_ERR_GNUTLS_ERROR, + /** failed to start network */ + VIR_WAR_NO_NETWORK, + /** domain not found or unexpectedly disappeared */ + VIR_ERR_NO_DOMAIN, + /** network not found */ + VIR_ERR_NO_NETWORK, + /** invalid MAC address */ + VIR_ERR_INVALID_MAC, + /** authentication failed */ + VIR_ERR_AUTH_FAILED, + /** invalid storage pool object */ + VIR_ERR_INVALID_STORAGE_POOL, + /** invalid storage vol object */ + VIR_ERR_INVALID_STORAGE_VOL, + /** failed to start storage */ + VIR_WAR_NO_STORAGE, + /** storage pool not found */ + VIR_ERR_NO_STORAGE_POOL, + /** storage pool not found */ + VIR_ERR_NO_STORAGE_VOL, + /** failed to start node driver */ + VIR_WAR_NO_NODE, + /** invalid node device object */ + VIR_ERR_INVALID_NODE_DEVICE, + /** node device not found */ + VIR_ERR_NO_NODE_DEVICE, + /** security model not found */ + VIR_ERR_NO_SECURITY_MODEL, + /** operation is not applicable at this time */ + VIR_ERR_OPERATION_INVALID, + /** failed to start interface driver */ + VIR_WAR_NO_INTERFACE, + /** interface driver not running */ + VIR_ERR_NO_INTERFACE, + /** invalid interface object */ + VIR_ERR_INVALID_INTERFACE, + /** more than one matching interface found */ + VIR_ERR_MULTIPLE_INTERFACES, + /** failed to start secret storage */ + VIR_WAR_NO_SECRET, + /** invalid secret */ + VIR_ERR_INVALID_SECRET, + /** secret not found */ + VIR_ERR_NO_SECRET, + /** unsupported configuration construct */ + VIR_ERR_CONFIG_UNSUPPORTED, + /** timeout occurred during operation */ + VIR_ERR_OPERATION_TIMEOUT, + /** a migration worked, but making the VM persist on the dest + * host failed */ + VIR_ERR_MIGRATE_PERSIST_FAILED, + /** a synchronous hook script failed */ + VIR_ERR_HOOK_SCRIPT_FAILED, + /** invalid domain snapshot */ + VIR_ERR_INVALID_DOMAIN_SNAPSHOT, + /** domain snapshot not found */ + VIR_ERR_NO_DOMAIN_SNAPSHOT, + /** stream pointer not valid */ + VIR_ERR_INVALID_STREAM, + /** valid API use but unsupported by the given driver */ + VIR_ERR_ARGUMENT_UNSUPPORTED, + /** storage pool probe failed */ + VIR_ERR_STORAGE_PROBE_FAILED, + /** storage pool already built */ + VIR_ERR_STORAGE_POOL_BUILT, + /** force was not requested for a risky domain snapshot + revert */ + VIR_ERR_SNAPSHOT_REVERT_RISKY, + /** operation on a domain was canceled/aborted by user */ + VIR_ERR_OPERATION_ABORTED, + /** authentication cancelled */ + VIR_ERR_AUTH_CANCELLED, + /** The metadata is not present */ + VIR_ERR_NO_DOMAIN_METADATA, + /** Migration is not safe */ + VIR_ERR_MIGRATE_UNSAFE, + /** integer overflow */ + VIR_ERR_OVERFLOW, + /** action prevented by block copy job */ + VIR_ERR_BLOCK_COPY_ACTIVE, + + /** unknown error */ + VIR_ERR_UNKNOWN; // must be the last entry! protected static final ErrorNumber wrap(int value) { return safeElementAt(value, values()); -- 1.7.9.5

Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index b02fd55..28ddc6e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ +*~ +\#*\# .classpath .project .settings -- 1.7.9.5

At Fri, 14 Feb 2014 11:06:12 +0100, Guido Günther wrote: Thank you for your reviews! It's always good to have a second pair of eyes look over... :-) Claudio

On Windows, the libvirt DLL is called libvirt-0.dll. Trying to load the "virt" library hence fails to find the file. Branch on the platform and load "virt-0" if we're running on this OS, use "virt" otherwise. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/jna/Libvirt.java | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index 813f09b..1be7c4f 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -4,6 +4,7 @@ import com.sun.jna.Callback; import com.sun.jna.Library; import com.sun.jna.Native; import com.sun.jna.NativeLong; +import com.sun.jna.Platform; import com.sun.jna.Pointer; import com.sun.jna.ptr.IntByReference; import com.sun.jna.ptr.LongByReference; @@ -96,7 +97,7 @@ public interface Libvirt extends Library { void eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, Pointer opaque) ; } - Libvirt INSTANCE = (Libvirt) Native.loadLibrary("virt", Libvirt.class); + Libvirt INSTANCE = (Libvirt) Native.loadLibrary(Platform.isWindows() ? "virt-0" : "virt", Libvirt.class); // Constants we need public static int VIR_UUID_BUFLEN = 16; -- 1.7.9.5

At Fri, 21 Feb 2014 14:42:26 +0100, Claudio Bley wrote: Pushed.

The libvirt function virNodeDeviceListCaps might return fewer elements than requested. Take this into account and properly decode the UTF-8 strings returned. Additionally, the given strings are freed before returning the resulting string array. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Device.java | 10 +++++++--- src/main/java/org/libvirt/jna/Libvirt.java | 2 +- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/libvirt/Device.java b/src/main/java/org/libvirt/Device.java index fe49ce9..d55321e 100644 --- a/src/main/java/org/libvirt/Device.java +++ b/src/main/java/org/libvirt/Device.java @@ -3,6 +3,8 @@ package org.libvirt; import org.libvirt.jna.DevicePointer; import static org.libvirt.Library.libvirt; +import com.sun.jna.Pointer; + /** * A device which is attached to a node */ @@ -135,13 +137,15 @@ public class Device { */ public String[] listCapabilities() throws LibvirtException { int maxCaps = getNumberOfCapabilities(); - String[] names = new String[maxCaps]; if (maxCaps > 0) { - libvirt.virNodeDeviceListCaps(VDP, names, maxCaps); + Pointer[] ptrs = new Pointer[maxCaps]; + int got = libvirt.virNodeDeviceListCaps(VDP, ptrs, maxCaps); processError(); + return Library.toStringArray(ptrs, got); + } else { + return Library.NO_STRINGS; } - return names; } /** diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index 78dd9bc..bf3291d 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -282,7 +282,7 @@ public interface Libvirt extends Library { String virNodeDeviceGetName(DevicePointer virDevicePointer); String virNodeDeviceGetParent(DevicePointer virDevicePointer); int virNodeDeviceNumOfCaps(DevicePointer virDevicePointer); - int virNodeDeviceListCaps(DevicePointer virDevicePointer, String[] names, int maxNames); + int virNodeDeviceListCaps(DevicePointer virDevicePointer, Pointer[] names, int maxNames); String virNodeDeviceGetXMLDesc(DevicePointer virDevicePointer); int virNodeDeviceFree(DevicePointer virDevicePointer); int virNodeDeviceDettach(DevicePointer virDevicePointer); -- 1.7.9.5

Almost every class contains a processError() method with an identical definition, just forwarding the call to ErrorHandler.processError(Libvirt). This function is always called after a libvirt function call (as per its javadoc comment). But, actually, there's no use in always calling processError when there was no error signalled by the libvirt function having been called. This is just a waste of CPU cycles. Furthermore, it's more than ugly that the error handling is littered all over the place in every class. This patch lays ground for generalizing the error handling in a common place and removing those functions from the individual classes. Basically, this copies the processError(int) and processError<T>(T) methods from the Connect class to the ErrorHandler class as static methods. It deprecates the processError(Libvirt) method, which will be removed eventually in a later patch. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/ErrorHandler.java | 47 ++++++++++++++++++++++++++- 1 file changed, 46 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/libvirt/ErrorHandler.java b/src/main/java/org/libvirt/ErrorHandler.java index 434c85d..8dcac8f 100644 --- a/src/main/java/org/libvirt/ErrorHandler.java +++ b/src/main/java/org/libvirt/ErrorHandler.java @@ -3,6 +3,11 @@ package org.libvirt; import org.libvirt.jna.Libvirt; import org.libvirt.jna.virError; +import static org.libvirt.Library.libvirt; + +import com.sun.jna.Pointer; +import com.sun.jna.PointerType; + /** * Utility class which processes the last error from the libvirt library. It * turns errors into Libvirt Exceptions. @@ -18,7 +23,12 @@ public class ErrorHandler { * the active connection * @throws LibvirtException */ - public static void processError(Libvirt libvirt) throws LibvirtException { + @Deprecated + static void processError(Libvirt libvirt) throws LibvirtException { + processError(); + } + + private static final void processError() throws LibvirtException { virError vError = libvirt.virGetLastError(); if (vError != null) { Error error = new Error(vError); @@ -30,4 +40,39 @@ public class ErrorHandler { } } } + + /** + * Calls {@link #processError()} when the given libvirt return code + * indicates an error. + * + * @param ret libvirt return code, indicating error if -1. + * @return {@code ret} + * @throws LibvirtException + */ + static final int processError(int ret) throws LibvirtException { + if (ret == -1) processError(); + return ret; + } + + /** + * Calls {@link #processError()} if {@code arg} is null. + * + * @param arg An arbitrary object returned by libvirt. + * @return {@code arg} + * @throws LibvirtException + */ + static final <T extends PointerType> T processError(T arg) throws LibvirtException { + if (arg == null) processError(); + return arg; + } + + static final Pointer processError(Pointer arg) throws LibvirtException { + if (arg == null) processError(); + return arg; + } + + static final String processError(String str) throws LibvirtException { + if (str == null) processError(); + return str; + } } -- 1.7.9.5

Wrap any fallible libvirt function in a call to ErrorHandler.processError(..). Also update erroneous javadoc comments stating that methods would return a value in case an error occurs. In case of a libvirt error, a LibvirtException is thrown. Add processErrorIfZero(long) to ErrorHandler class to handle special libvirt return codes, such as for virDomainGetMaxMemory. Use it in Domain.getMaxMemory(). Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Domain.java | 328 +++++++++------------------ src/main/java/org/libvirt/ErrorHandler.java | 5 + 2 files changed, 113 insertions(+), 220 deletions(-) diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java index b50e182..047ac33 100644 --- a/src/main/java/org/libvirt/Domain.java +++ b/src/main/java/org/libvirt/Domain.java @@ -13,6 +13,8 @@ import org.libvirt.jna.virDomainMemoryStats; import org.libvirt.jna.virSchedParameter; import org.libvirt.jna.virVcpuInfo; import static org.libvirt.Library.libvirt; +import static org.libvirt.ErrorHandler.processError; +import static org.libvirt.ErrorHandler.processErrorIfZero; import com.sun.jna.Native; import com.sun.jna.NativeLong; @@ -160,13 +162,11 @@ public class Domain { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainAbor... * Documentation</a> - * @return 0 in case of success and -1 in case of failure. + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int abortJob() throws LibvirtException { - int returnValue = libvirt.virDomainAbortJob(VDP); - processError(); - return returnValue; + return processError(libvirt.virDomainAbortJob(VDP)); } /** @@ -180,8 +180,7 @@ public class Domain { * @throws LibvirtException */ public void attachDevice(String xmlDesc) throws LibvirtException { - libvirt.virDomainAttachDevice(VDP, xmlDesc); - processError(); + processError(libvirt.virDomainAttachDevice(VDP, xmlDesc)); } /** @@ -197,8 +196,7 @@ public class Domain { * @throws LibvirtException */ public void attachDeviceFlags(String xmlDesc, int flags) throws LibvirtException { - libvirt.virDomainAttachDeviceFlags(VDP, xmlDesc, flags); - processError(); + processError(libvirt.virDomainAttachDeviceFlags(VDP, xmlDesc, flags)); } /** @@ -207,14 +205,13 @@ public class Domain { * * @param path * the path to the block device - * @return the info, or null if an error + * @return the info * @throws LibvirtException */ public DomainBlockInfo blockInfo(String path) throws LibvirtException { virDomainBlockInfo info = new virDomainBlockInfo(); - int success = libvirt.virDomainGetBlockInfo(VDP, path, info, 0); - processError(); - return success == 0 ? new DomainBlockInfo(info) : null; + processError(libvirt.virDomainGetBlockInfo(VDP, path, info, 0)); + return new DomainBlockInfo(info); } /** @@ -234,9 +231,8 @@ public class Domain { */ public DomainBlockStats blockStats(String path) throws LibvirtException { virDomainBlockStats stats = new virDomainBlockStats(); - int success = libvirt.virDomainBlockStats(VDP, path, stats, new SizeT(stats.size())); - processError(); - return success == 0 ? new DomainBlockStats(stats) : null; + processError(libvirt.virDomainBlockStats(VDP, path, stats, new SizeT(stats.size()))); + return new DomainBlockStats(stats); } /** @@ -251,8 +247,7 @@ public class Domain { * @throws LibvirtException */ public void blockResize(String disk, long size, int flags) throws LibvirtException { - int returnValue = libvirt.virDomainBlockResize(VDP, disk, size, flags); - processError(); + processError(libvirt.virDomainBlockResize(VDP, disk, size, flags)); } @@ -267,8 +262,7 @@ public class Domain { * @throws LibvirtException */ public void coreDump(String to, int flags) throws LibvirtException { - libvirt.virDomainCoreDump(VDP, to, flags); - processError(); + processError(libvirt.virDomainCoreDump(VDP, to, flags)); } /** @@ -283,12 +277,11 @@ public class Domain { * Launches this defined domain. If the call succeed the domain moves from * the defined to the running domains pools. * + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int create() throws LibvirtException { - int returnValue = libvirt.virDomainCreate(VDP); - processError(); - return returnValue; + return processError(libvirt.virDomainCreate(VDP)); } /** @@ -296,12 +289,11 @@ public class Domain { * If the call succeed the domain moves from * the defined to the running domains pools. * + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int create(int flags) throws LibvirtException { - int returnValue = libvirt.virDomainCreateWithFlags(VDP, flags); - processError(); - return returnValue; + return processError(libvirt.virDomainCreateWithFlags(VDP, flags)); } /** @@ -313,8 +305,7 @@ public class Domain { * @throws LibvirtException */ public void destroy() throws LibvirtException { - libvirt.virDomainDestroy(VDP); - processError(); + processError(libvirt.virDomainDestroy(VDP)); } /** @@ -328,8 +319,7 @@ public class Domain { * @throws LibvirtException */ public void detachDevice(String xmlDesc) throws LibvirtException { - libvirt.virDomainDetachDevice(VDP, xmlDesc); - processError(); + processError(libvirt.virDomainDetachDevice(VDP, xmlDesc)); } /** @@ -343,8 +333,7 @@ public class Domain { * @throws LibvirtException */ public void detachDeviceFlags(String xmlDesc, int flags) throws LibvirtException { - libvirt.virDomainDetachDeviceFlags(VDP, xmlDesc, flags); - processError(); + processError(libvirt.virDomainDetachDeviceFlags(VDP, xmlDesc, flags)); } @Override @@ -357,13 +346,12 @@ public class Domain { * structure is freed and should not be used thereafter. * * @throws LibvirtException - * @return number of references left (>= 0) for success, -1 for failure. + * @return number of references left (>= 0) */ public int free() throws LibvirtException { int success = 0; if (VDP != null) { - success = libvirt.virDomainFree(VDP); - processError(); + success = processError(libvirt.virDomainFree(VDP)); VDP = null; } @@ -379,8 +367,7 @@ public class Domain { */ public boolean getAutostart() throws LibvirtException { IntByReference autoStart = new IntByReference(); - libvirt.virDomainGetAutostart(VDP, autoStart); - processError(); + processError(libvirt.virDomainGetAutostart(VDP, autoStart)); return autoStart.getValue() != 0 ? true : false; } @@ -400,9 +387,7 @@ public class Domain { * @throws LibvirtException */ public int getID() throws LibvirtException { - int returnValue = libvirt.virDomainGetID(VDP); - processError(); - return returnValue; + return processError(libvirt.virDomainGetID(VDP)); } /** @@ -418,14 +403,9 @@ public class Domain { * @throws LibvirtException */ public DomainInfo getInfo() throws LibvirtException { - DomainInfo returnValue = null; virDomainInfo vInfo = new virDomainInfo(); - int success = libvirt.virDomainGetInfo(VDP, vInfo); - processError(); - if (success == 0) { - returnValue = new DomainInfo(vInfo); - } - return returnValue; + processError(libvirt.virDomainGetInfo(VDP, vInfo)); + return new DomainInfo(vInfo); } /** @@ -439,14 +419,9 @@ public class Domain { * @throws LibvirtException */ public DomainJobInfo getJobInfo() throws LibvirtException { - DomainJobInfo returnValue = null; virDomainJobInfo vInfo = new virDomainJobInfo(); - int success = libvirt.virDomainGetJobInfo(VDP, vInfo); - processError(); - if (success == 0) { - returnValue = new DomainJobInfo(vInfo); - } - return returnValue; + processError(libvirt.virDomainGetJobInfo(VDP, vInfo)); + return new DomainJobInfo(vInfo); } /** @@ -456,9 +431,9 @@ public class Domain { * @throws LibvirtException */ public long getMaxMemory() throws LibvirtException { + // the memory size in kibibytes (blocks of 1024 bytes), or 0 in case of error. NativeLong returnValue = libvirt.virDomainGetMaxMemory(VDP); - processError(); - return returnValue.longValue(); + return processErrorIfZero(returnValue.longValue()); } /** @@ -471,21 +446,17 @@ public class Domain { * @throws LibvirtException */ public int getMaxVcpus() throws LibvirtException { - int returnValue = libvirt.virDomainGetMaxVcpus(VDP); - processError(); - return returnValue; + return processError(libvirt.virDomainGetMaxVcpus(VDP)); } /** * Gets the public name for this domain * - * @return the name - * @throws LibvirtException + * @return the name, null if there is no name + * @throws LibvirtException <em>never</em> */ public String getName() throws LibvirtException { - String returnValue = libvirt.virDomainGetName(VDP); - processError(); - return returnValue; + return libvirt.virDomainGetName(VDP); } /** @@ -495,8 +466,7 @@ public class Domain { * @throws LibvirtException */ public String getOSType() throws LibvirtException { - Pointer ptr = libvirt.virDomainGetOSType(VDP); - processError(); + Pointer ptr = processError(libvirt.virDomainGetOSType(VDP)); try { return Library.getString(ptr); } finally { @@ -513,18 +483,14 @@ public class Domain { public SchedParameter[] getSchedulerParameters() throws LibvirtException { IntByReference nParams = new IntByReference(); SchedParameter[] returnValue = new SchedParameter[0]; - Pointer pScheduler = libvirt.virDomainGetSchedulerType(VDP, nParams); - processError(); - if (pScheduler != null) { - String scheduler = Library.getString(pScheduler); - Library.free(pScheduler); - virSchedParameter[] nativeParams = new virSchedParameter[nParams.getValue()]; - returnValue = new SchedParameter[nParams.getValue()]; - libvirt.virDomainGetSchedulerParameters(VDP, nativeParams, nParams); - processError(); - for (int x = 0; x < nParams.getValue(); x++) { - returnValue[x] = SchedParameter.create(nativeParams[x]); - } + Pointer pScheduler = processError(libvirt.virDomainGetSchedulerType(VDP, nParams)); + String scheduler = Library.getString(pScheduler); + Library.free(pScheduler); + virSchedParameter[] nativeParams = new virSchedParameter[nParams.getValue()]; + returnValue = new SchedParameter[nParams.getValue()]; + processError(libvirt.virDomainGetSchedulerParameters(VDP, nativeParams, nParams)); + for (int x = 0; x < nParams.getValue(); x++) { + returnValue[x] = SchedParameter.create(nativeParams[x]); } return returnValue; @@ -542,8 +508,7 @@ public class Domain { */ public String[] getSchedulerType() throws LibvirtException { IntByReference nParams = new IntByReference(); - Pointer pScheduler = libvirt.virDomainGetSchedulerType(VDP, nParams); - processError(); + Pointer pScheduler = processError(libvirt.virDomainGetSchedulerType(VDP, nParams)); String[] array = new String[1]; array[0] = Library.getString(pScheduler); Library.free(pScheduler); @@ -559,13 +524,8 @@ public class Domain { */ public int[] getUUID() throws LibvirtException { byte[] bytes = new byte[Libvirt.VIR_UUID_BUFLEN]; - int success = libvirt.virDomainGetUUID(VDP, bytes); - processError(); - int[] returnValue = new int[0]; - if (success == 0) { - returnValue = Connect.convertUUIDBytes(bytes); - } - return returnValue; + processError(libvirt.virDomainGetUUID(VDP, bytes)); + return Connect.convertUUIDBytes(bytes); } /** @@ -577,13 +537,8 @@ public class Domain { */ public String getUUIDString() throws LibvirtException { byte[] bytes = new byte[Libvirt.VIR_UUID_STRING_BUFLEN]; - int success = libvirt.virDomainGetUUIDString(VDP, bytes); - processError(); - String returnValue = null; - if (success == 0) { - returnValue = Native.toString(bytes); - } - return returnValue; + processError(libvirt.virDomainGetUUIDString(VDP, bytes)); + return Native.toString(bytes); } /** @@ -603,8 +558,7 @@ public class Domain { virVcpuInfo[] infos = new virVcpuInfo[cpuCount]; returnValue = new int[cpuCount * maplength]; byte[] cpumaps = new byte[cpuCount * maplength]; - libvirt.virDomainGetVcpus(VDP, infos, cpuCount, cpumaps, maplength); - processError(); + processError(libvirt.virDomainGetVcpus(VDP, infos, cpuCount, cpumaps, maplength)); for (int x = 0; x < cpuCount * maplength; x++) { returnValue[x] = cpumaps[x]; } @@ -622,8 +576,7 @@ public class Domain { int cpuCount = getMaxVcpus(); VcpuInfo[] returnValue = new VcpuInfo[cpuCount]; virVcpuInfo[] infos = new virVcpuInfo[cpuCount]; - libvirt.virDomainGetVcpus(VDP, infos, cpuCount, null, 0); - processError(); + processError(libvirt.virDomainGetVcpus(VDP, infos, cpuCount, null, 0)); for (int x = 0; x < cpuCount; x++) { returnValue[x] = new VcpuInfo(infos[x]); } @@ -642,8 +595,7 @@ public class Domain { * Description format </a> */ public String getXMLDesc(int flags) throws LibvirtException { - Pointer ptr = libvirt.virDomainGetXMLDesc(VDP, flags); - processError(); + Pointer ptr = processError(libvirt.virDomainGetXMLDesc(VDP, flags)); try { return Library.getString(ptr); } finally { @@ -656,13 +608,11 @@ public class Domain { * * @see <a href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainHasC... * r t Documentation</a> - * @return 1 if running, 0 if inactive, -1 on error + * @return 1 if running, 0 if inactive * @throws LibvirtException */ public int hasCurrentSnapshot() throws LibvirtException { - int returnValue = libvirt.virDomainHasCurrentSnapshot(VDP, 0); - processError(); - return returnValue; + return processError(libvirt.virDomainHasCurrentSnapshot(VDP, 0)); } /** @@ -675,9 +625,7 @@ public class Domain { * @throws LibvirtException */ public int hasManagedSaveImage() throws LibvirtException { - int returnValue = libvirt.virDomainHasManagedSaveImage(VDP, 0); - processError(); - return returnValue; + return processError(libvirt.virDomainHasManagedSaveImage(VDP, 0)); } /** @@ -695,8 +643,7 @@ public class Domain { */ public DomainInterfaceStats interfaceStats(String path) throws LibvirtException { virDomainInterfaceStats stats = new virDomainInterfaceStats(); - libvirt.virDomainInterfaceStats(VDP, path, stats, new SizeT(stats.size())); - processError(); + processError(libvirt.virDomainInterfaceStats(VDP, path, stats, new SizeT(stats.size()))); return new DomainInterfaceStats(stats); } @@ -706,13 +653,11 @@ public class Domain { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainIsAc... * Documentation</a> - * @return 1 if running, 0 if inactive, -1 on error + * @return 1 if running, 0 if inactive * @throws LibvirtException */ public int isActive() throws LibvirtException { - int returnValue = libvirt.virDomainIsActive(VDP); - processError(); - return returnValue; + return processError(libvirt.virDomainIsActive(VDP)); } /** @@ -722,13 +667,11 @@ public class Domain { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainIsPe... * Documentation</a> - * @return 1 if persistent, 0 if transient, -1 on error + * @return 1 if persistent, 0 if transient * @throws LibvirtException */ public int isPersistent() throws LibvirtException { - int returnValue = libvirt.virDomainIsPersistent(VDP); - processError(); - return returnValue; + return processError(libvirt.virDomainIsPersistent(VDP)); } /** @@ -737,13 +680,11 @@ public class Domain { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainMana... * Documentation</a> - * @return 0 in case of success or -1 in case of failure + * @return always 0 * @throws LibvirtException */ public int managedSave() throws LibvirtException { - int returnValue = libvirt.virDomainManagedSave(VDP, 0); - processError(); - return returnValue; + return processError(libvirt.virDomainManagedSave(VDP, 0)); } /** @@ -752,13 +693,11 @@ public class Domain { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainMana... * Documentation</a> - * @return 0 in case of success, and -1 in case of error + * @return always 0 * @throws LibvirtException */ public int managedSaveRemove() throws LibvirtException { - int returnValue = libvirt.virDomainManagedSaveRemove(VDP, 0); - processError(); - return returnValue; + return processError(libvirt.virDomainManagedSaveRemove(VDP, 0)); } /** @@ -766,19 +705,16 @@ public class Domain { * * @param number * the number of stats to retrieve - * @return the collection of stats, or null if an error occurs. + * @return the collection of stats * @throws LibvirtException */ public MemoryStatistic[] memoryStats(int number) throws LibvirtException { virDomainMemoryStats[] stats = new virDomainMemoryStats[number]; MemoryStatistic[] returnStats = null; - int result = libvirt.virDomainMemoryStats(VDP, stats, number, 0); - processError(); - if (result >= 0) { - returnStats = new MemoryStatistic[result]; - for (int x = 0; x < result; x++) { - returnStats[x] = new MemoryStatistic(stats[x]); - } + int result = processError(libvirt.virDomainMemoryStats(VDP, stats, number, 0)); + returnStats = new MemoryStatistic[result]; + for (int x = 0; x < result; x++) { + returnStats[x] = new MemoryStatistic(stats[x]); } return returnStats; } @@ -852,8 +788,8 @@ public class Domain { * @throws LibvirtException if the migration fails */ public Domain migrate(Connect dconn, long flags, String dxml, String dname, String uri, long bandwidth) throws LibvirtException { - DomainPointer newPtr = libvirt.virDomainMigrate2(VDP, dconn.VCP, dxml, new NativeLong(flags), dname, uri, new NativeLong(bandwidth)); - processError(); + DomainPointer newPtr = + processError(libvirt.virDomainMigrate2(VDP, dconn.VCP, dxml, new NativeLong(flags), dname, uri, new NativeLong(bandwidth))); return new Domain(dconn, newPtr); } @@ -896,14 +832,13 @@ public class Domain { * (optional) dest hostname/URI as seen from the source host * @param bandwidth * optional) specify migration bandwidth limit in Mbps - * @return the new domain object if the migration was successful, or NULL in - * case of error. Note that the new domain object exists in the - * scope of the destination connection (dconn). + * @return the new domain object if the migration was successful. Note that + * the new domain object exists in the scope of the destination + * connection (dconn). * @throws LibvirtException */ public Domain migrate(Connect dconn, long flags, String dname, String uri, long bandwidth) throws LibvirtException { - DomainPointer newPtr = libvirt.virDomainMigrate(VDP, dconn.VCP, new NativeLong(flags), dname, uri, new NativeLong(bandwidth)); - processError(); + DomainPointer newPtr = processError(libvirt.virDomainMigrate(VDP, dconn.VCP, new NativeLong(flags), dname, uri, new NativeLong(bandwidth))); return new Domain(dconn, newPtr); } @@ -916,13 +851,11 @@ public class Domain { * Documentation</a> * @param downtime * the time to be down - * @return 0 in case of success, -1 otherwise. + * @return always 0 * @throws LibvirtException */ public int migrateSetMaxDowntime(long downtime) throws LibvirtException { - int returnValue = libvirt.virDomainMigrateSetMaxDowntime(VDP, downtime, 0); - processError(); - return returnValue; + return processError(libvirt.virDomainMigrateSetMaxDowntime(VDP, downtime, 0)); } /** @@ -956,9 +889,9 @@ public class Domain { * @throws LibvirtException */ public int migrateToURI(String dconnuri, String miguri, String dxml, long flags, String dname, long bandwidth) throws LibvirtException { - int returnValue = libvirt.virDomainMigrateToURI2(VDP, dconnuri, miguri, dxml, new NativeLong(flags), dname, new NativeLong(bandwidth)); - processError(); - return returnValue; + return processError(libvirt.virDomainMigrateToURI2(VDP, dconnuri, miguri, + dxml, new NativeLong(flags), + dname, new NativeLong(bandwidth))); } /** @@ -981,9 +914,7 @@ public class Domain { * @throws LibvirtException */ public int migrateToURI(String uri, long flags, String dname, long bandwidth) throws LibvirtException { - int returnValue = libvirt.virDomainMigrateToURI(VDP, uri, new NativeLong(flags), dname, new NativeLong(bandwidth)); - processError(); - return returnValue; + return processError(libvirt.virDomainMigrateToURI(VDP, uri, new NativeLong(flags), dname, new NativeLong(bandwidth))); } /** @@ -1005,16 +936,7 @@ public class Domain { for (int x = 0; x < cpumap.length; x++) { packedMap[x] = (byte) cpumap[x]; } - libvirt.virDomainPinVcpu(VDP, vcpu, packedMap, cpumap.length); - processError(); - } - - /** - * Error handling logic to throw errors. Must be called after every libvirt - * call. - */ - protected void processError() throws LibvirtException { - virConnect.processError(); + processError(libvirt.virDomainPinVcpu(VDP, vcpu, packedMap, cpumap.length)); } /** @@ -1027,8 +949,7 @@ public class Domain { * @throws LibvirtException */ public void reboot(int flags) throws LibvirtException { - libvirt.virDomainReboot(VDP, flags); - processError(); + processError(libvirt.virDomainReboot(VDP, flags)); } /** @@ -1039,8 +960,7 @@ public class Domain { * @throws LibvirtException */ public void resume() throws LibvirtException { - libvirt.virDomainResume(VDP); - processError(); + processError(libvirt.virDomainResume(VDP)); } /** @@ -1051,13 +971,11 @@ public class Domain { * >Libvirt Documentation</> * @param snapshot * the snapshot to revert to - * @return 0 if the creation is successful, -1 on error. + * @return 0 if the creation is successful * @throws LibvirtException */ public int revertToSnapshot(DomainSnapshot snapshot) throws LibvirtException { - int returnCode = libvirt.virDomainRevertToSnapshot(snapshot.VDSP, 0); - processError(); - return returnCode; + return processError(libvirt.virDomainRevertToSnapshot(snapshot.VDSP, 0)); } /** @@ -1071,8 +989,7 @@ public class Domain { * @throws LibvirtException */ public void save(String to) throws LibvirtException { - libvirt.virDomainSave(VDP, to); - processError(); + processError(libvirt.virDomainSave(VDP, to)); } /** @@ -1084,8 +1001,7 @@ public class Domain { */ public void setAutostart(boolean autostart) throws LibvirtException { int autoValue = autostart ? 1 : 0; - libvirt.virDomainSetAutostart(VDP, autoValue); - processError(); + processError(libvirt.virDomainSetAutostart(VDP, autoValue)); } /** @@ -1097,8 +1013,7 @@ public class Domain { * @throws LibvirtException */ public void setMaxMemory(long memory) throws LibvirtException { - libvirt.virDomainSetMaxMemory(VDP, new NativeLong(memory)); - processError(); + processError(libvirt.virDomainSetMaxMemory(VDP, new NativeLong(memory))); } /** @@ -1111,8 +1026,7 @@ public class Domain { * @throws LibvirtException */ public void setMemory(long memory) throws LibvirtException { - libvirt.virDomainSetMemory(VDP, new NativeLong(memory)); - processError(); + processError(libvirt.virDomainSetMemory(VDP, new NativeLong(memory))); } /** @@ -1127,8 +1041,7 @@ public class Domain { for (int x = 0; x < params.length; x++) { input[x] = SchedParameter.toNative(params[x]); } - libvirt.virDomainSetSchedulerParameters(VDP, input, params.length); - processError(); + processError(libvirt.virDomainSetSchedulerParameters(VDP, input, params.length)); } /** @@ -1142,8 +1055,7 @@ public class Domain { * @throws LibvirtException */ public void setVcpus(int nvcpus) throws LibvirtException { - libvirt.virDomainSetVcpus(VDP, nvcpus); - processError(); + processError(libvirt.virDomainSetVcpus(VDP, nvcpus)); } /** @@ -1155,8 +1067,7 @@ public class Domain { * @throws LibvirtException */ public void shutdown() throws LibvirtException { - libvirt.virDomainShutdown(VDP); - processError(); + processError(libvirt.virDomainShutdown(VDP)); } /** @@ -1170,17 +1081,12 @@ public class Domain { * string containing an XML description of the domain * @param flags * flags for creating the snapshot, see the virDomainSnapshotCreateFlags for the flag options - * @return the snapshot, or null on Error + * @return the snapshot * @throws LibvirtException */ public DomainSnapshot snapshotCreateXML(String xmlDesc, int flags) throws LibvirtException { - DomainSnapshotPointer ptr = libvirt.virDomainSnapshotCreateXML(VDP, xmlDesc, flags); - processError(); - DomainSnapshot returnValue = null; - if (ptr != null) { - returnValue = new DomainSnapshot(virConnect, ptr); - } - return returnValue; + DomainSnapshotPointer ptr = processError(libvirt.virDomainSnapshotCreateXML(VDP, xmlDesc, flags)); + return new DomainSnapshot(virConnect, ptr); } /** @@ -1209,17 +1115,12 @@ public class Domain { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virDomainSnap... * Documentation</a> - * @return the snapshot, or null on Error + * @return the snapshot * @throws LibvirtException */ public DomainSnapshot snapshotCurrent() throws LibvirtException { - DomainSnapshotPointer ptr = libvirt.virDomainSnapshotCurrent(VDP, 0); - processError(); - DomainSnapshot returnValue = null; - if (ptr != null) { - returnValue = new DomainSnapshot(virConnect, ptr); - } - return returnValue; + DomainSnapshotPointer ptr = processError(libvirt.virDomainSnapshotCurrent(VDP, 0)); + return new DomainSnapshot(virConnect, ptr); } /** @@ -1237,8 +1138,7 @@ public class Domain { if (num >= 0) { returnValue = new String[num]; if (num > 0) { - libvirt.virDomainSnapshotListNames(VDP, returnValue, num, flags); - processError(); + processError(libvirt.virDomainSnapshotListNames(VDP, returnValue, num, flags)); } } return returnValue; @@ -1269,17 +1169,12 @@ public class Domain { * Documentation</a> * @param name * the name - * @return The located snapshot, or null if an error + * @return The located snapshot * @throws LibvirtException */ public DomainSnapshot snapshotLookupByName(String name) throws LibvirtException { - DomainSnapshotPointer ptr = libvirt.virDomainSnapshotLookupByName(VDP, name, 0); - processError(); - DomainSnapshot returnValue = null; - if (ptr != null) { - returnValue = new DomainSnapshot(virConnect, ptr); - } - return returnValue; + DomainSnapshotPointer ptr = processError(libvirt.virDomainSnapshotLookupByName(VDP, name, 0)); + return new DomainSnapshot(virConnect, ptr); } /** @@ -1290,9 +1185,7 @@ public class Domain { * Documentation</a> */ public int snapshotNum() throws LibvirtException { - int returnValue = libvirt.virDomainSnapshotNum(VDP, 0); - processError(); - return returnValue; + return processError(libvirt.virDomainSnapshotNum(VDP, 0)); } /** @@ -1304,8 +1197,7 @@ public class Domain { * @throws LibvirtException */ public void suspend() throws LibvirtException { - libvirt.virDomainSuspend(VDP); - processError(); + processError(libvirt.virDomainSuspend(VDP)); } /** @@ -1314,8 +1206,7 @@ public class Domain { * @throws LibvirtException */ public void undefine() throws LibvirtException { - libvirt.virDomainUndefine(VDP); - processError(); + processError(libvirt.virDomainUndefine(VDP)); } /** @@ -1327,8 +1218,7 @@ public class Domain { * @throws LibvirtException */ public void undefine(int flags) throws LibvirtException { - libvirt.virDomainUndefineFlags(VDP, flags); - processError(); + processError(libvirt.virDomainUndefineFlags(VDP, flags)); } /** @@ -1339,13 +1229,11 @@ public class Domain { * the xml to update with * @param flags * controls the update - * @return 0 in case of success, -1 in case of failure. + * @return always 0 * @throws LibvirtException */ public int updateDeviceFlags(String xml, int flags) throws LibvirtException { - int returnValue = libvirt.virDomainUpdateDeviceFlags(VDP, xml, flags); - processError(); - return returnValue; + return processError(libvirt.virDomainUpdateDeviceFlags(VDP, xml, flags)); } } diff --git a/src/main/java/org/libvirt/ErrorHandler.java b/src/main/java/org/libvirt/ErrorHandler.java index 8dcac8f..01e25d6 100644 --- a/src/main/java/org/libvirt/ErrorHandler.java +++ b/src/main/java/org/libvirt/ErrorHandler.java @@ -75,4 +75,9 @@ public class ErrorHandler { if (str == null) processError(); return str; } + + static final long processErrorIfZero(long ret) throws LibvirtException { + if (ret == 0) processError(); + return ret; + } } -- 1.7.9.5

Wrap any fallible libvirt function in a call to ErrorHandler.processError(..). Also correct wrong javadoc comments stating that methods would return a value in case an error occurs. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Interface.java | 43 ++++++++---------------------- 1 file changed, 11 insertions(+), 32 deletions(-) diff --git a/src/main/java/org/libvirt/Interface.java b/src/main/java/org/libvirt/Interface.java index 6ea21b6..e0ddc3f 100644 --- a/src/main/java/org/libvirt/Interface.java +++ b/src/main/java/org/libvirt/Interface.java @@ -2,6 +2,7 @@ package org.libvirt; import org.libvirt.jna.InterfacePointer; import static org.libvirt.Library.libvirt; +import static org.libvirt.ErrorHandler.processError; import com.sun.jna.Pointer; @@ -51,9 +52,7 @@ public class Interface { * @throws LibvirtException */ public int create() throws LibvirtException { - int returnValue = libvirt.virInterfaceCreate(VIP); - processError(); - return returnValue; + return processError(libvirt.virInterfaceCreate(VIP)); } /** @@ -72,9 +71,7 @@ public class Interface { * @throws LibvirtException */ public int destroy() throws LibvirtException { - int returnValue = libvirt.virInterfaceDestroy(VIP); - processError(); - return returnValue; + return processError(libvirt.virInterfaceDestroy(VIP)); } @Override @@ -87,13 +84,12 @@ public class Interface { * structure is freed and should not be used thereafter. * * @throws LibvirtException - * @return number of references left (>= 0) for success, -1 for failure. + * @return number of references left (>= 0) */ public int free() throws LibvirtException { int success = 0; if (VIP != null) { - success = libvirt.virInterfaceFree(VIP); - processError(); + success = processError(libvirt.virInterfaceFree(VIP)); VIP = null; } @@ -106,9 +102,7 @@ public class Interface { * @throws LibvirtException */ public String getMACString() throws LibvirtException { - String name = libvirt.virInterfaceGetMACString(VIP); - processError(); - return name; + return processError(libvirt.virInterfaceGetMACString(VIP)); } /** @@ -117,9 +111,7 @@ public class Interface { * @throws LibvirtException */ public String getName() throws LibvirtException { - String name = libvirt.virInterfaceGetName(VIP); - processError(); - return name; + return processError(libvirt.virInterfaceGetName(VIP)); } /** @@ -128,8 +120,7 @@ public class Interface { * @throws LibvirtException */ public String getXMLDescription(int flags) throws LibvirtException { - Pointer xml = libvirt.virInterfaceGetXMLDesc(VIP, flags); - processError(); + Pointer xml = processError(libvirt.virInterfaceGetXMLDesc(VIP, flags)); try { return Library.getString(xml); } finally { @@ -143,21 +134,11 @@ public class Interface { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virInterfaceI... * Documentation</a> - * @return 1 if running, 0 if inactive, -1 on error + * @return 1 if running, 0 if inactive * @throws LibvirtException */ public int isActive() throws LibvirtException { - int returnValue = libvirt.virInterfaceIsActive(VIP); - processError(); - return returnValue; - } - - /** - * Error handling logic to throw errors. Must be called after every libvirt - * call. - */ - protected void processError() throws LibvirtException { - virConnect.processError(); + return processError(libvirt.virInterfaceIsActive(VIP)); } /** @@ -167,8 +148,6 @@ public class Interface { * @throws LibvirtException */ public int undefine() throws LibvirtException { - int returnValue = libvirt.virInterfaceUndefine(VIP); - processError(); - return returnValue; + return processError(libvirt.virInterfaceUndefine(VIP)); } } -- 1.7.9.5

Wrap any fallible libvirt function in a call to ErrorHandler.processError(..). Also correct wrong javadoc comments stating that methods would return a value in case an error occurs. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/NetworkFilter.java | 43 ++++++-------------------- 1 file changed, 10 insertions(+), 33 deletions(-) diff --git a/src/main/java/org/libvirt/NetworkFilter.java b/src/main/java/org/libvirt/NetworkFilter.java index ba4d2ea..4f4bc6c 100644 --- a/src/main/java/org/libvirt/NetworkFilter.java +++ b/src/main/java/org/libvirt/NetworkFilter.java @@ -3,6 +3,7 @@ package org.libvirt; import org.libvirt.jna.Libvirt; import org.libvirt.jna.NetworkFilterPointer; import static org.libvirt.Library.libvirt; +import static org.libvirt.ErrorHandler.processError; import com.sun.jna.Native; @@ -32,13 +33,12 @@ public class NetworkFilter { * exist. * * @throws LibvirtException - * @return 0 on success, or -1 on error. + * @return <em>ignore</em> (always 0) */ public int free() throws LibvirtException { int success = 0; if (NFP != null) { - success = libvirt.virNWFilterFree(NFP); - processError(); + success = processError(libvirt.virNWFilterFree(NFP)); NFP = null; } @@ -52,9 +52,7 @@ public class NetworkFilter { * @throws LibvirtException */ public String getName() throws LibvirtException { - String returnValue = libvirt.virNWFilterGetName(NFP); - processError(); - return returnValue; + return processError(libvirt.virNWFilterGetName(NFP)); } /** @@ -66,13 +64,8 @@ public class NetworkFilter { */ public int[] getUUID() throws LibvirtException { byte[] bytes = new byte[Libvirt.VIR_UUID_BUFLEN]; - int success = libvirt.virNWFilterGetUUID(NFP, bytes); - processError(); - int[] returnValue = new int[0]; - if (success == 0) { - returnValue = Connect.convertUUIDBytes(bytes); - } - return returnValue; + processError(libvirt.virNWFilterGetUUID(NFP, bytes)); + return Connect.convertUUIDBytes(bytes); } /** @@ -84,13 +77,8 @@ public class NetworkFilter { */ public String getUUIDString() throws LibvirtException { byte[] bytes = new byte[Libvirt.VIR_UUID_STRING_BUFLEN]; - int success = libvirt.virNWFilterGetUUIDString(NFP, bytes); - processError(); - String returnValue = null; - if (success == 0) { - returnValue = Native.toString(bytes); - } - return returnValue; + processError(libvirt.virNWFilterGetUUIDString(NFP, bytes)); + return Native.toString(bytes); } /** @@ -102,17 +90,7 @@ public class NetworkFilter { * @return the XML document */ public String getXMLDesc() throws LibvirtException { - String returnValue = libvirt.virNWFilterGetXMLDesc(NFP, 0); - processError(); - return returnValue; - } - - /** - * Error handling logic to throw errors. Must be called after every libvirt - * call. - */ - protected void processError() throws LibvirtException { - virConnect.processError(); + return processError(libvirt.virNWFilterGetXMLDesc(NFP, 0)); } /** @@ -121,7 +99,6 @@ public class NetworkFilter { * @throws LibvirtException */ public void undefine() throws LibvirtException { - libvirt.virNWFilterUndefine(NFP); - processError(); + processError(libvirt.virNWFilterUndefine(NFP)); } } -- 1.7.9.5

Wrap any fallible libvirt function in a call to ErrorHandler.processError(..). Adjust the doc comment for storageVolLookupByName to indicate that it might return null. Also correct wrong javadoc comments stating that methods would return a value in case an error occurs. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/StoragePool.java | 95 +++++++++------------------- 1 file changed, 30 insertions(+), 65 deletions(-) diff --git a/src/main/java/org/libvirt/StoragePool.java b/src/main/java/org/libvirt/StoragePool.java index 2d59f68..bb608e3 100644 --- a/src/main/java/org/libvirt/StoragePool.java +++ b/src/main/java/org/libvirt/StoragePool.java @@ -5,6 +5,7 @@ import org.libvirt.jna.StoragePoolPointer; import org.libvirt.jna.StorageVolPointer; import org.libvirt.jna.virStoragePoolInfo; import static org.libvirt.Library.libvirt; +import static org.libvirt.ErrorHandler.processError; import com.sun.jna.Native; import com.sun.jna.ptr.IntByReference; @@ -72,8 +73,7 @@ public class StoragePool { * future flags, use 0 for now */ public void build(int flags) throws LibvirtException { - libvirt.virStoragePoolBuild(VSPP, flags); - processError(); + processError(libvirt.virStoragePoolBuild(VSPP, flags)); } /** @@ -83,8 +83,7 @@ public class StoragePool { * future flags, use 0 for now */ public void create(int flags) throws LibvirtException { - libvirt.virStoragePoolCreate(VSPP, flags); - processError(); + processError(libvirt.virStoragePoolCreate(VSPP, flags)); } /** @@ -95,8 +94,7 @@ public class StoragePool { * flags for obliteration process */ public void delete(int flags) throws LibvirtException { - libvirt.virStoragePoolDelete(VSPP, flags); - processError(); + processError(libvirt.virStoragePoolDelete(VSPP, flags)); } /** @@ -106,8 +104,7 @@ public class StoragePool { * This does not free the associated virStoragePoolPtr object. */ public void destroy() throws LibvirtException { - libvirt.virStoragePoolDestroy(VSPP); - processError(); + processError(libvirt.virStoragePoolDestroy(VSPP)); } @Override @@ -120,13 +117,12 @@ public class StoragePool { * not change the state of the pool on the host. * * @throws LibvirtException - * @return number of references left (>= 0) for success, -1 for failure. + * @return number of references left (>= 0) */ public int free() throws LibvirtException { int success = 0; if (VSPP != null) { - success = libvirt.virStoragePoolFree(VSPP); - processError(); + success = processError(libvirt.virStoragePoolFree(VSPP)); VSPP = null; } return success; @@ -141,8 +137,7 @@ public class StoragePool { */ public boolean getAutostart() throws LibvirtException { IntByReference autoStart = new IntByReference(); - libvirt.virStoragePoolGetAutostart(VSPP, autoStart); - processError(); + processError(libvirt.virStoragePoolGetAutostart(VSPP, autoStart)); return autoStart.getValue() != 0 ? true : false; } @@ -164,8 +159,7 @@ public class StoragePool { */ public StoragePoolInfo getInfo() throws LibvirtException { virStoragePoolInfo vInfo = new virStoragePoolInfo(); - libvirt.virStoragePoolGetInfo(VSPP, vInfo); - processError(); + processError(libvirt.virStoragePoolGetInfo(VSPP, vInfo)); return new StoragePoolInfo(vInfo); } @@ -176,9 +170,7 @@ public class StoragePool { * @throws LibvirtException */ public String getName() throws LibvirtException { - String returnValue = libvirt.virStoragePoolGetName(VSPP); - processError(); - return returnValue; + return processError(libvirt.virStoragePoolGetName(VSPP)); } /** @@ -189,13 +181,8 @@ public class StoragePool { */ public int[] getUUID() throws LibvirtException { byte[] bytes = new byte[Libvirt.VIR_UUID_BUFLEN]; - int success = libvirt.virStoragePoolGetUUID(VSPP, bytes); - processError(); - int[] returnValue = new int[0]; - if (success == 0) { - returnValue = Connect.convertUUIDBytes(bytes); - } - return returnValue; + processError(libvirt.virStoragePoolGetUUID(VSPP, bytes)); + return Connect.convertUUIDBytes(bytes); } /** @@ -206,13 +193,8 @@ public class StoragePool { */ public String getUUIDString() throws LibvirtException { byte[] bytes = new byte[Libvirt.VIR_UUID_STRING_BUFLEN]; - int success = libvirt.virStoragePoolGetUUIDString(VSPP, bytes); - processError(); - String returnValue = null; - if (success == 0) { - returnValue = Native.toString(bytes); - } - return returnValue; + processError(libvirt.virStoragePoolGetUUIDString(VSPP, bytes)); + return Native.toString(bytes); } /** @@ -224,9 +206,7 @@ public class StoragePool { * @return a XML document -java @throws LibvirtException */ public String getXMLDesc(int flags) throws LibvirtException { - String returnValue = libvirt.virStoragePoolGetXMLDesc(VSPP, flags); - processError(); - return returnValue; + return processError(libvirt.virStoragePoolGetXMLDesc(VSPP, flags)); } /** @@ -235,13 +215,11 @@ public class StoragePool { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virStoragePoo... * Documentation</a> - * @return 1 if running, 0 if inactive, -1 on error + * @return 1 if running, 0 if inactive * @throws LibvirtException */ public int isActive() throws LibvirtException { - int returnValue = libvirt.virStoragePoolIsActive(VSPP); - processError(); - return returnValue; + return processError(libvirt.virStoragePoolIsActive(VSPP)); } /** @@ -251,13 +229,11 @@ public class StoragePool { * @see <a * href="http://www.libvirt.org/html/libvirt-libvirt.html#virStoragePoo... * Documentation</a> - * @return 1 if persistent, 0 if transient, -1 on error + * @return 1 if persistent, 0 if transient * @throws LibvirtException */ public int isPersistent() throws LibvirtException { - int returnValue = libvirt.virStoragePoolIsPersistent(VSPP); - processError(); - return returnValue; + return processError(libvirt.virStoragePoolIsPersistent(VSPP)); } /** @@ -270,8 +246,7 @@ public class StoragePool { public String[] listVolumes() throws LibvirtException { int num = numOfVolumes(); String[] returnValue = new String[num]; - libvirt.virStoragePoolListVolumes(VSPP, returnValue, num); - processError(); + processError(libvirt.virStoragePoolListVolumes(VSPP, returnValue, num)); return returnValue; } @@ -282,13 +257,7 @@ public class StoragePool { * @throws LibvirtException */ public int numOfVolumes() throws LibvirtException { - int returnValue = libvirt.virStoragePoolNumOfVolumes(VSPP); - processError(); - return returnValue; - } - - protected void processError() throws LibvirtException { - virConnect.processError(); + return processError(libvirt.virStoragePoolNumOfVolumes(VSPP)); } /** @@ -301,8 +270,7 @@ public class StoragePool { * @throws LibvirtException */ public void refresh(int flags) throws LibvirtException { - libvirt.virStoragePoolRefresh(VSPP, flags); - processError(); + processError(libvirt.virStoragePoolRefresh(VSPP, flags)); } /** @@ -328,8 +296,7 @@ public class StoragePool { * @throws LibvirtException */ public StorageVol storageVolCreateXML(String xmlDesc, int flags) throws LibvirtException { - StorageVolPointer sPtr = libvirt.virStorageVolCreateXML(VSPP, xmlDesc, flags); - processError(); + StorageVolPointer sPtr = processError(libvirt.virStorageVolCreateXML(VSPP, xmlDesc, flags)); return new StorageVol(virConnect, sPtr); } @@ -338,13 +305,12 @@ public class StoragePool { * as input. Information for the new volume (name, perms) are passed via a * typical volume XML description. * - * @return The storage volume, or {@code null} on error. + * @return The storage volume * @throws LibvirtException */ public StorageVol storageVolCreateXMLFrom(String xmlDesc, StorageVol cloneVolume, int flags) throws LibvirtException { - StorageVolPointer sPtr = libvirt.virStorageVolCreateXMLFrom(VSPP, xmlDesc, cloneVolume.VSVP, flags); - processError(); + StorageVolPointer sPtr = processError(libvirt.virStorageVolCreateXMLFrom(VSPP, xmlDesc, cloneVolume.VSVP, flags)); return new StorageVol(virConnect, sPtr); } @@ -354,13 +320,13 @@ public class StoragePool { * * @param name * name of storage volume - * @return The StorageVol object found + * @return a StorageVol object, or {@code null} if not found. * @throws LibvirtException */ public StorageVol storageVolLookupByName(String name) throws LibvirtException { - StorageVolPointer sPtr = libvirt.virStorageVolLookupByName(VSPP, name); - processError(); - return new StorageVol(virConnect, sPtr); + StorageVolPointer sPtr = processError(libvirt.virStorageVolLookupByName(VSPP, name)); + + return (sPtr == null) ? null : new StorageVol(virConnect, sPtr); } /** @@ -369,8 +335,7 @@ public class StoragePool { * @throws LibvirtException */ public void undefine() throws LibvirtException { - libvirt.virStoragePoolUndefine(VSPP); - processError(); + processError(libvirt.virStoragePoolUndefine(VSPP)); } } -- 1.7.9.5

Wrap any fallible libvirt function in a call to ErrorHandler.processError(..). Also correct wrong javadoc comments stating that methods would return a value in case an error occurs. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Stream.java | 64 +++++++++++---------------------- 1 file changed, 20 insertions(+), 44 deletions(-) diff --git a/src/main/java/org/libvirt/Stream.java b/src/main/java/org/libvirt/Stream.java index 6d488e3..c36ed70 100644 --- a/src/main/java/org/libvirt/Stream.java +++ b/src/main/java/org/libvirt/Stream.java @@ -4,6 +4,7 @@ import org.libvirt.jna.Libvirt; import org.libvirt.jna.SizeT; import org.libvirt.jna.StreamPointer; import static org.libvirt.Library.libvirt; +import static org.libvirt.ErrorHandler.processError; public class Stream { @@ -27,11 +28,11 @@ public class Stream { /** * Request that the in progress data transfer be cancelled abnormally before * the end of the stream has been reached + * + * @return <em>ignore</em> (always 0) */ public int abort() throws LibvirtException { - int returnValue = libvirt.virStreamAbort(VSP); - processError(); - return returnValue; + return processError(libvirt.virStreamAbort(VSP)); } /** @@ -45,13 +46,11 @@ public class Stream { * the events to monitor * @param cb * the callback method - * @return 0 for success, -1 for failure + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int addCallback(int events, Libvirt.VirStreamEventCallback cb) throws LibvirtException { - int returnValue = libvirt.virStreamEventAddCallback(VSP, events, cb, null, null); - processError(); - return returnValue; + return processError(libvirt.virStreamEventAddCallback(VSP, events, cb, null, null)); } @Override @@ -63,27 +62,24 @@ public class Stream { * Indicate that there is no further data is to be transmitted on the * stream. * - * @return 0 if success, -1 if failure + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int finish() throws LibvirtException { - int returnValue = libvirt.virStreamFinish(VSP); - processError(); - return returnValue; + return processError(libvirt.virStreamFinish(VSP)); } /** * Decrement the reference count on a stream, releasing the stream object if * the reference count has hit zero. * + * @return <em>ignore</em> (always 0) * @throws LibvirtException - * @return 0 on success, or -1 on error. */ public int free() throws LibvirtException { int success = 0; if (VSP != null) { - success = libvirt.virStreamFree(VSP); - processError(); + processError(libvirt.virStreamFree(VSP)); VSP = null; } @@ -91,14 +87,6 @@ public class Stream { } /** - * Error handling logic to throw errors. Must be called after every libvirt - * call. - */ - protected void processError() throws LibvirtException { - virConnect.processError(); - } - - /** * Receives data from the stream into the buffer provided. * * @param data @@ -107,9 +95,7 @@ public class Stream { * @throws LibvirtException */ public int receive(byte[] data) throws LibvirtException { - int returnValue = libvirt.virStreamRecv(VSP, data, new SizeT(data.length)); - processError(); - return returnValue; + return processError(libvirt.virStreamRecv(VSP, data, new SizeT(data.length))); } /** @@ -118,26 +104,22 @@ public class Stream { * @see <a href="http://www.libvirt.org/html/libvirt-libvirt.html#virStreamRecv... * @param handler * the callback handler - * @return 0 if successfule, -1 otherwise + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int receiveAll(Libvirt.VirStreamSinkFunc handler) throws LibvirtException { - int returnValue = libvirt.virStreamRecvAll(VSP, handler, null); - processError(); - return returnValue; + return processError(libvirt.virStreamRecvAll(VSP, handler, null)); } /** * Remove an event callback from the stream * * @see <a href="http://www.libvirt.org/html/libvirt-libvirt.html#virStreamEven... Docs</a> - * @return 0 for success, -1 for failure + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int removeCallback() throws LibvirtException { - int returnValue = libvirt.virStreamEventRemoveCallback(VSP); - processError(); - return returnValue; + return processError(libvirt.virStreamEventRemoveCallback(VSP)); } /** @@ -150,9 +132,7 @@ public class Stream { * @throws LibvirtException */ public int send(String data) throws LibvirtException { - int returnValue = libvirt.virStreamSend(VSP, data, new SizeT(data.length())); - processError(); - return returnValue; + return processError(libvirt.virStreamSend(VSP, data, new SizeT(data.length()))); } /** @@ -163,13 +143,11 @@ public class Stream { * Documentation</a> * @param handler * the callback handler - * @return 0 if successfule, -1 otherwise + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int sendAll(Libvirt.VirStreamSourceFunc handler) throws LibvirtException { - int returnValue = libvirt.virStreamSendAll(VSP, handler, null); - processError(); - return returnValue; + return processError(libvirt.virStreamSendAll(VSP, handler, null)); } /** @@ -178,12 +156,10 @@ public class Stream { * @see <a href="http://www.libvirt.org/html/libvirt-libvirt.html#virStreamEven... Docs</a> * @param events * the events to monitor - * @return 0 for success, -1 for failure + * @return <em>ignore</em> (always 0) * @throws LibvirtException */ public int updateCallback(int events) throws LibvirtException { - int returnValue = libvirt.virStreamEventUpdateCallback(VSP, events); - processError(); - return returnValue; + return processError(libvirt.virStreamEventUpdateCallback(VSP, events)); } } -- 1.7.9.5

Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Library.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/libvirt/Library.java b/src/main/java/org/libvirt/Library.java index 33d3042..95c13cb 100644 --- a/src/main/java/org/libvirt/Library.java +++ b/src/main/java/org/libvirt/Library.java @@ -1,6 +1,7 @@ package org.libvirt; import org.libvirt.jna.Libvirt; +import static org.libvirt.ErrorHandler.processError; import com.sun.jna.Native; import com.sun.jna.Pointer; @@ -24,10 +25,9 @@ final class Library { // Load the native part static { - Libvirt.INSTANCE.virInitialize(); libvirt = Libvirt.INSTANCE; try { - ErrorHandler.processError(Libvirt.INSTANCE); + processError(libvirt.virInitialize()); } catch (Exception e) { e.printStackTrace(); } -- 1.7.9.5

Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Connect.java | 35 +++++++++++++++++ src/main/java/org/libvirt/Domain.java | 48 ++++++++++++++++++++++- src/test/java/org/libvirt/TestJavaBindings.java | 4 ++ 3 files changed, 86 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/libvirt/Connect.java b/src/main/java/org/libvirt/Connect.java index fedc60e..d92976e 100644 --- a/src/main/java/org/libvirt/Connect.java +++ b/src/main/java/org/libvirt/Connect.java @@ -89,6 +89,41 @@ public class Connect { */ protected ConnectionPointer VCP; + /* (non-Javadoc) + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((VCP == null) ? 0 : VCP.hashCode()); + return result; + } + + /* (non-Javadoc) + * @see java.lang.Object#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (!(obj instanceof Connect)) + return false; + Connect other = (Connect) obj; + if (VCP == null) + return (other.VCP == null); + else if (VCP.equals(other.VCP)) + return true; + + try { + return getURI().equals(other.getURI()); + } catch (LibvirtException e) { + throw new RuntimeException("libvirt error testing connect equality", e); + } + } + /** * Protected constructor to return a Connection with ConnectionPointer */ diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java index 047ac33..ab6f9f0 100644 --- a/src/main/java/org/libvirt/Domain.java +++ b/src/main/java/org/libvirt/Domain.java @@ -21,6 +21,8 @@ import com.sun.jna.NativeLong; import com.sun.jna.Pointer; import com.sun.jna.ptr.IntByReference; +import java.util.Arrays; + /** * A virtual machine defined within libvirt. */ @@ -135,10 +137,52 @@ public class Domain { */ DomainPointer VDP; + /* (non-Javadoc) + * @see java.lang.Object#hashCode() + */ + @Override + public int hashCode() { + final int prime = 31; + int result = 1; + result = prime * result + ((VDP == null) ? 0 : VDP.hashCode()); + result = prime * result + + ((virConnect == null) ? 0 : virConnect.hashCode()); + return result; + } + + /* (non-Javadoc) + * @see java.lang.Object#equals(java.lang.Object) + */ + @Override + public boolean equals(Object obj) { + if (this == obj) + return true; + if (obj == null) + return false; + if (!(obj instanceof Domain)) + return false; + Domain other = (Domain) obj; + + // return false when this domain belongs to + // a different hypervisor than the other + if (!this.virConnect.equals(other.virConnect)) + return false; + + if (VDP == null) return (other.VDP == null); + + if (VDP.equals(other.VDP)) return true; + + try { + return Arrays.equals(getUUID(), other.getUUID()); + } catch (LibvirtException e) { + throw new RuntimeException("libvirt error testing domain equality", e); + } + } + /** * The Connect Object that represents the Hypervisor of this Domain */ - private Connect virConnect; + private final Connect virConnect; /** * Constructs a Domain object from a known native DomainPointer, and a @@ -150,6 +194,8 @@ public class Domain { * the native virDomainPtr */ Domain(Connect virConnect, DomainPointer VDP) { + assert virConnect != null; + this.virConnect = virConnect; this.VDP = VDP; } diff --git a/src/test/java/org/libvirt/TestJavaBindings.java b/src/test/java/org/libvirt/TestJavaBindings.java index 0123e6a..91f8df4 100644 --- a/src/test/java/org/libvirt/TestJavaBindings.java +++ b/src/test/java/org/libvirt/TestJavaBindings.java @@ -132,6 +132,7 @@ public final class TestJavaBindings extends TestCase { + " <uuid>004b96e1-2d78-c30f-5aa5-f03c87d21e67</uuid>" + " <memory>8388608</memory>" + " <vcpu>2</vcpu>" + " <os><type arch='i686'>hvm</type></os>" + " <on_reboot>restart</on_reboot>" + " <on_poweroff>destroy</on_poweroff>" + " <on_crash>restart</on_crash>" + "</domain>", 0); + UUID dom2UUID = UUID.fromString("004b96e1-2d78-c30f-5aa5-f03c87d21e67"); assertEquals("Number of domains", 2, conn.numOfDomains()); assertEquals("Number of listed domains", 2, conn.listDomains().length); @@ -145,6 +146,9 @@ public final class TestJavaBindings extends TestCase { this.validateDomainData(conn.domainLookupByUUID(UUIDArray)); this.validateDomainData(conn.domainLookupByUUIDString("004b96e1-2d78-c30f-5aa5-f03c87d21e67")); this.validateDomainData(conn.domainLookupByUUID(UUID.fromString("004b96e1-2d78-c30f-5aa5-f03c87d21e67"))); + assertEquals("Domain is not equal to Domain retrieved by lookup", + dom2, + conn.domainLookupByUUID(dom2.getUUID())); } private void validateDomainData(Domain dom) throws Exception { -- 1.7.9.5

At Tue, 11 Mar 2014 11:18:57 +0100, Claudio Bley wrote: Darn copy'n'paste; just pretend it says "libvirt error generating hash code", OK?! Likewise for the Domain class. Claudio

We need to free the char* entries of the result array returned ourselves. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Domain.java | 14 +++++++------- src/main/java/org/libvirt/jna/Libvirt.java | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java index 6db8745..39cb7c5 100644 --- a/src/main/java/org/libvirt/Domain.java +++ b/src/main/java/org/libvirt/Domain.java @@ -1186,15 +1186,15 @@ public class Domain { * @throws LibvirtException */ public String[] snapshotListNames(int flags) throws LibvirtException { - String[] returnValue = null; int num = snapshotNum(); - if (num >= 0) { - returnValue = new String[num]; - if (num > 0) { - processError(libvirt.virDomainSnapshotListNames(VDP, returnValue, num, flags)); - } + if (num > 0) { + Pointer[] ptrs = new Pointer[num]; + int got = processError(libvirt.virDomainSnapshotListNames(VDP, ptrs, num, flags)); + + return Library.toStringArray(ptrs, got); + } else { + return Library.NO_STRINGS; } - return returnValue; } /** diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index bf3291d..5666c66 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -382,7 +382,7 @@ public interface Libvirt extends Library { int virDomainSnapshotDelete(DomainSnapshotPointer virDomainSnapshotPtr, int flags); String virDomainSnapshotGetXMLDesc(DomainSnapshotPointer virDomainSnapshotPtr, int flags); int virDomainSnapshotFree(DomainSnapshotPointer virDomainSnapshotPtr); - int virDomainSnapshotListNames(DomainPointer virDomainPtr, String[] names, int nameslen, int flags); + int virDomainSnapshotListNames(DomainPointer virDomainPtr, Pointer[] names, int nameslen, int flags); DomainSnapshotPointer virDomainSnapshotLookupByName(DomainPointer virDomainPtr, String name, int flags); int virDomainSnapshotNum(DomainPointer virDomainPtr, int flags); -- 1.7.9.5

Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/DomainSnapshot.java | 10 +++++++++- src/main/java/org/libvirt/jna/Libvirt.java | 2 +- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/libvirt/DomainSnapshot.java b/src/main/java/org/libvirt/DomainSnapshot.java index 4736a71..3013117 100644 --- a/src/main/java/org/libvirt/DomainSnapshot.java +++ b/src/main/java/org/libvirt/DomainSnapshot.java @@ -4,6 +4,8 @@ import org.libvirt.jna.DomainSnapshotPointer; import static org.libvirt.Library.libvirt; import static org.libvirt.ErrorHandler.processError; +import com.sun.jna.Pointer; + public class DomainSnapshot { /** @@ -71,6 +73,12 @@ public class DomainSnapshot { * @return the XML document */ public String getXMLDesc() throws LibvirtException { - return processError(libvirt.virDomainSnapshotGetXMLDesc(VDSP, 0)); + Pointer p = processError(libvirt.virDomainSnapshotGetXMLDesc(VDSP, 0)); + + try { + return Library.getString(p); + } finally { + Library.free(p); + } } } diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index 2eb1cdc..33b5f8c 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -380,7 +380,7 @@ public interface Libvirt extends Library { DomainSnapshotPointer virDomainSnapshotCreateXML(DomainPointer virDomainPtr, String xmlDesc, int flags); DomainSnapshotPointer virDomainSnapshotCurrent(DomainPointer virDomainPtr, int flags); int virDomainSnapshotDelete(DomainSnapshotPointer virDomainSnapshotPtr, int flags); - String virDomainSnapshotGetXMLDesc(DomainSnapshotPointer virDomainSnapshotPtr, int flags); + Pointer virDomainSnapshotGetXMLDesc(DomainSnapshotPointer virDomainSnapshotPtr, int flags); int virDomainSnapshotFree(DomainSnapshotPointer virDomainSnapshotPtr); int virDomainSnapshotListNames(DomainPointer virDomainPtr, Pointer[] names, int nameslen, int flags); DomainSnapshotPointer virDomainSnapshotLookupByName(DomainPointer virDomainPtr, String name, int flags); -- 1.7.9.5

Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/StorageVol.java | 8 +++++++- src/main/java/org/libvirt/jna/Libvirt.java | 2 +- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/libvirt/StorageVol.java b/src/main/java/org/libvirt/StorageVol.java index 7035c93..47b79f6 100644 --- a/src/main/java/org/libvirt/StorageVol.java +++ b/src/main/java/org/libvirt/StorageVol.java @@ -181,7 +181,13 @@ public class StorageVol { * @throws LibvirtException */ public String getXMLDesc(int flags) throws LibvirtException { - return processError(libvirt.virStorageVolGetXMLDesc(VSVP, flags)); + Pointer p = processError(libvirt.virStorageVolGetXMLDesc(VSVP, flags)); + + try { + return Library.getString(p); + } finally { + Library.free(p); + } } /** diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index 97907d0..67b6053 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -327,7 +327,7 @@ public interface Libvirt extends Library { String virStorageVolGetKey(StorageVolPointer storageVolPtr); String virStorageVolGetName(StorageVolPointer storageVolPtr); Pointer virStorageVolGetPath(StorageVolPointer storageVolPtr); - String virStorageVolGetXMLDesc(StorageVolPointer storageVolPtr, int flags); + Pointer virStorageVolGetXMLDesc(StorageVolPointer storageVolPtr, int flags); StorageVolPointer virStorageVolLookupByKey(ConnectionPointer virConnectPtr, String name); StorageVolPointer virStorageVolLookupByName(StoragePoolPointer storagePoolPtr, String name); StorageVolPointer virStorageVolLookupByPath(ConnectionPointer virConnectPtr, String path); -- 1.7.9.5

On Thu, Feb 13, 2014 at 04:22:44PM +0100, Claudio Bley wrote: ACK, if you also add the virEventUpdateTimeout method Regards, Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|

Note: these are only used internally. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Connect.java | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/main/java/org/libvirt/Connect.java b/src/main/java/org/libvirt/Connect.java index 0a45ac8..8ba9691 100644 --- a/src/main/java/org/libvirt/Connect.java +++ b/src/main/java/org/libvirt/Connect.java @@ -34,6 +34,26 @@ import com.sun.jna.ptr.LongByReference; public class Connect { /** + * Event IDs. + */ + private interface DomainEventID { + static final int LIFECYCLE = 0; + static final int REBOOT = 1; + static final int RTC_CHANGE = 2; + static final int WATCHDOG = 3; + static final int IO_ERROR = 4; + static final int GRAPHICS = 5; + static final int IO_ERROR_REASON = 6; + static final int CONTROL_ERROR = 7; + static final int BLOCK_JOB = 8; + static final int DISK_CHANGE = 9; + static final int TRAY_CHANGE = 10; + static final int PMWAKEUP = 11; + static final int PMSUSPEND = 12; + static final int LAST = 13; + } + + /** * Get the version of a connection. * * @see <a -- 1.7.9.5

Remove the public domainEventRegisterAny and domainEventDeregisterAny methods. These methods basically were of no use since the only thing you could register was a "generic" callback. At runtime, you would have to provide a real callback function matching the prototype of the native callback type. Trying to use a generic callback instead quickly leads to failures or JVM crashes. For convenience and the sake of type safety we don't let the user deal with Libvirt.VirDomainEventCallback interfaces directly. Instead, there will be a specific interface definition for each type of callback as we soon shall see. To prevent the garbage collector from reaping registered callback objects every event callback will be stored along with its eventID and corresponding listener instance. This will provide a natural, idiomatic interface using addListener/removeListener methods. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Connect.java | 79 ++++++++++++-------- src/main/java/org/libvirt/event/EventListener.java | 7 ++ src/main/java/org/libvirt/jna/Libvirt.java | 22 ++++-- 3 files changed, 73 insertions(+), 35 deletions(-) create mode 100644 src/main/java/org/libvirt/event/EventListener.java diff --git a/src/main/java/org/libvirt/Connect.java b/src/main/java/org/libvirt/Connect.java index 8ba9691..14668ef 100644 --- a/src/main/java/org/libvirt/Connect.java +++ b/src/main/java/org/libvirt/Connect.java @@ -1,7 +1,10 @@ package org.libvirt; +import java.util.HashMap; +import java.util.Map; import java.util.UUID; +import org.libvirt.event.*; import org.libvirt.jna.ConnectionPointer; import org.libvirt.jna.DevicePointer; import org.libvirt.jna.DomainPointer; @@ -33,6 +36,14 @@ import com.sun.jna.ptr.LongByReference; */ public class Connect { + // registered event listeners by DomainEventID + private Map<EventListener, Integer>[] eventListeners = makeHashMapArray(DomainEventID.LAST); + + @SuppressWarnings("unchecked") + private static <K, V> HashMap<K, V>[] makeHashMapArray(int size) { + return new HashMap[size]; + } + /** * Event IDs. */ @@ -354,42 +365,50 @@ public class Connect { } /** - * Removes an event callback. + * Removes the event listener for the given eventID parameter so + * that it no longer receives events. + * + * @param eventID the domain event identifier + * @param l the event listener + * @throws LibvirtException * * @see <a - * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... - * Documentation</a> - * @param callbackID - * the callback to deregister - * @return <em>ignore</em> (always 0) - * @throws LibvirtException + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * >virConnectDomainEventDeregisterAny</a> */ - public int domainEventDeregisterAny(int callbackID) throws LibvirtException { - return processError(libvirt.virConnectDomainEventDeregisterAny(VCP, callbackID)); + private void domainEventDeregister(int eventID, EventListener l) throws LibvirtException { + if (l == null) + return; + + Map<EventListener, Integer> handlers = eventListeners[eventID]; + + if (handlers == null) return; + + Integer listenerID = handlers.remove(l); + + if (listenerID != null) + processError(libvirt.virConnectDomainEventDeregisterAny(VCP, listenerID)); } - /** - * Adds a callback to receive notifications of arbitrary domain events - * occurring on a domain. - * - * @see <a - * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... - * Documentation</a> - * @param domain - * option domain to limit the events monitored - * @param eventId - * the events to monitor - * @param cb - * the callback function to use. - * @return The return value from this method is a positive integer - * identifier for the callback. - * @throws LibvirtException on failure - */ - public int domainEventRegisterAny(Domain domain, int eventId, Libvirt.VirConnectDomainEventGenericCallback cb) - throws LibvirtException { + private void domainEventRegister(Domain domain, int eventID, Libvirt.VirDomainEventCallback cb, EventListener l) + throws LibvirtException + { + Map<EventListener, Integer> handlers = eventListeners[eventID]; + + if (handlers == null) { + handlers = new HashMap<EventListener, Integer>(); + eventListeners[eventID] = handlers; + } else if (handlers.containsKey(l)) { + return; + } + DomainPointer ptr = domain == null ? null : domain.VDP; - int returnValue = libvirt.virConnectDomainEventRegisterAny(VCP, ptr, eventId, cb, null, null); - return processError(returnValue); + + int ret = processError(libvirt.virConnectDomainEventRegisterAny(VCP, ptr, + eventID, cb, + null, null)); + + handlers.put(l, ret); } /** diff --git a/src/main/java/org/libvirt/event/EventListener.java b/src/main/java/org/libvirt/event/EventListener.java new file mode 100644 index 0000000..fe7e127 --- /dev/null +++ b/src/main/java/org/libvirt/event/EventListener.java @@ -0,0 +1,7 @@ +package org.libvirt.event; + +/** + * Base interface implemented by every event listener. + */ +public interface EventListener { +} diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index ed52bd3..9eb9e86 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -66,6 +66,19 @@ public interface Libvirt extends Library { } /** + * Domain Event Callbacks + */ + + /** + * Common Event Callback super interface. + * + * All domain event callbacks extend this interface. + * + * @see #virConnectDomainEventRegisterAny + */ + interface VirDomainEventCallback extends Callback {} + + /** * Error callback */ interface VirErrorCallback extends Callback { @@ -94,10 +107,6 @@ public interface Libvirt extends Library { void freeCallback(Pointer opaque) ; } - interface VirConnectDomainEventGenericCallback extends Callback { - void eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, Pointer opaque) ; - } - /* * Timeout Callback */ @@ -125,7 +134,10 @@ public interface Libvirt extends Library { int virConnCopyLastError(ConnectionPointer virConnectPtr, virError to); int virConnectClose(ConnectionPointer virConnectPtr); int virConnectCompareCPU(ConnectionPointer virConnectPtr, String xmlDesc, int flags); - int virConnectDomainEventRegisterAny(ConnectionPointer virConnectPtr, DomainPointer virDomainPtr, int eventID, Libvirt.VirConnectDomainEventGenericCallback cb, Pointer opaque, Libvirt.VirFreeCallback freecb); + + // Register Domain Event Callbacks + int virConnectDomainEventRegisterAny(ConnectionPointer virConnectPtr, DomainPointer virDomainPtr, int eventID, VirDomainEventCallback cb, Pointer opaque, Libvirt.VirFreeCallback freecb); + int virConnectDomainEventDeregisterAny(ConnectionPointer virConnectPtr, int callbackID) ; void virConnSetErrorFunc(ConnectionPointer virConnectPtr, Pointer userData, VirErrorCallback callback); int virConnectIsAlive(ConnectionPointer virConnectPtr); -- 1.7.9.5

This method constructs a new Domain class instance while increasing the reference count on the virDomainPtr in order to make sure the Domain object "owns" the given virDomainPtr. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Domain.java | 14 ++++++++++++++ src/main/java/org/libvirt/jna/Libvirt.java | 2 +- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java index 39cb7c5..ec95f5f 100644 --- a/src/main/java/org/libvirt/Domain.java +++ b/src/main/java/org/libvirt/Domain.java @@ -201,6 +201,20 @@ public class Domain { } /** + * Constructs a new Domain object increasing the reference count + * on the DomainPointer. + * <p> + * This factory method is mostly useful with callback functions, + * since the virDomainPtr passed is only valid for the duration of + * execution of the callback. + */ + static Domain constructIncRef(Connect virConnect, DomainPointer VDP) throws LibvirtException { + processError(libvirt.virDomainRef(VDP)); + + return new Domain(virConnect, VDP); + } + + /** * Requests that the current background job be aborted at the soonest * opportunity. This will block until the job has either completed, or * aborted. diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index 9eb9e86..ba8b073 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -31,7 +31,6 @@ import com.sun.jna.ptr.PointerByReference; * * LIBVIRT_0.6.0 * virConnectRef - * virDomainRef * virNetworkRef * virStoragePoolRef * virStorageVolRef @@ -258,6 +257,7 @@ public interface Libvirt extends Library { int virDomainMemoryStats(DomainPointer virDomainPtr, virDomainMemoryStats[] stats, int nr_stats, int flags); int virDomainPinVcpu(DomainPointer virDomainPtr, int vcpu, byte[] cpumap, int maplen); int virDomainReboot(DomainPointer virDomainPtr, int flags); + int virDomainRef(DomainPointer virDomainPtr); int virDomainRestore(ConnectionPointer virConnectPtr, String from); int virDomainRevertToSnapshot(DomainSnapshotPointer virDomainSnapshotPtr, int flags); int virDomainResume(DomainPointer virDomainPtr); -- 1.7.9.5

Add IOErrorActionListener and IOErrorAction enum which is handed to the onIOError callback method when an IO error event occurs. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Connect.java | 59 ++++++++++++++++++++ src/main/java/org/libvirt/Domain.java | 16 ++++++ src/main/java/org/libvirt/Library.java | 20 +++++++ src/main/java/org/libvirt/event/IOErrorAction.java | 39 +++++++++++++ .../java/org/libvirt/event/IOErrorListener.java | 21 +++++++ src/main/java/org/libvirt/jna/Libvirt.java | 8 +++ 6 files changed, 163 insertions(+) create mode 100644 src/main/java/org/libvirt/event/IOErrorAction.java create mode 100644 src/main/java/org/libvirt/event/IOErrorListener.java diff --git a/src/main/java/org/libvirt/Connect.java b/src/main/java/org/libvirt/Connect.java index 14668ef..5637337 100644 --- a/src/main/java/org/libvirt/Connect.java +++ b/src/main/java/org/libvirt/Connect.java @@ -20,6 +20,7 @@ import org.libvirt.jna.virConnectAuth; import org.libvirt.jna.virNodeInfo; import static org.libvirt.Library.libvirt; +import static org.libvirt.Library.getConstant; import static org.libvirt.ErrorHandler.processError; import static org.libvirt.ErrorHandler.processErrorIfZero; @@ -411,6 +412,64 @@ public class Connect { handlers.put(l, ret); } + void domainEventRegister(Domain domain, final IOErrorListener cb) throws LibvirtException { + if (cb == null) + throw new IllegalArgumentException("IOError callback cannot be null"); + + Libvirt.VirConnectDomainEventIOErrorCallback virCB = new Libvirt.VirConnectDomainEventIOErrorCallback() { + @Override + public void eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, + String srcPath, + String devAlias, + int action, + Pointer opaque) { + assert VCP.equals(virConnectPtr); + + try { + Domain d = Domain.constructIncRef(Connect.this, virDomainPointer); + cb.onIOError(d, + srcPath, + devAlias, + getConstant(IOErrorAction.class, action)); + } catch (LibvirtException e) { + throw new RuntimeException("libvirt error in IOError callback", e); + } + } + }; + + domainEventRegister(domain, DomainEventID.IO_ERROR, virCB, cb); + } + + /** + * Adds the specified I/O error listener to receive I/O error events + * for domains of this connection. + * + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * Documentation</a> + * @param l + * the I/O error listener + * @throws LibvirtException on failure + */ + public void addIOErrorListener(final IOErrorListener l) throws LibvirtException { + domainEventRegister(null, l); + } + + /** + * Removes the specified I/O error listener so that it no longer + * receives I/O error events. + * + * @param l the I/O error listener + * @throws LibvirtException + * + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * >virConnectDomainEventDeregisterAny</a> + */ + public void removeIOErrorListener(IOErrorListener l) throws LibvirtException { + domainEventDeregister(DomainEventID.IO_ERROR, l); + } + /** * Finds a domain based on the hypervisor ID number. * diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java index ec95f5f..f37f299 100644 --- a/src/main/java/org/libvirt/Domain.java +++ b/src/main/java/org/libvirt/Domain.java @@ -1,5 +1,6 @@ package org.libvirt; +import org.libvirt.event.IOErrorListener; import org.libvirt.jna.DomainPointer; import org.libvirt.jna.DomainSnapshotPointer; import org.libvirt.jna.Libvirt; @@ -1031,6 +1032,21 @@ public class Domain { } /** + * Adds a callback to receive notifications of IOError domain events + * occurring on this domain. + * + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * Documentation</a> + * @param cb + * the IOErrorCallback instance + * @throws LibvirtException on failure + */ + public void addIOErrorListener(final IOErrorListener cb) throws LibvirtException { + virConnect.domainEventRegister(this, cb); + } + + /** * Revert the domain to a given snapshot. * * @see <a href= diff --git a/src/main/java/org/libvirt/Library.java b/src/main/java/org/libvirt/Library.java index 3cfb8fd..81df223 100644 --- a/src/main/java/org/libvirt/Library.java +++ b/src/main/java/org/libvirt/Library.java @@ -176,4 +176,24 @@ final class Library { null, null); } } + + /** + * Look up a constant of an enum by its ordinal number. + * + * @return the corresponding enum constant when such a constant exists, + * otherwise the element which has the biggest ordinal number + * assigned. + * + * @throws IllegalArgumentException if {@code ordinal} is negative + */ + static <T extends Enum<T>> T getConstant(final Class<T> c, final int ordinal) { + if (ordinal < 0) + throw new IllegalArgumentException("ordinal must be >= 0"); + + T[] a = c.getEnumConstants(); + + assert a.length > 0 : "there must be at least one enum constant"; + + return a[Math.min(ordinal, a.length - 1)]; + } } diff --git a/src/main/java/org/libvirt/event/IOErrorAction.java b/src/main/java/org/libvirt/event/IOErrorAction.java new file mode 100644 index 0000000..bfda1de --- /dev/null +++ b/src/main/java/org/libvirt/event/IOErrorAction.java @@ -0,0 +1,39 @@ +package org.libvirt.event; + +public enum IOErrorAction { + /** + * No action, I/O error ignored. + */ + NONE, + + /** + * Guest CPUs are paused. + */ + PAUSE, + + /** + * I/O error was reported to the guest OS. + */ + REPORT, + + /** + * An unknown action was taken. + */ + UNKNOWN; + + private static final IOErrorAction vals[] = IOErrorAction.values(); + + static { + // make sure that the enum constants have the correct + // ordinal number assigned in correspondence to the + // values of the virDomainEventIOErrorAction enum + // members + + assert NONE.ordinal() == 0; + assert PAUSE.ordinal() == 1; + assert REPORT.ordinal() == 2; + + // must be the last constant + assert UNKNOWN.ordinal() == vals.length - 1; + } +} diff --git a/src/main/java/org/libvirt/event/IOErrorListener.java b/src/main/java/org/libvirt/event/IOErrorListener.java new file mode 100644 index 0000000..efd66c4 --- /dev/null +++ b/src/main/java/org/libvirt/event/IOErrorListener.java @@ -0,0 +1,21 @@ +package org.libvirt.event; + +import org.libvirt.Domain; + +/** + * Interface for receiving domain I/O error events. + */ +public interface IOErrorListener extends EventListener { + /** + * This method gets called upon a domain I/O error event. + * + * @param domain the domain which got an I/O error + * @param srcPath the src of the block device with errors + * @param devAlias the device alias of the block device with errors + * @param action the action that is to be taken due to the I/O error + */ + void onIOError(Domain domain, + String srcPath, + String devAlias, + IOErrorAction action); +} diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index ba8b073..0e36251 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -77,6 +77,14 @@ public interface Libvirt extends Library { */ interface VirDomainEventCallback extends Callback {} + interface VirConnectDomainEventIOErrorCallback extends VirDomainEventCallback { + void eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, + String srcPath, + String devAlias, + int action, + Pointer opaque); + } + /** * Error callback */ -- 1.7.9.5

Add RebootListener interface in package org.libvirt.event and implement addRebootListener methods in classes Domain and Connect. Add removeRebootListener to Connect class. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Connect.java | 41 ++++++++++++++++++++ src/main/java/org/libvirt/Domain.java | 17 ++++++++ .../java/org/libvirt/event/RebootListener.java | 15 +++++++ src/main/java/org/libvirt/jna/Libvirt.java | 4 ++ 4 files changed, 77 insertions(+) create mode 100644 src/main/java/org/libvirt/event/RebootListener.java diff --git a/src/main/java/org/libvirt/Connect.java b/src/main/java/org/libvirt/Connect.java index 5637337..bbbd000 100644 --- a/src/main/java/org/libvirt/Connect.java +++ b/src/main/java/org/libvirt/Connect.java @@ -18,6 +18,7 @@ import org.libvirt.jna.StorageVolPointer; import org.libvirt.jna.StreamPointer; import org.libvirt.jna.virConnectAuth; import org.libvirt.jna.virNodeInfo; +import org.libvirt.event.*; import static org.libvirt.Library.libvirt; import static org.libvirt.Library.getConstant; @@ -455,6 +456,46 @@ public class Connect { domainEventRegister(null, l); } + void domainEventRegister(Domain domain, final RebootListener cb) throws LibvirtException { + if (cb == null) + throw new IllegalArgumentException("RebootCallback cannot be null"); + + Libvirt.VirConnectDomainEventGenericCallback virCB = new Libvirt.VirConnectDomainEventGenericCallback() { + @Override + public void eventCallback(ConnectionPointer virConnectPtr, + DomainPointer virDomainPointer, + Pointer opaque) { + assert VCP.equals(virConnectPtr); + + try { + Domain d = Domain.constructIncRef(Connect.this, virDomainPointer); + cb.onReboot(d); + } catch (LibvirtException e) { + throw new RuntimeException("libvirt error in reboot callback", e); + } + } + }; + + domainEventRegister(domain, DomainEventID.REBOOT, virCB, cb); + } + + /** + * Adds the specified reboot listener to receive reboot events for + * domains of this connection. + * + * @param l the reboot listener + * @throws LibvirtException on failure + * + * @see Domain#addRebootListener + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * >virConnectDomainEventRegisterAny</a> + * @since 1.5.2 + */ + public void addRebootListener(final RebootListener l) throws LibvirtException { + domainEventRegister(null, l); + } + /** * Removes the specified I/O error listener so that it no longer * receives I/O error events. diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java index f37f299..010fee0 100644 --- a/src/main/java/org/libvirt/Domain.java +++ b/src/main/java/org/libvirt/Domain.java @@ -13,6 +13,7 @@ import org.libvirt.jna.virDomainJobInfo; import org.libvirt.jna.virDomainMemoryStats; import org.libvirt.jna.virSchedParameter; import org.libvirt.jna.virVcpuInfo; +import org.libvirt.event.RebootListener; import static org.libvirt.Library.libvirt; import static org.libvirt.ErrorHandler.processError; import static org.libvirt.ErrorHandler.processErrorIfZero; @@ -1047,6 +1048,22 @@ public class Domain { } /** + * Adds the specified listener to receive reboot events for this domain. + * + * @param l the reboot listener + * @throws LibvirtException on failure + * + * @see Connect#addRebootListener + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * >virConnectDomainEventRegisterAny</a> + * @since 1.5.2 + */ + public void addRebootListener(final RebootListener l) throws LibvirtException { + virConnect.domainEventRegister(this, l); + } + + /** * Revert the domain to a given snapshot. * * @see <a href= diff --git a/src/main/java/org/libvirt/event/RebootListener.java b/src/main/java/org/libvirt/event/RebootListener.java new file mode 100644 index 0000000..1b440c0 --- /dev/null +++ b/src/main/java/org/libvirt/event/RebootListener.java @@ -0,0 +1,15 @@ +package org.libvirt.event; + +import org.libvirt.Domain; + +/** + * Interface for receiving domain reboot events. + */ +public interface RebootListener extends EventListener { + /** + * This method gets called upon a domain reboot event. + * + * @param domain the domain which was rebooted + */ + void onReboot(Domain domain); +} diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index 0e36251..913fe08 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -85,6 +85,10 @@ public interface Libvirt extends Library { Pointer opaque); } + interface VirConnectDomainEventGenericCallback extends VirDomainEventCallback { + void eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, Pointer opaque); + } + /** * Error callback */ -- 1.7.9.5

Add LifecycleListener interface which needs to be implemented when the user wishes to receive lifecycle change events on domains. The DomainEvent class represents the kind of event that occurred including details on that event. Signed-off-by: Claudio Bley <cbley(a)av-test.de&gt; --- src/main/java/org/libvirt/Connect.java | 66 ++++++++++++++++++ src/main/java/org/libvirt/Domain.java | 18 +++++ src/main/java/org/libvirt/event/CrashedDetail.java | 15 +++++ src/main/java/org/libvirt/event/DefinedDetail.java | 17 +++++ src/main/java/org/libvirt/event/DetailInfo.java | 5 ++ src/main/java/org/libvirt/event/DomainEvent.java | 71 ++++++++++++++++++++ .../java/org/libvirt/event/DomainEventDetail.java | 7 ++ .../java/org/libvirt/event/DomainEventType.java | 60 +++++++++++++++++ .../java/org/libvirt/event/LifecycleListener.java | 24 +++++++ .../java/org/libvirt/event/PMSuspendedDetail.java | 15 +++++ src/main/java/org/libvirt/event/ResumedDetail.java | 20 ++++++ .../java/org/libvirt/event/ShutdownDetail.java | 12 ++++ src/main/java/org/libvirt/event/StartedDetail.java | 30 +++++++++ src/main/java/org/libvirt/event/StoppedDetail.java | 40 +++++++++++ .../java/org/libvirt/event/SuspendedDetail.java | 40 +++++++++++ .../java/org/libvirt/event/UndefinedDetail.java | 7 ++ src/main/java/org/libvirt/jna/Libvirt.java | 7 ++ 17 files changed, 454 insertions(+) create mode 100644 src/main/java/org/libvirt/event/CrashedDetail.java create mode 100644 src/main/java/org/libvirt/event/DefinedDetail.java create mode 100644 src/main/java/org/libvirt/event/DetailInfo.java create mode 100644 src/main/java/org/libvirt/event/DomainEvent.java create mode 100644 src/main/java/org/libvirt/event/DomainEventDetail.java create mode 100644 src/main/java/org/libvirt/event/DomainEventType.java create mode 100644 src/main/java/org/libvirt/event/LifecycleListener.java create mode 100644 src/main/java/org/libvirt/event/PMSuspendedDetail.java create mode 100644 src/main/java/org/libvirt/event/ResumedDetail.java create mode 100644 src/main/java/org/libvirt/event/ShutdownDetail.java create mode 100644 src/main/java/org/libvirt/event/StartedDetail.java create mode 100644 src/main/java/org/libvirt/event/StoppedDetail.java create mode 100644 src/main/java/org/libvirt/event/SuspendedDetail.java create mode 100644 src/main/java/org/libvirt/event/UndefinedDetail.java diff --git a/src/main/java/org/libvirt/Connect.java b/src/main/java/org/libvirt/Connect.java index bbbd000..d82dba2 100644 --- a/src/main/java/org/libvirt/Connect.java +++ b/src/main/java/org/libvirt/Connect.java @@ -479,6 +479,72 @@ public class Connect { domainEventRegister(domain, DomainEventID.REBOOT, virCB, cb); } + void domainEventRegister(Domain domain, final LifecycleListener cb) throws LibvirtException { + if (cb == null) + throw new IllegalArgumentException("LifecycleCallback cannot be null"); + + Libvirt.VirConnectDomainEventCallback virCB = new Libvirt.VirConnectDomainEventCallback() { + @Override + public int eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, + final int eventCode, + final int detailCode, + Pointer opaque) { + assert VCP.equals(virConnectPtr); + + try { + Domain dom = Domain.constructIncRef(Connect.this, virDomainPointer); + DomainEventType type = getConstant(DomainEventType.class, eventCode); + DomainEvent event = new DomainEvent(type, detailCode); + + cb.onLifecycleChange(dom, event); + } catch (LibvirtException e) { + throw new RuntimeException("libvirt error in lifecycle callback", e); + } + + // always return 0, regardless of what the + // callback method returned. This may need to be + // changed in the future, in case the return value + // is used for something by libvirt. + return 0; + } + }; + + domainEventRegister(domain, DomainEventID.LIFECYCLE, virCB, cb); + } + + /** + * Adds the specified listener to receive lifecycle events for + * domains of this connections. + * + * @param l the lifecycle listener + * @throws LibvirtException on failure + * + * @see #removeLifecycleListener + * @see Domain#addLifecycleListener + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * >virConnectDomainEventRegisterAny</a> + */ + public void addLifecycleListener(final LifecycleListener l) throws LibvirtException + { + domainEventRegister(null, l); + } + + /** + * Removes the specified I/O error listener so that it no longer + * receives I/O error events. + * + * @param l the I/O error listener + * @throws LibvirtException + * + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * >virConnectDomainEventDeregisterAny</a> + */ + public void removeLifecycleListener(LifecycleListener l) throws LibvirtException { + domainEventDeregister(DomainEventID.LIFECYCLE, l); + } + /** * Adds the specified reboot listener to receive reboot events for * domains of this connection. diff --git a/src/main/java/org/libvirt/Domain.java b/src/main/java/org/libvirt/Domain.java index 010fee0..fb59781 100644 --- a/src/main/java/org/libvirt/Domain.java +++ b/src/main/java/org/libvirt/Domain.java @@ -14,6 +14,7 @@ import org.libvirt.jna.virDomainMemoryStats; import org.libvirt.jna.virSchedParameter; import org.libvirt.jna.virVcpuInfo; import org.libvirt.event.RebootListener; +import org.libvirt.event.LifecycleListener; import static org.libvirt.Library.libvirt; import static org.libvirt.ErrorHandler.processError; import static org.libvirt.ErrorHandler.processErrorIfZero; @@ -1064,6 +1065,23 @@ public class Domain { } /** + * Adds the specified listener to receive lifecycle events for this domain. + * + * @param l the lifecycle listener + * @throws LibvirtException on failure + * + * @see Connect#addLifecycleListener + * @see Connect#removeLifecycleListener + * @see <a + * href="http://www.libvirt.org/html/libvirt-libvirt.html#virConnectDom... + * >virConnectDomainEventRegisterAny</a> + */ + public void addLifecycleListener(final LifecycleListener l) throws LibvirtException + { + virConnect.domainEventRegister(this, l); + } + + /** * Revert the domain to a given snapshot. * * @see <a href= diff --git a/src/main/java/org/libvirt/event/CrashedDetail.java b/src/main/java/org/libvirt/event/CrashedDetail.java new file mode 100644 index 0000000..638a901 --- /dev/null +++ b/src/main/java/org/libvirt/event/CrashedDetail.java @@ -0,0 +1,15 @@ +package org.libvirt.event; + +/** + * Details about a CRASHED domain event + * + * @see DomainEvent + */ +public enum CrashedDetail implements DomainEventDetail { + /** + * Guest was panicked. + */ + PANICKED, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/event/DefinedDetail.java b/src/main/java/org/libvirt/event/DefinedDetail.java new file mode 100644 index 0000000..f0220f0 --- /dev/null +++ b/src/main/java/org/libvirt/event/DefinedDetail.java @@ -0,0 +1,17 @@ +package org.libvirt.event; + +import org.libvirt.Domain; + +public enum DefinedDetail implements DomainEventDetail { + /** + * Newly created config file. + */ + ADDED, + + /** + * Changed config file. + */ + UPDATED, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/event/DetailInfo.java b/src/main/java/org/libvirt/event/DetailInfo.java new file mode 100644 index 0000000..c2572b9 --- /dev/null +++ b/src/main/java/org/libvirt/event/DetailInfo.java @@ -0,0 +1,5 @@ +package org.libvirt.event; + +// public interface DetailInfo { +// <T extends Enum<T>> T detail(final DomainEventDetail d); +// } diff --git a/src/main/java/org/libvirt/event/DomainEvent.java b/src/main/java/org/libvirt/event/DomainEvent.java new file mode 100644 index 0000000..21fac60 --- /dev/null +++ b/src/main/java/org/libvirt/event/DomainEvent.java @@ -0,0 +1,71 @@ +package org.libvirt.event; + +/** + * Contains information about a life cycle change of a domain. + * <p> + * This includes the domain event that occurred together with + * further details about that event. + * <p> + * Usage: + * <pre>{@code + * int onLifecycleChange(Domain dom, DomainEvent info) { + * switch (info.getType()) { + * case STARTED: + * StartedDetail detail = info.getDetail(); + * + * switch (detail) { + * case BOOTED: + * ... + * break; + * ... + * } + * } + * } + * }}</pre> + * <p> + * Note, that a ClassCastException will be thrown at runtime when + * assigning to the wrong detail enumeration type: + * <pre>{@code + * DomainEvent info; + * + * if (info.getType() == DomainEventType.STARTED) { + * // info.getDetails() returns a StartedDetail enum + * StoppedDetail detail = info.getDetail(); // throws ClassCastException + * }}</pre> + * + * @see LifecycleListener + * @since 1.5.2 + */ +public final class DomainEvent { + private final DomainEventType type; + private final int detail; + + public DomainEvent(DomainEventType type, int code) { + this.type = type; + this.detail = code; + } + + /** + * Returns the type of event which occurred. + */ + public DomainEventType getType() { + return this.type; + } + + /** + * Returns the corresponding domain event detail in regard to + * the DomainEventType of this instance. + * + * @return a constant of one of the enums implementing the + * {@link DomainEventDetail} interface + */ + public <T extends Enum<T> & DomainEventDetail> T getDetail() { + return this.type.obtain(this.detail); + } + + @Override + public String toString() { + Object d = this.type.safeAt(this.detail); + return this.type + " (" + d + ")"; + } +} diff --git a/src/main/java/org/libvirt/event/DomainEventDetail.java b/src/main/java/org/libvirt/event/DomainEventDetail.java new file mode 100644 index 0000000..59ef5aa --- /dev/null +++ b/src/main/java/org/libvirt/event/DomainEventDetail.java @@ -0,0 +1,7 @@ +package org.libvirt.event; + +/** + * A common interface for all domain event detail enums. + */ +public interface DomainEventDetail { +} diff --git a/src/main/java/org/libvirt/event/DomainEventType.java b/src/main/java/org/libvirt/event/DomainEventType.java new file mode 100644 index 0000000..b675d8b --- /dev/null +++ b/src/main/java/org/libvirt/event/DomainEventType.java @@ -0,0 +1,60 @@ +package org.libvirt.event; + +/** + * Enum constants representing the type of event occurred on + * a domain + */ +public enum DomainEventType { + /** A domain was defined */ + DEFINED(DefinedDetail.values()), + + /** A domain was undefined */ + UNDEFINED(UndefinedDetail.values()), + + /** A domain was started */ + STARTED(StartedDetail.values()), + + /** A domain was suspended */ + SUSPENDED(SuspendedDetail.values()), + + /** A domain was resumed */ + RESUMED(ResumedDetail.values()), + + /** A domain was stopped */ + STOPPED(StoppedDetail.values()), + + /** A domain was shut down */ + SHUTDOWN(ShutdownDetail.values()), + + /** A domain was PM suspended */ + PMSUSPENDED(PMSuspendedDetail.values()), + + /** A domain crashed */ + CRASHED(CrashedDetail.values()), + + /** + * An unknown event occured + * + * This can happen if upstream libvirt adds more event types + * that this library does not yet know about. + */ + UNKNOWN(null); + + private final Object[] details; + + DomainEventType(Object[] d) { + details = d; + } + + @SuppressWarnings("unchecked") + <T extends Enum<T>> T obtain(final int detail) { + return (T)safeAt(detail); + } + + // this method is only necessary for OpenJDK 6 which does not + // compile calls to `obtain(d)` in some circumstances + Object safeAt(final int detail) { + final int index = Math.min(this.details.length - 1, detail); + return this.details[index]; + } +} diff --git a/src/main/java/org/libvirt/event/LifecycleListener.java b/src/main/java/org/libvirt/event/LifecycleListener.java new file mode 100644 index 0000000..78d7419 --- /dev/null +++ b/src/main/java/org/libvirt/event/LifecycleListener.java @@ -0,0 +1,24 @@ +package org.libvirt.event; + +import org.libvirt.Domain; + +/** + * Interface for receiving events occurring on a domain. + * + * @see <a href="http://libvirt.org/html/libvirt-libvirt.html#virConnectDomainE... + */ +public interface LifecycleListener extends EventListener { + + /** + * This method gets called when a change in the lifecycle + * of a domain occurs. + * + * @param domain the domain on which the event occurred + * @param event contains information about the type of event + * that occurred and details about that event + * + * @return the return value is currently ignored. + */ + int onLifecycleChange(Domain domain, + DomainEvent event); +} diff --git a/src/main/java/org/libvirt/event/PMSuspendedDetail.java b/src/main/java/org/libvirt/event/PMSuspendedDetail.java new file mode 100644 index 0000000..05e5ee0 --- /dev/null +++ b/src/main/java/org/libvirt/event/PMSuspendedDetail.java @@ -0,0 +1,15 @@ +package org.libvirt.event; + +public enum PMSuspendedDetail implements DomainEventDetail { + /** + * Guest was PM suspended to memory. + */ + MEMORY, + + /** + * Guest was PM suspended to disk. + */ + DISK, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/event/ResumedDetail.java b/src/main/java/org/libvirt/event/ResumedDetail.java new file mode 100644 index 0000000..55bcf4a --- /dev/null +++ b/src/main/java/org/libvirt/event/ResumedDetail.java @@ -0,0 +1,20 @@ +package org.libvirt.event; + +public enum ResumedDetail implements DomainEventDetail { + /** + * Normal resume due to admin unpause. + */ + UNPAUSED, + + /** + * Resumed for completion of migration. + */ + MIGRATED, + + /** + * Resumed from snapshot. + */ + FROM_SNAPSHOT, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/event/ShutdownDetail.java b/src/main/java/org/libvirt/event/ShutdownDetail.java new file mode 100644 index 0000000..8975831 --- /dev/null +++ b/src/main/java/org/libvirt/event/ShutdownDetail.java @@ -0,0 +1,12 @@ +package org.libvirt.event; + +public enum ShutdownDetail implements DomainEventDetail { + /** + * Guest finished shutdown sequence. + */ + FINISHED, + + UNKNOWN +} + + diff --git a/src/main/java/org/libvirt/event/StartedDetail.java b/src/main/java/org/libvirt/event/StartedDetail.java new file mode 100644 index 0000000..12c52bc --- /dev/null +++ b/src/main/java/org/libvirt/event/StartedDetail.java @@ -0,0 +1,30 @@ +package org.libvirt.event; + +public enum StartedDetail implements DomainEventDetail { + /** + * Normal startup from boot. + */ + BOOTED, + + /** + * Incoming migration from another host. + */ + MIGRATED, + + /** + * Restored from a state file. + */ + RESTORED, + + /** + * Restored from snapshot + */ + FROM_SNAPSHOT, + + /** + * Started due to wakeup event. + */ + WAKEUP, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/event/StoppedDetail.java b/src/main/java/org/libvirt/event/StoppedDetail.java new file mode 100644 index 0000000..53e25e9 --- /dev/null +++ b/src/main/java/org/libvirt/event/StoppedDetail.java @@ -0,0 +1,40 @@ +package org.libvirt.event; + +public enum StoppedDetail implements DomainEventDetail { + /** + * Normal shutdown. + */ + SHUTDOWN, + + /** + * Forced poweroff from host. + */ + DESTROYED, + + /** + * Guest crashed. + */ + CRASHED, + + /** + * Migrated off to another host. + */ + MIGRATED, + + /** + * Saved to a state file. + */ + SAVED, + + /** + * Host emulator/mgmt failed. + */ + FAILED, + + /** + * Offline snapshot was loaded. + */ + FROM_SNAPSHOT, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/event/SuspendedDetail.java b/src/main/java/org/libvirt/event/SuspendedDetail.java new file mode 100644 index 0000000..9862052 --- /dev/null +++ b/src/main/java/org/libvirt/event/SuspendedDetail.java @@ -0,0 +1,40 @@ +package org.libvirt.event; + +public enum SuspendedDetail implements DomainEventDetail { + /** + * Normal suspend due to admin pause. + */ + PAUSED, + + /** + * Suspended for offline migration. + */ + MIGRATED, + + /** + * Suspended due to a disk I/O error. + */ + IOERROR, + + /** + * Suspended due to a watchdog firing. + */ + WATCHDOG, + + /** + * Restored from paused state file. + */ + RESTORED, + + /** + * Restored from paused snapshot. + */ + FROM_SNAPSHOT, + + /** + * Suspended after failure during libvirt API call. + */ + API_ERROR, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/event/UndefinedDetail.java b/src/main/java/org/libvirt/event/UndefinedDetail.java new file mode 100644 index 0000000..ec814f1 --- /dev/null +++ b/src/main/java/org/libvirt/event/UndefinedDetail.java @@ -0,0 +1,7 @@ +package org.libvirt.event; + +public enum UndefinedDetail implements DomainEventDetail { + REMOVED, + + UNKNOWN +} diff --git a/src/main/java/org/libvirt/jna/Libvirt.java b/src/main/java/org/libvirt/jna/Libvirt.java index 913fe08..5bb9fa0 100644 --- a/src/main/java/org/libvirt/jna/Libvirt.java +++ b/src/main/java/org/libvirt/jna/Libvirt.java @@ -89,6 +89,13 @@ public interface Libvirt extends Library { void eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, Pointer opaque); } + interface VirConnectDomainEventCallback extends VirDomainEventCallback { + int eventCallback(ConnectionPointer virConnectPtr, DomainPointer virDomainPointer, + int event, + int detail, + Pointer opaque); + } + /** * Error callback */ -- 1.7.9.5

On Sat, Nov 01, 2014 at 10:40:06PM +0100, Claudio Bley wrote: Sounds good, thanks for all the improvements you've done on the Java work Regards, Daniel -- |: http://berrange.com -o- http://www.flickr.com/photos/dberrange/ :| |: http://libvirt.org -o- http://virt-manager.org :| |: http://autobuild.org -o- http://search.cpan.org/~danberr/ :| |: http://entangle-photo.org -o- http://live.gnome.org/gtk-vnc :|

At Fri, 21 Feb 2014 11:21:17 +0000, Daniel P. Berrange wrote: Sure thing. I've pushed this a couple of minutes ago under the trivial rule: ---------------------------------------------------------------------- commit c04d0aef148e9f89b08a4ccbfc17b17e2e4c8caf Author: Claudio Bley <cbley(a)av-test.de&gt; Date: Wed Mar 26 10:50:41 2014 +0100 Take over libvirt-java as the primary maintainer diff --git a/AUTHORS b/AUTHORS index 8404152..07809bf 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,6 +1,10 @@ Packaging Daniel Veillard <veillard(a)redhat.com&gt; Initial code base from Tóth István <stoty(a)tvnet.hu&gt; +Primary maintainer: + +Claudio Bley <cbley(a)av-test.de&gt; + Patches provided by: Daniel Schwager <Daniel.Schwager(a)dtnet.de&gt; @@ -11,5 +15,4 @@ Luis Carlos Moreira da Costa <tcljava(a)gmail.com&gt; Andrea Sansottera <andrea.sansottera(a)gmail.com&gt; Stefan Majer <stefan.majer(a)gmail.com&gt; Wido den Hollander <wido(a)widodh.nl&gt; -Claudio Bley <cbley(a)av-test.de&gt; Eric Blake <eblake(a)redhat.com&gt; ---------------------------------------------------------------------- Regards, Claudio