public class IVirtualSystemDescription extends IUnknown
IAppliance.getVirtualSystemDescriptions()
array. AfterIAppliance.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. SeeIAppliance
for the steps required to
import an OVF into VirtualBox.
Interface ID: {01510F40-C196-4D26-B8DB-4C8C389F1F82}Constructor and Description |
---|
IVirtualSystemDescription(java.lang.String wrapped,
org.virtualbox_6_1.ObjectRefManager objMgr,
org.virtualbox_6_1.jaxws.VboxPortType port) |
Modifier and Type | Method and Description |
---|---|
void |
addDescription(VirtualSystemDescriptionType type,
java.lang.String VBoxValue,
java.lang.String extraConfigValue)
This method adds an additional description entry to the stack of already
available descriptions for this virtual system.
|
java.lang.Long |
getCount()
Return the number of virtual system description entries.
|
void |
getDescription(Holder<java.util.List<VirtualSystemDescriptionType>> types,
Holder<java.util.List<java.lang.String>> refs,
Holder<java.util.List<java.lang.String>> OVFValues,
Holder<java.util.List<java.lang.String>> VBoxValues,
Holder<java.util.List<java.lang.String>> extraConfigValues)
Returns information about the virtual system as arrays of instruction items.
|
void |
getDescriptionByType(VirtualSystemDescriptionType type,
Holder<java.util.List<VirtualSystemDescriptionType>> types,
Holder<java.util.List<java.lang.String>> refs,
Holder<java.util.List<java.lang.String>> OVFValues,
Holder<java.util.List<java.lang.String>> VBoxValues,
Holder<java.util.List<java.lang.String>> extraConfigValues)
This is the same as
getDescription(Holder,Holder,Holder,Holder,Holder) except that you can specify which types
should be returned. |
java.util.List<java.lang.String> |
getValuesByType(VirtualSystemDescriptionType type,
VirtualSystemDescriptionValueType which)
This is the same as
getDescriptionByType(org.virtualbox_6_1.VirtualSystemDescriptionType,Holder,Holder,Holder,Holder,Holder) except that you can specify which
value types should be returned. |
static IVirtualSystemDescription |
queryInterface(IUnknown obj) |
void |
removeDescriptionByType(VirtualSystemDescriptionType type)
Delete all records which are equal to the passed type from the list
|
void |
setFinalValues(java.util.List<java.lang.Boolean> enabled,
java.util.List<java.lang.String> VBoxValues,
java.util.List<java.lang.String> extraConfigValues)
This method allows the appliance's user to change the configuration for the virtual
system descriptions.
|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
public IVirtualSystemDescription(java.lang.String wrapped, org.virtualbox_6_1.ObjectRefManager objMgr, org.virtualbox_6_1.jaxws.VboxPortType port)
public java.lang.Long getCount()
public static IVirtualSystemDescription queryInterface(IUnknown obj)
public void getDescription(Holder<java.util.List<VirtualSystemDescriptionType>> types, Holder<java.util.List<java.lang.String>> refs, Holder<java.util.List<java.lang.String>> OVFValues, Holder<java.util.List<java.lang.String>> VBoxValues, Holder<java.util.List<java.lang.String>> extraConfigValues)
VirtualSystemDescriptionType
enum value in the array item in aTypes[]. In each case,
the array item with the same index in OVFValues[] 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.IVirtualBox.getGuestOSTypes()
. The corresponding
item in OVFValues[] will contain a numerical value that described the operating system in the OVF.IMachine
name that does not exist yet.StorageControllerType
).
The matching item in the aRefs[] array will be used as with IDE controllers (see above).public void getDescriptionByType(VirtualSystemDescriptionType type, Holder<java.util.List<VirtualSystemDescriptionType>> types, Holder<java.util.List<java.lang.String>> refs, Holder<java.util.List<java.lang.String>> OVFValues, Holder<java.util.List<java.lang.String>> VBoxValues, Holder<java.util.List<java.lang.String>> extraConfigValues)
getDescription(Holder,Holder,Holder,Holder,Holder)
except that you can specify which types
should be returned.public void removeDescriptionByType(VirtualSystemDescriptionType type)
public java.util.List<java.lang.String> getValuesByType(VirtualSystemDescriptionType type, VirtualSystemDescriptionValueType which)
getDescriptionByType(org.virtualbox_6_1.VirtualSystemDescriptionType,Holder,Holder,Holder,Holder,Holder)
except that you can specify which
value types should be returned. SeeVirtualSystemDescriptionValueType
for possible
values.public void setFinalValues(java.util.List<java.lang.Boolean> enabled, java.util.List<java.lang.String> VBoxValues, java.util.List<java.lang.String> extraConfigValues)
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 fromgetDescription(Holder,Holder,Holder,Holder,Holder)
,
the configuration remains unchanged. Please see the documentation forgetDescription(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 addDescription(VirtualSystemDescriptionType type, java.lang.String VBoxValue, java.lang.String extraConfigValue)
VirtualSystemDescriptionType
.