com.sun.xml.ws.commons.virtualbox.ISystemProperties Maven / Gradle / Ivy
package com.sun.xml.ws.commons.virtualbox;
import java.math.BigInteger;
import java.util.List;
import javax.xml.ws.WebServiceException;
/**
* 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.
*
*/
public class ISystemProperties
extends VBoxObject
{
public ISystemProperties(String _this, VboxPortType port) {
super(_this,port);
}
/**
* Minimum guest system memory in Megabytes.
*
*/
public long getMinGuestRAM() {
try {
long retVal = port.iSystemPropertiesGetMinGuestRAM(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Maximum guest system memory in Megabytes.
*
*/
public long getMaxGuestRAM() {
try {
long retVal = port.iSystemPropertiesGetMaxGuestRAM(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Minimum guest video memory in Megabytes.
*
*/
public long getMinGuestVRAM() {
try {
long retVal = port.iSystemPropertiesGetMinGuestVRAM(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Maximum guest video memory in Megabytes.
*
*/
public long getMaxGuestVRAM() {
try {
long retVal = port.iSystemPropertiesGetMaxGuestVRAM(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Minimum CPU count.
*
*/
public long getMinGuestCPUCount() {
try {
long retVal = port.iSystemPropertiesGetMinGuestCPUCount(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Maximum CPU count.
*
*/
public long getMaxGuestCPUCount() {
try {
long retVal = port.iSystemPropertiesGetMaxGuestCPUCount(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Maximum size of a virtual disk image in Megabytes.
*
*/
public BigInteger getMaxVDISize() {
try {
BigInteger retVal = port.iSystemPropertiesGetMaxVDISize(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Number of network adapters associated with every {@link IMachine} instance.
*
*/
public long getNetworkAdapterCount() {
try {
long retVal = port.iSystemPropertiesGetNetworkAdapterCount(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Number of serial ports associated with every {@link IMachine} instance.
*
*/
public long getSerialPortCount() {
try {
long retVal = port.iSystemPropertiesGetSerialPortCount(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Number of parallel ports associated with every {@link IMachine} instance.
*
*/
public long getParallelPortCount() {
try {
long retVal = port.iSystemPropertiesGetParallelPortCount(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* 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.
* @see
*
*/
public long getMaxBootPosition() {
try {
long retVal = port.iSystemPropertiesGetMaxBootPosition(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Full path to the default directory used to create new or open
* existing machines when a settings file name contains no
* path.
*
* The initial value of this property is< {@link IVirtualBox#homeFolder}>/Machines.Setting this property tonullwill restore the
* initial value.
When settings this property, the specified path can be
* absolute (full path) or relative
* to the {@link IVirtualBox#homeFolder}.
* When reading this property, a full path is
* always returned.
The specified path may not exist, it will be created
* when necessary.
* @see ,
*
*/
public String getDefaultMachineFolder() {
try {
String retVal = port.iSystemPropertiesGetDefaultMachineFolder(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Full path to the default directory used to create new or open
* existing machines when a settings file name contains no
* path.
*
* The initial value of this property is< {@link IVirtualBox#homeFolder}>/Machines.Setting this property tonullwill restore the
* initial value.
When settings this property, the specified path can be
* absolute (full path) or relative
* to the {@link IVirtualBox#homeFolder}.
* When reading this property, a full path is
* always returned.
The specified path may not exist, it will be created
* when necessary.
* @see ,
*
*/
public void setDefaultMachineFolder(String value) {
try {
port.iSystemPropertiesSetDefaultMachineFolder(_this, value);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Full path to the default directory used to create new or open existing
* virtual disks.
*
* This path is used when the storage unit of a hard disk is a regular file
* in the host's file system and only a file name that contains no path is
* given.
*
* The initial value of this property is< {@link IVirtualBox#homeFolder}>/HardDisks.Setting this property tonullwill restore the
* initial value.
When settings this property, the specified path can be relative
* to the {@link IVirtualBox#homeFolder} or
* absolute. When reading this property, a full path is
* always returned.
The specified path may not exist, it will be created
* when necessary.
* @see IHardDisk,,,
*
*/
public String getDefaultHardDiskFolder() {
try {
String retVal = port.iSystemPropertiesGetDefaultHardDiskFolder(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Full path to the default directory used to create new or open existing
* virtual disks.
*
* This path is used when the storage unit of a hard disk is a regular file
* in the host's file system and only a file name that contains no path is
* given.
*
* The initial value of this property is< {@link IVirtualBox#homeFolder}>/HardDisks.Setting this property tonullwill restore the
* initial value.
When settings this property, the specified path can be relative
* to the {@link IVirtualBox#homeFolder} or
* absolute. When reading this property, a full path is
* always returned.
The specified path may not exist, it will be created
* when necessary.
* @see IHardDisk,,,
*
*/
public void setDefaultHardDiskFolder(String value) {
try {
port.iSystemPropertiesSetDefaultHardDiskFolder(_this, value);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* List of all hard disk storage formats supported by this VirtualBox
* installation.
*
* Keep in mind that the hard disk format identifier
* ({@link IHardDiskFormat#id}) used in other API calls like {@link IVirtualBox#createHardDisk} to refer to a particular
* hard disk format is a case-insensitive string. This means that, for
* example, all of the following strings:"VDI"
* "vdi"
* "VdI"refer to the same hard disk format.
*
* Note that the virtual hard disk framework is backend-based, therefore
* the list of supported formats depends on what backends are currently
* installed.
* @see ,
*
*/
public List getHardDiskFormats() {
try {
List retVal = port.iSystemPropertiesGetHardDiskFormats(_this);
return Helper.wrap(IHardDiskFormat.class, port, retVal);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Identifier of the default hard disk format used by VirtualBox.
*
* The hard disk format set by this attribute is used by VirtualBox
* when the hard disk format was not specified explicitly. One example is {@link IVirtualBox#createHardDisk} with thenullformat argument. A more complex example is implicit creation of
* differencing hard disks when taking a snapshot of a virtual machine:
* this operation will try to use a format of the parent hard disk first
* and if this format does not support differencing hard disks the default
* format specified by this argument will be used.
*
* The list of supported hard disk formats may be obtained by the {@link #hardDiskFormats} call. Note that the default hard disk
* format must have a capability to create differencing hard disks;
* otherwise opeartions that create hard disks implicitly may fail
* unexpectedly.
*
* The initial value of this property isVDIin the current
* version of the VirtualBox product, but may change in the future.Setting this property tonullwill restore the
* initial value.
* @see ,,
*
*/
public String getDefaultHardDiskFormat() {
try {
String retVal = port.iSystemPropertiesGetDefaultHardDiskFormat(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Identifier of the default hard disk format used by VirtualBox.
*
* The hard disk format set by this attribute is used by VirtualBox
* when the hard disk format was not specified explicitly. One example is {@link IVirtualBox#createHardDisk} with thenullformat argument. A more complex example is implicit creation of
* differencing hard disks when taking a snapshot of a virtual machine:
* this operation will try to use a format of the parent hard disk first
* and if this format does not support differencing hard disks the default
* format specified by this argument will be used.
*
* The list of supported hard disk formats may be obtained by the {@link #hardDiskFormats} call. Note that the default hard disk
* format must have a capability to create differencing hard disks;
* otherwise opeartions that create hard disks implicitly may fail
* unexpectedly.
*
* The initial value of this property isVDIin the current
* version of the VirtualBox product, but may change in the future.Setting this property tonullwill restore the
* initial value.
* @see ,,
*
*/
public void setDefaultHardDiskFormat(String value) {
try {
port.iSystemPropertiesSetDefaultHardDiskFormat(_this, value);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Library that provides authentication for VRDP 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 isVRDPAuth. 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.Setting this property tonullwill restore the
* initial value.
*
*/
public String getRemoteDisplayAuthLibrary() {
try {
String retVal = port.iSystemPropertiesGetRemoteDisplayAuthLibrary(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* Library that provides authentication for VRDP 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 isVRDPAuth. 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.Setting this property tonullwill restore the
* initial value.
*
*/
public void setRemoteDisplayAuthLibrary(String value) {
try {
port.iSystemPropertiesSetRemoteDisplayAuthLibrary(_this, value);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* 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 {@link IWebsessionManager#logon} implementation.
*
* As opposed to {@link ISystemProperties#remoteDisplayAuthLibrary},
* 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 {@link IWebsessionManager#logon} will always succeed,
* no matter what user name and password are supplied.
*
* The initial value of this property isVRDPAuth,
* meaning that the webservice will use the same authentication
* library that is used by default for VBoxVRDP (again, see {@link ISystemProperties#remoteDisplayAuthLibrary}).
* The format and calling convention of authentication libraries
* is the same for the webservice as it is for VBoxVRDP.
*
*/
public String getWebServiceAuthLibrary() {
try {
String retVal = port.iSystemPropertiesGetWebServiceAuthLibrary(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* 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 {@link IWebsessionManager#logon} implementation.
*
* As opposed to {@link ISystemProperties#remoteDisplayAuthLibrary},
* 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 {@link IWebsessionManager#logon} will always succeed,
* no matter what user name and password are supplied.
*
* The initial value of this property isVRDPAuth,
* meaning that the webservice will use the same authentication
* library that is used by default for VBoxVRDP (again, see {@link ISystemProperties#remoteDisplayAuthLibrary}).
* The format and calling convention of authentication libraries
* is the same for the webservice as it is for VBoxVRDP.
*
*/
public void setWebServiceAuthLibrary(String value) {
try {
port.iSystemPropertiesSetWebServiceAuthLibrary(_this, value);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* This specifies the default value for hardware virtualization
* extensions. If enabled, virtual machines will make use of
* hardware virtualization extensions such as Intel VT-x and
* AMD-V by default. This value can be overridden by each VM
* using their {@link IMachine#HWVirtExEnabled} property.
*
*/
public boolean getHWVirtExEnabled() {
try {
boolean retVal = port.iSystemPropertiesGetHWVirtExEnabled(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* This specifies the default value for hardware virtualization
* extensions. If enabled, virtual machines will make use of
* hardware virtualization extensions such as Intel VT-x and
* AMD-V by default. This value can be overridden by each VM
* using their {@link IMachine#HWVirtExEnabled} property.
*
*/
public void setHWVirtExEnabled(boolean value) {
try {
port.iSystemPropertiesSetHWVirtExEnabled(_this, value);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* This value specifies how many old release log files are kept.
*
*/
public long getLogHistoryCount() {
try {
long retVal = port.iSystemPropertiesGetLogHistoryCount(_this);
return retVal;
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
/**
* This value specifies how many old release log files are kept.
*
*/
public void setLogHistoryCount(long value) {
try {
port.iSystemPropertiesSetLogHistoryCount(_this, value);
} catch (com.sun.xml.ws.commons.virtualbox.InvalidObjectFaultMsg e) {
throw new WebServiceException(e);
} catch (com.sun.xml.ws.commons.virtualbox.RuntimeFaultMsg e) {
throw new WebServiceException(e);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy