| // 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 org.apache.cloudstack.engine.subsystem.api.storage; |
| |
| import java.util.List; |
| |
| import com.cloud.deploy.DeploymentPlan; |
| import com.cloud.deploy.DeploymentPlanner.ExcludeList; |
| import com.cloud.storage.StoragePool; |
| import com.cloud.utils.component.Adapter; |
| import com.cloud.vm.DiskProfile; |
| import com.cloud.vm.VirtualMachineProfile; |
| |
| /** |
| */ |
| public interface StoragePoolAllocator extends Adapter { |
| /** |
| * Determines which storage pools are suitable for the guest virtual machine |
| * and returns a list of pools suitable. |
| * |
| * Allocators must set any other pools not considered for allocation in the |
| * ExcludeList avoid. Thus the avoid set and the list of pools suitable, |
| * together must cover the entire pool set in the cluster. |
| * |
| * @param DiskProfile |
| * dskCh |
| * @param VirtualMachineProfile |
| * vmProfile |
| * @param DeploymentPlan |
| * plan |
| * @param ExcludeList |
| * avoid |
| * @param int returnUpTo (use -1 to return all possible pools) |
| * @return List<StoragePool> List of storage pools that are suitable for the |
| * VM |
| **/ |
| List<StoragePool> allocateToPool(DiskProfile dskCh, VirtualMachineProfile vmProfile, DeploymentPlan plan, ExcludeList avoid, int returnUpTo); |
| |
| static int RETURN_UPTO_ALL = -1; |
| } |