Generated code for mknod, mkfifo, mknod_b, mknod_c, umask.
[libguestfs.git] / java / com / redhat / et / libguestfs / GuestFS.java
index 4075420..3cb1c7f 100644 (file)
@@ -427,7 +427,7 @@ public HashMap<String,String> test0rhashtableerr ()
    * to modify the image).
    * <p>
    * This is equivalent to the qemu parameter "-drive
-   * file=filename".
+   * file=filename,cache=off".
    * <p>
    * Note that this call checks for the existence of
    * "filename". This stops you from specifying other types
@@ -908,6 +908,57 @@ public HashMap<String,String> test0rhashtableerr ()
     throws LibGuestFSException;
 
   /**
+   * set memory allocated to the qemu subprocess
+   * <p>
+   * This sets the memory size in megabytes allocated to the
+   * qemu subprocess. This only has any effect if called
+   * before "g.launch".
+   * <p>
+   * You can also change this by setting the environment
+   * variable "LIBGUESTFS_MEMSIZE" before the handle is
+   * created.
+   * <p>
+   * For more information on the architecture of libguestfs,
+   * see guestfs(3).
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void set_memsize (int memsize)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("set_memsize: handle is closed");
+    _set_memsize (g, memsize);
+  }
+  private native void _set_memsize (long g, int memsize)
+    throws LibGuestFSException;
+
+  /**
+   * get memory allocated to the qemu subprocess
+   * <p>
+   * This gets the memory size in megabytes allocated to the
+   * qemu subprocess.
+   * <p>
+   * If "g.set_memsize" was not called on this handle, and if
+   * "LIBGUESTFS_MEMSIZE" was not set, then this returns the
+   * compiled-in default value for memsize.
+   * <p>
+   * For more information on the architecture of libguestfs,
+   * see guestfs(3).
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public int get_memsize ()
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("get_memsize: handle is closed");
+    return _get_memsize (g);
+  }
+  private native int _get_memsize (long g)
+    throws LibGuestFSException;
+
+  /**
    * mount a guest disk at a position in the filesystem
    * <p>
    * Mount a guest disk at a position in the filesystem.
@@ -2801,6 +2852,8 @@ public HashMap<String,String> test0rhashtableerr ()
    * sufficient to remove any partition tables, filesystem
    * superblocks and so on.
    * <p>
+   * See also: "g.scrub_device".
+   * <p>
    * @throws LibGuestFSException
    */
   public void zero (String device)
@@ -3110,14 +3163,14 @@ public HashMap<String,String> test0rhashtableerr ()
    * <p>
    * @throws LibGuestFSException
    */
-  public void sfdisk_N (String device, int n, int cyls, int heads, int sectors, String line)
+  public void sfdisk_N (String device, int partnum, 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);
+    _sfdisk_N (g, device, partnum, cyls, heads, sectors, line);
   }
-  private native void _sfdisk_N (long g, String device, int n, int cyls, int heads, int sectors, String line)
+  private native void _sfdisk_N (long g, String device, int partnum, int cyls, int heads, int sectors, String line)
     throws LibGuestFSException;
 
   /**
@@ -3435,4 +3488,566 @@ public HashMap<String,String> test0rhashtableerr ()
   private native String[] _sh_lines (long g, String command)
     throws LibGuestFSException;
 
+  /**
+   * expand a wildcard path
+   * <p>
+   * This command searches for all the pathnames matching
+   * "pattern" according to the wildcard expansion rules used
+   * by the shell.
+   * <p>
+   * If no paths match, then this returns an empty list
+   * (note: not an error).
+   * <p>
+   * It is just a wrapper around the C glob(3) function with
+   * flags "GLOB_MARK|GLOB_BRACE". See that manual page for
+   * more details.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String[] glob_expand (String pattern)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("glob_expand: handle is closed");
+    return _glob_expand (g, pattern);
+  }
+  private native String[] _glob_expand (long g, String pattern)
+    throws LibGuestFSException;
+
+  /**
+   * scrub (securely wipe) a device
+   * <p>
+   * This command writes patterns over "device" to make data
+   * retrieval more difficult.
+   * <p>
+   * It is an interface to the scrub(1) program. See that
+   * manual page for more details.
+   * <p>
+   * This command is dangerous. Without careful use you can
+   * easily destroy all your data.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void scrub_device (String device)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("scrub_device: handle is closed");
+    _scrub_device (g, device);
+  }
+  private native void _scrub_device (long g, String device)
+    throws LibGuestFSException;
+
+  /**
+   * scrub (securely wipe) a file
+   * <p>
+   * This command writes patterns over a file to make data
+   * retrieval more difficult.
+   * <p>
+   * The file is *removed* after scrubbing.
+   * <p>
+   * It is an interface to the scrub(1) program. See that
+   * manual page for more details.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void scrub_file (String file)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("scrub_file: handle is closed");
+    _scrub_file (g, file);
+  }
+  private native void _scrub_file (long g, String file)
+    throws LibGuestFSException;
+
+  /**
+   * scrub (securely wipe) free space
+   * <p>
+   * This command creates the directory "dir" and then fills
+   * it with files until the filesystem is full, and scrubs
+   * the files as for "g.scrub_file", and deletes them. The
+   * intention is to scrub any free space on the partition
+   * containing "dir".
+   * <p>
+   * It is an interface to the scrub(1) program. See that
+   * manual page for more details.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void scrub_freespace (String dir)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("scrub_freespace: handle is closed");
+    _scrub_freespace (g, dir);
+  }
+  private native void _scrub_freespace (long g, String dir)
+    throws LibGuestFSException;
+
+  /**
+   * create a temporary directory
+   * <p>
+   * This command creates a temporary directory. The
+   * "template" parameter should be a full pathname for the
+   * temporary directory name with the final six characters
+   * being "XXXXXX".
+   * <p>
+   * For example: "/tmp/myprogXXXXXX" or
+   * "/Temp/myprogXXXXXX", the second one being suitable for
+   * Windows filesystems.
+   * <p>
+   * The name of the temporary directory that was created is
+   * returned.
+   * <p>
+   * The temporary directory is created with mode 0700 and is
+   * owned by root.
+   * <p>
+   * The caller is responsible for deleting the temporary
+   * directory and its contents after use.
+   * <p>
+   * See also: mkdtemp(3)
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String mkdtemp (String template)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mkdtemp: handle is closed");
+    return _mkdtemp (g, template);
+  }
+  private native String _mkdtemp (long g, String template)
+    throws LibGuestFSException;
+
+  /**
+   * count lines in a file
+   * <p>
+   * This command counts the lines in a file, using the "wc
+   * -l" external command.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public int wc_l (String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("wc_l: handle is closed");
+    return _wc_l (g, path);
+  }
+  private native int _wc_l (long g, String path)
+    throws LibGuestFSException;
+
+  /**
+   * count words in a file
+   * <p>
+   * This command counts the words in a file, using the "wc
+   * -w" external command.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public int wc_w (String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("wc_w: handle is closed");
+    return _wc_w (g, path);
+  }
+  private native int _wc_w (long g, String path)
+    throws LibGuestFSException;
+
+  /**
+   * count characters in a file
+   * <p>
+   * This command counts the characters in a file, using the
+   * "wc -c" external command.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public int wc_c (String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("wc_c: handle is closed");
+    return _wc_c (g, path);
+  }
+  private native int _wc_c (long g, String path)
+    throws LibGuestFSException;
+
+  /**
+   * return first 10 lines of a file
+   * <p>
+   * This command returns up to the first 10 lines of a file
+   * as a list of strings.
+   * <p>
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String[] head (String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("head: handle is closed");
+    return _head (g, path);
+  }
+  private native String[] _head (long g, String path)
+    throws LibGuestFSException;
+
+  /**
+   * return first N lines of a file
+   * <p>
+   * If the parameter "nrlines" is a positive number, this
+   * returns the first "nrlines" lines of the file "path".
+   * <p>
+   * If the parameter "nrlines" is a negative number, this
+   * returns lines from the file "path", excluding the last
+   * "nrlines" lines.
+   * <p>
+   * If the parameter "nrlines" is zero, this returns an
+   * empty list.
+   * <p>
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String[] head_n (int nrlines, String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("head_n: handle is closed");
+    return _head_n (g, nrlines, path);
+  }
+  private native String[] _head_n (long g, int nrlines, String path)
+    throws LibGuestFSException;
+
+  /**
+   * return last 10 lines of a file
+   * <p>
+   * This command returns up to the last 10 lines of a file
+   * as a list of strings.
+   * <p>
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String[] tail (String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("tail: handle is closed");
+    return _tail (g, path);
+  }
+  private native String[] _tail (long g, String path)
+    throws LibGuestFSException;
+
+  /**
+   * return last N lines of a file
+   * <p>
+   * If the parameter "nrlines" is a positive number, this
+   * returns the last "nrlines" lines of the file "path".
+   * <p>
+   * If the parameter "nrlines" is a negative number, this
+   * returns lines from the file "path", starting with the
+   * "-nrlines"th line.
+   * <p>
+   * If the parameter "nrlines" is zero, this returns an
+   * empty list.
+   * <p>
+   * Because of the message protocol, there is a transfer
+   * limit of somewhere between 2MB and 4MB. To transfer
+   * large files you should use FTP.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String[] tail_n (int nrlines, String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("tail_n: handle is closed");
+    return _tail_n (g, nrlines, path);
+  }
+  private native String[] _tail_n (long g, int nrlines, String path)
+    throws LibGuestFSException;
+
+  /**
+   * report file system disk space usage
+   * <p>
+   * This command runs the "df" command to report disk space
+   * used.
+   * <p>
+   * This command is mostly useful for interactive sessions.
+   * It is *not* intended that you try to parse the output
+   * string. Use "statvfs" from programs.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String df ()
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("df: handle is closed");
+    return _df (g);
+  }
+  private native String _df (long g)
+    throws LibGuestFSException;
+
+  /**
+   * report file system disk space usage (human readable)
+   * <p>
+   * This command runs the "df -h" command to report disk
+   * space used in human-readable format.
+   * <p>
+   * This command is mostly useful for interactive sessions.
+   * It is *not* intended that you try to parse the output
+   * string. Use "statvfs" from programs.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String df_h ()
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("df_h: handle is closed");
+    return _df_h (g);
+  }
+  private native String _df_h (long g)
+    throws LibGuestFSException;
+
+  /**
+   * estimate file space usage
+   * <p>
+   * This command runs the "du -s" command to estimate file
+   * space usage for "path".
+   * <p>
+   * "path" can be a file or a directory. If "path" is a
+   * directory then the estimate includes the contents of the
+   * directory and all subdirectories (recursively).
+   * <p>
+   * The result is the estimated size in *kilobytes* (ie.
+   * units of 1024 bytes).
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public long du (String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("du: handle is closed");
+    return _du (g, path);
+  }
+  private native long _du (long g, String path)
+    throws LibGuestFSException;
+
+  /**
+   * list files in an initrd
+   * <p>
+   * This command lists out files contained in an initrd.
+   * <p>
+   * The files are listed without any initial "/" character.
+   * The files are listed in the order they appear (not
+   * necessarily alphabetical). Directory names are listed as
+   * separate items.
+   * <p>
+   * Old Linux kernels (2.4 and earlier) used a compressed
+   * ext2 filesystem as initrd. We *only* support the newer
+   * initramfs format (compressed cpio files).
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public String[] initrd_list (String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("initrd_list: handle is closed");
+    return _initrd_list (g, path);
+  }
+  private native String[] _initrd_list (long g, String path)
+    throws LibGuestFSException;
+
+  /**
+   * mount a file using the loop device
+   * <p>
+   * This command lets you mount "file" (a filesystem image
+   * in a file) on a mount point. It is entirely equivalent
+   * to the command "mount -o loop file mountpoint".
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mount_loop (String file, String mountpoint)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mount_loop: handle is closed");
+    _mount_loop (g, file, mountpoint);
+  }
+  private native void _mount_loop (long g, String file, String mountpoint)
+    throws LibGuestFSException;
+
+  /**
+   * create a swap partition
+   * <p>
+   * Create a swap partition on "device".
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mkswap (String device)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mkswap: handle is closed");
+    _mkswap (g, device);
+  }
+  private native void _mkswap (long g, String device)
+    throws LibGuestFSException;
+
+  /**
+   * create a swap partition with a label
+   * <p>
+   * Create a swap partition on "device" with label "label".
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mkswap_L (String label, String device)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mkswap_L: handle is closed");
+    _mkswap_L (g, label, device);
+  }
+  private native void _mkswap_L (long g, String label, String device)
+    throws LibGuestFSException;
+
+  /**
+   * create a swap partition with an explicit UUID
+   * <p>
+   * Create a swap partition on "device" with UUID "uuid".
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mkswap_U (String uuid, String device)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mkswap_U: handle is closed");
+    _mkswap_U (g, uuid, device);
+  }
+  private native void _mkswap_U (long g, String uuid, String device)
+    throws LibGuestFSException;
+
+  /**
+   * make block, character or FIFO devices
+   * <p>
+   * This call creates block or character special devices, or
+   * named pipes (FIFOs).
+   * <p>
+   * The "mode" parameter should be the mode, using the
+   * standard constants. "devmajor" and "devminor" are the
+   * device major and minor numbers, only used when creating
+   * block and character special devices.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mknod (int mode, int devmajor, int devminor, String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mknod: handle is closed");
+    _mknod (g, mode, devmajor, devminor, path);
+  }
+  private native void _mknod (long g, int mode, int devmajor, int devminor, String path)
+    throws LibGuestFSException;
+
+  /**
+   * make FIFO (named pipe)
+   * <p>
+   * This call creates a FIFO (named pipe) called "path" with
+   * mode "mode". It is just a convenient wrapper around
+   * "g.mknod".
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mkfifo (int mode, String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mkfifo: handle is closed");
+    _mkfifo (g, mode, path);
+  }
+  private native void _mkfifo (long g, int mode, String path)
+    throws LibGuestFSException;
+
+  /**
+   * make block device node
+   * <p>
+   * This call creates a block device node called "path" with
+   * mode "mode" and device major/minor "devmajor" and
+   * "devminor". It is just a convenient wrapper around
+   * "g.mknod".
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mknod_b (int mode, int devmajor, int devminor, String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mknod_b: handle is closed");
+    _mknod_b (g, mode, devmajor, devminor, path);
+  }
+  private native void _mknod_b (long g, int mode, int devmajor, int devminor, String path)
+    throws LibGuestFSException;
+
+  /**
+   * make char device node
+   * <p>
+   * This call creates a char device node called "path" with
+   * mode "mode" and device major/minor "devmajor" and
+   * "devminor". It is just a convenient wrapper around
+   * "g.mknod".
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public void mknod_c (int mode, int devmajor, int devminor, String path)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("mknod_c: handle is closed");
+    _mknod_c (g, mode, devmajor, devminor, path);
+  }
+  private native void _mknod_c (long g, int mode, int devmajor, int devminor, String path)
+    throws LibGuestFSException;
+
+  /**
+   * set file mode creation mask (umask)
+   * <p>
+   * This function sets the mask used for creating new files
+   * and device nodes to "mask & 0777".
+   * <p>
+   * Typical umask values would be 022 which creates new
+   * files with permissions like "-rw-r--r--" or
+   * "-rwxr-xr-x", and 002 which creates new files with
+   * permissions like "-rw-rw-r--" or "-rwxrwxr-x".
+   * <p>
+   * See also umask(2), "g.mknod", "g.mkdir".
+   * <p>
+   * This call returns the previous umask.
+   * <p>
+   * @throws LibGuestFSException
+   */
+  public int umask (int mask)
+    throws LibGuestFSException
+  {
+    if (g == 0)
+      throw new LibGuestFSException ("umask: handle is closed");
+    return _umask (g, mask);
+  }
+  private native int _umask (long g, int mask)
+    throws LibGuestFSException;
+
 }