X-Git-Url: http://git.annexia.org/?p=libguestfs.git;a=blobdiff_plain;f=java%2Fcom%2Fredhat%2Fet%2Flibguestfs%2FGuestFS.java;h=6e2304e6db9b9715e4fd039b526392a5337595a6;hp=0d9ae9dfb12a958823cb55d9900b496959a387e5;hb=3e408f493496597dc026d20778837f421f05a9dd;hpb=0faa5dde7b992ba11bb88f77b3424676c7c492e4 diff --git a/java/com/redhat/et/libguestfs/GuestFS.java b/java/com/redhat/et/libguestfs/GuestFS.java index 0d9ae9d..6e2304e 100644 --- a/java/com/redhat/et/libguestfs/GuestFS.java +++ b/java/com/redhat/et/libguestfs/GuestFS.java @@ -229,10 +229,6 @@ public class GuestFS { * You can also override this by setting the * "LIBGUESTFS_QEMU" environment variable. * - * The string "qemu" is stashed in the libguestfs handle, - * so the caller must make sure it remains valid for the - * lifetime of the handle. - * * Setting "qemu" to "NULL" restores the default qemu * binary. * @@ -277,10 +273,6 @@ public class GuestFS { * The default is "$libdir/guestfs" unless overridden by * setting "LIBGUESTFS_PATH" environment variable. * - * The string "path" is stashed in the libguestfs handle, - * so the caller must make sure it remains valid for the - * lifetime of the handle. - * * Setting "path" to "NULL" restores the default path. * * @throws LibGuestFSException @@ -316,6 +308,50 @@ public class GuestFS { throws LibGuestFSException; /** + * add options to kernel command line + * + * This function is used to add additional options to the + * guest kernel command line. + * + * The default is "NULL" unless overridden by setting + * "LIBGUESTFS_APPEND" environment variable. + * + * Setting "append" to "NULL" means *no* additional options + * are passed (libguestfs always adds a few of its own). + * + * @throws LibGuestFSException + */ + public void set_append (String append) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("set_append: handle is closed"); + _set_append (g, append); + } + private native void _set_append (long g, String append) + throws LibGuestFSException; + + /** + * get the additional kernel options + * + * Return the additional kernel options which are added to + * the guest kernel command line. + * + * If "NULL" then no options are added. + * + * @throws LibGuestFSException + */ + public String get_append () + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("get_append: handle is closed"); + return _get_append (g); + } + private native String _get_append (long g) + throws LibGuestFSException; + + /** * set autosync mode * * If "autosync" is true, this enables autosync. Libguestfs @@ -535,6 +571,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. @@ -1461,6 +1518,8 @@ public class GuestFS { * you would pass "lines" as a single element list, when * the single element being the string "," (comma). * + * See also: "g.sfdisk_l", "g.sfdisk_N" + * * This command is dangerous. Without careful use you can * easily destroy all your data. * @@ -1625,6 +1684,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 @@ -1636,6 +1702,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) @@ -1654,6 +1724,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) @@ -2657,4 +2731,294 @@ public class GuestFS { private native String _hexdump (long g, String path) throws LibGuestFSException; + /** + * zero unused inodes and disk blocks on ext2/3 filesystem + * + * This runs the *zerofree* program on "device". This + * program claims to zero unused inodes and disk blocks on + * an ext2/3 filesystem, thus making it possible to + * compress the filesystem more effectively. + * + * You should not run this program if the filesystem is + * mounted. + * + * It is possible that using this program can damage the + * filesystem or data on the filesystem. + * + * @throws LibGuestFSException + */ + public void zerofree (String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("zerofree: handle is closed"); + _zerofree (g, device); + } + private native void _zerofree (long g, String device) + throws LibGuestFSException; + + /** + * resize an LVM physical volume + * + * This resizes (expands or shrinks) an existing LVM + * physical volume to match the new size of the underlying + * device. + * + * @throws LibGuestFSException + */ + public void pvresize (String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("pvresize: handle is closed"); + _pvresize (g, device); + } + private native void _pvresize (long g, String device) + throws LibGuestFSException; + + /** + * modify a single partition on a block device + * + * This runs sfdisk(8) option to modify just the single + * partition "n" (note: "n" counts from 1). + * + * For other parameters, see "g.sfdisk". You should usually + * pass 0 for the cyls/heads/sectors parameters. + * + * This command is dangerous. Without careful use you can + * easily destroy all your data. + * + * @throws LibGuestFSException + */ + public void sfdisk_N (String device, int n, int cyls, int heads, int sectors, String line) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("sfdisk_N: handle is closed"); + _sfdisk_N (g, device, n, cyls, heads, sectors, line); + } + private native void _sfdisk_N (long g, String device, int n, int cyls, int heads, int sectors, String line) + throws LibGuestFSException; + + /** + * display the partition table + * + * This displays the partition table on "device", in the + * human-readable output of the sfdisk(8) command. It is + * not intended to be parsed. + * + * @throws LibGuestFSException + */ + public String sfdisk_l (String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("sfdisk_l: handle is closed"); + return _sfdisk_l (g, device); + } + private native String _sfdisk_l (long g, String device) + throws LibGuestFSException; + + /** + * display the kernel geometry + * + * This displays the kernel's idea of the geometry of + * "device". + * + * The result is in human-readable format, and not designed + * to be parsed. + * + * @throws LibGuestFSException + */ + public String sfdisk_kernel_geometry (String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("sfdisk_kernel_geometry: handle is closed"); + return _sfdisk_kernel_geometry (g, device); + } + private native String _sfdisk_kernel_geometry (long g, String device) + throws LibGuestFSException; + + /** + * display the disk geometry from the partition table + * + * This displays the disk geometry of "device" read from + * the partition table. Especially in the case where the + * underlying block device has been resized, this can be + * different from the kernel's idea of the geometry (see + * "g.sfdisk_kernel_geometry"). + * + * The result is in human-readable format, and not designed + * to be parsed. + * + * @throws LibGuestFSException + */ + public String sfdisk_disk_geometry (String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("sfdisk_disk_geometry: handle is closed"); + return _sfdisk_disk_geometry (g, device); + } + private native String _sfdisk_disk_geometry (long g, String device) + throws LibGuestFSException; + + /** + * activate or deactivate all volume groups + * + * This command activates or (if "activate" is false) + * deactivates all logical volumes in all volume groups. If + * activated, then they are made known to the kernel, ie. + * they appear as "/dev/mapper" devices. If deactivated, + * then those devices disappear. + * + * This command is the same as running "vgchange -a y|n" + * + * @throws LibGuestFSException + */ + public void vg_activate_all (boolean activate) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("vg_activate_all: handle is closed"); + _vg_activate_all (g, activate); + } + private native void _vg_activate_all (long g, boolean activate) + throws LibGuestFSException; + + /** + * activate or deactivate some volume groups + * + * This command activates or (if "activate" is false) + * deactivates all logical volumes in the listed volume + * groups "volgroups". If activated, then they are made + * known to the kernel, ie. they appear as "/dev/mapper" + * devices. If deactivated, then those devices disappear. + * + * This command is the same as running "vgchange -a y|n + * volgroups..." + * + * Note that if "volgroups" is an empty list then all + * volume groups are activated or deactivated. + * + * @throws LibGuestFSException + */ + public void vg_activate (boolean activate, String[] volgroups) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("vg_activate: handle is closed"); + _vg_activate (g, activate, volgroups); + } + private native void _vg_activate (long g, boolean activate, String[] volgroups) + throws LibGuestFSException; + + /** + * resize an LVM logical volume + * + * This resizes (expands or shrinks) an existing LVM + * logical volume to "mbytes". When reducing, data in the + * reduced part is lost. + * + * @throws LibGuestFSException + */ + public void lvresize (String device, int mbytes) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("lvresize: handle is closed"); + _lvresize (g, device, mbytes); + } + private native void _lvresize (long g, String device, int mbytes) + throws LibGuestFSException; + + /** + * resize an ext2/ext3 filesystem + * + * This resizes an ext2 or ext3 filesystem to match the + * size of the underlying device. + * + * *Note:* It is sometimes required that you run + * "g.e2fsck_f" on the "device" before calling this + * command. For unknown reasons "resize2fs" sometimes gives + * an error about this and sometimes not. In any case, it + * is always safe to call "g.e2fsck_f" before calling this + * function. + * + * @throws LibGuestFSException + */ + public void resize2fs (String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("resize2fs: handle is closed"); + _resize2fs (g, device); + } + private native void _resize2fs (long g, String device) + throws LibGuestFSException; + + /** + * find all files and directories + * + * This command lists out all files and directories, + * recursively, starting at "directory". It is essentially + * equivalent to running the shell command "find directory + * -print" but some post-processing happens on the output, + * described below. + * + * This returns a list of strings *without any prefix*. + * Thus if the directory structure was: + * + * /tmp/a + * /tmp/b + * /tmp/c/d + * + * then the returned list from "g.find" "/tmp" would be 4 + * elements: + * + * a + * b + * c + * c/d + * + * If "directory" is not a directory, then this command + * returns an error. + * + * The returned list is sorted. + * + * @throws LibGuestFSException + */ + public String[] find (String directory) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("find: handle is closed"); + return _find (g, directory); + } + private native String[] _find (long g, String directory) + throws LibGuestFSException; + + /** + * check an ext2/ext3 filesystem + * + * This runs "e2fsck -p -f device", ie. runs the ext2/ext3 + * filesystem checker on "device", noninteractively ("-p"), + * even if the filesystem appears to be clean ("-f"). + * + * This command is only needed because of "g.resize2fs" + * (q.v.). Normally you should use "g.fsck". + * + * @throws LibGuestFSException + */ + public void e2fsck_f (String device) + throws LibGuestFSException + { + if (g == 0) + throw new LibGuestFSException ("e2fsck_f: handle is closed"); + _e2fsck_f (g, device); + } + private native void _e2fsck_f (long g, String device) + throws LibGuestFSException; + }