// Copyright 2012 Citrix Systems, Inc. Licensed under the
// Apache License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License.  Citrix Systems, Inc.
// reserves all rights not expressly granted by 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.
// 
// Automatically generated by addcopyright.py at 04/03/2012
package com.cloud.storage.allocator;

import java.util.List;
import java.util.Set;

import com.cloud.deploy.DeploymentPlan;
import com.cloud.deploy.DeploymentPlanner.ExcludeList;
import com.cloud.host.Host;
import com.cloud.storage.StoragePool;
import com.cloud.utils.component.Adapter;
import com.cloud.vm.DiskProfile;
import com.cloud.vm.VirtualMachine;
import com.cloud.vm.VirtualMachineProfile;

/**
 */
public interface StoragePoolAllocator extends Adapter {
	
	//keeping since storageMgr is using this API for some existing functionalities
	List<StoragePool> allocateToPool(DiskProfile dskCh, VirtualMachineProfile<? extends VirtualMachine> vmProfile, long dcId, long podId, Long clusterId, Set<? extends StoragePool> avoids, int returnUpTo);	
	
	String chooseStorageIp(VirtualMachine vm, Host host, Host storage);

	/** 
	* Determines which storage pools are suitable for the guest virtual machine 
	* 
	* @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<? extends VirtualMachine> vmProfile, DeploymentPlan plan, ExcludeList avoid, int returnUpTo);	
	
	public static int RETURN_UPTO_ALL = -1;
}