Add default for EnginePlugin.getEngineFactory (#2419)

Adds default implementation for getEngineFactory in EnginePlugin. The default just returns Optional.empty(), allowing plugin developers to implement this plugin without implementing this method. Signed-off-by: John Mazanec <[email protected]>
opensearch-project · Mar 16, 2022 · f52f6f5 · f52f6f5
1 parent 02ffd4c
commit f52f6f5
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/server/src/main/java/org/opensearch/plugins/EnginePlugin.java b/server/src/main/java/org/opensearch/plugins/EnginePlugin.java
@@ -56,7 +56,9 @@ public interface EnginePlugin {
      *
      * @return an optional engine factory
      */
-    Optional<EngineFactory> getEngineFactory(IndexSettings indexSettings);
+    default Optional<EngineFactory> getEngineFactory(IndexSettings indexSettings) {
+        return Optional.empty();
+    }
 
     /**
      * EXPERT:

diff --git a/server/src/test/java/org/opensearch/index/engine/EngineConfigFactoryTests.java b/server/src/test/java/org/opensearch/index/engine/EngineConfigFactoryTests.java
@@ -146,6 +146,21 @@ public void testCreateCodecServiceFromFactory() {
         assertNotNull(config.getCodec());
     }
 
+    public void testGetEngineFactory() {
+        final EngineFactory engineFactory = config -> null;
+        EnginePlugin enginePluginThatImplementsGetEngineFactory = new EnginePlugin() {
+            @Override
+            public Optional<EngineFactory> getEngineFactory(IndexSettings indexSettings) {
+                return Optional.of(engineFactory);
+            }
+        };
+        assertEquals(engineFactory, enginePluginThatImplementsGetEngineFactory.getEngineFactory(null).orElse(null));
+
+        EnginePlugin enginePluginThatDoesNotImplementsGetEngineFactory = new EnginePlugin() {
+        };
+        assertFalse(enginePluginThatDoesNotImplementsGetEngineFactory.getEngineFactory(null).isPresent());
+    }
+
     private static class FooEnginePlugin extends Plugin implements EnginePlugin {
         @Override
         public Optional<EngineFactory> getEngineFactory(final IndexSettings indexSettings) {