org.virtualbox_7_0
Class ICloudClient

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

public class ICloudClient
extends IUnknown


Field Summary
 
Fields inherited from class org.virtualbox_7_0.IUnknown
obj, objMgr, port
 
Constructor Summary
ICloudClient(java.lang.String wrapped, org.virtualbox_7_0.ObjectRefManager objMgr, org.virtualbox_7_0.jaxws.VboxPortType port)
           
 
Method Summary
 IProgress addCloudMachine(java.lang.String instanceId, Holder<ICloudMachine> machine)
          Adopt a running instance and register it as cloud machine.
 IProgress createCloudMachine(IVirtualSystemDescription description, Holder<ICloudMachine> machine)
          This is transitional method that combineslaunchVM(org.virtualbox_7_0.IVirtualSystemDescription)andaddCloudMachine(String,Holder).
 IProgress createImage(java.util.List<java.lang.String> parameters)
          Create an image in the Cloud.
 IProgress deleteImage(java.lang.String uid)
          Delete an existing image with passed id from the Cloud.
 IProgress exportImage(IMedium image, java.util.List<java.lang.String> parameters)
          Export an existing VBox image in the Cloud.
 void exportVM(IVirtualSystemDescription description, IProgress progress)
          Export local VM into the cloud, creating a custom image.
 ICloudMachine getCloudMachine(java.lang.String id)
          Create an object that represents a cloud machine with the specified UUID.
 java.util.List<ICloudMachine> getCloudMachineList()
          SeereadCloudMachineList().
 java.util.List<ICloudMachine> getCloudMachineStubList()
          SeereadCloudMachineStubList().
 IProgress getExportDescriptionForm(IVirtualSystemDescription description, Holder<IVirtualSystemDescriptionForm> form)
          Returns a form for editing the virtual system description for exporting a local VM into a cloud custom image.
 IProgress getImageInfo(java.lang.String uid, Holder<IStringArray> infoArray)
          Returns the information about an image in the Cloud.
 IProgress getImportDescriptionForm(IVirtualSystemDescription description, Holder<IVirtualSystemDescriptionForm> form)
          Returns a form for editing the virtual system description for import from cloud.
 IProgress getInstanceInfo(java.lang.String uid, IVirtualSystemDescription description)
          Returns the information about an instance in the Cloud.
 IProgress getLaunchDescriptionForm(IVirtualSystemDescription description, Holder<IVirtualSystemDescriptionForm> form)
           
 IProgress getSubnetSelectionForm(IVirtualSystemDescription description, Holder<IVirtualSystemDescriptionForm> form)
           
 IProgress getVnicInfo(java.lang.String uid, Holder<IStringArray> infoArray)
          Returns the information about Vnic in the Cloud.
 IProgress importImage(java.lang.String uid, java.util.List<java.lang.String> parameters)
          Import an existing image in the Cloud to the local host.
 void importInstance(IVirtualSystemDescription description, IProgress progress)
          Import an existing cloud instance to the local host.
 IProgress launchVM(IVirtualSystemDescription description)
           
 IProgress listBootVolumes(Holder<IStringArray> returnNames, Holder<IStringArray> returnIds)
          Returns the list of boot volumes in the Cloud.
 IProgress listImages(java.util.List<CloudImageState> imageState, Holder<IStringArray> returnNames, Holder<IStringArray> returnIds)
          Returns the list of the images in the Cloud.
 IProgress listInstances(java.util.List<CloudMachineState> machineState, Holder<IStringArray> returnNames, Holder<IStringArray> returnIds)
          Returns the list of the instances in the Cloud.
 IProgress listSourceBootVolumes(Holder<IStringArray> returnNames, Holder<IStringArray> returnIds)
          Returns the list of boot volumes in the cloud that can be added/adopted as VirtualBox cloud machines.
 IProgress listSourceInstances(Holder<IStringArray> returnNames, Holder<IStringArray> returnIds)
          Returns the list of instances in the cloud that can be added/adopted as VirtualBox cloud machines.
 IProgress listVnicAttachments(java.util.List<java.lang.String> parameters, Holder<IStringArray> returnVnicAttachmentIds, Holder<IStringArray> returnVnicIds)
          Returns the list of the Vnic attachements in the Cloud.
 IProgress pauseInstance(java.lang.String uid)
          Pause an existing instance with passed id.
static ICloudClient queryInterface(IUnknown obj)
           
 IProgress readCloudMachineList()
          Make the list of cloud machines available viagetCloudMachineList()attribute.
 IProgress readCloudMachineStubList()
          Make the list of cloud machine stubs available viagetCloudMachineStubList()attribute.
 IProgress setupCloudNetworkEnvironment(java.lang.String tunnelNetworkName, java.lang.String tunnelNetworkRange, java.lang.String gatewayOsName, java.lang.String gatewayOsVersion, java.lang.String gatewayShape, Holder<ICloudNetworkEnvironmentInfo> networkEnvironmentInfo)
           
 IProgress startCloudNetworkGateway(ICloudNetwork network, java.lang.String sshPublicKey, Holder<ICloudNetworkGatewayInfo> gatewayInfo)
           
 IProgress startInstance(java.lang.String uid)
          Start an existing instance with passed id.
 IProgress terminateInstance(java.lang.String uid)
          Terminate an existing instance with passed id.
 
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

ICloudClient

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

getCloudMachineList

public java.util.List<ICloudMachine> getCloudMachineList()
SeereadCloudMachineList().

Returns:
List<org.virtualbox_7_0.ICloudMachine>

getCloudMachineStubList

public java.util.List<ICloudMachine> getCloudMachineStubList()
SeereadCloudMachineStubList().

Returns:
List<org.virtualbox_7_0.ICloudMachine>

queryInterface

public static ICloudClient queryInterface(IUnknown obj)

getExportDescriptionForm

public IProgress getExportDescriptionForm(IVirtualSystemDescription description,
                                          Holder<IVirtualSystemDescriptionForm> form)
Returns a form for editing the virtual system description for exporting a local VM into a cloud custom image.

Parameters:
description - Virtual system description to be edited.
form - An IForm instance for editing the virtual system description.
Returns:
Progress object to track the operation completion.

exportVM

public void exportVM(IVirtualSystemDescription description,
                     IProgress progress)
Export local VM into the cloud, creating a custom image.

Parameters:
description - Virtual system description object which describes the machine and all required parameters.
progress - Progress object to track the operation completion.

getLaunchDescriptionForm

public IProgress getLaunchDescriptionForm(IVirtualSystemDescription description,
                                          Holder<IVirtualSystemDescriptionForm> form)

launchVM

public IProgress launchVM(IVirtualSystemDescription description)

getImportDescriptionForm

public IProgress getImportDescriptionForm(IVirtualSystemDescription description,
                                          Holder<IVirtualSystemDescriptionForm> form)
Returns a form for editing the virtual system description for import from cloud.

Parameters:
description - Virtual system description to be edited.
form - An IForm instance for editing the virtual system description.
Returns:
Progress object to track the operation completion.

importInstance

public void importInstance(IVirtualSystemDescription description,
                           IProgress progress)
Import an existing cloud instance to the local host. All needed parameters are passed in the description (VSD).

Parameters:
description - VirtualSystemDescription object which is describing a machine and all required parameters.
progress - Progress object to track the operation completion.

getCloudMachine

public ICloudMachine getCloudMachine(java.lang.String id)
Create an object that represents a cloud machine with the specified UUID. Note that the operation is synchronous. The returned machine is initiatally in inaccessible state and requires a refresh to get its data from the cloud.

Parameters:
id - UUID of a cloud machine.
Returns:
Object that represents the cloud machine with the specified UUID.

readCloudMachineList

public IProgress readCloudMachineList()
Make the list of cloud machines available viagetCloudMachineList()attribute.

Returns:
Progress object to track the operation completion.

readCloudMachineStubList

public IProgress readCloudMachineStubList()
Make the list of cloud machine stubs available viagetCloudMachineStubList()attribute. Like withgetCloudMachine(String), the returned machines are initiatally inaccessible and require a refresh to get their data from the cloud.

Returns:
Progress object to track the operation completion.

addCloudMachine

public IProgress addCloudMachine(java.lang.String instanceId,
                                 Holder<ICloudMachine> machine)
Adopt a running instance and register it as cloud machine. This is kinda like adding a local .vbox file as a local VM.

Parameters:
instanceId - ID of an instance to be added as a cloud machine.
machine - Object that represents the newly registered cloud machine.
Returns:
Progress object to track the operation completion.

createCloudMachine

public IProgress createCloudMachine(IVirtualSystemDescription description,
                                    Holder<ICloudMachine> machine)
This is transitional method that combineslaunchVM(org.virtualbox_7_0.IVirtualSystemDescription)andaddCloudMachine(String,Holder).

Parameters:
description - Virtual system description object which describes the machine and all required parameters.
machine - Object that represents the newly created cloud machine.
Returns:
Progress object to track the operation completion.

listInstances

public IProgress listInstances(java.util.List<CloudMachineState> machineState,
                               Holder<IStringArray> returnNames,
                               Holder<IStringArray> returnIds)
Returns the list of the instances in the Cloud.

Parameters:
machineState - State of each VM.
returnNames - VM names.
returnIds - VM ids.
Returns:
Progress object to track the operation completion.

listSourceInstances

public IProgress listSourceInstances(Holder<IStringArray> returnNames,
                                     Holder<IStringArray> returnIds)
Returns the list of instances in the cloud that can be added/adopted as VirtualBox cloud machines.

Parameters:
returnNames - Instance names.
returnIds - Instance idss.
Returns:
Progress object to track the operation completion.

listImages

public IProgress listImages(java.util.List<CloudImageState> imageState,
                            Holder<IStringArray> returnNames,
                            Holder<IStringArray> returnIds)
Returns the list of the images in the Cloud.

Parameters:
imageState - State of each image.
returnNames - Images names.
returnIds - Images ids.
Returns:
Progress object to track the operation completion.

listBootVolumes

public IProgress listBootVolumes(Holder<IStringArray> returnNames,
                                 Holder<IStringArray> returnIds)
Returns the list of boot volumes in the Cloud.

Parameters:
returnNames - Boot volume names.
returnIds - Boot volume ids.
Returns:
Progress object to track the operation completion.

listSourceBootVolumes

public IProgress listSourceBootVolumes(Holder<IStringArray> returnNames,
                                       Holder<IStringArray> returnIds)
Returns the list of boot volumes in the cloud that can be added/adopted as VirtualBox cloud machines.

Parameters:
returnNames - Boot volume names.
returnIds - Boot volume ids.
Returns:
Progress object to track the operation completion.

listVnicAttachments

public IProgress listVnicAttachments(java.util.List<java.lang.String> parameters,
                                     Holder<IStringArray> returnVnicAttachmentIds,
                                     Holder<IStringArray> returnVnicIds)
Returns the list of the Vnic attachements in the Cloud.

Parameters:
parameters - Each parameter in the array must be in the form "name=value".
returnVnicAttachmentIds - VM ids.
returnVnicIds - VM ids.
Returns:
Progress object to track the operation completion.

getInstanceInfo

public IProgress getInstanceInfo(java.lang.String uid,
                                 IVirtualSystemDescription description)
Returns the information about an instance in the Cloud.

Parameters:
uid - The id of instance in the Cloud.
description - VirtualSystemDescription object which is describing a machine
Returns:
Progress object to track the operation completion.

startInstance

public IProgress startInstance(java.lang.String uid)
Start an existing instance with passed id.

Parameters:
uid - The id of instance in the Cloud.
Returns:
Progress object to track the operation completion.

pauseInstance

public IProgress pauseInstance(java.lang.String uid)
Pause an existing instance with passed id.

Parameters:
uid - The id of instance in the Cloud.
Returns:
Progress object to track the operation completion.

terminateInstance

public IProgress terminateInstance(java.lang.String uid)
Terminate an existing instance with passed id.

Parameters:
uid - the id of instance in the Cloud.
Returns:
Progress object to track the operation completion.

createImage

public IProgress createImage(java.util.List<java.lang.String> parameters)
Create an image in the Cloud.

Parameters:
parameters - Each parameter in the array must be in the form "name=value".
Returns:
Progress object to track the operation completion.

exportImage

public IProgress exportImage(IMedium image,
                             java.util.List<java.lang.String> parameters)
Export an existing VBox image in the Cloud.

Parameters:
image - Reference to the existing VBox image.
parameters - Each parameter in the array must be in the form "name=value".
Returns:
Progress object to track the operation completion.

importImage

public IProgress importImage(java.lang.String uid,
                             java.util.List<java.lang.String> parameters)
Import an existing image in the Cloud to the local host.

Parameters:
uid - the id of image in the Cloud.
parameters - Each parameter in the array must be in the form "name=value".
Returns:
Progress object to track the operation completion.

deleteImage

public IProgress deleteImage(java.lang.String uid)
Delete an existing image with passed id from the Cloud.

Parameters:
uid - The id of image in the Cloud.
Returns:
Progress object to track the operation completion.

getImageInfo

public IProgress getImageInfo(java.lang.String uid,
                              Holder<IStringArray> infoArray)
Returns the information about an image in the Cloud.

Parameters:
uid - The id of image in the Cloud.
infoArray - An array where the image settings or properties is returned. Each parameter in the array must be in the form "name=value".
Returns:
Progress object to track the operation completion.

startCloudNetworkGateway

public IProgress startCloudNetworkGateway(ICloudNetwork network,
                                          java.lang.String sshPublicKey,
                                          Holder<ICloudNetworkGatewayInfo> gatewayInfo)

setupCloudNetworkEnvironment

public IProgress setupCloudNetworkEnvironment(java.lang.String tunnelNetworkName,
                                              java.lang.String tunnelNetworkRange,
                                              java.lang.String gatewayOsName,
                                              java.lang.String gatewayOsVersion,
                                              java.lang.String gatewayShape,
                                              Holder<ICloudNetworkEnvironmentInfo> networkEnvironmentInfo)

getVnicInfo

public IProgress getVnicInfo(java.lang.String uid,
                             Holder<IStringArray> infoArray)
Returns the information about Vnic in the Cloud.

Parameters:
uid - The id of vnic in the Cloud.
infoArray - An array where the Vnic settings/properties is returned. Each parameter in the array must be in the form "name=value".
Returns:
Progress object to track the operation completion.

getSubnetSelectionForm

public IProgress getSubnetSelectionForm(IVirtualSystemDescription description,
                                        Holder<IVirtualSystemDescriptionForm> form)