Improve global settings UI to be more intuitive/logical

api/src/main/java/com/cloud/server/ManagementService.java

@@ -22,6 +22,7 @@
 
 import com.cloud.user.UserData;
 import org.apache.cloudstack.api.command.admin.cluster.ListClustersCmd;
+import org.apache.cloudstack.api.command.admin.config.ListCfgGroupsByCmd;
 import org.apache.cloudstack.api.command.admin.config.ListCfgsByCmd;
 import org.apache.cloudstack.api.command.admin.config.UpdateHypervisorCapabilitiesCmd;
 import org.apache.cloudstack.api.command.admin.guest.AddGuestOsCmd;
@@ -63,6 +64,7 @@
 import org.apache.cloudstack.api.command.user.vm.GetVMPasswordCmd;
 import org.apache.cloudstack.api.command.user.vmgroup.UpdateVMGroupCmd;
 import org.apache.cloudstack.config.Configuration;
+import org.apache.cloudstack.config.ConfigurationGroup;
 
 import com.cloud.alert.Alert;
 import com.cloud.capacity.Capacity;
@@ -102,6 +104,13 @@ public interface ManagementService {
      */
     Pair<List<? extends Configuration>, Integer> searchForConfigurations(ListCfgsByCmd c);
 
+    /**
+     * returns the the configuration groups
+     *
+     * @return list of configuration groups
+     */
+    Pair<List<? extends ConfigurationGroup>, Integer> listConfigurationGroups(ListCfgGroupsByCmd cmd);
+
     /**
      * Searches for Clusters by the specified search criteria
      *

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

@@ -118,6 +118,7 @@ public class ApiConstants {
     public static final String MAX_IOPS = "maxiops";
     public static final String HYPERVISOR_SNAPSHOT_RESERVE = "hypervisorsnapshotreserve";
     public static final String DATADISK_OFFERING_LIST = "datadiskofferinglist";
+    public static final String DEFAULT_VALUE = "defaultvalue";
     public static final String DESCRIPTION = "description";
     public static final String DESTINATION = "destination";
     public static final String DESTINATION_ZONE_ID = "destzoneid";
@@ -187,6 +188,7 @@ public class ApiConstants {
     public static final String GATEWAY = "gateway";
     public static final String IP6_GATEWAY = "ip6gateway";
     public static final String GROUP = "group";
+    public static final String SUBGROUP = "subgroup";
     public static final String GROUP_ID = "groupid";
     public static final String GSLB_LB_METHOD = "gslblbmethod";
     public static final String GSLB_SERVICE_DOMAIN_NAME = "gslbdomainname";
@@ -296,6 +298,7 @@ public class ApiConstants {
     public static final String IS_DEFAULT_USE = "defaultuse";
     public static final String OLD_FORMAT = "oldformat";
     public static final String OP = "op";
+    public static final String OPTIONS = "options";
     public static final String OS_CATEGORY_ID = "oscategoryid";
     public static final String OS_CATEGORY_NAME = "oscategoryname";
     public static final String OS_ID = "osid";
@@ -307,6 +310,7 @@ public class ApiConstants {
     public static final String OUTPUT = "output";
     public static final String PROPERTIES = "properties";
     public static final String PARAMS = "params";
+    public static final String PARENT = "parent";
     public static final String PARENT_ID = "parentid";
     public static final String PARENT_DOMAIN_ID = "parentdomainid";
     public static final String PARENT_TEMPLATE_ID = "parenttemplateid";
@@ -328,6 +332,7 @@ public class ApiConstants {
     public static final String POSITION = "position";
     public static final String POST_URL = "postURL";
     public static final String POWER_STATE = "powerstate";
+    public static final String PRECEDENCE = "precedence";
     public static final String PRIVATE_INTERFACE = "privateinterface";
     public static final String PRIVATE_IP = "privateip";
     public static final String PRIVATE_PORT = "privateport";

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

@@ -40,6 +40,7 @@
 import org.apache.cloudstack.api.response.CapacityResponse;
 import org.apache.cloudstack.api.response.ClusterResponse;
 import org.apache.cloudstack.api.response.ConditionResponse;
+import org.apache.cloudstack.api.response.ConfigurationGroupResponse;
 import org.apache.cloudstack.api.response.ConfigurationResponse;
 import org.apache.cloudstack.api.response.CounterResponse;
 import org.apache.cloudstack.api.response.CreateCmdResponse;
@@ -133,6 +134,7 @@
 import org.apache.cloudstack.backup.BackupOffering;
 import org.apache.cloudstack.backup.BackupSchedule;
 import org.apache.cloudstack.config.Configuration;
+import org.apache.cloudstack.config.ConfigurationGroup;
 import org.apache.cloudstack.direct.download.DirectDownloadCertificate;
 import org.apache.cloudstack.direct.download.DirectDownloadCertificateHostMap;
 import org.apache.cloudstack.direct.download.DirectDownloadManager;
@@ -244,6 +246,8 @@ public interface ResponseGenerator {
 
     ConfigurationResponse createConfigurationResponse(Configuration cfg);
 
+    ConfigurationGroupResponse createConfigurationGroupResponse(ConfigurationGroup cfgGroup);
+
     SnapshotResponse createSnapshotResponse(Snapshot snapshot);
 
     SnapshotPolicyResponse createSnapshotPolicyResponse(SnapshotPolicy policy);

api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgGroupsByCmd.java

@@ -0,0 +1,79 @@
+// 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.config;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.cloudstack.api.APICommand;
+import org.apache.cloudstack.api.ApiConstants;
+import org.apache.cloudstack.api.BaseCmd;
+import org.apache.cloudstack.api.BaseListCmd;
+import org.apache.cloudstack.api.Parameter;
+import org.apache.cloudstack.api.response.ConfigurationGroupResponse;
+import org.apache.cloudstack.api.response.ListResponse;
+import org.apache.cloudstack.config.ConfigurationGroup;
+import org.apache.log4j.Logger;
+
+import com.cloud.utils.Pair;
+
+@APICommand(name = ListCfgGroupsByCmd.APINAME, description = "Lists all configuration groups (primarily used for UI).", responseObject = ConfigurationGroupResponse.class,
+        requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.18.0")
+public class ListCfgGroupsByCmd extends BaseListCmd {
+    public static final Logger s_logger = Logger.getLogger(ListCfgGroupsByCmd.class.getName());
+
+    public static final String APINAME = "listConfigurationGroups";
+
+    // ///////////////////////////////////////////////////
+    // ////////////// API parameters /////////////////////
+    // ///////////////////////////////////////////////////
+
+    @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "lists configuration group by group name")
+    private String groupName;
+
+    // ///////////////////////////////////////////////////
+    // ///////////////// Accessors ///////////////////////
+    // ///////////////////////////////////////////////////
+
+    public String getGroupName() {
+        return groupName;
+    }
+
+    // ///////////////////////////////////////////////////
+    // ///////////// API Implementation///////////////////
+    // ///////////////////////////////////////////////////
+
+    @Override
+    public String getCommandName() {
+        return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX;
+    }
+
+    @Override
+    public void execute() {
+        Pair<List<? extends ConfigurationGroup>, Integer> result = _mgr.listConfigurationGroups(this);
+        ListResponse<ConfigurationGroupResponse> response = new ListResponse<>();
+        List<ConfigurationGroupResponse> configGroupResponses = new ArrayList<>();
+        for (ConfigurationGroup cfgGroup : result.first()) {
+            ConfigurationGroupResponse cfgGroupResponse = _responseGenerator.createConfigurationGroupResponse(cfgGroup);
+            configGroupResponses.add(cfgGroupResponse);
+        }
+
+        response.setResponses(configGroupResponses, result.second());
+        response.setResponseName(getCommandName());
+        setResponseObject(response);
+    }
+}

api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgsByCmd.java

@@ -19,7 +19,10 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import org.apache.cloudstack.api.ApiErrorCode;
+import org.apache.cloudstack.api.ServerApiException;
 import org.apache.cloudstack.api.response.DomainResponse;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.log4j.Logger;
 
 import org.apache.cloudstack.api.APICommand;
@@ -35,7 +38,9 @@
 import org.apache.cloudstack.api.response.ZoneResponse;
 import org.apache.cloudstack.config.Configuration;
 
+import com.cloud.exception.InvalidParameterValueException;
 import com.cloud.utils.Pair;
+import com.cloud.utils.exception.CloudRuntimeException;
 
 @APICommand(name = "listConfigurations", description = "Lists all configurations.", responseObject = ConfigurationResponse.class,
         requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
@@ -89,6 +94,15 @@ public class ListCfgsByCmd extends BaseListCmd {
             description = "the ID of the Image Store to update the parameter value for corresponding image store")
     private Long imageStoreId;
 
+    @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "lists configuration by group name (primarily used for UI)", since = "4.18.0")
+    private String groupName;
+
+    @Parameter(name = ApiConstants.SUBGROUP, type = CommandType.STRING, description = "lists configuration by subgroup name (primarily used for UI)", since = "4.18.0")
+    private String subGroupName;
+
+    @Parameter(name = ApiConstants.PARENT, type = CommandType.STRING, description = "lists configuration by parent name (primarily used for UI)", since = "4.18.0")
+    private String parentName;
+
     // ///////////////////////////////////////////////////
     // ///////////////// Accessors ///////////////////////
     // ///////////////////////////////////////////////////
@@ -125,6 +139,26 @@ public Long getImageStoreId() {
         return imageStoreId;
     }
 
+    public String getGroupName() {
+        return groupName;
+    }
+
+    public String getSubGroupName() {
+        return subGroupName;
+    }
+
+    public String getParentName() {
+        return parentName;
+    }
+
+    @Override
+    public Integer getPageSize() {
+        if (StringUtils.isNotEmpty(getGroupName())) {
+            return Integer.valueOf(s_pageSizeUnlimited.intValue());
+        }
+        return super.getPageSize();
+    }
+
     @Override
     public Long getPageSizeVal() {
         Long defaultPageSize = 500L;
@@ -143,37 +177,74 @@ public Long getPageSizeVal() {
     // ///////////// API Implementation///////////////////
     // ///////////////////////////////////////////////////
 
+    private void setScope(ConfigurationResponse cfgResponse) {
+        if (!matchesConfigurationGroup(cfgResponse)) {
+            return;
+        }
+        cfgResponse.setObjectName("configuration");
+        if (getZoneId() != null) {
+            cfgResponse.setScope("zone");
+        }
+        if (getClusterId() != null) {
+            cfgResponse.setScope("cluster");
+        }
+        if (getStoragepoolId() != null) {
+            cfgResponse.setScope("storagepool");
+        }
+        if (getAccountId() != null) {
+            cfgResponse.setScope("account");
+        }
+        if (getDomainId() != null) {
+            cfgResponse.setScope("domain");
+        }
+        if (getImageStoreId() != null){
+            cfgResponse.setScope("imagestore");
+        }
+    }
+
     @Override
     public void execute() {
-        Pair<List<? extends Configuration>, Integer> result = _mgr.searchForConfigurations(this);
-        ListResponse<ConfigurationResponse> response = new ListResponse<ConfigurationResponse>();
-        List<ConfigurationResponse> configResponses = new ArrayList<ConfigurationResponse>();
-        for (Configuration cfg : result.first()) {
-            ConfigurationResponse cfgResponse = _responseGenerator.createConfigurationResponse(cfg);
-            cfgResponse.setObjectName("configuration");
-            if (getZoneId() != null) {
-                cfgResponse.setScope("zone");
-            }
-            if (getClusterId() != null) {
-                cfgResponse.setScope("cluster");
+        validateParameters();
+        try {
+            Pair<List<? extends Configuration>, Integer> result = _mgr.searchForConfigurations(this);
+            ListResponse<ConfigurationResponse> response = new ListResponse<>();
+            List<ConfigurationResponse> configResponses = new ArrayList<>();
+            for (Configuration cfg : result.first()) {
+                ConfigurationResponse cfgResponse = _responseGenerator.createConfigurationResponse(cfg);
+                setScope(cfgResponse);
+                configResponses.add(cfgResponse);
             }
-            if (getStoragepoolId() != null) {
-                cfgResponse.setScope("storagepool");
-            }
-            if (getAccountId() != null) {
-                cfgResponse.setScope("account");
+
+            if (StringUtils.isNotEmpty(getGroupName())) {
+                response.setResponses(configResponses, configResponses.size());
+            } else {
+                response.setResponses(configResponses, result.second());
             }
-            if (getDomainId() != null) {
-                cfgResponse.setScope("domain");
+            response.setResponseName(getCommandName());
+            setResponseObject(response);
+        }  catch (InvalidParameterValueException e) {
+            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, e.getMessage());
+        } catch (CloudRuntimeException e) {
+            throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
+        }
+    }
+
+    private void validateParameters() {
+        if (StringUtils.isNotEmpty(getSubGroupName()) && StringUtils.isEmpty(getGroupName())) {
+            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Configuration group name must be specified with the subgroup name");
+        }
+    }
+
+    private boolean matchesConfigurationGroup(ConfigurationResponse cfgResponse) {
+        if (StringUtils.isNotEmpty(getGroupName())) {
+            if (!(getGroupName().equalsIgnoreCase(cfgResponse.getGroup()))) {
+                return false;
             }
-            if (getImageStoreId() != null){
-                cfgResponse.setScope("imagestore");
+            if (StringUtils.isNotEmpty(getSubGroupName()) &&
+                !getSubGroupName().equalsIgnoreCase(cfgResponse.getSubGroup())) {
+                return false;
             }
-            configResponses.add(cfgResponse);
         }
-
-        response.setResponses(configResponses, result.second());
-        response.setResponseName(getCommandName());
-        setResponseObject(response);
+        return true;
     }
 }