DataCenterServices.java

/**
 * Copyright (C) 2009-2015 Dell, Inc.
 * See annotations for authorship information
 *
 * ====================================================================
 * Licensed 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.dasein.cloud.dc;

import java.util.Locale;

import org.dasein.cloud.CloudException;
import org.dasein.cloud.InternalException;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * <p>
 * Describe the physical configuration of the underlying cloud provider so applications
 * may determine how to create redundancies and protect jurisdictional concerns.
 * </p>
 * <p>
 *   The logical structure of this API divides a cloud into multiple regions. A region is
 *   simply a boundary within a cloud across which no common infrastructure is shared. A region
 *   has a jurisdiction that describe what laws govern the data in that region as well as
 *   one or more data centers providing resources in that region.
 * </p>
 * <p>
 *   Data centers share some resources yet provide some level of physical independence. The following
 *   rules should hold for any data center:
 * </p>
 * <ul>
 * <li>If two virtual servers are in different data centers, they cannot be running on the same physical hardware.</li>
 * <li>Outages in one data center are highly unlikely to impact other data centers.</li>
 * </ul>
 * @author George Reese @ enstratius (http://www.enstratius.com)
 */
public interface DataCenterServices {
    /**
     * Provides access to meta-data about region capabilities in this cloud.
     *
     * @return a description of the features supported by this region of this cloud
     * @throws InternalException an error occurred within the Dasein Cloud API implementation
     * @throws CloudException    an error occurred within the cloud provider
     */
    public @Nonnull DataCenterCapabilities getCapabilities() throws InternalException, CloudException;

    /**
     * Provides access to the full data center information for the specified data center.
     * @param providerDataCenterId the provider-specific identifier that the provider uses to identify the data center
     * @return the current state of the desired data center
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nullable DataCenter getDataCenter(@Nonnull String providerDataCenterId) throws InternalException, CloudException;

    /**
     * Provides the cloud-specific term for a data center (e.g. "availability zone").
     * @param locale the locale into which the term should be translated
     * @return the term for a data center
     */
    @Deprecated
    public String getProviderTermForDataCenter(Locale locale);
    
    /**
     * Provides the cloud-specific term for a region.
     * @param locale the locale into which the term should be translated
     * @return the term for a region
     */
    @Deprecated
    public String getProviderTermForRegion(Locale locale);
    
    /**
     * Provides the region matching the specified region ID.
     * @param providerRegionId the provider-specified unique ID that identifies a region for the provider
     * @return the current state of the desired region
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nullable Region getRegion(@Nonnull String providerRegionId) throws InternalException, CloudException;

    /**
     * Lists all data centers, active and inactive, available and unavailable, for the specified region.
     * @param providerRegionId the region in which you are searching for data centers
     * @return the complete list of data centers for the region
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nonnull Iterable<DataCenter> listDataCenters(@Nonnull String providerRegionId) throws InternalException, CloudException;
    
    /**
     * Lists all regions, active and inactive, available and unavailable.
     * @return all regions supported for this cloud in any context
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nonnull Iterable<Region> listRegions() throws InternalException, CloudException;

    /**
     * Lists all resource pools
     *
     * @param providerDataCenterId the datacenter in which you are searching for resource pools
     * @return all resource pools supported for this cloud in the given datacenter
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException    an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nonnull Iterable<ResourcePool> listResourcePools(@Nonnull String providerDataCenterId) throws InternalException, CloudException;

    /**
     * Provides access to the full resource pool information for the specified resource pool.
     * @param providerResourcePoolId the provider-specific identifier that the provider uses to identify the resource pool
     * @return the current state of the desired resource pool
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nullable ResourcePool getResourcePool(@Nonnull String providerResourcePoolId) throws InternalException, CloudException;

    /**
     * Lists all storage pools
     *
     * @return all storage pools supported for this cloud in the context region
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException    an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nonnull Iterable<StoragePool> listStoragePools() throws InternalException, CloudException;

    /**
     * Provides access to the full storage pool information for the specified storage pool
     *
     * @param providerStoragePoolId the provider-specific identifier that the provider uses to identify the storage pool
     * @return the Storage Pool object with the specified id
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException    an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nullable StoragePool getStoragePool(@Nonnull String providerStoragePoolId) throws InternalException, CloudException;


    /**
     * Lists all vm folders
     *
     * @return all vm folders supported for this cloud in the context region
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException    an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nonnull Iterable<Folder> listVMFolders() throws InternalException, CloudException;

    /**
     * Provides access to the full vm folder information for the specified vm folder
     *
     * @param providerVMFolderId the provider-specific identifier that the provider uses to identify the vm folder
     * @return the vm folder object with the specified id
     * @throws InternalException an error occurred locally in processing the request
     * @throws CloudException    an error occurred within the cloud provider or the cloud provider did not approve of the request
     */
    public @Nullable Folder getVMFolder(@Nonnull String providerVMFolderId) throws InternalException, CloudException;
}