| 
 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectorg.virtualbox_7_1.IUnknown
org.virtualbox_7_1.ICloudClient
public class ICloudClient
| Field Summary | 
|---|
| Fields inherited from class org.virtualbox_7_1.IUnknown | 
|---|
| obj, objMgr, port | 
| Constructor Summary | |
|---|---|
| ICloudClient(java.lang.String wrapped,
             org.virtualbox_7_1.ObjectRefManager objMgr,
             org.virtualbox_7_1.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 | cloneInstance(java.lang.String uid,
              java.lang.String newName,
              Holder<ICloudMachine> clone)Clone cloud virtual machine. | 
|  IProgress | createCloudMachine(IVirtualSystemDescription description,
                   Holder<ICloudMachine> machine)This is transitional method that combines launchVM(org.virtualbox_7_1.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()See readCloudMachineList(). | 
|  java.util.List<ICloudMachine> | getCloudMachineStubList()See readCloudMachineStubList(). | 
|  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) | 
|  MetricType | getMetricTypeByName(java.lang.String metricName)Tries to find an appropriate metric type for the passed metric name. | 
|  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 via getCloudMachineList()attribute. | 
|  IProgress | readCloudMachineStubList()Make the list of cloud machine stubs available via getCloudMachineStubList()attribute. | 
|  IProgress | resetInstance(java.lang.String uid)Reset an existing instance with passed id. | 
|  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_1.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 | 
|---|
public ICloudClient(java.lang.String wrapped,
                    org.virtualbox_7_1.ObjectRefManager objMgr,
                    org.virtualbox_7_1.jaxws.VboxPortType port)
| Method Detail | 
|---|
public java.util.List<ICloudMachine> getCloudMachineList()
readCloudMachineList().
public java.util.List<ICloudMachine> getCloudMachineStubList()
readCloudMachineStubList().
public static ICloudClient queryInterface(IUnknown obj)
public IProgress getExportDescriptionForm(IVirtualSystemDescription description,
                                          Holder<IVirtualSystemDescriptionForm> form)
description - Virtual system description to be edited.form - An IForm instance for editing the virtual system description.
public void exportVM(IVirtualSystemDescription description,
                     IProgress progress)
description - Virtual system description object which describes the
machine and all required parameters.progress - Progress object to track the operation completion.
public IProgress getLaunchDescriptionForm(IVirtualSystemDescription description,
                                          Holder<IVirtualSystemDescriptionForm> form)
public IProgress launchVM(IVirtualSystemDescription description)
public IProgress getImportDescriptionForm(IVirtualSystemDescription description,
                                          Holder<IVirtualSystemDescriptionForm> form)
description - Virtual system description to be edited.form - An IForm instance for editing the virtual system description.
public void importInstance(IVirtualSystemDescription description,
                           IProgress progress)
description - VirtualSystemDescription object which is describing a machine and all required parameters.progress - Progress object to track the operation completion.public ICloudMachine getCloudMachine(java.lang.String id)
id - UUID of a cloud machine.
public IProgress readCloudMachineList()
getCloudMachineList()attribute.
public IProgress readCloudMachineStubList()
getCloudMachineStubList()attribute.
Like withgetCloudMachine(String), the returned machines
are initiatally inaccessible and require a refresh to get
their data from the cloud.
public IProgress addCloudMachine(java.lang.String instanceId,
                                 Holder<ICloudMachine> machine)
instanceId - ID of an instance to be added as a cloud machine.machine - Object that represents the newly registered cloud machine.
public IProgress createCloudMachine(IVirtualSystemDescription description,
                                    Holder<ICloudMachine> machine)
launchVM(org.virtualbox_7_1.IVirtualSystemDescription)andaddCloudMachine(String,Holder).
description - Virtual system description object which describes the
machine and all required parameters.machine - Object that represents the newly created cloud machine.
public IProgress listInstances(java.util.List<CloudMachineState> machineState,
                               Holder<IStringArray> returnNames,
                               Holder<IStringArray> returnIds)
machineState - State of each VM.returnNames - VM names.returnIds - VM ids.
public IProgress listSourceInstances(Holder<IStringArray> returnNames,
                                     Holder<IStringArray> returnIds)
returnNames - Instance names.returnIds - Instance idss.
public IProgress listImages(java.util.List<CloudImageState> imageState,
                            Holder<IStringArray> returnNames,
                            Holder<IStringArray> returnIds)
imageState - State of each image.returnNames - Images names.returnIds - Images ids.
public IProgress listBootVolumes(Holder<IStringArray> returnNames,
                                 Holder<IStringArray> returnIds)
returnNames - Boot volume names.returnIds - Boot volume ids.
public IProgress listSourceBootVolumes(Holder<IStringArray> returnNames,
                                       Holder<IStringArray> returnIds)
returnNames - Boot volume names.returnIds - Boot volume ids.
public IProgress listVnicAttachments(java.util.List<java.lang.String> parameters,
                                     Holder<IStringArray> returnVnicAttachmentIds,
                                     Holder<IStringArray> returnVnicIds)
parameters - Each parameter in the array must be in the form "name=value".returnVnicAttachmentIds - VM ids.returnVnicIds - VM ids.
public IProgress getInstanceInfo(java.lang.String uid,
                                 IVirtualSystemDescription description)
uid - The id of instance in the Cloud.description - VirtualSystemDescription object which is describing a machine
public IProgress startInstance(java.lang.String uid)
uid - The id of instance in the Cloud.
public IProgress pauseInstance(java.lang.String uid)
uid - The id of instance in the Cloud.
public IProgress terminateInstance(java.lang.String uid)
uid - the id of instance in the Cloud.
public IProgress resetInstance(java.lang.String uid)
uid - The id of instance in the Cloud.
public IProgress cloneInstance(java.lang.String uid,
                               java.lang.String newName,
                               Holder<ICloudMachine> clone)
uid - The id of instance in the Cloud that should be cloned.
Prerequisities:
The instance must be in the list of VirtualBox cloud machines.
VirtualBox operates only with those machines which are already
known.newName - Name for a cloud machine.clone - Object that represents a cloned cloud machine.
public IProgress createImage(java.util.List<java.lang.String> parameters)
parameters - Each parameter in the array must be in the form "name=value".
public IProgress exportImage(IMedium image,
                             java.util.List<java.lang.String> parameters)
image - Reference to the existing VBox image.parameters - Each parameter in the array must be in the form "name=value".
public IProgress importImage(java.lang.String uid,
                             java.util.List<java.lang.String> parameters)
uid - the id of image in the Cloud.parameters - Each parameter in the array must be in the form "name=value".
public IProgress deleteImage(java.lang.String uid)
uid - The id of image in the Cloud.
public IProgress getImageInfo(java.lang.String uid,
                              Holder<IStringArray> infoArray)
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".
public IProgress startCloudNetworkGateway(ICloudNetwork network,
                                          java.lang.String sshPublicKey,
                                          Holder<ICloudNetworkGatewayInfo> gatewayInfo)
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)
public IProgress getVnicInfo(java.lang.String uid,
                             Holder<IStringArray> infoArray)
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".
public IProgress getSubnetSelectionForm(IVirtualSystemDescription description,
                                        Holder<IVirtualSystemDescriptionForm> form)
public MetricType getMetricTypeByName(java.lang.String metricName)
metricName - Metric name (seeICloudMachine.listMetricNames(Holder))
| 
 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||