mirror of https://github.com/apache/cloudstack.git
132 lines
6.0 KiB
Java
Executable File
132 lines
6.0 KiB
Java
Executable File
/**
|
|
* Copyright (C) 2010 Cloud.com, Inc. All rights reserved.
|
|
*
|
|
* This software is licensed under the GNU General Public License v3 or later.
|
|
*
|
|
* It is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or any later version.
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
package com.cloud.vm;
|
|
|
|
import com.cloud.api.ServerApiException;
|
|
import com.cloud.api.commands.AttachVolumeCmd;
|
|
import com.cloud.api.commands.CreateTemplateCmd;
|
|
import com.cloud.api.commands.CreateVMGroupCmd;
|
|
import com.cloud.api.commands.DeleteVMGroupCmd;
|
|
import com.cloud.api.commands.DeployVm2Cmd;
|
|
import com.cloud.api.commands.DestroyVMCmd;
|
|
import com.cloud.api.commands.DetachVolumeCmd;
|
|
import com.cloud.api.commands.RebootVMCmd;
|
|
import com.cloud.api.commands.RecoverVMCmd;
|
|
import com.cloud.api.commands.ResetVMPasswordCmd;
|
|
import com.cloud.api.commands.StartVMCmd;
|
|
import com.cloud.api.commands.StopVMCmd;
|
|
import com.cloud.api.commands.UpdateVMCmd;
|
|
import com.cloud.api.commands.UpgradeVMCmd;
|
|
import com.cloud.api.response.VolumeResponse;
|
|
import com.cloud.async.executor.OperationResponse;
|
|
import com.cloud.async.executor.RebootVMExecutor;
|
|
import com.cloud.async.executor.VMOperationParam;
|
|
import com.cloud.exception.ConcurrentOperationException;
|
|
import com.cloud.exception.InsufficientCapacityException;
|
|
import com.cloud.exception.InternalErrorException;
|
|
import com.cloud.exception.InvalidParameterValueException;
|
|
import com.cloud.exception.PermissionDeniedException;
|
|
import com.cloud.exception.ResourceAllocationException;
|
|
import com.cloud.exception.ResourceUnavailableException;
|
|
import com.cloud.exception.StorageUnavailableException;
|
|
import com.cloud.storage.VMTemplateVO;
|
|
import com.cloud.uservm.UserVm;
|
|
import com.cloud.utils.component.Manager;
|
|
import com.cloud.utils.exception.CloudRuntimeException;
|
|
import com.cloud.utils.exception.ExecutionException;
|
|
|
|
public interface UserVmService extends Manager {
|
|
/**
|
|
* Destroys one virtual machine
|
|
* @param userId the id of the user performing the action
|
|
* @param vmId the id of the virtual machine.
|
|
*/
|
|
boolean destroyVm(DestroyVMCmd cmd);
|
|
|
|
/**
|
|
* Resets the password of a virtual machine.
|
|
* @param cmd - the command specifying vmId, password
|
|
* @return the VM if reset worked successfully, null otherwise
|
|
*/
|
|
UserVm resetVMPassword(ResetVMPasswordCmd cmd);
|
|
|
|
/**
|
|
* Attaches the specified volume to the specified VM
|
|
* @param cmd - the command specifying volumeId and vmId
|
|
* @throws InternalErrorException, InvalidParameterValueException, PermissionDeniedException
|
|
*/
|
|
void attachVolumeToVM(AttachVolumeCmd cmd) throws InternalErrorException, InvalidParameterValueException, PermissionDeniedException;
|
|
|
|
/**
|
|
* Detaches the specified volume from the VM it is currently attached to.
|
|
* @param cmd - the command specifying volumeId
|
|
* @return the VolumeResponse object if detach worked successfully.
|
|
* @throws InternalErrorException
|
|
* @throws InvalidParameterValueException
|
|
*/
|
|
VolumeResponse detachVolumeFromVM(DetachVolumeCmd cmmd) throws InternalErrorException, InvalidParameterValueException;
|
|
|
|
UserVmVO startVirtualMachine(StartVMCmd cmd) throws StorageUnavailableException, ExecutionException, ConcurrentOperationException;
|
|
UserVmVO stopVirtualMachine(StopVMCmd cmd) throws ServerApiException;
|
|
UserVm rebootVirtualMachine(RebootVMCmd cmd);
|
|
|
|
@Deprecated
|
|
OperationResponse executeRebootVM(RebootVMExecutor executor, VMOperationParam param);
|
|
|
|
boolean recoverVirtualMachine(RecoverVMCmd cmd) throws ResourceAllocationException, InternalErrorException;
|
|
|
|
/**
|
|
* Create a template database record in preparation for creating a private template.
|
|
* @param cmd the command object that defines the name, display text, snapshot/volume, bits, public/private, etc.
|
|
* for the private template
|
|
* @return the vm template object if successful, null otherwise
|
|
* @throws InvalidParameterValueException, PermissionDeniedException
|
|
*/
|
|
VMTemplateVO createPrivateTemplateRecord(CreateTemplateCmd cmd) throws InvalidParameterValueException, PermissionDeniedException;
|
|
|
|
/**
|
|
* Creates a private template from a snapshot of a VM
|
|
* @param cmd - the command specifying snapshotId, name, description
|
|
* @return a template if successfully created, null otherwise
|
|
* @throws InvalidParameterValueException
|
|
*/
|
|
VMTemplateVO createPrivateTemplate(CreateTemplateCmd cmd) throws InternalErrorException;
|
|
|
|
void updateVirtualMachine(UpdateVMCmd cmd);
|
|
|
|
UserVm createVirtualMachine(DeployVm2Cmd cmd) throws InvalidParameterValueException, PermissionDeniedException, InsufficientCapacityException, ConcurrentOperationException, ResourceUnavailableException, CloudRuntimeException;
|
|
|
|
UserVm startVirtualMachine(DeployVm2Cmd cmd) throws InsufficientCapacityException, ConcurrentOperationException, ResourceUnavailableException, CloudRuntimeException;
|
|
/**
|
|
* Creates a vm group.
|
|
* @param name - name of the group
|
|
* @param accountId - accountId
|
|
*/
|
|
InstanceGroupVO createVmGroup(CreateVMGroupCmd cmd) throws InvalidParameterValueException, PermissionDeniedException;
|
|
|
|
boolean deleteVmGroup(DeleteVMGroupCmd cmd) throws InvalidParameterValueException, PermissionDeniedException;
|
|
|
|
/**
|
|
* upgrade the service offering of the virtual machine
|
|
* @param cmd - the command specifying vmId and new serviceOfferingId
|
|
* @return the vm
|
|
* @throws InvalidParameterValueException
|
|
*/
|
|
UserVm upgradeVirtualMachine(UpgradeVMCmd cmd) throws ServerApiException, InvalidParameterValueException;
|
|
}
|