org.virtualbox_4_1
Class IVRDEServer

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

public class IVRDEServer
extends IUnknown


Field Summary
 
Fields inherited from class org.virtualbox_4_1.IUnknown
obj, port
 
Constructor Summary
IVRDEServer(java.lang.String wrapped, org.virtualbox_4_1.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean getAllowMultiConnection()
          Flag whether multiple simultaneous connections to the VM are permitted.
 java.lang.String getAuthLibrary()
          Library used for authentication of RDP clients by this VM.
 java.lang.Long getAuthTimeout()
          Timeout for guest authentication.
 AuthType getAuthType()
          VRDE authentication method.
 java.lang.Boolean getEnabled()
          VRDE server status.
 java.lang.Boolean getReuseSingleConnection()
          Flag whether the existing connection must be dropped and a new connection must be established by the VRDE server, when a new client connects in single connection mode.
 java.lang.String getVRDEExtPack()
          The name of Extension Pack providing VRDE for this VM.
 java.util.List<java.lang.String> getVRDEProperties()
          Array of names of properties, which are supported by this VRDE server.
 java.lang.String getVRDEProperty(java.lang.String key)
          Returns a VRDE specific property string.
static IVRDEServer queryInterface(IUnknown obj)
           
 void setAllowMultiConnection(java.lang.Boolean value)
          Flag whether multiple simultaneous connections to the VM are permitted.
 void setAuthLibrary(java.lang.String value)
          Library used for authentication of RDP clients by this VM.
 void setAuthTimeout(java.lang.Long value)
          Timeout for guest authentication.
 void setAuthType(AuthType value)
          VRDE authentication method.
 void setEnabled(java.lang.Boolean value)
          VRDE server status.
 void setReuseSingleConnection(java.lang.Boolean value)
          Flag whether the existing connection must be dropped and a new connection must be established by the VRDE server, when a new client connects in single connection mode.
 void setVRDEExtPack(java.lang.String value)
          The name of Extension Pack providing VRDE for this VM.
 void setVRDEProperty(java.lang.String key, java.lang.String value)
          Sets a VRDE specific property string.
 
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

IVRDEServer

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

getEnabled

public java.lang.Boolean getEnabled()
VRDE server status.

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
VRDE server status.

Parameters:
value - Boolean

getAuthType

public AuthType getAuthType()
VRDE authentication method.

Returns:
org.virtualbox_4_1.AuthType

setAuthType

public void setAuthType(AuthType value)
VRDE authentication method.

Parameters:
value - org.virtualbox_4_1.AuthType

getAuthTimeout

public java.lang.Long getAuthTimeout()
Timeout for guest authentication. Milliseconds.

Returns:
Long

setAuthTimeout

public void setAuthTimeout(java.lang.Long value)
Timeout for guest authentication. Milliseconds.

Parameters:
value - Long

getAllowMultiConnection

public java.lang.Boolean getAllowMultiConnection()
Flag whether multiple simultaneous connections to the VM are permitted. Note that this will be replaced by a more powerful mechanism in the future.

Returns:
Boolean

setAllowMultiConnection

public void setAllowMultiConnection(java.lang.Boolean value)
Flag whether multiple simultaneous connections to the VM are permitted. Note that this will be replaced by a more powerful mechanism in the future.

Parameters:
value - Boolean

getReuseSingleConnection

public java.lang.Boolean getReuseSingleConnection()
Flag whether the existing connection must be dropped and a new connection must be established by the VRDE server, when a new client connects in single connection mode.

Returns:
Boolean

setReuseSingleConnection

public void setReuseSingleConnection(java.lang.Boolean value)
Flag whether the existing connection must be dropped and a new connection must be established by the VRDE server, when a new client connects in single connection mode.

Parameters:
value - Boolean

getVRDEExtPack

public java.lang.String getVRDEExtPack()
The name of Extension Pack providing VRDE for this VM. Overrides ISystemProperties.getDefaultVRDEExtPack().

Returns:
String

setVRDEExtPack

public void setVRDEExtPack(java.lang.String value)
The name of Extension Pack providing VRDE for this VM. Overrides ISystemProperties.getDefaultVRDEExtPack().

Parameters:
value - String

getAuthLibrary

public java.lang.String getAuthLibrary()
Library used for authentication of RDP clients by this VM. Overrides ISystemProperties.getVRDEAuthLibrary().

Returns:
String

setAuthLibrary

public void setAuthLibrary(java.lang.String value)
Library used for authentication of RDP clients by this VM. Overrides ISystemProperties.getVRDEAuthLibrary().

Parameters:
value - String

getVRDEProperties

public java.util.List<java.lang.String> getVRDEProperties()
Array of names of properties, which are supported by this VRDE server.

Returns:
List

queryInterface

public static IVRDEServer queryInterface(IUnknown obj)

setVRDEProperty

public void setVRDEProperty(java.lang.String key,
                            java.lang.String value)
Sets a VRDE specific property string. If you pass null or empty string as a key value, the given key will be deleted.

Parameters:
key - Name of the key to set.
value - Value to assign to the key.

getVRDEProperty

public java.lang.String getVRDEProperty(java.lang.String key)
Returns a VRDE specific property string. If the requested data key does not exist, this function will succeed and return an empty string in the value argument.

Parameters:
key - Name of the key to get.
Returns:
Value of the requested key.