public class ISystemProperties extends IUnknown
{BED5B0EC-E866-401B-AC32-FD63AA67954B}
Constructor and Description |
---|
ISystemProperties(java.lang.String wrapped,
org.virtualbox_7_1.ObjectRefManager objMgr,
org.virtualbox_7_1.jaxws.VboxPortType port) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAutostartDatabasePath()
The path to the autostart database.
|
java.util.List<ICPUProfile> |
getCPUProfiles(CPUArchitecture architecture,
java.lang.String namePattern)
Returns CPU profiles matching the given criteria.
|
java.lang.String |
getDefaultAdditionsISO()
The path to the default Guest Additions ISO image.
|
AudioDriverType |
getDefaultAudioDriver()
This value hold the default audio driver for the current
system.
|
java.lang.String |
getDefaultCryptoExtPack()
The name of the extension pack providing the default cryptographic support
for full VM encryption.
|
java.lang.String |
getDefaultFrontend()
Selects which VM frontend should be used by default when launching
a VM through the
IMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List) method. |
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.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.String |
getLanguageId()
The API language ID used to translate messages to client.
|
java.lang.String |
getLoggingLevel()
Specifies the logging level in current use by VirtualBox.
|
java.lang.Long |
getLogHistoryCount()
This value specifies how many old release log files are kept.
|
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.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.
|
IPlatformProperties |
getPlatform()
Platform properties of the VirtualBox installation.
|
ProxyMode |
getProxyMode()
The proxy mode setting: System, NoProxy or Manual.
|
java.lang.String |
getProxyURL()
Proxy server URL for the
ProxyMode.Manual proxy mode. |
java.util.List<BitmapFormat> |
getScreenShotFormats()
Supported bitmap formats which can be used with takeScreenShot
and takeScreenShotToArray methods.
|
java.util.List<AudioDriverType> |
getSupportedAudioDriverTypes()
Returns an array of officially supported values for enum
AudioDriverType ,
in the sense of what is e.g. |
java.util.List<AutostopType> |
getSupportedAutostopTypes()
Returns an array of officially supported values for enum
AutostopType ,
in the sense of what is e.g. |
java.util.List<ClipboardMode> |
getSupportedClipboardModes()
Returns an array of officially supported values for enum
ClipboardMode ,
in the sense of what is e.g. |
java.util.List<CloneOptions> |
getSupportedCloneOptions()
Returns an array of officially supported values for enum
CloneOptions ,
in the sense of what is e.g. |
java.util.List<DnDMode> |
getSupportedDnDModes()
Returns an array of officially supported values for enum
DnDMode ,
in the sense of what is e.g. |
java.util.List<ExportOptions> |
getSupportedExportOptions()
Returns an array of officially supported values for enum
ExportOptions ,
in the sense of what is e.g. |
java.util.List<ImportOptions> |
getSupportedImportOptions()
Returns an array of officially supported values for enum
ImportOptions ,
in the sense of what is e.g. |
java.util.List<KeyboardHIDType> |
getSupportedKeyboardHIDTypes()
Returns an array of officially supported values for enum
KeyboardHIDType ,
in the sense of what is e.g. |
java.util.List<NetworkAttachmentType> |
getSupportedNetworkAttachmentTypes()
Returns an array of officially supported values for enum
NetworkAttachmentType ,
in the sense of what is e.g. |
java.util.List<PlatformArchitecture> |
getSupportedPlatformArchitectures()
Returns an array of officially supported values for enum
PlatformArchitecture ,
in the sense of what is e.g. |
java.util.List<PointingHIDType> |
getSupportedPointingHIDTypes()
Returns an array of officially supported values for enum
PointingHIDType ,
in the sense of what is e.g. |
java.util.List<PortMode> |
getSupportedPortModes()
Returns an array of officially supported values for enum
PortMode ,
in the sense of what is e.g. |
java.util.List<RecordingRateControlMode> |
getSupportedRecordingARCModes()
Returns an array of officially supported audio codec values for enum
RecordingRateControlMode ,
in the sense of what is e.g. |
java.util.List<RecordingAudioCodec> |
getSupportedRecordingAudioCodecs()
Returns an array of officially supported values for enum
RecordingAudioCodec ,
in the sense of what is e.g. |
java.util.List<RecordingFeature> |
getSupportedRecordingFeatures()
Returns an array of officially supported values for enum
RecordingFeature ,
in the sense of what is e.g. |
java.util.List<RecordingVideoCodec> |
getSupportedRecordingVideoCodecs()
Returns an array of officially supported values for enum
RecordingVideoCodec ,
in the sense of what is e.g. |
java.util.List<RecordingRateControlMode> |
getSupportedRecordingVRCModes()
Returns an array of officially supported video codec values for enum
RecordingRateControlMode ,
in the sense of what is e.g. |
java.util.List<RecordingVideoScalingMode> |
getSupportedRecordingVSModes()
Returns an array of officially supported values for enum
RecordingVideoScalingMode ,
in the sense of what is e.g. |
java.util.List<VFSType> |
getSupportedVFSTypes()
Returns an array of officially supported values for enum
VFSType ,
in the sense of what is e.g. |
java.util.List<VMProcPriority> |
getSupportedVMProcPriorities()
Returns an array of officially supported values for enum
VMProcPriority ,
in the sense of what is e.g. |
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 |
setAutostartDatabasePath(java.lang.String value)
The path to the autostart database.
|
void |
setDefaultAdditionsISO(java.lang.String value)
The path to the default Guest Additions ISO image.
|
void |
setDefaultCryptoExtPack(java.lang.String value)
The name of the extension pack providing the default cryptographic support
for full VM encryption.
|
void |
setDefaultFrontend(java.lang.String value)
Selects which VM frontend should be used by default when launching
a VM through the
IMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List) method. |
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 |
setLanguageId(java.lang.String value)
The API language ID used to translate messages to client.
|
void |
setLoggingLevel(java.lang.String value)
Specifies the logging level in current use by VirtualBox.
|
void |
setLogHistoryCount(java.lang.Long value)
This value specifies how many old release log files are kept.
|
void |
setProxyMode(ProxyMode value)
The proxy mode setting: System, NoProxy or Manual.
|
void |
setProxyURL(java.lang.String value)
Proxy server URL for the
ProxyMode.Manual proxy mode. |
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.
|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
public ISystemProperties(java.lang.String wrapped, org.virtualbox_7_1.ObjectRefManager objMgr, org.virtualbox_7_1.jaxws.VboxPortType port)
public IPlatformProperties getPlatform()
public java.lang.Long getMinGuestRAM()
public java.lang.Long getMaxGuestRAM()
public java.lang.Long getMinGuestVRAM()
public java.lang.Long getMaxGuestVRAM()
public java.lang.Long getMinGuestCPUCount()
public java.lang.Long getMaxGuestCPUCount()
public java.lang.Long getMaxGuestMonitors()
public java.lang.Long getInfoVDSize()
public java.lang.String getDefaultMachineFolder()
public void setDefaultMachineFolder(java.lang.String value)
public java.lang.String getLoggingLevel()
public void setLoggingLevel(java.lang.String value)
value
- Stringpublic java.util.List<IMediumFormat> getMediumFormats()
IMediumFormat.getId()
) used in other API calls likeIVirtualBox.createMedium(String,String,org.virtualbox_7_1.AccessMode,org.virtualbox_7_1.DeviceType)
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.
IMediumFormat
public java.lang.String getDefaultHardDiskFormat()
IVirtualBox.createMedium(String,String,org.virtualbox_7_1.AccessMode,org.virtualbox_7_1.DeviceType)
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 thegetMediumFormats()
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.public void setDefaultHardDiskFormat(java.lang.String value)
IVirtualBox.createMedium(String,String,org.virtualbox_7_1.AccessMode,org.virtualbox_7_1.DeviceType)
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 thegetMediumFormats()
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.value
- StringgetMediumFormats()
,
IMediumFormat.getId()
,
IVirtualBox.createMedium(String,String,org.virtualbox_7_1.AccessMode,org.virtualbox_7_1.DeviceType)
public java.lang.Long getFreeDiskSpaceWarning()
public void setFreeDiskSpaceWarning(java.lang.Long value)
value
- Longpublic java.lang.Long getFreeDiskSpacePercentWarning()
public void setFreeDiskSpacePercentWarning(java.lang.Long value)
value
- Longpublic java.lang.Long getFreeDiskSpaceError()
public void setFreeDiskSpaceError(java.lang.Long value)
value
- Longpublic java.lang.Long getFreeDiskSpacePercentError()
public void setFreeDiskSpacePercentError(java.lang.Long value)
value
- Longpublic java.lang.String getVRDEAuthLibrary()
"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.public void setVRDEAuthLibrary(java.lang.String value)
"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.value
- Stringpublic java.lang.String getWebServiceAuthLibrary()
IWebsessionManager.logon(String,String)
implementation.
As opposed togetVRDEAuthLibrary()
,
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 thatIWebsessionManager.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, seegetVRDEAuthLibrary()
).
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.public void setWebServiceAuthLibrary(java.lang.String value)
IWebsessionManager.logon(String,String)
implementation.
As opposed togetVRDEAuthLibrary()
,
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 thatIWebsessionManager.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, seegetVRDEAuthLibrary()
).
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.value
- Stringpublic java.lang.String getDefaultVRDEExtPack()
public void setDefaultVRDEExtPack(java.lang.String value)
value
- Stringpublic java.lang.String getDefaultCryptoExtPack()
public void setDefaultCryptoExtPack(java.lang.String value)
value
- Stringpublic java.lang.Long getLogHistoryCount()
public void setLogHistoryCount(java.lang.Long value)
value
- Longpublic AudioDriverType getDefaultAudioDriver()
public java.lang.String getAutostartDatabasePath()
public void setAutostartDatabasePath(java.lang.String value)
value
- Stringpublic java.lang.String getDefaultAdditionsISO()
public void setDefaultAdditionsISO(java.lang.String value)
value
- Stringpublic java.lang.String getDefaultFrontend()
IMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
method.
Empty or null strings do not define a particular default, it is up
toIMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
to select one. See the
description ofIMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
for the valid
frontend types.
This global setting is overridden by the per-VM attributeIMachine.getDefaultFrontend()
or a frontend type
passed toIMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
.public void setDefaultFrontend(java.lang.String value)
IMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
method.
Empty or null strings do not define a particular default, it is up
toIMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
to select one. See the
description ofIMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
for the valid
frontend types.
This global setting is overridden by the per-VM attributeIMachine.getDefaultFrontend()
or a frontend type
passed toIMachine.launchVMProcess(org.virtualbox_7_1.ISession,String,List)
.value
- Stringpublic java.util.List<BitmapFormat> getScreenShotFormats()
public ProxyMode getProxyMode()
public void setProxyMode(ProxyMode value)
value
- org.virtualbox_7_1.ProxyModepublic java.lang.String getProxyURL()
ProxyMode.Manual
proxy mode.
The format is: [{type}"://"][{userid}[:{password}]@]{server}[":"{port}]
Valid types are: http (default), https, socks4, socks4a, socks5, socks5h and direct.
Please note that these are proxy types defining how the proxy operates rather than
how to proxy any similarly named protocol (i.e. don't confuse a http-proxy with
proxying the http protocol, as a http-proxy usually can proxy https and other protocols too).
The port number defaults to 80 for http, 443 for https and 1080 for the socks ones.An empty string will cause the behavior to be identical toProxyMode.System
.
For compatibility with libproxy, an URL starting with "direct://" will causeProxyMode.NoProxy
behavior.
NOTE: The password is currently stored as plain text! Use theProxyMode.System
mode if you consider the proxy password to be sensitive.public void setProxyURL(java.lang.String value)
ProxyMode.Manual
proxy mode.
The format is: [{type}"://"][{userid}[:{password}]@]{server}[":"{port}]
Valid types are: http (default), https, socks4, socks4a, socks5, socks5h and direct.
Please note that these are proxy types defining how the proxy operates rather than
how to proxy any similarly named protocol (i.e. don't confuse a http-proxy with
proxying the http protocol, as a http-proxy usually can proxy https and other protocols too).
The port number defaults to 80 for http, 443 for https and 1080 for the socks ones.An empty string will cause the behavior to be identical toProxyMode.System
.
For compatibility with libproxy, an URL starting with "direct://" will causeProxyMode.NoProxy
behavior.
NOTE: The password is currently stored as plain text! Use theProxyMode.System
mode if you consider the proxy password to be sensitive.value
- Stringpublic java.util.List<PlatformArchitecture> getSupportedPlatformArchitectures()
PlatformArchitecture
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<ClipboardMode> getSupportedClipboardModes()
ClipboardMode
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<DnDMode> getSupportedDnDModes()
DnDMode
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<PointingHIDType> getSupportedPointingHIDTypes()
PointingHIDType
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<KeyboardHIDType> getSupportedKeyboardHIDTypes()
KeyboardHIDType
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<VFSType> getSupportedVFSTypes()
VFSType
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<ImportOptions> getSupportedImportOptions()
ImportOptions
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<ExportOptions> getSupportedExportOptions()
ExportOptions
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<RecordingFeature> getSupportedRecordingFeatures()
RecordingFeature
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<RecordingAudioCodec> getSupportedRecordingAudioCodecs()
RecordingAudioCodec
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<RecordingVideoCodec> getSupportedRecordingVideoCodecs()
RecordingVideoCodec
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<RecordingVideoScalingMode> getSupportedRecordingVSModes()
RecordingVideoScalingMode
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<RecordingRateControlMode> getSupportedRecordingARCModes()
RecordingRateControlMode
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<RecordingRateControlMode> getSupportedRecordingVRCModes()
RecordingRateControlMode
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<CloneOptions> getSupportedCloneOptions()
CloneOptions
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<AutostopType> getSupportedAutostopTypes()
AutostopType
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<VMProcPriority> getSupportedVMProcPriorities()
VMProcPriority
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<NetworkAttachmentType> getSupportedNetworkAttachmentTypes()
NetworkAttachmentType
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<PortMode> getSupportedPortModes()
PortMode
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.util.List<AudioDriverType> getSupportedAudioDriverTypes()
AudioDriverType
,
in the sense of what is e.g. worth offering in the VirtualBox GUI.public java.lang.String getLanguageId()
public void setLanguageId(java.lang.String value)
value
- Stringpublic static ISystemProperties queryInterface(IUnknown obj)
public java.lang.Boolean getDefaultIoCacheSettingForStorageController(StorageControllerType controllerType)
controllerType
- The storage controller type to get the setting for.public java.util.List<ICPUProfile> getCPUProfiles(CPUArchitecture architecture, java.lang.String namePattern)
architecture
- The architecture to get profiles for. Required.namePattern
- Name pattern. Simple wildcard matching using asterisk (*) and
question mark (?).