server: ability to create disk offerings for domain(s) and zone(s)

Allows creating storage offerings associated with particular domain(s) and zone(s). In create disk/storage offfering form UI, a mult-select control has been addded to select desired zone(s) and domain select element has been made multi-select.
createDiskOffering API has been modified to allow passing list of domain and zone IDs with keys domainids and zoneids respectively. These lists are stored in DB in cloud.disk_offering_details table with 'domainids' and 'zoneids' key as string of comma separated list of IDs. Response for create, update and list disk offering APIs will return domainids, domainnames, zoneids and zonenames in details object of offering.
listDiskOfferings API has been modified to allow passing zoneid to return only offerings which are associated with the zone.

Signed-off-by: Abhishek Kumar <[email protected]>

Author: shwstppr

api/src/main/java/com/cloud/user/AccountService.java

@@ -25,6 +25,7 @@
 import org.apache.cloudstack.api.command.admin.user.RegisterCmd;
 import org.apache.cloudstack.api.command.admin.user.UpdateUserCmd;
 
+import com.cloud.dc.DataCenter;
 import com.cloud.domain.Domain;
 import com.cloud.exception.PermissionDeniedException;
 import com.cloud.offering.DiskOffering;
@@ -98,7 +99,7 @@ UserAccount createUserAccount(String userName, String password, String firstName
 
     void checkAccess(Account account, ServiceOffering so) throws PermissionDeniedException;
 
-    void checkAccess(Account account, DiskOffering dof) throws PermissionDeniedException;
+    void checkAccess(Account account, DiskOffering dof, DataCenter zone) throws PermissionDeniedException;
 
     void checkAccess(User user, ControlledEntity entity);
 

api/src/main/java/org/apache/cloudstack/acl/SecurityChecker.java

@@ -138,5 +138,5 @@ boolean checkAccess(Account caller, AccessType accessType, String action, Contro
 
     public boolean checkAccess(Account account, ServiceOffering so) throws PermissionDeniedException;
 
-    boolean checkAccess(Account account, DiskOffering dof) throws PermissionDeniedException;
+    boolean checkAccess(Account account, DiskOffering dof, DataCenter zone) throws PermissionDeniedException;
 }

api/src/main/java/org/apache/cloudstack/api/ApiConstants.java

@@ -112,6 +112,8 @@ public class ApiConstants {
     public static final String DOMAIN = "domain";
     public static final String DOMAIN_ID = "domainid";
     public static final String DOMAIN__ID = "domainId";
+    public static final String DOMAIN_ID_LIST = "domainids";
+    public static final String DOMAIN_NAME_LIST = "domainnames";
     public static final String DURATION = "duration";
     public static final String ELIGIBLE = "eligible";
     public static final String EMAIL = "email";
@@ -706,6 +708,7 @@ public class ApiConstants {
     public static final String NETSCALER_SERVICEPACKAGE_ID = "netscalerservicepackageid";
 
     public static final String ZONE_ID_LIST = "zoneids";
+    public static final String ZONE_NAME_LIST = "zonenames";
     public static final String DESTINATION_ZONE_ID_LIST = "destzoneids";
     public static final String ADMIN = "admin";
     public static final String CHECKSUM_PARAMETER_PREFIX_DESCRIPTION = "The parameter containing the checksum will be considered a MD5sum if it is not prefixed\n"

api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateDiskOfferingCmd.java

@@ -16,7 +16,8 @@
 // under the License.
 package org.apache.cloudstack.api.command.admin.offering;
 
-import org.apache.log4j.Logger;
+import java.util.ArrayList;
+import java.util.List;
 
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiConstants;
@@ -26,10 +27,12 @@
 import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.response.DiskOfferingResponse;
 import org.apache.cloudstack.api.response.DomainResponse;
+import org.apache.cloudstack.api.response.ZoneResponse;
+import org.apache.log4j.Logger;
 
-import com.cloud.storage.Storage.ProvisioningType;
 import com.cloud.offering.DiskOffering;
 import com.cloud.offering.ServiceOffering;
+import com.cloud.storage.Storage.ProvisioningType;
 import com.cloud.user.Account;
 
 @APICommand(name = "createDiskOffering", description = "Creates a disk offering.", responseObject = DiskOfferingResponse.class,
@@ -64,6 +67,24 @@ public class CreateDiskOfferingCmd extends BaseCmd {
                description = "the ID of the containing domain, null for public offerings")
     private Long domainId;
 
+    @Parameter(name = ApiConstants.DOMAIN_ID_LIST,
+            type = CommandType.LIST,
+            collectionType = CommandType.UUID,
+            entityType = DomainResponse.class,
+            required = false,
+            description = "the ID of the domains offering is associated with, null for all domain offerings",
+            since = "4.13")
+    private List<Long> domainIds;
+
+    @Parameter(name = ApiConstants.ZONE_ID_LIST,
+            type = CommandType.LIST,
+            collectionType = CommandType.UUID,
+            entityType = ZoneResponse.class,
+            required = false,
+            description = "the ID of the zones offering is associated with, null for all zone offerings",
+            since = "4.13")
+    private List<Long> zoneIds;
+
     @Parameter(name = ApiConstants.STORAGE_TYPE, type = CommandType.STRING, description = "the storage type of the disk offering. Values are local and shared.")
     private String storageType = ServiceOffering.StorageType.shared.toString();
 
@@ -170,6 +191,20 @@ public Long getDomainId() {
         return domainId;
     }
 
+    public List<Long> getDomainIds() {
+        if (domainId != null) {
+            if (domainIds == null) {
+                domainIds = new ArrayList<>();
+            }
+            domainIds.add(domainId);
+        }
+        return domainIds;
+    }
+
+    public List<Long> getZoneIds() {
+        return zoneIds;
+    }
+
     public Long getBytesReadRate() {
         return bytesReadRate;
     }

api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateDiskOfferingCmd.java

@@ -16,15 +16,14 @@
 // under the License.
 package org.apache.cloudstack.api.command.admin.offering;
 
-import org.apache.log4j.Logger;
-
 import org.apache.cloudstack.api.APICommand;
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.ApiErrorCode;
 import org.apache.cloudstack.api.BaseCmd;
 import org.apache.cloudstack.api.Parameter;
 import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.response.DiskOfferingResponse;
+import org.apache.log4j.Logger;
 
 import com.cloud.offering.DiskOffering;
 import com.cloud.user.Account;

api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListDiskOfferingsCmd.java

@@ -16,6 +16,7 @@
 // under the License.
 package org.apache.cloudstack.api.command.user.offering;
 
+import org.apache.cloudstack.api.response.ZoneResponse;
 import org.apache.log4j.Logger;
 
 import org.apache.cloudstack.api.APICommand;
@@ -42,6 +43,13 @@ public class ListDiskOfferingsCmd extends BaseListDomainResourcesCmd {
     @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "name of the disk offering")
     private String diskOfferingName;
 
+    @Parameter(name = ApiConstants.ZONE_ID,
+            type = CommandType.UUID,
+            entityType = ZoneResponse.class,
+            description = "id of zone disk offering is associated with",
+            since = "4.13")
+    private Long zoneId;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -54,6 +62,10 @@ public String getDiskOfferingName() {
         return diskOfferingName;
     }
 
+    public Long getZoneId() {
+        return zoneId;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/response/DiskOfferingResponse.java

@@ -17,15 +17,15 @@
 package org.apache.cloudstack.api.response;
 
 import java.util.Date;
-
-import com.google.gson.annotations.SerializedName;
+import java.util.Map;
 
 import org.apache.cloudstack.api.ApiConstants;
 import org.apache.cloudstack.api.BaseResponse;
 import org.apache.cloudstack.api.EntityReference;
 
 import com.cloud.offering.DiskOffering;
 import com.cloud.serializer.Param;
+import com.google.gson.annotations.SerializedName;
 
 @EntityReference(value = DiskOffering.class)
 public class DiskOfferingResponse extends BaseResponse {
@@ -144,6 +144,10 @@ public class DiskOfferingResponse extends BaseResponse {
     @Param(description = "whether to display the offering to the end user or not.")
     private Boolean displayOffering;
 
+    @SerializedName(ApiConstants.DETAILS)
+    @Param(description = "the details of the disk offering", since = "4.13.0")
+    private Map<String, String> details;
+
     public Boolean getDisplayOffering() {
         return displayOffering;
     }
@@ -328,4 +332,12 @@ public void setIopsWriteRateMax(Long iopsWriteRateMax) {
     public void setIopsWriteRateMaxLength(Long iopsWriteRateMaxLength) {
         this.iopsWriteRateMaxLength = iopsWriteRateMaxLength;
     }
+
+    public Map<String, String> getDetails() {
+        return details;
+    }
+
+    public void setDetails(Map<String, String> details) {
+        this.details = details;
+    }
 }

engine/components-api/src/main/java/com/cloud/configuration/ConfigurationManager.java

@@ -177,7 +177,7 @@ DataCenterVO createZone(long userId, String zoneName, String dns1, String dns2,
 
     void checkZoneAccess(Account caller, DataCenter zone);
 
-    void checkDiskOfferingAccess(Account caller, DiskOffering dof);
+    void checkDiskOfferingAccess(Account caller, DiskOffering dof, DataCenter zone);
 
     /**
      * Creates a new network offering

engine/schema/src/main/java/com/cloud/dc/dao/DataCenterDao.java

@@ -121,4 +121,6 @@ public Integer getVlan() {
     List<DataCenterVO> findByKeyword(String keyword);
 
     List<DataCenterVO> listAllZones();
+
+    List<DataCenterVO> list(Object[] ids);
 }

engine/schema/src/main/java/com/cloud/dc/dao/DataCenterDaoImpl.java

@@ -437,4 +437,12 @@ public List<DataCenterVO> listAllZones() {
 
         return dcs;
     }
+
+    @Override
+    public List<DataCenterVO> list(Object[] ids) {
+        SearchBuilder<DataCenterVO> sb = createSearchBuilder();
+        SearchCriteria<DataCenterVO> sc = sb.create();
+        sc.addAnd("id", SearchCriteria.Op.IN, ids);
+        return listBy(sc);
+    }
 }