server/src/com/cloud/storage/dao/StoragePoolDao.java

// 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.storage.dao;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.apache.cloudstack.engine.subsystem.api.storage.ScopeType;
import org.apache.cloudstack.storage.datastore.db.StoragePoolVO;

import com.cloud.storage.StoragePoolStatus;
import com.cloud.utils.db.GenericDao;
/**
 * Data Access Object for storage_pool table
 */
public interface StoragePoolDao extends GenericDao<StoragePoolVO, Long> {

	/**
	 * @param datacenterId -- the id of the datacenter (availability zone)
	 */
	List<StoragePoolVO> listByDataCenterId(long datacenterId);
	
	/**
	 * @param datacenterId -- the id of the datacenter (availability zone)
	 */
	List<StoragePoolVO> listBy(long datacenterId, long podId, Long clusterId, ScopeType scope);
    
	/**
	 * Set capacity of storage pool in bytes
	 * @param id pool id.
	 * @param capacity capacity in bytes
	 */
    void updateCapacity(long id, long capacity);
    
	/**
	 * Set available bytes of storage pool in bytes
	 * @param id pool id.
	 * @param available available capacity in bytes
	 */
    void updateAvailable(long id, long available);
        
    
    StoragePoolVO persist(StoragePoolVO pool, Map<String, String> details);
    
    /**
     * Find pool by name.
     * 
     * @param name name of pool.
     * @return the single  StoragePoolVO
     */
    List<StoragePoolVO> findPoolByName(String name);
    
    /**
     * Find pools by the pod that matches the details.
     * 
     * @param podId pod id to find the pools in.
     * @param details details to match.  All must match for the pool to be returned.
     * @return List of StoragePoolVO
     */
    List<StoragePoolVO> findPoolsByDetails(long dcId, long podId, Long clusterId, Map<String, String> details, ScopeType scope);
    
    List<StoragePoolVO> findPoolsByTags(long dcId, long podId, Long clusterId, String[] tags);
    
    /**
     * Find pool by UUID.
     * 
     * @param uuid uuid of pool.
     * @return the single  StoragePoolVO
     */
    StoragePoolVO findPoolByUUID(String uuid);

    List<StoragePoolVO> listByStorageHost(String hostFqdnOrIp);

    StoragePoolVO findPoolByHostPath(long dcId, Long podId, String host, String path, String uuid);
    
    List<StoragePoolVO> listPoolByHostPath(String host, String path);
    
    void updateDetails(long poolId, Map<String, String> details);
    
    Map<String, String> getDetails(long poolId);

	List<String> searchForStoragePoolDetails(long poolId, String value);
	
	List<StoragePoolVO> findIfDuplicatePoolsExistByUUID(String uuid);

    List<StoragePoolVO> listByStatus(StoragePoolStatus status);

    long countPoolsByStatus(StoragePoolStatus... statuses);

	List<StoragePoolVO> listByStatusInZone(long dcId, StoragePoolStatus status);
    
    List<StoragePoolVO> listPoolsByCluster(long clusterId);

	List<StoragePoolVO> findLocalStoragePoolsByTags(long dcId, long podId,
			Long clusterId, String[] tags);

	List<StoragePoolVO> findZoneWideStoragePoolsByTags(long dcId, String[] tags);
}