Improve global settings in the UI to be more intuitive/logical

Author: sureshanaparti

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

@@ -168,6 +168,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";
@@ -274,6 +275,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";

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;
@@ -90,6 +93,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")
+    private String groupName;
+
+    @Parameter(name = ApiConstants.SUBGROUP, type = CommandType.STRING, description = "lists configuration by subgroup name")
+    private String subGroupName;
+
+    @Parameter(name = ApiConstants.PARENT, type = CommandType.STRING, description = "lists configuration by parent name")
+    private String parentName;
+
     // ///////////////////////////////////////////////////
     // ///////////////// Accessors ///////////////////////
     // ///////////////////////////////////////////////////
@@ -126,6 +138,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;
@@ -151,11 +183,15 @@ public String getCommandName() {
 
     @Override
     public void execute() {
+        validParameters();
         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);
+            if (!matchesConfigurationGroup(cfgResponse)) {
+                continue;
+            }
             cfgResponse.setObjectName("configuration");
             if (getZoneId() != null) {
                 cfgResponse.setScope("zone");
@@ -178,8 +214,32 @@ public void execute() {
             configResponses.add(cfgResponse);
         }
 
-        response.setResponses(configResponses, result.second());
+        if (StringUtils.isNotEmpty(getGroupName())) {
+            response.setResponses(configResponses, configResponses.size());
+        } else {
+            response.setResponses(configResponses, result.second());
+        }
         response.setResponseName(getCommandName());
         setResponseObject(response);
     }
+
+    private void validParameters() {
+        if (StringUtils.isNotEmpty(getSubGroupName())&& StringUtils.isEmpty(getGroupName())) {
+            throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "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 (StringUtils.isNotEmpty(getSubGroupName())) {
+                if (!(getSubGroupName().equalsIgnoreCase(cfgResponse.getSubGroup()))) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
 }

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

@@ -28,6 +28,14 @@ public class ConfigurationResponse extends BaseResponse {
     @Param(description = "the category of the configuration")
     private String category;
 
+    @SerializedName(ApiConstants.GROUP)
+    @Param(description = "the group of the configuration")
+    private String group;
+
+    @SerializedName(ApiConstants.SUBGROUP)
+    @Param(description = "the subgroup of the configuration")
+    private String subGroup;
+
     @SerializedName(ApiConstants.NAME)
     @Param(description = "the name of the configuration")
     private String name;
@@ -52,6 +60,22 @@ public class ConfigurationResponse extends BaseResponse {
     @Param(description = "true if the configuration is dynamic")
     private boolean isDynamic;
 
+    @SerializedName(ApiConstants.COMPONENT)
+    @Param(description = "the component of the configuration", since = "4.17.0")
+    private String component;
+
+    @SerializedName("parent")
+    @Param(description = "the name of the parent configuration", since = "4.17.0")
+    private String parent;
+
+    @SerializedName(ApiConstants.DISPLAY_TEXT)
+    @Param(description = "the display text of the configuration", since = "4.17.0")
+    private String displayText;
+
+    @SerializedName(ApiConstants.TYPE)
+    @Param(description = "the type of the configuration value", since = "4.17.0")
+    private String type;
+
     public String getCategory() {
         return category;
     }
@@ -60,6 +84,22 @@ public void setCategory(String category) {
         this.category = category;
     }
 
+    public String getGroup() {
+        return group;
+    }
+
+    public void setGroup(String group) {
+        this.group = group;
+    }
+
+    public String getSubGroup() {
+        return subGroup;
+    }
+
+    public void setSubGroup(String subGroup) {
+        this.subGroup = subGroup;
+    }
+
     public String getName() {
         return name;
     }
@@ -100,4 +140,35 @@ public void setIsDynamic(boolean isDynamic) {
         this.isDynamic = isDynamic;
     }
 
+    public String getComponent() {
+        return component;
+    }
+
+    public void setComponent(String component) {
+        this.component = component;
+    }
+
+    public String getParent() {
+        return parent;
+    }
+
+    public void setParent(String parent) {
+        this.parent = parent;
+    }
+
+    public String getDisplayText() {
+        return displayText;
+    }
+
+    public void setDisplayText(String displayText) {
+        this.displayText = displayText;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public void setType(String type) {
+        this.type = type;
+    }
 }

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

@@ -42,6 +42,7 @@
 import com.cloud.offerings.NetworkOfferingVO;
 import com.cloud.org.Grouping.AllocationState;
 import com.cloud.user.Account;
+import com.cloud.utils.Pair;
 
 /**
  * ConfigurationManager handles adding pods/zones, changing IP ranges, enabling external firewalls, and editing
@@ -259,4 +260,8 @@ Vlan createVlanAndPublicIpRange(long zoneId, long networkId, long physicalNetwor
     AllocationState findPodAllocationState(HostPodVO pod);
 
     AllocationState findClusterAllocationState(ClusterVO cluster);
+
+    String getConfigurationType(String configName); // Value type
+
+    Pair<String, String> getConfigurationGroup(String configName);
 }