X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=java%2Fcom%2Fredhat%2Fet%2Flibguestfs%2FGuestFS.java;h=70efb8d0247b73cb9b355a3721299eb693b002d5;hp=5b8162388a02e6213f7be5d6aa694f3688277085;hb=45d78361d791f4a752fca9472b81bdc75f9f92a4;hpb=36f9dac1a2530b575dab9226f6ddd85e6e8c8590 diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java index 5b81623..70efb8d 100644 --- a/java/com/redhat/et/libguestfs/GuestFS.java +++ b/java/com/redhat/et/libguestfs/GuestFS.java @@ -535,6 +535,27 @@ public class GuestFS { throws LibGuestFSException; /** + * leave the busy state + * + * This sets the state to "READY", or if in "CONFIG" then + * it leaves the state as is. This is only used when + * implementing actions using the low-level API. + * + * For more information on states, see guestfs(3). + * + * @throws LibGuestFSException + */ + public void end_busy () + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("end_busy: handle is closed"); + _end_busy (g); + } + private native void _end_busy (long g) + throws LibGuestFSException; + + /** * mount a guest disk at a position in the filesystem * * Mount a guest disk at a position in the filesystem. @@ -1420,7 +1441,7 @@ public class GuestFS { * make a filesystem * * This creates a filesystem on "device" (usually a - * partition of LVM logical volume). The filesystem type is + * partition or LVM logical volume). The filesystem type is * "fstype", for example "ext3". * * @throws LibGuestFSException @@ -1487,6 +1508,11 @@ public class GuestFS { * calculated using "strlen" (so in this case the content * cannot contain embedded ASCII NULs). * + * *NB.* Owing to a bug, writing content containing ASCII + * NUL characters does *not* work, even if the length is + * specified. We hope to resolve this bug in a future + * version. In the meantime use "g.upload". + * * Because of the message protocol, there is a transfer * limit of somewhere between 2MB and 4MB. To transfer * large files you should use FTP. @@ -1620,6 +1646,13 @@ public class GuestFS { * Subsequent elements are parameters. The list must be * non-empty (ie. must contain a program name). * + * The return value is anything printed to *stdout* by the + * command. + * + * If the command returns a non-zero exit status, then this + * function returns an error message. The error message + * string is the content of *stderr* from the command. + * * The $PATH environment variable will contain at least * "/usr/bin" and "/bin". If you require a program from * another location, you should provide the full path in @@ -1631,6 +1664,10 @@ public class GuestFS { * ensure all filesystems that are needed are mounted at * the right locations. * + * Because of the message protocol, there is a transfer + * limit of somewhere between 2MB and 4MB. To transfer + * large files you should use FTP. + * * @throws LibGuestFSException */ public String command (String[] arguments) @@ -1649,6 +1686,10 @@ public class GuestFS { * This is the same as "g.command", but splits the result * into a list of lines. * + * Because of the message protocol, there is a transfer + * limit of somewhere between 2MB and 4MB. To transfer + * large files you should use FTP. + * * @throws LibGuestFSException */ public String[] command_lines (String[] arguments) @@ -2414,4 +2455,242 @@ public class GuestFS { private native void _zero (long g, String device) throws LibGuestFSException; + /** + * install GRUB + * + * This command installs GRUB (the Grand Unified + * Bootloader) on "device", with the root directory being + * "root". + * + * @throws LibGuestFSException + */ + public void grub_install (String root, String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("grub_install: handle is closed"); + _grub_install (g, root, device); + } + private native void _grub_install (long g, String root, String device) + throws LibGuestFSException; + + /** + * copy a file + * + * This copies a file from "src" to "dest" where "dest" is + * either a destination filename or destination directory. + * + * @throws LibGuestFSException + */ + public void cp (String src, String dest) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("cp: handle is closed"); + _cp (g, src, dest); + } + private native void _cp (long g, String src, String dest) + throws LibGuestFSException; + + /** + * copy a file or directory recursively + * + * This copies a file or directory from "src" to "dest" + * recursively using the "cp -a" command. + * + * @throws LibGuestFSException + */ + public void cp_a (String src, String dest) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("cp_a: handle is closed"); + _cp_a (g, src, dest); + } + private native void _cp_a (long g, String src, String dest) + throws LibGuestFSException; + + /** + * move a file + * + * This moves a file from "src" to "dest" where "dest" is + * either a destination filename or destination directory. + * + * @throws LibGuestFSException + */ + public void mv (String src, String dest) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("mv: handle is closed"); + _mv (g, src, dest); + } + private native void _mv (long g, String src, String dest) + throws LibGuestFSException; + + /** + * drop kernel page cache, dentries and inodes + * + * This instructs the guest kernel to drop its page cache, + * and/or dentries and inode caches. The parameter + * "whattodrop" tells the kernel what precisely to drop, + * see + * + * Setting "whattodrop" to 3 should drop everything. + * + * This automatically calls sync(2) before the operation, + * so that the maximum guest memory is freed. + * + * @throws LibGuestFSException + */ + public void drop_caches (int whattodrop) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("drop_caches: handle is closed"); + _drop_caches (g, whattodrop); + } + private native void _drop_caches (long g, int whattodrop) + throws LibGuestFSException; + + /** + * return kernel messages + * + * This returns the kernel messages ("dmesg" output) from + * the guest kernel. This is sometimes useful for extended + * debugging of problems. + * + * Another way to get the same information is to enable + * verbose messages with "g.set_verbose" or by setting the + * environment variable "LIBGUESTFS_DEBUG=1" before running + * the program. + * + * @throws LibGuestFSException + */ + public String dmesg () + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("dmesg: handle is closed"); + return _dmesg (g); + } + private native String _dmesg (long g) + throws LibGuestFSException; + + /** + * ping the guest daemon + * + * This is a test probe into the guestfs daemon running + * inside the qemu subprocess. Calling this function checks + * that the daemon responds to the ping message, without + * affecting the daemon or attached block device(s) in any + * other way. + * + * @throws LibGuestFSException + */ + public void ping_daemon () + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("ping_daemon: handle is closed"); + _ping_daemon (g); + } + private native void _ping_daemon (long g) + throws LibGuestFSException; + + /** + * test if two files have equal contents + * + * This compares the two files "file1" and "file2" and + * returns true if their content is exactly equal, or false + * otherwise. + * + * The external cmp(1) program is used for the comparison. + * + * @throws LibGuestFSException + */ + public boolean equal (String file1, String file2) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("equal: handle is closed"); + return _equal (g, file1, file2); + } + private native boolean _equal (long g, String file1, String file2) + throws LibGuestFSException; + + /** + * print the printable strings in a file + * + * This runs the strings(1) command on a file and returns + * the list of printable strings found. + * + * Because of the message protocol, there is a transfer + * limit of somewhere between 2MB and 4MB. To transfer + * large files you should use FTP. + * + * @throws LibGuestFSException + */ + public String[] strings (String path) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("strings: handle is closed"); + return _strings (g, path); + } + private native String[] _strings (long g, String path) + throws LibGuestFSException; + + /** + * print the printable strings in a file + * + * This is like the "g.strings" command, but allows you to + * specify the encoding. + * + * See the strings(1) manpage for the full list of + * encodings. + * + * Commonly useful encodings are "l" (lower case L) which + * will show strings inside Windows/x86 files. + * + * The returned strings are transcoded to UTF-8. + * + * Because of the message protocol, there is a transfer + * limit of somewhere between 2MB and 4MB. To transfer + * large files you should use FTP. + * + * @throws LibGuestFSException + */ + public String[] strings_e (String encoding, String path) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("strings_e: handle is closed"); + return _strings_e (g, encoding, path); + } + private native String[] _strings_e (long g, String encoding, String path) + throws LibGuestFSException; + + /** + * dump a file in hexadecimal + * + * This runs "hexdump -C" on the given "path". The result + * is the human-readable, canonical hex dump of the file. + * + * Because of the message protocol, there is a transfer + * limit of somewhere between 2MB and 4MB. To transfer + * large files you should use FTP. + * + * @throws LibGuestFSException + */ + public String hexdump (String path) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("hexdump: handle is closed"); + return _hexdump (g, path); + } + private native String _hexdump (long g, String path) + throws LibGuestFSException; + }