All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.virtualbox_4_2.IVirtualSystemDescription Maven / Gradle / Ivy

Go to download

VirtualBox Client API 4.2.8

There is a newer version: 4.2.8
Show newest version

/*
 *  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.
 *
 * IVirtualSystemDescription.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 org.virtualbox_4_2.jaxws.*;
import javax.xml.ws.*;
import java.util.List;

/**
Represents one virtual system (machine) in an appliance. This interface is used in
      the {@link org.virtualbox_4_2.IAppliance#getVirtualSystemDescriptions()} array. After
      {@link org.virtualbox_4_2.IAppliance#interpret()} has been called, that array contains information
      about how the virtual systems described in the OVF should best be imported into
      VirtualBox virtual machines. See {@link org.virtualbox_4_2.IAppliance} for the steps required to
      import an OVF into VirtualBox.
    
Interface ID: {D7525E6C-531A-4C51-8E04-41235083A3D8}
*/
public class IVirtualSystemDescription extends IUnknown {

    public IVirtualSystemDescription(String wrapped, VboxPortType port) {
          super(wrapped, port);
    }
/**
Return the number of virtual system description entries.
@return Long

*/
    public Long getCount() {
      try {
         Long retVal = port.iVirtualSystemDescriptionGetCount(obj);
         return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
    public static IVirtualSystemDescription queryInterface(IUnknown obj) {
       return obj == null ?  null : new IVirtualSystemDescription(obj.getWrapped(), obj.getRemoteWSPort());
    }
/**
Returns information about the virtual system as arrays of instruction items. In each array, the
      items with the same indices correspond and jointly represent an import instruction for VirtualBox.

      The list below identifies the value sets that are possible depending on the
      {@link org.virtualbox_4_2.VirtualSystemDescriptionType} enum value in the array item in  aTypes[]. In each case,
      the array item with the same index in  aOvfValues[] will contain the original value as contained
      in the OVF file (just for informational purposes), and the corresponding item in  aVBoxValues[]
      will contain a suggested value to be used for VirtualBox. Depending on the description type,
      the  aExtraConfigValues[] array item may also be used.

      
  • 
        "OS": the guest operating system type. There must be exactly one such array item on import. The
        corresponding item in   aVBoxValues[] contains the suggested guest operating system for VirtualBox.
        This will be one of the values listed in {@link org.virtualbox_4_2.IVirtualBox#getGuestOSTypes()}. The corresponding
        item in  aOvfValues[] will contain a numerical value that described the operating system in the OVF.
      
  • 
        "Name": the name to give to the new virtual machine. There can be at most one such array item;
        if none is present on import, then an automatic name will be created from the operating system
        type. The corresponding item im  aOvfValues[] will contain the suggested virtual machine name
        from the OVF file, and  aVBoxValues[] will contain a suggestion for a unique VirtualBox
        {@link org.virtualbox_4_2.IMachine} name that does not exist yet.
      
  • 
          "Description": an arbitrary description.
      
  • 
          "License": the EULA section from the OVF, if present. It is the responsibility of the calling
          code to display such a license for agreement; the Main API does not enforce any such policy.
      
  • 
          Miscellaneous: reserved for future use.
      
  • 
        "CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
      
  • 
        "Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
        is present on import, then VirtualBox will set a meaningful default based on the operating system
        type.
      
  • 
        "HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
        An optional value in  aOvfValues[] and  aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
        the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
        writes into the OVF.
        The matching item in the  aRefs[] array will contain an integer that items of the "Harddisk"
        type can use to specify which hard disk controller a virtual disk should be connected to.
        Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
        in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
        its virtual machines supports four channels (primary master, primary slave, secondary master,
        secondary slave) and thus maps to two IDE controllers in the OVF sense.
      
  • 
        "HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
        has no value in  aOvfValues[] or  aVBoxValues[].
        The matching item in the  aRefs[] array will be used as with IDE controllers (see above).
      
  • 
        "HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
        The items in  aOvfValues[] and  aVBoxValues[] will either be "LsiLogic", "BusLogic" or
        "LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
        whereas VirtualBox considers it a class of storage controllers of its own; see
        {@link org.virtualbox_4_2.StorageControllerType}).
        The matching item in the  aRefs[] array will be used as with IDE controllers (see above).
      
  • 
        "HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
        arbitrary number of these items, one for each virtual disk image that accompanies the OVF.

        The array item in  aOvfValues[] will contain the file specification from the OVF file (without
        a path since the image file should be in the same location as the OVF file itself), whereas the
        item in  aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
        hard disk image. This means that on import the image will be copied and converted from the
        "ovf" location to the "vbox" location; on export, this will be handled the other way round.

        The matching item in the  aExtraConfigValues[] array must contain a string of the following
        format: "controller=;channel="
        In this string,  must be an integer specifying the hard disk controller to connect
        the image to. That number must be the index of an array item with one of the hard disk controller
        types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
        In addition,  must specify the channel to use on that controller. For IDE controllers,
        this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
        before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
        no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
      
  • 
        "CDROM": a virtual CD-ROM drive. The matching item in  aExtraConfigValue[] contains the same
        attachment information as with "HardDiskImage" items.
      
  • 
        "CDROM": a virtual floppy drive. The matching item in  aExtraConfigValue[] contains the same
        attachment information as with "HardDiskImage" items.
      
  • 
        "NetworkAdapter": a network adapter. The array item in  aVBoxValues[] will specify the hardware
        for the network adapter, whereas the array item in  aExtraConfigValues[] will have a string
        of the "type=" format, where  must be either "NAT" or "Bridged".
      
  • 
          "USBController": a USB controller. There can be at most one such item. If and only if such an
          item ispresent, USB support will be enabled for the new virtual machine.
      
  • 
          "SoundCard": a sound card. There can be at most one such item. If and only if such an item is
          present, sound support will be enabled for the new virtual machine. Note that the virtual
          machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
          may be different from the virtual soundcard expected by the appliance.
      

*/
    public void getDescription(Holder> aTypes, Holder> aRefs, Holder> aOvfValues, Holder> aVBoxValues, Holder> aExtraConfigValues) {
      try {
        javax.xml.ws.Holder>   tmp_aTypes = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aRefs = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aOvfValues = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aVBoxValues = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aExtraConfigValues = new  javax.xml.ws.Holder>();
        port.iVirtualSystemDescriptionGetDescription(obj, tmp_aTypes, tmp_aRefs, tmp_aOvfValues, tmp_aVBoxValues, tmp_aExtraConfigValues);
        aTypes.value = Helper.convertEnums(org.virtualbox_4_2.jaxws.VirtualSystemDescriptionType.class, org.virtualbox_4_2.VirtualSystemDescriptionType.class, tmp_aTypes.value);
        aRefs.value = tmp_aRefs.value;
        aOvfValues.value = tmp_aOvfValues.value;
        aVBoxValues.value = tmp_aVBoxValues.value;
        aExtraConfigValues.value = tmp_aExtraConfigValues.value;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
/**
This is the same as {@link #getDescription(Holder,Holder,Holder,Holder,Holder)} except that you can specify which types
      should be returned.
*/
    public void getDescriptionByType(org.virtualbox_4_2.VirtualSystemDescriptionType aType, Holder> aTypes, Holder> aRefs, Holder> aOvfValues, Holder> aVBoxValues, Holder> aExtraConfigValues) {
      try {
        javax.xml.ws.Holder>   tmp_aTypes = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aRefs = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aOvfValues = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aVBoxValues = new  javax.xml.ws.Holder>();
        javax.xml.ws.Holder>   tmp_aExtraConfigValues = new  javax.xml.ws.Holder>();
        port.iVirtualSystemDescriptionGetDescriptionByType(obj, org.virtualbox_4_2.jaxws.VirtualSystemDescriptionType.fromValue(aType.name()), tmp_aTypes, tmp_aRefs, tmp_aOvfValues, tmp_aVBoxValues, tmp_aExtraConfigValues);
        aTypes.value = Helper.convertEnums(org.virtualbox_4_2.jaxws.VirtualSystemDescriptionType.class, org.virtualbox_4_2.VirtualSystemDescriptionType.class, tmp_aTypes.value);
        aRefs.value = tmp_aRefs.value;
        aOvfValues.value = tmp_aOvfValues.value;
        aVBoxValues.value = tmp_aVBoxValues.value;
        aExtraConfigValues.value = tmp_aExtraConfigValues.value;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
/**
This is the same as {@link #getDescriptionByType(org.virtualbox_4_2.VirtualSystemDescriptionType,Holder,Holder,Holder,Holder,Holder)} except that you can specify which
      value types should be returned. See {@link org.virtualbox_4_2.VirtualSystemDescriptionValueType} for possible
      values.
*/
    public List getValuesByType(org.virtualbox_4_2.VirtualSystemDescriptionType aType, org.virtualbox_4_2.VirtualSystemDescriptionValueType aWhich) {
      try {
        List     retVal;
        retVal = port.iVirtualSystemDescriptionGetValuesByType(obj, org.virtualbox_4_2.jaxws.VirtualSystemDescriptionType.fromValue(aType.name()), org.virtualbox_4_2.jaxws.VirtualSystemDescriptionValueType.fromValue(aWhich.name()));
        return retVal;
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
/**

        This method allows the appliance's user to change the configuration for the virtual
        system descriptions. For each array item returned from {@link #getDescription(Holder,Holder,Holder,Holder,Holder)},
        you must pass in one boolean value and one configuration value.

        Each item in the boolean array determines whether the particular configuration item
        should be enabled.
        You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
        HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
        and SoundCard.

        For the "vbox" and "extra configuration" values, if you pass in the same arrays
        as returned in the aVBoxValues and aExtraConfigValues arrays from {@link #getDescription(Holder,Holder,Holder,Holder,Holder)},
        the configuration remains unchanged. Please see the documentation for {@link #getDescription(Holder,Holder,Holder,Holder,Holder)}
        for valid configuration values for the individual array item types. If the
        corresponding item in the aEnabled array is  false, the configuration value is ignored.
      
*/
    public void setFinalValues(List aEnabled, List aVBoxValues, List aExtraConfigValues) {
      try {
        port.iVirtualSystemDescriptionSetFinalValues(obj, aEnabled, aVBoxValues, aExtraConfigValues);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
/**

      This method adds an additional description entry to the stack of already
      available descriptions for this virtual system. This is handy for writing
      values which aren't directly supported by VirtualBox. One example would
      be the License type of {@link org.virtualbox_4_2.VirtualSystemDescriptionType}.
      
*/
    public void addDescription(org.virtualbox_4_2.VirtualSystemDescriptionType aType, String aVBoxValue, String aExtraConfigValue) {
      try {
        port.iVirtualSystemDescriptionAddDescription(obj, org.virtualbox_4_2.jaxws.VirtualSystemDescriptionType.fromValue(aType.name()), aVBoxValue, aExtraConfigValue);
     } catch (InvalidObjectFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     } catch (RuntimeFaultMsg e) {
          throw new VBoxException(e, e.getMessage());
     }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy