org.virtualbox_4_1
Class ISystemProperties

java.lang.Object
  extended by org.virtualbox_4_1.IUnknown
      extended by org.virtualbox_4_1.ISystemProperties

public class ISystemProperties
extends IUnknown

The ISystemProperties interface represents global properties of the given VirtualBox installation. These properties define limits and default values for various attributes and parameters. Most of the properties are read-only, but some can be changed by a user. Interface ID: {8A0AB9AB-48C1-4D04-954B-4A751413D084}


Field Summary
 
Fields inherited from class org.virtualbox_4_1.IUnknown
obj, port
 
Constructor Summary
ISystemProperties(java.lang.String wrapped, org.virtualbox_4_1.jaxws.VboxPortType port)
           
 
Method Summary
 AudioDriverType getDefaultAudioDriver()
          This value hold the default audio driver for the current system.
 java.lang.String getDefaultHardDiskFormat()
          Identifier of the default medium format used by VirtualBox.
 java.lang.Boolean getDefaultIoCacheSettingForStorageController(StorageControllerType controllerType)
          Returns the default I/O cache setting for the given storage controller
 java.lang.String getDefaultMachineFolder()
          Full path to the default directory used to create new or open existing machines when a machine settings file name contains no path.
 java.lang.String getDefaultVRDEExtPack()
          The name of the extension pack providing the default VRDE.
 java.util.List<DeviceType> getDeviceTypesForStorageBus(StorageBus bus)
          Returns list of all the supported device types (DeviceType) for the given type of storage bus.
 java.lang.Long getFreeDiskSpaceError()
          Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.
 java.lang.Long getFreeDiskSpacePercentError()
          Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.
 java.lang.Long getFreeDiskSpacePercentWarning()
          Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.
 java.lang.Long getFreeDiskSpaceWarning()
          Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.
 java.lang.Long getInfoVDSize()
          Maximum size of a virtual disk image in bytes.
 java.lang.Long getLogHistoryCount()
          This value specifies how many old release log files are kept.
 java.lang.Long getMaxBootPosition()
          Maximum device position in the boot order.
 java.lang.Long getMaxDevicesPerPortForStorageBus(StorageBus bus)
          Returns the maximum number of devices which can be attached to a port for the given storage bus.
 java.lang.Long getMaxGuestCPUCount()
          Maximum CPU count.
 java.lang.Long getMaxGuestMonitors()
          Maximum of monitors which could be connected.
 java.lang.Long getMaxGuestRAM()
          Maximum guest system memory in Megabytes.
 java.lang.Long getMaxGuestVRAM()
          Maximum guest video memory in Megabytes.
 java.lang.Long getMaxInstancesOfStorageBus(ChipsetType chipset, StorageBus bus)
          Returns the maximum number of storage bus instances which can be configured for each VM.
 java.lang.Long getMaxNetworkAdapters(ChipsetType chipset)
          Maximum total number of network adapters associated with every IMachine instance.
 java.lang.Long getMaxNetworkAdaptersOfType(ChipsetType chipset, NetworkAttachmentType type)
          Maximum number of network adapters of a given attachment type, associated with every IMachine instance.
 java.lang.Long getMaxPortCountForStorageBus(StorageBus bus)
          Returns the maximum number of ports the given storage bus supports.
 java.util.List<IMediumFormat> getMediumFormats()
          List of all medium storage formats supported by this VirtualBox installation.
 java.lang.Long getMinGuestCPUCount()
          Minimum CPU count.
 java.lang.Long getMinGuestRAM()
          Minimum guest system memory in Megabytes.
 java.lang.Long getMinGuestVRAM()
          Minimum guest video memory in Megabytes.
 java.lang.Long getMinPortCountForStorageBus(StorageBus bus)
          Returns the minimum number of ports the given storage bus supports.
 java.lang.Long getParallelPortCount()
          Maximum number of parallel ports associated with every IMachine instance.
 java.lang.Long getSerialPortCount()
          Maximum number of serial ports associated with every IMachine instance.
 java.lang.String getVRDEAuthLibrary()
          Library that provides authentication for Remote Desktop clients.
 java.lang.String getWebServiceAuthLibrary()
          Library that provides authentication for webservice clients.
static ISystemProperties queryInterface(IUnknown obj)
           
 void setDefaultHardDiskFormat(java.lang.String value)
          Identifier of the default medium format used by VirtualBox.
 void setDefaultMachineFolder(java.lang.String value)
          Full path to the default directory used to create new or open existing machines when a machine settings file name contains no path.
 void setDefaultVRDEExtPack(java.lang.String value)
          The name of the extension pack providing the default VRDE.
 void setFreeDiskSpaceError(java.lang.Long value)
          Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.
 void setFreeDiskSpacePercentError(java.lang.Long value)
          Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.
 void setFreeDiskSpacePercentWarning(java.lang.Long value)
          Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.
 void setFreeDiskSpaceWarning(java.lang.Long value)
          Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.
 void setLogHistoryCount(java.lang.Long value)
          This value specifies how many old release log files are kept.
 void setVRDEAuthLibrary(java.lang.String value)
          Library that provides authentication for Remote Desktop clients.
 void setWebServiceAuthLibrary(java.lang.String value)
          Library that provides authentication for webservice clients.
 
Methods inherited from class org.virtualbox_4_1.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ISystemProperties

public ISystemProperties(java.lang.String wrapped,
                         org.virtualbox_4_1.jaxws.VboxPortType port)
Method Detail

getMinGuestRAM

public java.lang.Long getMinGuestRAM()
Minimum guest system memory in Megabytes.

Returns:
Long

getMaxGuestRAM

public java.lang.Long getMaxGuestRAM()
Maximum guest system memory in Megabytes.

Returns:
Long

getMinGuestVRAM

public java.lang.Long getMinGuestVRAM()
Minimum guest video memory in Megabytes.

Returns:
Long

getMaxGuestVRAM

public java.lang.Long getMaxGuestVRAM()
Maximum guest video memory in Megabytes.

Returns:
Long

getMinGuestCPUCount

public java.lang.Long getMinGuestCPUCount()
Minimum CPU count.

Returns:
Long

getMaxGuestCPUCount

public java.lang.Long getMaxGuestCPUCount()
Maximum CPU count.

Returns:
Long

getMaxGuestMonitors

public java.lang.Long getMaxGuestMonitors()
Maximum of monitors which could be connected.

Returns:
Long

getInfoVDSize

public java.lang.Long getInfoVDSize()
Maximum size of a virtual disk image in bytes. Informational value, does not reflect the limits of any virtual disk image format.

Returns:
Long

getSerialPortCount

public java.lang.Long getSerialPortCount()
Maximum number of serial ports associated with every IMachine instance.

Returns:
Long

getParallelPortCount

public java.lang.Long getParallelPortCount()
Maximum number of parallel ports associated with every IMachine instance.

Returns:
Long

getMaxBootPosition

public java.lang.Long getMaxBootPosition()
Maximum device position in the boot order. This value corresponds to the total number of devices a machine can boot from, to make it possible to include all possible devices to the boot list.

Returns:
Long
See Also:
IMachine.setBootOrder(Long,org.virtualbox_4_1.DeviceType)

getDefaultMachineFolder

public java.lang.String getDefaultMachineFolder()
Full path to the default directory used to create new or open existing machines when a machine settings file name contains no path. Starting with VirtualBox 4.0, by default, this attribute contains the full path of folder named "VirtualBox VMs" in the user's home directory, which depends on the host platform. When setting this attribute, a full path must be specified. Setting this property to null or an empty string or the special value "Machines" (for compatibility reasons) will restore that default value. If the folder specified herein does not exist, it will be created automatically as needed.

Returns:
String
See Also:
IVirtualBox.createMachine(String,String,String,String,Boolean), IVirtualBox.openMachine(String)

setDefaultMachineFolder

public void setDefaultMachineFolder(java.lang.String value)
Full path to the default directory used to create new or open existing machines when a machine settings file name contains no path. Starting with VirtualBox 4.0, by default, this attribute contains the full path of folder named "VirtualBox VMs" in the user's home directory, which depends on the host platform. When setting this attribute, a full path must be specified. Setting this property to null or an empty string or the special value "Machines" (for compatibility reasons) will restore that default value. If the folder specified herein does not exist, it will be created automatically as needed.

Parameters:
value - String
See Also:
IVirtualBox.createMachine(String,String,String,String,Boolean), IVirtualBox.openMachine(String)

getMediumFormats

public java.util.List<IMediumFormat> getMediumFormats()
List of all medium storage formats supported by this VirtualBox installation. Keep in mind that the medium format identifier (IMediumFormat.getId()) used in other API calls like IVirtualBox.createHardDisk(String,String) to refer to a particular medium format is a case-insensitive string. This means that, for example, all of the following strings:
          "VDI"
          "vdi"
          "VdI"
refer to the same medium format. Note that the virtual medium framework is backend-based, therefore the list of supported formats depends on what backends are currently installed.

Returns:
List
See Also:
IMediumFormat

getDefaultHardDiskFormat

public java.lang.String getDefaultHardDiskFormat()
Identifier of the default medium format used by VirtualBox. The medium format set by this attribute is used by VirtualBox when the medium format was not specified explicitly. One example is IVirtualBox.createHardDisk(String,String) with the empty format argument. A more complex example is implicit creation of differencing media when taking a snapshot of a virtual machine: this operation will try to use a format of the parent medium first and if this format does not support differencing media the default format specified by this argument will be used. The list of supported medium formats may be obtained by the getMediumFormats() call. Note that the default medium format must have a capability to create differencing media; otherwise operations that create media implicitly may fail unexpectedly. The initial value of this property is "VDI" in the current version of the VirtualBox product, but may change in the future. NOTE: Setting this property to null or empty string will restore the initial value.

Returns:
String
See Also:
getMediumFormats(), IMediumFormat.getId(), IVirtualBox.createHardDisk(String,String)

setDefaultHardDiskFormat

public void setDefaultHardDiskFormat(java.lang.String value)
Identifier of the default medium format used by VirtualBox. The medium format set by this attribute is used by VirtualBox when the medium format was not specified explicitly. One example is IVirtualBox.createHardDisk(String,String) with the empty format argument. A more complex example is implicit creation of differencing media when taking a snapshot of a virtual machine: this operation will try to use a format of the parent medium first and if this format does not support differencing media the default format specified by this argument will be used. The list of supported medium formats may be obtained by the getMediumFormats() call. Note that the default medium format must have a capability to create differencing media; otherwise operations that create media implicitly may fail unexpectedly. The initial value of this property is "VDI" in the current version of the VirtualBox product, but may change in the future. NOTE: Setting this property to null or empty string will restore the initial value.

Parameters:
value - String
See Also:
getMediumFormats(), IMediumFormat.getId(), IVirtualBox.createHardDisk(String,String)

getFreeDiskSpaceWarning

public java.lang.Long getFreeDiskSpaceWarning()
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.

Returns:
Long

setFreeDiskSpaceWarning

public void setFreeDiskSpaceWarning(java.lang.Long value)
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.

Parameters:
value - Long

getFreeDiskSpacePercentWarning

public java.lang.Long getFreeDiskSpacePercentWarning()
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.

Returns:
Long

setFreeDiskSpacePercentWarning

public void setFreeDiskSpacePercentWarning(java.lang.Long value)
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.

Parameters:
value - Long

getFreeDiskSpaceError

public java.lang.Long getFreeDiskSpaceError()
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.

Returns:
Long

setFreeDiskSpaceError

public void setFreeDiskSpaceError(java.lang.Long value)
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes.

Parameters:
value - Long

getFreeDiskSpacePercentError

public java.lang.Long getFreeDiskSpacePercentError()
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.

Returns:
Long

setFreeDiskSpacePercentError

public void setFreeDiskSpacePercentError(java.lang.Long value)
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage.

Parameters:
value - Long

getVRDEAuthLibrary

public java.lang.String getVRDEAuthLibrary()
Library that provides authentication for Remote Desktop clients. The library is used if a virtual machine's authentication type is set to "external" in the VM RemoteDisplay configuration. The system library extension (".DLL" or ".so") must be omitted. A full path can be specified; if not, then the library must reside on the system's default library path. The default value of this property is "VBoxAuth". There is a library of that name in one of the default VirtualBox library directories. For details about VirtualBox authentication libraries and how to implement them, please refer to the VirtualBox manual. NOTE: Setting this property to null or empty string will restore the initial value.

Returns:
String

setVRDEAuthLibrary

public void setVRDEAuthLibrary(java.lang.String value)
Library that provides authentication for Remote Desktop clients. The library is used if a virtual machine's authentication type is set to "external" in the VM RemoteDisplay configuration. The system library extension (".DLL" or ".so") must be omitted. A full path can be specified; if not, then the library must reside on the system's default library path. The default value of this property is "VBoxAuth". There is a library of that name in one of the default VirtualBox library directories. For details about VirtualBox authentication libraries and how to implement them, please refer to the VirtualBox manual. NOTE: Setting this property to null or empty string will restore the initial value.

Parameters:
value - String

getWebServiceAuthLibrary

public java.lang.String getWebServiceAuthLibrary()
Library that provides authentication for webservice clients. The library is used if a virtual machine's authentication type is set to "external" in the VM RemoteDisplay configuration and will be called from within the org.virtualbox_4_1.IWebsessionManager#logon(String,String) implementation. As opposed to getVRDEAuthLibrary(), there is no per-VM setting for this, as the webservice is a global resource (if it is running). Only for this setting (for the webservice), setting this value to a literal "null" string disables authentication, meaning that org.virtualbox_4_1.IWebsessionManager#logon(String,String) will always succeed, no matter what user name and password are supplied. The initial value of this property is "VBoxAuth", meaning that the webservice will use the same authentication library that is used by default for VRDE (again, see getVRDEAuthLibrary()). The format and calling convention of authentication libraries is the same for the webservice as it is for VRDE. NOTE: Setting this property to null or empty string will restore the initial value.

Returns:
String

setWebServiceAuthLibrary

public void setWebServiceAuthLibrary(java.lang.String value)
Library that provides authentication for webservice clients. The library is used if a virtual machine's authentication type is set to "external" in the VM RemoteDisplay configuration and will be called from within the org.virtualbox_4_1.IWebsessionManager#logon(String,String) implementation. As opposed to getVRDEAuthLibrary(), there is no per-VM setting for this, as the webservice is a global resource (if it is running). Only for this setting (for the webservice), setting this value to a literal "null" string disables authentication, meaning that org.virtualbox_4_1.IWebsessionManager#logon(String,String) will always succeed, no matter what user name and password are supplied. The initial value of this property is "VBoxAuth", meaning that the webservice will use the same authentication library that is used by default for VRDE (again, see getVRDEAuthLibrary()). The format and calling convention of authentication libraries is the same for the webservice as it is for VRDE. NOTE: Setting this property to null or empty string will restore the initial value.

Parameters:
value - String

getDefaultVRDEExtPack

public java.lang.String getDefaultVRDEExtPack()
The name of the extension pack providing the default VRDE. This attribute is for choosing between multiple extension packs providing VRDE. If only one is installed, it will automatically be the default one. The attribute value can be empty if no VRDE extension pack is installed. For details about VirtualBox Remote Desktop Extension and how to implement one, please refer to the VirtualBox SDK.

Returns:
String

setDefaultVRDEExtPack

public void setDefaultVRDEExtPack(java.lang.String value)
The name of the extension pack providing the default VRDE. This attribute is for choosing between multiple extension packs providing VRDE. If only one is installed, it will automatically be the default one. The attribute value can be empty if no VRDE extension pack is installed. For details about VirtualBox Remote Desktop Extension and how to implement one, please refer to the VirtualBox SDK.

Parameters:
value - String

getLogHistoryCount

public java.lang.Long getLogHistoryCount()
This value specifies how many old release log files are kept.

Returns:
Long

setLogHistoryCount

public void setLogHistoryCount(java.lang.Long value)
This value specifies how many old release log files are kept.

Parameters:
value - Long

getDefaultAudioDriver

public AudioDriverType getDefaultAudioDriver()
This value hold the default audio driver for the current system.

Returns:
org.virtualbox_4_1.AudioDriverType

queryInterface

public static ISystemProperties queryInterface(IUnknown obj)

getMaxNetworkAdapters

public java.lang.Long getMaxNetworkAdapters(ChipsetType chipset)
Maximum total number of network adapters associated with every IMachine instance.

Parameters:
chipset - The chipset type to get the value for.
Returns:
The maximum total number of network adapters allowed.

getMaxNetworkAdaptersOfType

public java.lang.Long getMaxNetworkAdaptersOfType(ChipsetType chipset,
                                                  NetworkAttachmentType type)
Maximum number of network adapters of a given attachment type, associated with every IMachine instance.

Parameters:
chipset - The chipset type to get the value for.
type - Type of attachment.
Returns:
The maximum number of network adapters allowed for particular chipset and attachment type.

getMaxDevicesPerPortForStorageBus

public java.lang.Long getMaxDevicesPerPortForStorageBus(StorageBus bus)
Returns the maximum number of devices which can be attached to a port for the given storage bus.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The maximum number of devices which can be attached to the port for the given storage bus.

getMinPortCountForStorageBus

public java.lang.Long getMinPortCountForStorageBus(StorageBus bus)
Returns the minimum number of ports the given storage bus supports.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The minimum number of ports for the given storage bus.

getMaxPortCountForStorageBus

public java.lang.Long getMaxPortCountForStorageBus(StorageBus bus)
Returns the maximum number of ports the given storage bus supports.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The maximum number of ports for the given storage bus.

getMaxInstancesOfStorageBus

public java.lang.Long getMaxInstancesOfStorageBus(ChipsetType chipset,
                                                  StorageBus bus)
Returns the maximum number of storage bus instances which can be configured for each VM. This corresponds to the number of storage controllers one can have. Value may depend on chipset type used.

Parameters:
chipset - The chipset type to get the value for.
bus - The storage bus type to get the value for.
Returns:
The maximum number of instances for the given storage bus.

getDeviceTypesForStorageBus

public java.util.List<DeviceType> getDeviceTypesForStorageBus(StorageBus bus)
Returns list of all the supported device types (DeviceType) for the given type of storage bus.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The list of all supported device types for the given storage bus.

getDefaultIoCacheSettingForStorageController

public java.lang.Boolean getDefaultIoCacheSettingForStorageController(StorageControllerType controllerType)
Returns the default I/O cache setting for the given storage controller

Parameters:
controllerType - The storage controller to the setting for.
Returns:
Returned flag indicating the default value