Interface EnginePlugin


  • public interface EnginePlugin
    A plugin that provides alternative engine implementations.
    • Method Summary

      Modifier and Type Method Description
      java.util.Optional<EngineFactory> getEngineFactory​(IndexSettings indexSettings)
      When an index is created this method is invoked for each engine plugin.
    • Method Detail

      • getEngineFactory

        java.util.Optional<EngineFactory> getEngineFactory​(IndexSettings indexSettings)
        When an index is created this method is invoked for each engine plugin. Engine plugins can inspect the index settings to determine whether or not to provide an engine factory for the given index. A plugin that is not overriding the default engine should return Optional.empty(). If multiple plugins return an engine factory for a given index the index will not be created and an IllegalStateException will be thrown during index creation.
        Returns:
        an optional engine factory