org.virtualbox_6_0
Class ICloudClient

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

public class ICloudClient
extends IUnknown


Field Summary
 
Fields inherited from class org.virtualbox_6_0.IUnknown
obj, objMgr, port
 
Constructor Summary
ICloudClient(java.lang.String wrapped, org.virtualbox_6_0.ObjectRefManager objMgr, org.virtualbox_6_0.jaxws.VboxPortType port)
           
 
Method Summary
 CloudCommandResult checkCommandResult(java.lang.String Id, Holder<java.lang.Long> startTime, Holder<java.lang.Long> lastTime)
          Check a cloud operation result by ID
 java.lang.String createCommand(CloudCommand cloudCommand, java.lang.String condition)
          Creates a cloud operation object for the passed profile if profile name is NULL or empty string creates operation for the active profile.
 void exportVM(IVirtualSystemDescription description, IProgress progress, IVirtualBox virtualBox)
          Exports a VM described in description parameter
 java.util.List<java.lang.String> getCommandParameterNames(CloudCommand cloudCommand)
          Returns the parameters names for this operation.
 java.util.List<java.lang.String> getCommandParameterProperties(java.lang.String parameterName, Holder<java.lang.String> parameterType, Holder<java.lang.String> parameterDesc)
          Returns the value/s for the passed parameter.
 java.lang.String getCommandParameters(CloudCommand cloudCommand)
          Returns the parameters with their values.
 java.util.List<CloudCommand> getCommandsForOperation(CloudOperation cloudOperation, java.lang.Boolean prep)
          Returns the list of commands for particular operation.
 java.lang.String getExportParameters()
          Returns the parameters required to be shown to user for export a VM to a cloud operation.
 java.lang.String getOperationParameters(CloudOperation cloudOperation)
          Returns the parameters with their values.
static ICloudClient queryInterface(IUnknown obj)
           
 CloudCommandResult runCommand(java.lang.String Id, java.lang.Long timeout)
          Runs a cloud operation by ID
 void runSeveralCommands(java.util.List<java.lang.String> commandIdList, java.util.List<java.lang.String> parameterNames, java.util.List<java.lang.String> parameterValues, IProgress progress)
          Runs a set of prepared cloud operations by their ids
 void setCommandParameters(java.lang.String Id, java.util.List<java.lang.String> names, java.util.List<java.lang.String> values)
          Sets the parameters values for the particular command by ID.
 java.lang.Boolean validateCommand(java.lang.String Id)
          Validates a cloud operation by ID
 
Methods inherited from class org.virtualbox_6_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_6_0.ObjectRefManager objMgr,
                    org.virtualbox_6_0.jaxws.VboxPortType port)
Method Detail

queryInterface

public static ICloudClient queryInterface(IUnknown obj)

createCommand

public java.lang.String createCommand(CloudCommand cloudCommand,
                                      java.lang.String condition)
Creates a cloud operation object for the passed profile if profile name is NULL or empty string creates operation for the active profile. if profile name is NULL or empty string and there is not the active profile returns "VERR_INVALID_PARAMETER"

Parameters:
cloudCommand - The type of the supported cloud commands.
condition - The successful condition for finishing the command. The command will be repeated if condition isn't in the needed state
Returns:
UUID of the operation. It's used later when user chooses and runs this cloud operation

runCommand

public CloudCommandResult runCommand(java.lang.String Id,
                                     java.lang.Long timeout)
Runs a cloud operation by ID

Parameters:
Id - UUID of the operation.
timeout - Timeout in seconds.

runSeveralCommands

public void runSeveralCommands(java.util.List<java.lang.String> commandIdList,
                               java.util.List<java.lang.String> parameterNames,
                               java.util.List<java.lang.String> parameterValues,
                               IProgress progress)
Runs a set of prepared cloud operations by their ids

Parameters:
commandIdList - The list of UUID of the operations.
parameterNames - Initial set of parameter names.
parameterValues - Initial set of parameter values.
progress - Progress object to track the operation completion.

validateCommand

public java.lang.Boolean validateCommand(java.lang.String Id)
Validates a cloud operation by ID

Parameters:
Id - UUID of the operation.
Returns:
if the command is valid return s true else returns false.

checkCommandResult

public CloudCommandResult checkCommandResult(java.lang.String Id,
                                             Holder<java.lang.Long> startTime,
                                             Holder<java.lang.Long> lastTime)
Check a cloud operation result by ID

Parameters:
Id - UUID of the operation.
startTime - Start time of operation.
lastTime - Time of the last result.
Returns:
The last result of the cloud command.

getCommandParameterNames

public java.util.List<java.lang.String> getCommandParameterNames(CloudCommand cloudCommand)
Returns the parameters names for this operation.

Parameters:
cloudCommand - The type of the supported cloud commands.
Returns:
Names of the parameters.

getCommandParameterProperties

public java.util.List<java.lang.String> getCommandParameterProperties(java.lang.String parameterName,
                                                                      Holder<java.lang.String> parameterType,
                                                                      Holder<java.lang.String> parameterDesc)
Returns the value/s for the passed parameter.

Parameters:
parameterName - Parameter name.
parameterType - Parameter type.
parameterDesc - Parameter description.
Returns:
Possible values of the parameter.

getCommandParameters

public java.lang.String getCommandParameters(CloudCommand cloudCommand)
Returns the parameters with their values.

Parameters:
cloudCommand - The type of the supported cloud commands.
Returns:
the parameters with values in json format.

setCommandParameters

public void setCommandParameters(java.lang.String Id,
                                 java.util.List<java.lang.String> names,
                                 java.util.List<java.lang.String> values)
Sets the parameters values for the particular command by ID.

Parameters:
Id - UUID of the operation.
names - Names of the parameters.
values - Values of the parameters.

getCommandsForOperation

public java.util.List<CloudCommand> getCommandsForOperation(CloudOperation cloudOperation,
                                                            java.lang.Boolean prep)
Returns the list of commands for particular operation.

Parameters:
cloudOperation - The type of the supported cloud operation.
prep - Which list to return: false - general commands, true - preparatory commands
Returns:
The list of cloud commands.

getOperationParameters

public java.lang.String getOperationParameters(CloudOperation cloudOperation)
Returns the parameters with their values.

Parameters:
cloudOperation - The type of the supported cloud operation.
Returns:
the parameters with values in json format.

getExportParameters

public java.lang.String getExportParameters()
Returns the parameters required to be shown to user for export a VM to a cloud operation.

Returns:
the parameters with values in json format.

exportVM

public void exportVM(IVirtualSystemDescription description,
                     IProgress progress,
                     IVirtualBox virtualBox)
Exports a VM described in description parameter

Parameters:
description - VirtualSystemDescription object which is describing a machine and all required parameters.
progress - Progress object to track the operation completion.
virtualBox - Reference to the server-side API root object.