org.virtualbox_7_0
Class ICloudMachine

java.lang.Object
  extended by org.virtualbox_7_0.IUnknown
      extended by org.virtualbox_7_0.ICloudMachine

public class ICloudMachine
extends IUnknown

Virtual virtual machine (sic) in the cloud. Reading object attributes returns cached values, userefresh()to refresh them. Interface ID: {147816C8-17E0-11EB-81FA-87CEA6263E1A}


Field Summary
 
Fields inherited from class org.virtualbox_7_0.IUnknown
obj, objMgr, port
 
Constructor Summary
ICloudMachine(java.lang.String wrapped, org.virtualbox_7_0.ObjectRefManager objMgr, org.virtualbox_7_0.jaxws.VboxPortType port)
           
 
Method Summary
 IProgress createConsoleConnection(java.lang.String sshPublicKey)
           
 IProgress deleteConsoleConnection()
           
 IVirtualBoxErrorInfo getAccessError()
          Error information describing the reason of machine inaccessibility.
 java.lang.Boolean getAccessible()
          Whether this virtual machine is currently accessible or not.
 java.lang.String getConsoleConnectionFingerprint()
          The fingerprint of the ssh key that is authorized to access the machine's console connection.
 IProgress getConsoleHistory(Holder<IDataStream> stream)
          Get the backlog of the machine's console.
 IForm getDetailsForm()
          Obtain a form with the current settings for this cloud machine.
 java.lang.String getId()
          UUID of the cloud machine.
 java.lang.String getName()
          Convenience shortcut to retrieve the name of the cloud machine.
 java.lang.String getOSTypeId()
          Convenience shortcut to retrieve the OS Type id of the cloud machine.
 java.lang.String getSerialConsoleCommand()
          The shell command to establish ssh connection to the cloud machine serial console.
 java.lang.String getSerialConsoleCommandWindows()
          The PowerShell command to establish ssh connection to the cloud machine serial console using PuTTY's plink.
 IProgress getSettingsForm(Holder<IForm> form)
          Obtain a form with settings for this cloud machine.
 CloudMachineState getState()
          Machine state.
 java.lang.String getVNCConsoleCommand()
          The shell command to establish ssh port forwarding for the VNC connection to the cloud machine console.
 java.lang.String getVNCConsoleCommandWindows()
          The PowerShell command to establish ssh port forwarding for the VNC connection to the cloud machine console using PuTTY's plink.
 IProgress powerDown()
          Initiates the power down procedure to stop the virtual machine execution.
 IProgress powerUp()
          Start cloud virtual machine execution.
static ICloudMachine queryInterface(IUnknown obj)
           
 IProgress reboot()
          Reboot cloud virtual machine.
 IProgress refresh()
          Refresh information by reading it from the cloud.
 IProgress remove()
          Unregister this cloud machine and delete all its cloud artifacts.
 IProgress reset()
          Forcing reset or hard reset of a cloud virtual machine.
 IProgress shutdown()
          Shutdown cloud virtual machine.
 IProgress terminate()
          Terminate cloud virtual machine.
 IProgress unregister()
          Unregister this cloud machine, but leave the cloud artifacts intact.
 
Methods inherited from class org.virtualbox_7_0.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ICloudMachine

public ICloudMachine(java.lang.String wrapped,
                     org.virtualbox_7_0.ObjectRefManager objMgr,
                     org.virtualbox_7_0.jaxws.VboxPortType port)
Method Detail

getId

public java.lang.String getId()
UUID of the cloud machine.

Returns:
String

getAccessible

public java.lang.Boolean getAccessible()
Whether this virtual machine is currently accessible or not. TBD...

Returns:
Boolean

getAccessError

public IVirtualBoxErrorInfo getAccessError()
Error information describing the reason of machine inaccessibility. Reading this property is only valid after the last call togetAccessible()returned false (i.e. the machine is currently inaccessible). Otherwise, a null IVirtualBoxErrorInfo object will be returned.

Returns:
org.virtualbox_7_0.IVirtualBoxErrorInfo

getName

public java.lang.String getName()
Convenience shortcut to retrieve the name of the cloud machine. The name is part of the machine settings that are hidden behind the settings form (seegetSettingsForm(Holder)).

Returns:
String

getOSTypeId

public java.lang.String getOSTypeId()
Convenience shortcut to retrieve the OS Type id of the cloud machine. It is part of the machine settings that are hidden behind the settings form (seegetSettingsForm(Holder)).

Returns:
String

getState

public CloudMachineState getState()
Machine state.

Returns:
org.virtualbox_7_0.CloudMachineState

getConsoleConnectionFingerprint

public java.lang.String getConsoleConnectionFingerprint()
The fingerprint of the ssh key that is authorized to access the machine's console connection.

Returns:
String

getSerialConsoleCommand

public java.lang.String getSerialConsoleCommand()
The shell command to establish ssh connection to the cloud machine serial console.

Returns:
String

getSerialConsoleCommandWindows

public java.lang.String getSerialConsoleCommandWindows()
The PowerShell command to establish ssh connection to the cloud machine serial console using PuTTY's plink.

Returns:
String

getVNCConsoleCommand

public java.lang.String getVNCConsoleCommand()
The shell command to establish ssh port forwarding for the VNC connection to the cloud machine console.

Returns:
String

getVNCConsoleCommandWindows

public java.lang.String getVNCConsoleCommandWindows()
The PowerShell command to establish ssh port forwarding for the VNC connection to the cloud machine console using PuTTY's plink.

Returns:
String

queryInterface

public static ICloudMachine queryInterface(IUnknown obj)

refresh

public IProgress refresh()
Refresh information by reading it from the cloud.

Returns:
Progress object to track the operation completion.

getDetailsForm

public IForm getDetailsForm()
Obtain a form with the current settings for this cloud machine. The form is not editable.

Returns:
A form with the cloud machine settings.

getSettingsForm

public IProgress getSettingsForm(Holder<IForm> form)
Obtain a form with settings for this cloud machine. The form is editable.

Parameters:
form - A form with the cloud machine settings.
Returns:
Progress object to track the operation completion.

powerUp

public IProgress powerUp()
Start cloud virtual machine execution.

Returns:
Progress object to track the operation completion.

reboot

public IProgress reboot()
Reboot cloud virtual machine.

Returns:
Progress object to track the operation completion.

reset

public IProgress reset()
Forcing reset or hard reset of a cloud virtual machine.

Returns:
Progress object to track the operation completion.

shutdown

public IProgress shutdown()
Shutdown cloud virtual machine.

Returns:
Progress object to track the operation completion.

powerDown

public IProgress powerDown()
Initiates the power down procedure to stop the virtual machine execution. The completion of the power down procedure is tracked using the returned IProgress object. After the operation is complete, the machine will go to the PoweredOff state.

Expected result codes:
VBOX_E_INVALID_VM_STATE - Virtual machine must be Running, to be powered down.

Returns:
Progress object to track the operation completion.

terminate

public IProgress terminate()
Terminate cloud virtual machine.

Returns:
Progress object to track the operation completion.

unregister

public IProgress unregister()
Unregister this cloud machine, but leave the cloud artifacts intact.

Returns:
Progress object to track the operation completion.

remove

public IProgress remove()
Unregister this cloud machine and delete all its cloud artifacts.

Returns:
Progress object to track the operation completion.

getConsoleHistory

public IProgress getConsoleHistory(Holder<IDataStream> stream)
Get the backlog of the machine's console. If you have ever seen console teletypes, this is like looking at the last few meters of the paper it spewed.

Parameters:
stream - Data stream object for reading the console history. For now we are abusing/repurposing this interface from the media convertion API to avoid marshalling a huge string through xpcom.
Returns:
Progress object to track the operation completion.

createConsoleConnection

public IProgress createConsoleConnection(java.lang.String sshPublicKey)

deleteConsoleConnection

public IProgress deleteConsoleConnection()