Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   
   /*
    *  Copyright (C) 2010-2011 Oracle Corporation
    *
    *  This file is part of the VirtualBox SDK, as available from
    *  http://www.virtualbox.org.  This library is free software; you can
    *  redistribute it and/or modify it under the terms of the GNU Lesser General
    *  Public License as published by the Free Software Foundation, in version 2.1
    *  as it comes in the "COPYING.LIB" file of the VirtualBox SDK distribution.
   *  This library is distributed in the hope that it will be useful, but WITHOUT
   *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
   *  License for more details.
   *
   * IVirtualBox.java
   *
   * DO NOT EDIT! This is a generated file.
   * Generated from: src/VBox/Main/idl/VirtualBox.xidl (VirtualBox's interface definitions in XML)
   * Generator: src/VBox/Main/glue/glue-java.xsl
   */
  
  package org.virtualbox_4_2;
  
  import javax.xml.ws.*;
  import java.util.List;

The IVirtualBox interface represents the main interface exposed by the product that provides virtual machine management. An instance of IVirtualBox is required for the product to do anything useful. Even though the interface does not expose this, internally, IVirtualBox is implemented as a singleton and actually lives in the process of the VirtualBox server (VBoxSVC.exe). This makes sure that IVirtualBox can track the state of all virtual machines on a particular host, regardless of which frontend started them. To enumerate all the virtual machines on the host, use the getMachines() attribute. Interface ID: {3B2F08EB-B810-4715-BEE0-BB06B9880AD2}
  
  public class IVirtualBox extends IUnknown {
  
      public IVirtualBox(String wrappedVboxPortType port) {
            super(wrappedport);
      }
A string representing the version number of the product. The format is 3 integer numbers divided by dots (e.g. 1.0.1). The last number represents the build number and will frequently change. This may be followed by a _ALPHA[0-9]*, _BETA[0-9]* or _RC[0-9]* tag in prerelease builds. Non-Oracle builds may (/shall) also have a publisher tag, at the end. The publisher tag starts with an underscore just like the prerelease build type tag.

Returns:
String
  
      public String getVersion() {
        try {
           String retVal = .iVirtualBoxGetVersion();
           return retVal;
       } catch (InvalidObjectFaultMsg e) {
            throw new VBoxException(ee.getMessage());
       } catch (RuntimeFaultMsg e) {
            throw new VBoxException(ee.getMessage());
       }
      }
A string representing the version number of the product, without the publisher information (but still with other tags). See getVersion().

Returns:
String
  
      public String getVersionNormalized() {
        try {
           String retVal = .iVirtualBoxGetVersionNormalized();
           return retVal;
       } catch (InvalidObjectFaultMsg e) {
            throw new VBoxException(ee.getMessage());
       } catch (RuntimeFaultMsg e) {
            throw new VBoxException(ee.getMessage());
       }
      }
The internal build revision number of the product.

Returns:
Long
  
     public Long getRevision() {
       try {
          Long retVal = .iVirtualBoxGetRevision();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
A string representing the package type of this product. The format is OS_ARCH_DIST where OS is either WINDOWS, LINUX, SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST is either GENERIC, UBUNTU_606, UBUNTU_710, or something like this.

Returns:
String
 
     public String getPackageType() {
       try {
          String retVal = .iVirtualBoxGetPackageType();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
A string representing the VirtualBox API version number. The format is 2 integer numbers divided by an underscore (e.g. 1_0). After the first public release of packages with a particular API version the API will not be changed in an incompatible way. Note that this guarantee does not apply to development builds, and also there is no guarantee that this version is identical to the first two integer numbers of the package version.

Returns:
String
 
     public String getAPIVersion() {
       try {
          String retVal = .iVirtualBoxGetAPIVersion();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Full path to the directory where the global settings file, VirtualBox.xml, is stored. In this version of VirtualBox, the value of this property is always <user_dir>/.VirtualBox (where <user_dir> is the path to the user directory, as determined by the host OS), and cannot be changed. This path is also used as the base to resolve relative paths in places where relative paths are allowed (unless otherwise expressly indicated).

Returns:
String
 
     public String getHomeFolder() {
       try {
          String retVal = .iVirtualBoxGetHomeFolder();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Full name of the global settings file. The value of this property corresponds to the value of getHomeFolder() plus /VirtualBox.xml.

Returns:
String
 
     public String getSettingsFilePath() {
       try {
          String retVal = .iVirtualBoxGetSettingsFilePath();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Associated host object.

Returns:
org.virtualbox_4_2.IHost
 
     public org.virtualbox_4_2.IHost getHost() {
       try {
          String retVal = .iVirtualBoxGetHost();
          return (retVal.length() > 0) ? new org.virtualbox_4_2.IHost(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Associated system information object.

Returns:
org.virtualbox_4_2.ISystemProperties
 
       try {
          String retVal = .iVirtualBoxGetSystemProperties();
          return (retVal.length() > 0) ? new org.virtualbox_4_2.ISystemProperties(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Array of machine objects registered within this VirtualBox instance.

Returns:
List<org.virtualbox_4_2.IMachine>
 
     public List<org.virtualbox_4_2.IMachinegetMachines() {
       try {
          List<StringretVal = .iVirtualBoxGetMachines();
          return Helper.wrap(org.virtualbox_4_2.IMachine.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Array of all machine group names which are used by the machines which are accessible. Each group is only listed once, however they are listed in no particular order and there is no guarantee that there are no gaps in the group hierarchy (i.e. "/", "/group/subgroup" is a valid result).

Returns:
List<String>
 
     public List<StringgetMachineGroups() {
       try {
          List<StringretVal = .iVirtualBoxGetMachineGroups();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Array of medium objects known to this VirtualBox installation. This array contains only base media. All differencing media of the given base medium can be enumerated using IMedium.getChildren().

Returns:
List<org.virtualbox_4_2.IMedium>
 
     public List<org.virtualbox_4_2.IMediumgetHardDisks() {
       try {
          List<StringretVal = .iVirtualBoxGetHardDisks();
          return Helper.wrap(org.virtualbox_4_2.IMedium.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Array of CD/DVD image objects currently in use by this VirtualBox instance.

Returns:
List<org.virtualbox_4_2.IMedium>
 
     public List<org.virtualbox_4_2.IMediumgetDVDImages() {
       try {
          List<StringretVal = .iVirtualBoxGetDVDImages();
          return Helper.wrap(org.virtualbox_4_2.IMedium.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Array of floppy image objects currently in use by this VirtualBox instance.

Returns:
List<org.virtualbox_4_2.IMedium>
 
       try {
          List<StringretVal = .iVirtualBoxGetFloppyImages();
          return Helper.wrap(org.virtualbox_4_2.IMedium.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
       try {
          List<StringretVal = .iVirtualBoxGetProgressOperations();
          return Helper.wrap(org.virtualbox_4_2.IProgress.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
       try {
          return Helper.wrap2(org.virtualbox_4_2.IGuestOSType.classorg.virtualbox_4_2.jaxws.IGuestOSType.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Collection of global shared folders. Global shared folders are available to all virtual machines. New shared folders are added to the collection using createSharedFolder(java.lang.String,java.lang.String,java.lang.Boolean,java.lang.Boolean). Existing shared folders can be removed using removeSharedFolder(java.lang.String). NOTE: In the current version of the product, global shared folders are not implemented and therefore this collection is always empty.

Returns:
List<org.virtualbox_4_2.ISharedFolder>
 
       try {
          return Helper.wrap2(org.virtualbox_4_2.ISharedFolder.classorg.virtualbox_4_2.jaxws.ISharedFolder.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Associated performance collector object.

Returns:
org.virtualbox_4_2.IPerformanceCollector
 
       try {
          String retVal = .iVirtualBoxGetPerformanceCollector();
          return (retVal.length() > 0) ? new org.virtualbox_4_2.IPerformanceCollector(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
DHCP servers.

Returns:
List<org.virtualbox_4_2.IDHCPServer>
 
       try {
          List<StringretVal = .iVirtualBoxGetDHCPServers();
          return Helper.wrap(org.virtualbox_4_2.IDHCPServer.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Event source for VirtualBox events.

Returns:
org.virtualbox_4_2.IEventSource
 
       try {
          String retVal = .iVirtualBoxGetEventSource();
          return (retVal.length() > 0) ? new org.virtualbox_4_2.IEventSource(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
   // skip attribute extensionPackManager of suppressed type IExtPackManager
 
Names of all internal networks.

Returns:
List<String>
 
     public List<StringgetInternalNetworks() {
       try {
          List<StringretVal = .iVirtualBoxGetInternalNetworks();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Names of all generic network drivers.

Returns:
List<String>
 
     public List<StringgetGenericNetworkDrivers() {
       try {
          List<StringretVal = .iVirtualBoxGetGenericNetworkDrivers();
          return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
     public static IVirtualBox queryInterface(IUnknown obj) {
        return obj == null ?  null : new IVirtualBox(obj.getWrapped(), obj.getRemoteWSPort());
     }
Returns a recommended full path of the settings file name for a new virtual machine. This API serves two purposes:
  • It gets called by createMachine(java.lang.String,java.lang.String,java.util.List,java.lang.String,java.lang.String) if null or empty string (which is recommended) is specified for the settingsFile argument there, which means that API should use a recommended default file name.
  • It can be called manually by a client software before creating a machine, e.g. if that client wants to pre-create the machine directory to create virtual hard disks in that directory together with the new machine settings file. In that case, the file name should be stripped from the full settings file path returned by this function to obtain the machine directory.
See IMachine.getName() and createMachine(java.lang.String,java.lang.String,java.util.List,java.lang.String,java.lang.String) for more details about the machine name. groupName defines which additional subdirectory levels should be included. It must be either a valid group name or null or empty string which designates that the machine will not be related to a machine group. If baseFolder is a null or empty string (which is recommended), the default machine settings folder (see ISystemProperties.getDefaultMachineFolder()) will be used as a base folder for the created machine, resulting in a file name like "/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder will be used. This method does not access the host disks. In particular, it does not check for whether a machine with this name already exists.

Parameters:
name Suggested machine name.
group Machine group name for the new machine or machine group. It is used to determine the right subdirectory.
createFlags Machine creation flags, see createMachine(java.lang.String,java.lang.String,java.util.List,java.lang.String,java.lang.String) (optional).
baseFolder Base machine folder (optional).
Returns:
Fully qualified path where the machine would be created.
 
     public String composeMachineFilename(String nameString groupString createFlagsString baseFolder) {
       try {
         String     retVal;
         retVal = .iVirtualBoxComposeMachineFilename(namegroupcreateFlagsbaseFolder);
         return retVal;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Creates a new virtual machine by creating a machine settings file at the given location. VirtualBox machine settings files use a custom XML dialect. Starting with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced, and machine files can be created at arbitrary locations. However, it is recommended that machines are created in the default machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see ISystemProperties.getDefaultMachineFolder()). If you specify null or empty string (which is recommended) for the settingsFile argument, composeMachineFilename(java.lang.String,java.lang.String,java.lang.String,java.lang.String) is called automatically to have such a recommended name composed based on the machine name given in the name argument and the primary group. If the resulting settings file already exists, this method will fail, unless the forceOverwrite flag is set. The new machine is created unregistered, with the initial configuration set according to the specified guest OS type. A typical sequence of actions to create a new virtual machine is as follows:
  1. Call this method to have a new machine created. The returned machine object will be "mutable" allowing to change any machine property.
  2. Configure the machine using the appropriate attributes and methods.
  3. Call IMachine.saveSettings() to write the settings to the machine's XML settings file. The configuration of the newly created machine will not be saved to disk until this method is called.
  4. Call registerMachine(org.virtualbox_4_2.IMachine) to add the machine to the list of machines known to VirtualBox.
The specified guest OS type identifier must match an ID of one of known guest OS types listed in the getGuestOSTypes() array.

Parameters:
settingsFile Fully qualified path where the settings file should be created, empty string or null for a default folder and file based on the name argument and the primary group. (see composeMachineFilename(java.lang.String,java.lang.String,java.lang.String,java.lang.String)).
name Machine name.
groups Array of group names. null or an empty array have the same meaning as an array with just the empty string or "/", i.e. create a machine without group association.
osTypeId Guest OS Type ID.
flags Additional property parameters, passed as a comma-separated list of "name=value" type entries. The following ones are recognized: forceOverwrite=1 to overwrite an existing machine settings file, UUID=<uuid> to specify a machine UUID and directoryIncludesUUID=1 to switch to a special VM directory naming scheme which should not be used unless necessary.
Returns:
Created machine object. Expected result codes:
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND osTypeId is invalid.
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERROR Resulting settings file name is invalid or the settings file already exists or could not be created due to an I/O error.
E_INVALIDARG name is empty or null.
NOTE: There is no way to change the name of the settings file or subfolder of the created machine directly.
 
     public org.virtualbox_4_2.IMachine createMachine(String settingsFileString nameList<StringgroupsString osTypeIdString flags) {
       try {
         String     retVal;
         retVal = .iVirtualBoxCreateMachine(settingsFilenamegroupsosTypeIdflags);
         return (retVal.length() > 0) ? new org.virtualbox_4_2.IMachine(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Opens a virtual machine from the existing settings file. The opened machine remains unregistered until you call registerMachine(org.virtualbox_4_2.IMachine). The specified settings file name must be fully qualified. The file must exist and be a valid machine XML settings file whose contents will be used to construct the machine object.

Parameters:
settingsFile Name of the machine settings file.
Returns:
Opened machine object. Expected result codes:
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERROR Settings file name invalid, not found or sharing violation.
 
     public org.virtualbox_4_2.IMachine openMachine(String settingsFile) {
       try {
         String     retVal;
         retVal = .iVirtualBoxOpenMachine(settingsFile);
         return (retVal.length() > 0) ? new org.virtualbox_4_2.IMachine(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Registers the machine previously created using createMachine(java.lang.String,java.lang.String,java.util.List,java.lang.String,java.lang.String) or opened using openMachine(java.lang.String) within this VirtualBox installation. After successful method invocation, the IMachineRegisteredEvent event is fired. Expected result codes:
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND No matching virtual machine found.
@link ::VBOX_E_INVALID_OBJECT_STATE VBOX_E_INVALID_OBJECT_STATE Virtual machine was not created within this VirtualBox instance.
NOTE: This method implicitly calls IMachine.saveSettings() to save all current machine settings before registering it.
 
     public void registerMachine(org.virtualbox_4_2.IMachine machine) {
       try {
         .iVirtualBoxRegisterMachine(, ((machine == null) ? null :machine.getWrapped()));
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Attempts to find a virtual machine given its name or UUID.

Parameters:
nameOrId What to search for. This can either be the UUID or the name of a virtual machine.
Returns:
Machine object, if found. Expected result codes:
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND Could not find registered machine matching nameOrId.
NOTE: Inaccessible machines cannot be found by name, only by UUID, because their name cannot safely be determined.
 
     public org.virtualbox_4_2.IMachine findMachine(String nameOrId) {
       try {
         String     retVal;
         retVal = .iVirtualBoxFindMachine(nameOrId);
         return (retVal.length() > 0) ? new org.virtualbox_4_2.IMachine(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Gets all machine references which are in one of the specified groups.

Parameters:
groups What groups to match. The usual group list rules apply, i.e. passing an empty list will match VMs in the toplevel group, likewise the empty string.
Returns:
All machines which matched.
 
       try {
         List<String>     retVal;
         retVal = .iVirtualBoxGetMachinesByGroups(groups);
         return Helper.wrap(org.virtualbox_4_2.IMachine.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Gets the state of several machines in a single operation.

Parameters:
machines Array with the machine references.
Returns:
Machine states, corresponding to the machines.
 
       try {
         List<org.virtualbox_4_2.jaxws.MachineState>     retVal;
         retVal = .iVirtualBoxGetMachineStates(, Helper.unwrap(machines));
         return Helper.convertEnums(org.virtualbox_4_2.jaxws.MachineState.classorg.virtualbox_4_2.MachineState.classretVal);
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Creates a new appliance object, which represents an appliance in the Open Virtual Machine Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export machines as an OVF appliance; see the documentation for IAppliance for details.

Returns:
New appliance.
 
       try {
         String     retVal;
         retVal = .iVirtualBoxCreateAppliance();
         return (retVal.length() > 0) ? new org.virtualbox_4_2.IAppliance(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Creates a new base medium object that will use the given storage format and location for medium data. The actual storage unit is not created by this method. In order to do it, and before you are able to attach the created medium to virtual machines, you must call one of the following methods to allocate a format-specific storage unit at the specified location: Some medium attributes, such as IMedium.getId(), may remain uninitialized until the medium storage unit is successfully created by one of the above methods. After the storage unit is successfully created, it will be accessible through the openMedium(java.lang.String,org.virtualbox_4_2.DeviceType,org.virtualbox_4_2.AccessMode,java.lang.Boolean) method and can be found in the getHardDisks() array. The list of all storage formats supported by this VirtualBox installation can be obtained using ISystemProperties.getMediumFormats(). If the format attribute is empty or null then the default storage format specified by ISystemProperties.getDefaultHardDiskFormat() will be used for creating a storage unit of the medium. Note that the format of the location string is storage format specific. See IMedium.getLocation() and IMedium for more details.

Parameters:
format Identifier of the storage format to use for the new medium.
location Location of the storage unit for the new medium.
Returns:
Created medium object. Expected result codes:
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND format identifier is invalid. See ISystemProperties.getMediumFormats().
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERROR location is a not valid file name (for file-based formats only).
 
     public org.virtualbox_4_2.IMedium createHardDisk(String formatString location) {
       try {
         String     retVal;
         retVal = .iVirtualBoxCreateHardDisk(formatlocation);
         return (retVal.length() > 0) ? new org.virtualbox_4_2.IMedium(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Finds existing media or opens a medium from an existing storage location. Once a medium has been opened, it can be passed to other VirtualBox methods, in particular to IMachine.attachDevice(java.lang.String,java.lang.Integer,java.lang.Integer,org.virtualbox_4_2.DeviceType,org.virtualbox_4_2.IMedium). Depending on the given device type, the file at the storage location must be in one of the media formats understood by VirtualBox:
  • With a "HardDisk" device type, the file must be a hard disk image in one of the formats supported by VirtualBox (see ISystemProperties.getMediumFormats()). After this method succeeds, if the medium is a base medium, it will be added to the getHardDisks() array attribute.
  • With a "DVD" device type, the file must be an ISO 9960 CD/DVD image. After this method succeeds, the medium will be added to the getDVDImages() array attribute.
  • With a "Floppy" device type, the file must be an RAW floppy image. After this method succeeds, the medium will be added to the getFloppyImages() array attribute.
After having been opened, the medium can be re-found by this method and can be attached to virtual machines. See IMedium for more details. The UUID of the newly opened medium will either be retrieved from the storage location, if the format supports it (e.g. for hard disk images), or a new UUID will be randomly generated (e.g. for ISO and RAW files). If for some reason you need to change the medium's UUID, use IMedium.setIds(java.lang.Boolean,java.lang.String,java.lang.Boolean,java.lang.String). If a differencing hard disk medium is to be opened by this method, the operation will succeed only if its parent medium and all ancestors, if any, are already known to this VirtualBox installation (for example, were opened by this method before). This method attempts to guess the storage format of the specified medium by reading medium data at the specified location. If accessMode is ReadWrite (which it should be for hard disks and floppies), the image is opened for read/write access and must have according permissions, as VirtualBox may actually write status information into the disk's metadata sections. Note that write access is required for all typical hard disk usage in VirtualBox, since VirtualBox may need to write metadata such as a UUID into the image. The only exception is opening a source image temporarily for copying and cloning (see IMedium.cloneTo(org.virtualbox_4_2.IMedium,java.lang.Long,org.virtualbox_4_2.IMedium) when the image will be closed again soon. The format of the location string is storage format specific. See IMedium.getLocation() and IMedium for more details.

Parameters:
location Location of the storage unit that contains medium data in one of the supported storage formats.
deviceType Must be one of "HardDisk", "DVD" or "Floppy".
accessMode Whether to open the image in read/write or read-only mode. For a "DVD" device type, this is ignored and read-only mode is always assumed.
forceNewUuid Allows the caller to request a completely new medium UUID for the image which is to be opened. Useful if one intends to open an exact copy of a previously opened image, as this would normally fail due to the duplicate UUID.
Returns:
Opened medium object. Expected result codes:
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERROR Invalid medium storage file location or could not find the medium at the specified location.
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERROR Could not get medium storage format.
E_INVALIDARG Invalid medium storage format.
@link ::VBOX_E_INVALID_OBJECT_STATE VBOX_E_INVALID_OBJECT_STATE Medium has already been added to a media registry.
 
     public org.virtualbox_4_2.IMedium openMedium(String locationorg.virtualbox_4_2.DeviceType deviceTypeorg.virtualbox_4_2.AccessMode accessModeBoolean forceNewUuid) {
       try {
         String     retVal;
         retVal = .iVirtualBoxOpenMedium(location, org.virtualbox_4_2.jaxws.DeviceType.fromValue(deviceType.name()), org.virtualbox_4_2.jaxws.AccessMode.fromValue(accessMode.name()), forceNewUuid);
         return (retVal.length() > 0) ? new org.virtualbox_4_2.IMedium(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Returns an object describing the specified guest OS type. The requested guest OS type is specified using a string which is a mnemonic identifier of the guest operating system, such as "win31" or "ubuntu". The guest OS type ID of a particular virtual machine can be read or set using the IMachine.getOSTypeId() attribute. The getGuestOSTypes() collection contains all available guest OS type objects. Each object has an IGuestOSType.getId() attribute which contains an identifier of the guest OS this object describes.

Parameters:
id Guest OS type ID string.
Returns:
Guest OS type object. Expected result codes:
E_INVALIDARG id is not a valid Guest OS type.
 
       try {
         org.virtualbox_4_2.jaxws.IGuestOSType     retVal;
         retVal = .iVirtualBoxGetGuestOSType(id);
         return (retVal != null) ? new org.virtualbox_4_2.IGuestOSType(retVal) : null;
      } catch (InvalidObjectFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      } catch (RuntimeFaultMsg e) {
           throw new VBoxException(ee.getMessage());
      }
     }
Creates a new global shared folder by associating the given logical name with the given host path, adds it to the collection of shared folders and starts sharing it. Refer to the description of ISharedFolder to read more about logical names.

Parameters:
name Unique logical name of the shared folder.
hostPath Full path to the shared folder in the host file system.
writable Whether the share is writable or readonly
automount Whether the share gets automatically mounted by the guest or not. NOTE: In the current implementation, this operation is not implemented.
    public void createSharedFolder(String nameString hostPathBoolean writableBoolean automount) {
      try {
        .iVirtualBoxCreateSharedFolder(namehostPathwritableautomount);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Removes the global shared folder with the given name previously created by createSharedFolder(java.lang.String,java.lang.String,java.lang.Boolean,java.lang.Boolean) from the collection of shared folders and stops sharing it.

Parameters:
name Logical name of the shared folder to remove. NOTE: In the current implementation, this operation is not implemented.
    public void removeSharedFolder(String name) {
      try {
        .iVirtualBoxRemoveSharedFolder(name);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Returns an array representing the global extra data keys which currently have values defined.

Returns:
Array of extra data keys.
    public List<StringgetExtraDataKeys() {
      try {
        List<String>     retVal;
        retVal = .iVirtualBoxGetExtraDataKeys();
        return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Returns associated global extra data. If the requested data key does not exist, this function will succeed and return an empty string in the value argument.

Parameters:
key Name of the data key to get.
Returns:
Value of the requested data key. Expected result codes:
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERROR Settings file not accessible.
@link ::VBOX_E_XML_ERROR VBOX_E_XML_ERROR Could not parse the settings file.
    public String getExtraData(String key) {
      try {
        String     retVal;
        retVal = .iVirtualBoxGetExtraData(key);
        return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Sets associated global extra data. If you pass null or empty string as a key value, the given key will be deleted.

Parameters:
key Name of the data key to set.
value Value to assign to the key. Expected result codes:
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERROR Settings file not accessible.
@link ::VBOX_E_XML_ERROR VBOX_E_XML_ERROR Could not parse the settings file.
E_ACCESSDENIED Modification request refused.
NOTE: Before performing the actual data change, this method will ask all registered event listener using the IExtraDataCanChangeEvent notification for a permission. If one of the listeners refuses the new value, the change will not be performed. NOTE: On success, the IExtraDataChangedEvent notification is called to inform all registered listeners about a successful data change.
    public void setExtraData(String keyString value) {
      try {
        .iVirtualBoxSetExtraData(keyvalue);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Unlocks the secret data by passing the unlock password to the server. The server will cache the password for that machine.

Parameters:
password The cipher key. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATE Virtual machine is not mutable.
    public void setSettingsSecret(String password) {
      try {
        .iVirtualBoxSetSettingsSecret(password);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Creates a DHCP server settings to be used for the given internal network name

Parameters:
name server name
Returns:
DHCP server settings Expected result codes:
E_INVALIDARG Host network interface name already exists.
      try {
        String     retVal;
        retVal = .iVirtualBoxCreateDHCPServer(name);
        return (retVal.length() > 0) ? new org.virtualbox_4_2.IDHCPServer(retVal) : null;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Searches a DHCP server settings to be used for the given internal network name

Parameters:
name server name
Returns:
DHCP server settings Expected result codes:
E_INVALIDARG Host network interface name already exists.
      try {
        String     retVal;
        retVal = .iVirtualBoxFindDHCPServerByNetworkName(name);
        return (retVal.length() > 0) ? new org.virtualbox_4_2.IDHCPServer(retVal) : null;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Removes the DHCP server settings

Parameters:
server DHCP server settings to be removed Expected result codes:
E_INVALIDARG Host network interface name already exists.
    public void removeDHCPServer(org.virtualbox_4_2.IDHCPServer server) {
      try {
        .iVirtualBoxRemoveDHCPServer(, ((server == null) ? null :server.getWrapped()));
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
Check if this VirtualBox installation has a firmware of the given type available, either system-wide or per-user. Optionally, this may return a hint where this firmware can be downloaded from.

Parameters:
firmwareType Type of firmware to check.
version Expected version number, usually empty string (presently ignored).
url Suggested URL to download this firmware from.
file Filename of firmware, only valid if result == TRUE.
Returns:
If firmware of this type and version is available.
    public Boolean checkFirmwarePresent(org.virtualbox_4_2.FirmwareType firmwareTypeString versionHolder<StringurlHolder<Stringfile) {
      try {
        javax.xml.ws.Holder<String>   tmp_url = new  javax.xml.ws.Holder<String>();
        javax.xml.ws.Holder<String>   tmp_file = new  javax.xml.ws.Holder<String>();
        javax.xml.ws.Holder<BooleanretVal = new javax.xml.ws.Holder<Boolean>();
        .iVirtualBoxCheckFirmwarePresent(, org.virtualbox_4_2.jaxws.FirmwareType.fromValue(firmwareType.name()), versiontmp_urltmp_fileretVal);
        url.value = tmp_url.value;
        file.value = tmp_file.value;
        return retVal.value;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(ee.getMessage());
     }
    }
New to GrepCode? Check out our FAQ X