move security attribute to security plugin.

Signed-off-by: Ruirui Zhang <[email protected]>

Author: ruai0511

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/RuleAttribute.java

@@ -10,8 +10,6 @@
 
 import org.opensearch.rule.autotagging.Attribute;
 
-import java.util.TreeMap;
-
 /**
  * Generic Rule attributes that features can use out of the use by using the lib.
  * @opensearch.experimental
@@ -34,11 +32,6 @@ public String getName() {
         return name;
     }
 
-    @Override
-    public TreeMap<Integer, String> getPrioritizedSubfields() {
-        return new TreeMap<>();
-    }
-
     /**
      * Retrieves the RuleAttribute from a name string
      * @param name - attribute name

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/SecurityAttribute.java

@@ -38,7 +38,9 @@ public interface Attribute extends Writeable {
     /**
      * Returns a map of subfields ordered by priority, where 1 represents the highest priority.
      */
-    TreeMap<Integer, String> getPrioritizedSubfields();
+    default TreeMap<Integer, String> getPrioritizedSubfields() {
+        return new TreeMap<>();
+    }
 
     /**
      * Ensure that `validateAttribute` is called in the constructor of attribute implementations

modules/autotagging-commons/common/src/main/java/org/opensearch/rule/autotagging/Attribute.java

@@ -20,7 +20,6 @@
 import java.time.Instant;
 import java.util.Map;
 import java.util.Set;
-import java.util.TreeMap;
 
 import static org.opensearch.rule.autotagging.RuleTests.TestAttribute.TEST_ATTRIBUTE_1;
 import static org.opensearch.rule.autotagging.RuleTests.TestAttribute.TEST_ATTRIBUTE_2;
@@ -71,11 +70,6 @@ public enum TestAttribute implements Attribute {
         public String getName() {
             return name;
         }
-
-        @Override
-        public TreeMap<Integer, String> getPrioritizedSubfields() {
-            return new TreeMap<>();
-        }
     }
 
     public static class TestFeatureType implements FeatureType {

modules/autotagging-commons/common/src/test/java/org/opensearch/rule/SecurityAttributeTests.java

@@ -17,7 +17,6 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
-import java.util.TreeMap;
 
 import static org.junit.Assert.assertEquals;
 
@@ -128,10 +127,5 @@ public enum MockRuleAttributes implements Attribute {
         public String getName() {
             return name;
         }
-
-        @Override
-        public TreeMap<Integer, String> getPrioritizedSubfields() {
-            return new TreeMap<>();
-        }
     }
 }

modules/autotagging-commons/common/src/test/java/org/opensearch/rule/autotagging/RuleTests.java

@@ -0,0 +1,22 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.rule.spi;
+
+import org.opensearch.rule.autotagging.Attribute;
+
+/**
+ * Represents a custom attribute extension for the rule framework.
+ * Implementations provide a single attribute to be used in auto tagging.
+ */
+public interface AttributesExtension {
+    /**
+     * Returns the attribute provided by this extension.
+     */
+    Attribute getAttribute();
+}

modules/autotagging-commons/common/src/test/java/org/opensearch/rule/utils/RuleTestUtils.java

@@ -10,8 +10,10 @@
 
 import org.opensearch.rule.RulePersistenceService;
 import org.opensearch.rule.RuleRoutingService;
+import org.opensearch.rule.autotagging.Attribute;
 import org.opensearch.rule.autotagging.FeatureType;
 
+import java.util.List;
 import java.util.function.Supplier;
 
 /**
@@ -36,4 +38,10 @@ public interface RuleFrameworkExtension {
      * @return the specific implementation of FeatureType
      */
     Supplier<FeatureType> getFeatureTypeSupplier();
+
+    /**
+     * Flow attributes from RuleFrameworkExtension to implementation plugins
+     * @param attributes
+     */
+    void setAttributes(List<Attribute> attributes);
 }

modules/autotagging-commons/spi/src/main/java/org/opensearch/rule/spi/AttributesExtension.java

@@ -30,12 +30,14 @@
 import org.opensearch.rule.action.TransportGetRuleAction;
 import org.opensearch.rule.action.TransportUpdateRuleAction;
 import org.opensearch.rule.action.UpdateRuleAction;
+import org.opensearch.rule.autotagging.Attribute;
 import org.opensearch.rule.autotagging.AutoTaggingRegistry;
 import org.opensearch.rule.autotagging.FeatureType;
 import org.opensearch.rule.rest.RestCreateRuleAction;
 import org.opensearch.rule.rest.RestDeleteRuleAction;
 import org.opensearch.rule.rest.RestGetRuleAction;
 import org.opensearch.rule.rest.RestUpdateRuleAction;
+import org.opensearch.rule.spi.AttributesExtension;
 import org.opensearch.rule.spi.RuleFrameworkExtension;
 import org.opensearch.threadpool.ExecutorBuilder;
 import org.opensearch.threadpool.FixedExecutorBuilder;
@@ -115,6 +117,11 @@ public Collection<Module> createGuiceModules() {
     @Override
     public void loadExtensions(ExtensionLoader loader) {
         ruleFrameworkExtensions.addAll(loader.loadExtensions(RuleFrameworkExtension.class));
+        Collection<AttributesExtension> attributesExtensions = loader.loadExtensions(AttributesExtension.class);
+        List<Attribute> attributes = attributesExtensions.stream().map(AttributesExtension::getAttribute).toList();
+        for (RuleFrameworkExtension ruleFrameworkExtension : ruleFrameworkExtensions) {
+            ruleFrameworkExtension.setAttributes(attributes);
+        }
     }
 
     private void consumeFrameworkExtension(RuleFrameworkExtension ruleFrameworkExtension) {

modules/autotagging-commons/spi/src/main/java/org/opensearch/rule/spi/RuleFrameworkExtension.java

@@ -21,7 +21,6 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
-import java.util.TreeMap;
 
 public class InMemoryRuleProcessingServiceTests extends OpenSearchTestCase {
     InMemoryRuleProcessingService sut;
@@ -170,11 +169,6 @@ public String getName() {
             return name;
         }
 
-        @Override
-        public TreeMap<Integer, String> getPrioritizedSubfields() {
-            return new TreeMap<>();
-        }
-
         @Override
         public void validateAttribute() {}
     }