| // Licensed to the Apache Software Foundation (ASF) under one | |
| // or more contributor license agreements. See the NOTICE file | |
| // distributed with this work for additional information | |
| // regarding copyright ownership. The ASF licenses this file | |
| // to you under the Apache License, Version 2.0 (the | |
| // "License"); you may not use this file except in compliance | |
| // with the License. You may obtain a copy of the License at | |
| // | |
| // http://www.apache.org/licenses/LICENSE-2.0 | |
| // | |
| // Unless required by applicable law or agreed to in writing, | |
| // software distributed under the License is distributed on an | |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| // KIND, either express or implied. See the License for the | |
| // specific language governing permissions and limitations | |
| // under the License. | |
| package com.cloud.vm; | |
| import java.net.URI; | |
| import java.util.List; | |
| import java.util.Map; | |
| import com.cloud.agent.api.to.NicTO; | |
| import com.cloud.agent.api.to.VirtualMachineTO; | |
| import com.cloud.deploy.DeployDestination; | |
| import com.cloud.deploy.DeploymentPlan; | |
| import com.cloud.exception.AgentUnavailableException; | |
| import com.cloud.exception.ConcurrentOperationException; | |
| import com.cloud.exception.InsufficientCapacityException; | |
| import com.cloud.exception.InsufficientServerCapacityException; | |
| import com.cloud.exception.ManagementServerException; | |
| import com.cloud.exception.OperationTimedoutException; | |
| import com.cloud.exception.ResourceUnavailableException; | |
| import com.cloud.exception.VirtualMachineMigrationException; | |
| import com.cloud.hypervisor.Hypervisor.HypervisorType; | |
| import com.cloud.network.Network; | |
| import com.cloud.network.dao.NetworkVO; | |
| import com.cloud.offering.ServiceOffering; | |
| import com.cloud.service.ServiceOfferingVO; | |
| import com.cloud.storage.DiskOfferingVO; | |
| import com.cloud.storage.StoragePool; | |
| import com.cloud.storage.VMTemplateVO; | |
| import com.cloud.user.Account; | |
| import com.cloud.user.User; | |
| import com.cloud.utils.Pair; | |
| import com.cloud.utils.component.Manager; | |
| import com.cloud.utils.fsm.NoTransitionException; | |
| /** | |
| * Manages allocating resources to vms. | |
| */ | |
| public interface VirtualMachineManager extends Manager { | |
| <T extends VMInstanceVO> T allocate(T vm, | |
| VMTemplateVO template, | |
| ServiceOfferingVO serviceOffering, | |
| Pair<? extends DiskOfferingVO, Long> rootDiskOffering, | |
| List<Pair<DiskOfferingVO, Long>> dataDiskOfferings, | |
| List<Pair<NetworkVO, NicProfile>> networks, | |
| Map<VirtualMachineProfile.Param, Object> params, | |
| DeploymentPlan plan, | |
| HypervisorType hyperType, | |
| Account owner) throws InsufficientCapacityException; | |
| <T extends VMInstanceVO> T allocate(T vm, | |
| VMTemplateVO template, | |
| ServiceOfferingVO serviceOffering, | |
| Long rootSize, | |
| Pair<DiskOfferingVO, Long> dataDiskOffering, | |
| List<Pair<NetworkVO, NicProfile>> networks, | |
| DeploymentPlan plan, | |
| HypervisorType hyperType, | |
| Account owner) throws InsufficientCapacityException; | |
| <T extends VMInstanceVO> T allocate(T vm, | |
| VMTemplateVO template, | |
| ServiceOfferingVO serviceOffering, | |
| List<Pair<NetworkVO, NicProfile>> networkProfiles, | |
| DeploymentPlan plan, | |
| HypervisorType hyperType, | |
| Account owner) throws InsufficientCapacityException; | |
| <T extends VMInstanceVO> T start(T vm, Map<VirtualMachineProfile.Param, Object> params, User caller, Account account) throws InsufficientCapacityException, ResourceUnavailableException; | |
| <T extends VMInstanceVO> T start(T vm, Map<VirtualMachineProfile.Param, Object> params, User caller, Account account, DeploymentPlan planToDeploy) throws InsufficientCapacityException, ResourceUnavailableException; | |
| <T extends VMInstanceVO> boolean stop(T vm, User caller, Account account) throws ResourceUnavailableException; | |
| <T extends VMInstanceVO> boolean expunge(T vm, User caller, Account account) throws ResourceUnavailableException; | |
| <T extends VMInstanceVO> void registerGuru(VirtualMachine.Type type, VirtualMachineGuru<T> guru); | |
| boolean stateTransitTo(VMInstanceVO vm, VirtualMachine.Event e, Long hostId) throws NoTransitionException; | |
| <T extends VMInstanceVO> T advanceStart(T vm, Map<VirtualMachineProfile.Param, Object> params, User caller, Account account) throws InsufficientCapacityException, ResourceUnavailableException, ConcurrentOperationException, OperationTimedoutException; | |
| <T extends VMInstanceVO> T advanceStart(T vm, Map<VirtualMachineProfile.Param, Object> params, User caller, Account account, DeploymentPlan planToDeploy) throws InsufficientCapacityException, ResourceUnavailableException, ConcurrentOperationException, OperationTimedoutException; | |
| <T extends VMInstanceVO> boolean advanceStop(T vm, boolean forced, User caller, Account account) throws ResourceUnavailableException, OperationTimedoutException, ConcurrentOperationException; | |
| <T extends VMInstanceVO> boolean advanceExpunge(T vm, User caller, Account account) throws ResourceUnavailableException, OperationTimedoutException, ConcurrentOperationException; | |
| <T extends VMInstanceVO> boolean remove(T vm, User caller, Account account); | |
| <T extends VMInstanceVO> boolean destroy(T vm, User caller, Account account) throws AgentUnavailableException, OperationTimedoutException, ConcurrentOperationException; | |
| boolean migrateAway(VirtualMachine.Type type, long vmid, long hostId) throws InsufficientServerCapacityException, VirtualMachineMigrationException; | |
| <T extends VMInstanceVO> T migrate(T vm, long srcHostId, DeployDestination dest) throws ResourceUnavailableException, ConcurrentOperationException, ManagementServerException, VirtualMachineMigrationException; | |
| <T extends VMInstanceVO> T reboot(T vm, Map<VirtualMachineProfile.Param, Object> params, User caller, Account account) throws InsufficientCapacityException, ResourceUnavailableException; | |
| <T extends VMInstanceVO> T advanceReboot(T vm, Map<VirtualMachineProfile.Param, Object> params, User caller, Account account) throws InsufficientCapacityException, ResourceUnavailableException, ConcurrentOperationException, OperationTimedoutException; | |
| VMInstanceVO findByIdAndType(VirtualMachine.Type type, long vmId); | |
| /** | |
| * Check to see if a virtual machine can be upgraded to the given service offering | |
| * | |
| * @param vm | |
| * @param offering | |
| * @return true if the host can handle the upgrade, false otherwise | |
| */ | |
| boolean isVirtualMachineUpgradable(final VirtualMachine vm, final ServiceOffering offering); | |
| VMInstanceVO findById(long vmId); | |
| <T extends VMInstanceVO> T storageMigration(T vm, StoragePool storagePoolId); | |
| /** | |
| * @param vmInstance | |
| * @param newServiceOfferingId | |
| */ | |
| void checkIfCanUpgrade(VirtualMachine vmInstance, long newServiceOfferingId); | |
| /** | |
| * @param vmId | |
| * @param serviceOfferingId | |
| * @return | |
| */ | |
| boolean upgradeVmDb(long vmId, long serviceOfferingId); | |
| /** | |
| * @param vm | |
| * @param network | |
| * @param requested TODO | |
| * @return | |
| * @throws ConcurrentOperationException | |
| * @throws ResourceUnavailableException | |
| * @throws InsufficientCapacityException | |
| */ | |
| NicProfile addVmToNetwork(VirtualMachine vm, Network network, NicProfile requested) throws ConcurrentOperationException, | |
| ResourceUnavailableException, InsufficientCapacityException; | |
| /** | |
| * @param vm | |
| * @param nic | |
| * @return | |
| * @throws ResourceUnavailableException | |
| * @throws ConcurrentOperationException | |
| */ | |
| boolean removeNicFromVm(VirtualMachine vm, NicVO nic) throws ConcurrentOperationException, ResourceUnavailableException; | |
| /** | |
| * @param vm | |
| * @param network | |
| * @param broadcastUri TODO | |
| * @return | |
| * @throws ResourceUnavailableException | |
| * @throws ConcurrentOperationException | |
| */ | |
| boolean removeVmFromNetwork(VirtualMachine vm, Network network, URI broadcastUri) throws ConcurrentOperationException, ResourceUnavailableException; | |
| /** | |
| * @param nic | |
| * @param hypervisorType | |
| * @return | |
| */ | |
| NicTO toNicTO(NicProfile nic, HypervisorType hypervisorType); | |
| /** | |
| * @param profile | |
| * @param hvGuru | |
| * @return | |
| */ | |
| VirtualMachineTO toVmTO(VirtualMachineProfile<? extends VMInstanceVO> profile); | |
| VMInstanceVO reConfigureVm(VMInstanceVO vm, ServiceOffering newServiceOffering, boolean sameHost) | |
| throws ResourceUnavailableException, ConcurrentOperationException; | |
| VMInstanceVO findHostAndMigrate(VirtualMachine.Type vmType, VMInstanceVO vm, Long newSvcOfferingId) throws InsufficientCapacityException, | |
| ConcurrentOperationException, ResourceUnavailableException, | |
| VirtualMachineMigrationException, ManagementServerException; | |
| <T extends VMInstanceVO> T migrateForScale(T vm, long srcHostId, DeployDestination dest, Long newSvcOfferingId) | |
| throws ResourceUnavailableException, ConcurrentOperationException, | |
| ManagementServerException, VirtualMachineMigrationException; | |
| } |