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

Author: sureshanaparti

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

@@ -21,6 +21,7 @@
 import java.util.Map;
 
 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;
@@ -58,6 +59,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;
@@ -97,6 +99,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

@@ -171,6 +171,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";
@@ -277,6 +278,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";
@@ -298,6 +300,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

@@ -23,10 +23,13 @@
 import java.util.Set;
 
 import com.cloud.server.ResourceIcon;
+
+import org.apache.cloudstack.api.response.ConfigurationGroupResponse;
 import org.apache.cloudstack.api.response.ResourceIconResponse;
 import org.apache.cloudstack.api.response.RouterHealthCheckResultResponse;
 import com.cloud.resource.RollingMaintenanceManager;
 import org.apache.cloudstack.api.response.RollingMaintenanceResponse;
+import org.apache.cloudstack.config.ConfigurationGroup;
 import org.apache.cloudstack.management.ManagementServerHost;
 import org.apache.cloudstack.affinity.AffinityGroup;
 import org.apache.cloudstack.affinity.AffinityGroupResponse;
@@ -230,6 +233,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,80 @@
+// 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.", responseObject = ConfigurationGroupResponse.class,
+        requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.17.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<ConfigurationGroupResponse>();
+        List<ConfigurationGroupResponse> configGroupResponses = new ArrayList<ConfigurationGroupResponse>();
+        for (ConfigurationGroup cfgGroup : result.first()) {
+            ConfigurationGroupResponse cfgGroupResponse = _responseGenerator.createConfigurationGroupResponse(cfgGroup);
+            cfgGroupResponse.setObjectName("configurationgroup");
+            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;
@@ -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", since = "4.17.0")
+    private String groupName;
+
+    @Parameter(name = ApiConstants.SUBGROUP, type = CommandType.STRING, description = "lists configuration by subgroup name", since = "4.17.0")
+    private String subGroupName;
+
+    @Parameter(name = ApiConstants.PARENT, type = CommandType.STRING, description = "lists configuration by parent name", since = "4.17.0")
+    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() {
+        validateParameters();
         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 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 (StringUtils.isNotEmpty(getSubGroupName())) {
+                if (!(getSubGroupName().equalsIgnoreCase(cfgResponse.getSubGroup()))) {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
 }

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

@@ -0,0 +1,76 @@
+// 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 java.util.List;
+
+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 ConfigurationGroupResponse extends BaseResponse {
+    @SerializedName(ApiConstants.NAME)
+    @Param(description = "the name of the configuration group")
+    private String groupName;
+
+    @SerializedName(ApiConstants.SUBGROUP)
+    @Param(description = "the subgroups of the configuration group", responseObject = ConfigurationSubGroupResponse.class)
+    private List<ConfigurationSubGroupResponse> subGroups;
+
+    @SerializedName(ApiConstants.DESCRIPTION)
+    @Param(description = "the description of the configuration group")
+    private String description;
+
+    @SerializedName(ApiConstants.PRECEDENCE)
+    @Param(description = "the precedence of the configuration group")
+    private Long precedence;
+
+    public String getGroupName() {
+        return groupName;
+    }
+
+    public void setGroupName(String groupName) {
+        this.groupName = groupName;
+    }
+
+    public List<ConfigurationSubGroupResponse> getSubGroups() {
+        return subGroups;
+    }
+
+    public void setSubGroups(List<ConfigurationSubGroupResponse> subGroups) {
+        this.subGroups = subGroups;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    public Long getPrecedence() {
+        return precedence;
+    }
+
+    public void setPrecedence(Long precedence) {
+        this.precedence = precedence;
+    }
+}