Issue-522: Added ListStorageAccessGroups API and storageaccessgroup parameter in list APIs (FR79 Issue) (apache#524)

This adds listStorageAccessGroups API and storageaccessgroup parameter in list hosts/pods/clusters/zones/storagepools APIs
This PR addresses apache#522

Author: harikrishna-patnala

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

@@ -435,6 +435,7 @@ public class ApiConstants {
     public static final String TAGS = "tags";
     public static final String STORAGE_TAGS = "storagetags";
     public static final String STORAGE_ACCESS_GROUPS = "storageaccessgroups";
+    public static final String STORAGE_ACCESS_GROUP = "storageaccessgroup";
     public static final String TARGET_IQN = "targetiqn";
     public static final String TEMPLATE_FILTER = "templatefilter";
     public static final String TEMPLATE_ID = "templateid";

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

@@ -290,6 +290,8 @@ public interface ResponseGenerator {
 
     PodResponse createPodResponse(Pod pod, Boolean showCapacities);
 
+    PodResponse createMinimalPodResponse(Pod pod);
+
     ZoneResponse createZoneResponse(ResponseView view, DataCenter dataCenter, Boolean showCapacities, Boolean showResourceIcon);
 
     DataCenterGuestIpv6PrefixResponse createDataCenterGuestIpv6PrefixResponse(DataCenterGuestIpv6Prefix prefix);
@@ -304,6 +306,8 @@ public interface ResponseGenerator {
 
     ClusterResponse createClusterResponse(Cluster cluster, Boolean showCapacities);
 
+    ClusterResponse createMinimalClusterResponse(Cluster cluster);
+
     FirewallRuleResponse createPortForwardingRuleResponse(PortForwardingRule fwRule);
 
     IpForwardingRuleResponse createIpForwardingRuleResponse(StaticNatRule fwRule);

api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/ListClustersCmd.java

@@ -70,6 +70,9 @@ public class ListClustersCmd extends BaseListCmd {
     @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the clusters")
     private Boolean showCapacities;
 
+    @Parameter(name = ApiConstants.STORAGE_ACCESS_GROUP, type = CommandType.STRING, description = "the name of the storage access group")
+    private String storageAccessGroup;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -114,6 +117,18 @@ public Boolean getShowCapacities() {
         return showCapacities;
     }
 
+    public String getStorageAccessGroup() {
+        return storageAccessGroup;
+    }
+
+    public ListClustersCmd() {
+
+    }
+
+    public ListClustersCmd(String storageAccessGroup) {
+        this.storageAccessGroup = storageAccessGroup;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/command/admin/host/ListHostsCmd.java

@@ -111,6 +111,9 @@ public class ListHostsCmd extends BaseListCmd {
     @Parameter(name = ApiConstants.MANAGEMENT_SERVER_ID, type = CommandType.UUID, entityType = ManagementServerResponse.class, description = "the id of the management server", since="4.18.1")
     private Long managementServerId;
 
+    @Parameter(name = ApiConstants.STORAGE_ACCESS_GROUP, type = CommandType.STRING, description = "the name of the storage access group")
+    private String storageAccessGroup;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -194,6 +197,18 @@ public Long getManagementServerId() {
         return managementServerId;
     }
 
+    public String getStorageAccessGroup() {
+        return storageAccessGroup;
+    }
+
+    public ListHostsCmd() {
+
+    }
+
+    public ListHostsCmd(String storageAccessGroup) {
+        this.storageAccessGroup = storageAccessGroup;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/command/admin/pod/ListPodsByCmd.java

@@ -57,6 +57,9 @@ public class ListPodsByCmd extends BaseListCmd {
     @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the pods")
     private Boolean showCapacities;
 
+    @Parameter(name = ApiConstants.STORAGE_ACCESS_GROUP, type = CommandType.STRING, description = "the name of the storage access group")
+    private String storageAccessGroup;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -81,6 +84,18 @@ public Boolean getShowCapacities() {
         return showCapacities;
     }
 
+    public String getStorageAccessGroup() {
+        return storageAccessGroup;
+    }
+
+    public ListPodsByCmd() {
+
+    }
+
+    public ListPodsByCmd(String storageAccessGroup) {
+        this.storageAccessGroup = storageAccessGroup;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStorageAccessGroupsCmd.java

@@ -0,0 +1,67 @@
+/*
+ * 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.api.command.admin.storage;
+
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseCmd;
+import org.apache.cloudstack.api.Parameter;
+import org.apache.cloudstack.api.response.StorageAccessGroupResponse;
+import org.apache.log4j.Logger;
+import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiCommandResourceType;
+import org.apache.cloudstack.api.BaseListCmd;
+import org.apache.cloudstack.api.response.ListResponse;
+
+@APICommand(name = "listStorageAccessGroups", description = "Lists storage access groups", responseObject = StorageAccessGroupResponse.class, since = "4.18.1", requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
+public class ListStorageAccessGroupsCmd extends BaseListCmd {
+    public static final Logger s_logger = Logger.getLogger(ListStorageAccessGroupsCmd.class.getName());
+
+    // ///////////////////////////////////////////////////
+    // ////////////// API parameters /////////////////////
+    // ///////////////////////////////////////////////////
+
+    @Parameter(name = ApiConstants.NAME, type = BaseCmd.CommandType.STRING, description = "Name of the Storage access group")
+    private String name;
+
+    // ///////////////////////////////////////////////////
+    // ///////////////// Accessors ///////////////////////
+    // ///////////////////////////////////////////////////
+
+    public String getName() {
+        return name;
+    }
+
+    // ///////////////////////////////////////////////////
+    // ///////////// API Implementation///////////////////
+    // ///////////////////////////////////////////////////
+
+    @Override
+    public ApiCommandResourceType getApiResourceType() {
+        return ApiCommandResourceType.StoragePool;
+    }
+
+    @Override
+    public void execute() {
+        ListResponse<StorageAccessGroupResponse> response = _queryService.searchForStorageAccessGroups(this);
+
+        response.setResponseName(getCommandName());
+
+        setResponseObject(response);
+    }
+}

api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStoragePoolsCmd.java

@@ -75,6 +75,10 @@ public class ListStoragePoolsCmd extends BaseListCmd {
 
     @Parameter(name = ApiConstants.STORAGE_CUSTOM_STATS, type = CommandType.BOOLEAN, description = "If true, lists the custom stats of the storage pool", since = "4.18.1")
     private Boolean customStats;
+
+    @Parameter(name = ApiConstants.STORAGE_ACCESS_GROUP, type = CommandType.STRING, description = "the name of the storage access group")
+    private String storageAccessGroup;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -122,6 +126,19 @@ public void setId(Long id) {
     public Boolean getCustomStats() {
         return customStats != null && customStats;
     }
+
+    public String getStorageAccessGroup() {
+        return storageAccessGroup;
+    }
+
+    public ListStoragePoolsCmd() {
+
+    }
+
+    public ListStoragePoolsCmd(String storageAccessGroup) {
+        this.storageAccessGroup = storageAccessGroup;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

api/src/main/java/org/apache/cloudstack/api/command/user/zone/ListZonesCmd.java

@@ -68,6 +68,9 @@ public class ListZonesCmd extends BaseListCmd implements UserCmd {
     @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "flag to display the resource image for the zones")
     private Boolean showIcon;
 
+    @Parameter(name = ApiConstants.STORAGE_ACCESS_GROUP, type = CommandType.STRING, description = "the name of the storage access group")
+    private String storageAccessGroup;
+
     /////////////////////////////////////////////////////
     /////////////////// Accessors ///////////////////////
     /////////////////////////////////////////////////////
@@ -104,6 +107,18 @@ public Boolean getShowIcon () {
         return  showIcon != null ? showIcon : false;
     }
 
+    public String getStorageAccessGroup() {
+        return storageAccessGroup;
+    }
+
+    public ListZonesCmd() {
+
+    }
+
+    public ListZonesCmd(String storageAccessGroup) {
+        this.storageAccessGroup = storageAccessGroup;
+    }
+
     /////////////////////////////////////////////////////
     /////////////// API Implementation///////////////////
     /////////////////////////////////////////////////////

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

@@ -151,7 +151,7 @@ public class HostResponse extends BaseResponseWithAnnotations {
     @Deprecated
     @SerializedName("memoryallocated")
     @Param(description = "the amount of the host's memory currently allocated")
-    private long memoryAllocated;
+    private Long memoryAllocated;
 
     @SerializedName("memoryallocatedpercentage")
     @Param(description = "the amount of the host's memory currently allocated in percentage")

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

@@ -0,0 +1,108 @@
+// 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.api.response;
+
+import com.google.gson.annotations.SerializedName;
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseResponse;
+import com.cloud.serializer.Param;
+
+public class StorageAccessGroupResponse extends BaseResponse {
+    @SerializedName(ApiConstants.ID)
+    @Param(description = "the ID of the storage access group")
+    private String id;
+
+    @SerializedName(ApiConstants.NAME)
+    @Param(description = "the name of the storage access group")
+    private String name;
+
+    @SerializedName("hosts")
+    @Param(description = "List of Hosts in the Storage Access Group")
+    private ListResponse<HostResponse> hostResponseList;
+
+    @SerializedName("clusters")
+    @Param(description = "List of Clusters in the Storage Access Group")
+    private ListResponse<ClusterResponse> clusterResponseList;
+
+    @SerializedName("pods")
+    @Param(description = "List of Pods in the Storage Access Group")
+    private ListResponse<PodResponse> podResponseList;
+
+    @SerializedName("zones")
+    @Param(description = "List of Zones in the Storage Access Group")
+    private ListResponse<ZoneResponse> zoneResponseList;
+
+    @SerializedName("storagepools")
+    @Param(description = "List of Storage Pools in the Storage Access Group")
+    private ListResponse<StoragePoolResponse> storagePoolResponseList;
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public ListResponse<HostResponse> getHostResponseList() {
+        return hostResponseList;
+    }
+
+    public void setHostResponseList(ListResponse<HostResponse> hostResponseList) {
+        this.hostResponseList = hostResponseList;
+    }
+
+    public ListResponse<ClusterResponse> getClusterResponseList() {
+        return clusterResponseList;
+    }
+
+    public void setClusterResponseList(ListResponse<ClusterResponse> clusterResponseList) {
+        this.clusterResponseList = clusterResponseList;
+    }
+
+    public ListResponse<PodResponse> getPodResponseList() {
+        return podResponseList;
+    }
+
+    public void setPodResponseList(ListResponse<PodResponse> podResponseList) {
+        this.podResponseList = podResponseList;
+    }
+
+    public ListResponse<ZoneResponse> getZoneResponseList() {
+        return zoneResponseList;
+    }
+
+    public void setZoneResponseList(ListResponse<ZoneResponse> zoneResponseList) {
+        this.zoneResponseList = zoneResponseList;
+    }
+
+    public ListResponse<StoragePoolResponse> getStoragePoolResponseList() {
+        return storagePoolResponseList;
+    }
+
+    public void setStoragePoolResponseList(ListResponse<StoragePoolResponse> storagePoolResponseList) {
+        this.storagePoolResponseList = storagePoolResponseList;
+    }
+}