modify based on comment

Signed-off-by: Ruirui Zhang <mariazrr@amazon.com>

Author: ruai0511

CHANGELOG.md

@@ -15,7 +15,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Introduce SecureHttpTransportParameters experimental API (to complement SecureTransportParameters counterpart) ([#18572](https://github.com/opensearch-project/OpenSearch/issues/18572))
 - Create equivalents of JSM's AccessController in the java agent ([#18346](https://github.com/opensearch-project/OpenSearch/issues/18346))
 - [WLM] Add WLM mode validation for workload group CRUD requests ([#18346](https://github.com/opensearch-project/OpenSearch/issues/18346))
-- Introduced a new cluster-level API to fetch remote store metadata (segments and translogs) for each shard of an index. ([#18652](https://github.com/opensearch-project/OpenSearch/pull/18652))
+- Introduced a new cluster-level API to fetch remote store metadata (segments and translogs) for each shard of an index. ([#18257](https://github.com/opensearch-project/OpenSearch/pull/18257))
 - Add last index request timestamp columns to the `_cat/indices` API. ([10766](https://github.com/opensearch-project/OpenSearch/issues/10766))
 - Introduce a new pull-based ingestion plugin for file-based indexing (for local testing) ([#18591](https://github.com/opensearch-project/OpenSearch/pull/18591))
 - Add support for search pipeline in search and msearch template ([#18564](https://github.com/opensearch-project/OpenSearch/pull/18564))

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/NonPluginSettingValuesProvider.java renamed to plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/WlmClusterSettingValuesProvider.java

@@ -14,19 +14,19 @@
 import org.opensearch.wlm.WorkloadManagementSettings;
 
 /**
- * Central provider for maintaining and supplying the current values of non-plugin cluster settings.
+ * Central provider for maintaining and supplying the current values of wlm cluster settings.
  * This class listens for updates to relevant settings and provides the latest setting values.
  */
-public class NonPluginSettingValuesProvider {
+public class WlmClusterSettingValuesProvider {
 
     private volatile WlmMode wlmMode;
 
     /**
-     * Constructor for NonPluginSettingValuesProvider
+     * Constructor for WlmClusterSettingValuesProvider
      * @param settings OpenSearch settings
      * @param clusterSettings Cluster settings to register update listener
      */
-    public NonPluginSettingValuesProvider(Settings settings, ClusterSettings clusterSettings) {
+    public WlmClusterSettingValuesProvider(Settings settings, ClusterSettings clusterSettings) {
         this.wlmMode = WorkloadManagementSettings.WLM_MODE_SETTING.get(settings);
         clusterSettings.addSettingsUpdateConsumer(WorkloadManagementSettings.WLM_MODE_SETTING, this::setWlmMode);
     }

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/WorkloadManagementPlugin.java

@@ -91,7 +91,7 @@ public class WorkloadManagementPlugin extends Plugin implements ActionPlugin, Sy
     private static FeatureType featureType;
     private static RulePersistenceService rulePersistenceService;
     private static RuleRoutingService ruleRoutingService;
-    private NonPluginSettingValuesProvider nonPluginSettingValuesProvider;
+    private WlmClusterSettingValuesProvider wlmClusterSettingValuesProvider;
     private AutoTaggingActionFilter autoTaggingActionFilter;
 
     /**
@@ -113,7 +113,7 @@ public Collection<Object> createComponents(
         IndexNameExpressionResolver indexNameExpressionResolver,
         Supplier<RepositoriesService> repositoriesServiceSupplier
     ) {
-        nonPluginSettingValuesProvider = new NonPluginSettingValuesProvider(
+        wlmClusterSettingValuesProvider = new WlmClusterSettingValuesProvider(
             clusterService.getSettings(),
             clusterService.getClusterSettings()
         );
@@ -140,7 +140,7 @@ public Collection<Object> createComponents(
             featureType,
             rulePersistenceService,
             new RuleEventClassifier(Collections.emptySet(), ruleProcessingService),
-            nonPluginSettingValuesProvider
+            wlmClusterSettingValuesProvider
         );
 
         autoTaggingActionFilter = new AutoTaggingActionFilter(ruleProcessingService, threadPool);
@@ -184,10 +184,10 @@ public List<RestHandler> getRestHandlers(
         Supplier<DiscoveryNodes> nodesInCluster
     ) {
         return List.of(
-            new RestCreateWorkloadGroupAction(nonPluginSettingValuesProvider),
+            new RestCreateWorkloadGroupAction(wlmClusterSettingValuesProvider),
             new RestGetWorkloadGroupAction(),
-            new RestDeleteWorkloadGroupAction(nonPluginSettingValuesProvider),
-            new RestUpdateWorkloadGroupAction(nonPluginSettingValuesProvider)
+            new RestDeleteWorkloadGroupAction(wlmClusterSettingValuesProvider),
+            new RestUpdateWorkloadGroupAction(wlmClusterSettingValuesProvider)
         );
     }
 

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rest/RestCreateWorkloadGroupAction.java

@@ -11,7 +11,7 @@
 import org.opensearch.core.rest.RestStatus;
 import org.opensearch.core.xcontent.ToXContent;
 import org.opensearch.core.xcontent.XContentParser;
-import org.opensearch.plugin.wlm.NonPluginSettingValuesProvider;
+import org.opensearch.plugin.wlm.WlmClusterSettingValuesProvider;
 import org.opensearch.plugin.wlm.action.CreateWorkloadGroupAction;
 import org.opensearch.plugin.wlm.action.CreateWorkloadGroupRequest;
 import org.opensearch.plugin.wlm.action.CreateWorkloadGroupResponse;
@@ -36,13 +36,13 @@
  */
 public class RestCreateWorkloadGroupAction extends BaseRestHandler {
 
-    private final NonPluginSettingValuesProvider nonPluginSettingValuesProvider;
+    private final WlmClusterSettingValuesProvider nonPluginSettingValuesProvider;
 
     /**
      * Constructor for RestCreateWorkloadGroupAction
      * @param nonPluginSettingValuesProvider the settings provider to access the current WLM mode
      */
-    public RestCreateWorkloadGroupAction(NonPluginSettingValuesProvider nonPluginSettingValuesProvider) {
+    public RestCreateWorkloadGroupAction(WlmClusterSettingValuesProvider nonPluginSettingValuesProvider) {
         this.nonPluginSettingValuesProvider = nonPluginSettingValuesProvider;
     }
 
@@ -61,7 +61,7 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
-        nonPluginSettingValuesProvider.ensureWlmEnabled("create workload group");
+        nonPluginSettingValuesProvider.ensureWlmEnabled(getName());
         try (XContentParser parser = request.contentParser()) {
             CreateWorkloadGroupRequest createWorkloadGroupRequest = CreateWorkloadGroupRequest.fromXContent(parser);
             return channel -> client.execute(

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rest/RestDeleteWorkloadGroupAction.java

@@ -8,7 +8,7 @@
 
 package org.opensearch.plugin.wlm.rest;
 
-import org.opensearch.plugin.wlm.NonPluginSettingValuesProvider;
+import org.opensearch.plugin.wlm.WlmClusterSettingValuesProvider;
 import org.opensearch.plugin.wlm.action.DeleteWorkloadGroupAction;
 import org.opensearch.plugin.wlm.action.DeleteWorkloadGroupRequest;
 import org.opensearch.rest.BaseRestHandler;
@@ -28,13 +28,13 @@
  */
 public class RestDeleteWorkloadGroupAction extends BaseRestHandler {
 
-    private final NonPluginSettingValuesProvider nonPluginSettingValuesProvider;
+    private final WlmClusterSettingValuesProvider nonPluginSettingValuesProvider;
 
     /**
      * Constructor for RestDeleteWorkloadGroupAction
      * @param nonPluginSettingValuesProvider the settings provider to access the current WLM mode
      */
-    public RestDeleteWorkloadGroupAction(NonPluginSettingValuesProvider nonPluginSettingValuesProvider) {
+    public RestDeleteWorkloadGroupAction(WlmClusterSettingValuesProvider nonPluginSettingValuesProvider) {
         this.nonPluginSettingValuesProvider = nonPluginSettingValuesProvider;
     }
 
@@ -53,7 +53,7 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
-        nonPluginSettingValuesProvider.ensureWlmEnabled("delete workload group");
+        nonPluginSettingValuesProvider.ensureWlmEnabled(getName());
         DeleteWorkloadGroupRequest deleteWorkloadGroupRequest = new DeleteWorkloadGroupRequest(request.param("name"));
         deleteWorkloadGroupRequest.clusterManagerNodeTimeout(
             request.paramAsTime("cluster_manager_timeout", deleteWorkloadGroupRequest.clusterManagerNodeTimeout())

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rest/RestUpdateWorkloadGroupAction.java

@@ -11,7 +11,7 @@
 import org.opensearch.core.rest.RestStatus;
 import org.opensearch.core.xcontent.ToXContent;
 import org.opensearch.core.xcontent.XContentParser;
-import org.opensearch.plugin.wlm.NonPluginSettingValuesProvider;
+import org.opensearch.plugin.wlm.WlmClusterSettingValuesProvider;
 import org.opensearch.plugin.wlm.action.UpdateWorkloadGroupAction;
 import org.opensearch.plugin.wlm.action.UpdateWorkloadGroupRequest;
 import org.opensearch.plugin.wlm.action.UpdateWorkloadGroupResponse;
@@ -36,13 +36,13 @@
  */
 public class RestUpdateWorkloadGroupAction extends BaseRestHandler {
 
-    private final NonPluginSettingValuesProvider nonPluginSettingValuesProvider;
+    private final WlmClusterSettingValuesProvider nonPluginSettingValuesProvider;
 
     /**
      * Constructor for RestUpdateWorkloadGroupAction
      * @param nonPluginSettingValuesProvider the settings provider to access the current WLM mode
      */
-    public RestUpdateWorkloadGroupAction(NonPluginSettingValuesProvider nonPluginSettingValuesProvider) {
+    public RestUpdateWorkloadGroupAction(WlmClusterSettingValuesProvider nonPluginSettingValuesProvider) {
         this.nonPluginSettingValuesProvider = nonPluginSettingValuesProvider;
     }
 
@@ -61,7 +61,7 @@ public List<Route> routes() {
 
     @Override
     protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
-        nonPluginSettingValuesProvider.ensureWlmEnabled("update workload group");
+        nonPluginSettingValuesProvider.ensureWlmEnabled(getName());
         try (XContentParser parser = request.contentParser()) {
             UpdateWorkloadGroupRequest updateWorkloadGroupRequest = UpdateWorkloadGroupRequest.fromXContent(parser, request.param("name"));
             return channel -> client.execute(

plugins/workload-management/src/main/java/org/opensearch/plugin/wlm/rule/sync/RefreshBasedSyncMechanism.java

@@ -15,7 +15,7 @@
 import org.opensearch.common.settings.Settings;
 import org.opensearch.common.unit.TimeValue;
 import org.opensearch.core.action.ActionListener;
-import org.opensearch.plugin.wlm.NonPluginSettingValuesProvider;
+import org.opensearch.plugin.wlm.WlmClusterSettingValuesProvider;
 import org.opensearch.plugin.wlm.rule.sync.detect.RuleEvent;
 import org.opensearch.plugin.wlm.rule.sync.detect.RuleEventClassifier;
 import org.opensearch.rule.RulePersistenceService;
@@ -65,7 +65,7 @@ public class RefreshBasedSyncMechanism extends AbstractLifecycleComponent {
     private final RulePersistenceService rulePersistenceService;
     private final RuleEventClassifier ruleEventClassifier;
     private final FeatureType featureType;
-    private final NonPluginSettingValuesProvider nonPluginSettingValuesProvider;
+    private final WlmClusterSettingValuesProvider nonPluginSettingValuesProvider;
     // This var keeps the Rules which were present during last run of this service
     private Set<Rule> lastRunIndexedRules;
     private static final Logger logger = LogManager.getLogger(RefreshBasedSyncMechanism.class);
@@ -86,7 +86,7 @@ public RefreshBasedSyncMechanism(
         FeatureType featureType,
         RulePersistenceService rulePersistenceService,
         RuleEventClassifier ruleEventClassifier,
-        NonPluginSettingValuesProvider nonPluginSettingValuesProvider
+        WlmClusterSettingValuesProvider nonPluginSettingValuesProvider
     ) {
         this.threadPool = threadPool;
         refreshInterval = RULE_SYNC_REFRESH_INTERVAL_SETTING.get(settings);

plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/NonPluginSettingValuesProviderTests.java renamed to plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/WlmClusterSettingValuesProviderTests.java

@@ -18,9 +18,9 @@
 
 import java.util.HashSet;
 
-public class NonPluginSettingValuesProviderTests extends OpenSearchTestCase {
+public class WlmClusterSettingValuesProviderTests extends OpenSearchTestCase {
 
-    private NonPluginSettingValuesProvider provider;
+    private WlmClusterSettingValuesProvider provider;
     private ClusterSettings clusterSettings;
 
     @Before
@@ -33,7 +33,7 @@ public void setUp() throws Exception {
                 .build();
             clusterSettings = new ClusterSettings(Settings.EMPTY, new HashSet<>(plugin.getSettings()));
             clusterSettings.registerSetting(WorkloadManagementSettings.WLM_MODE_SETTING);
-            provider = new NonPluginSettingValuesProvider(settings, clusterSettings);
+            provider = new WlmClusterSettingValuesProvider(settings, clusterSettings);
         }
     }
 

plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/WorkloadGroupTestUtils.java renamed to plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/WorkloadManagementTestUtils.java

@@ -40,7 +40,7 @@
 import static org.junit.Assert.assertTrue;
 import static org.mockito.Mockito.mock;
 
-public class WorkloadGroupTestUtils {
+public class WorkloadManagementTestUtils {
     public static final String NAME_ONE = "workload_group_one";
     public static final String NAME_TWO = "workload_group_two";
     public static final String _ID_ONE = "AgfUO5Ja9yfsYlONlYi3TQ==";
@@ -168,15 +168,15 @@ public static void assertEqualWorkloadGroups(
         }
     }
 
-    public static NonPluginSettingValuesProvider setUpNonPluginSettingValuesProvider(String wlmMode) throws Exception {
+    public static WlmClusterSettingValuesProvider setUpNonPluginSettingValuesProvider(String wlmMode) throws Exception {
         try (WorkloadManagementPlugin plugin = new WorkloadManagementPlugin()) {
             Settings settings = Settings.builder()
                 .put(RefreshBasedSyncMechanism.RULE_SYNC_REFRESH_INTERVAL_SETTING_NAME, 1000)
                 .put(WorkloadManagementSettings.WLM_MODE_SETTING_NAME, wlmMode)
                 .build();
             ClusterSettings clusterSettings = new ClusterSettings(Settings.EMPTY, new HashSet<>(plugin.getSettings()));
             clusterSettings.registerSetting(WorkloadManagementSettings.WLM_MODE_SETTING);
-            return new NonPluginSettingValuesProvider(settings, clusterSettings);
+            return new WlmClusterSettingValuesProvider(settings, clusterSettings);
         }
     }
 }

plugins/workload-management/src/test/java/org/opensearch/plugin/wlm/action/CreateWorkloadGroupRequestTests.java

@@ -17,8 +17,8 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import static org.opensearch.plugin.wlm.WorkloadGroupTestUtils.assertEqualWorkloadGroups;
-import static org.opensearch.plugin.wlm.WorkloadGroupTestUtils.workloadGroupOne;
+import static org.opensearch.plugin.wlm.WorkloadManagementTestUtils.assertEqualWorkloadGroups;
+import static org.opensearch.plugin.wlm.WorkloadManagementTestUtils.workloadGroupOne;
 
 public class CreateWorkloadGroupRequestTests extends OpenSearchTestCase {