Interface IndexManagerImplementor
-
public interface IndexManagerImplementor
The object responsible for applying works and searches to a full-text index.This is the interface implemented by backends and provided to the engine.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addTo(IndexScopeBuilder builder)
IndexIndexer
createIndexer(BackendSessionContext sessionContext)
<R> IndexIndexingPlan<R>
createIndexingPlan(BackendSessionContext sessionContext, EntityReferenceFactory<R> entityReferenceFactory, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy)
IndexScopeBuilder
createScopeBuilder(BackendMappingContext mappingContext)
IndexWorkspace
createWorkspace(DetachedBackendSessionContext sessionContext)
CompletableFuture<?>
preStop()
Prepare forstop()
.IndexSchemaManager
schemaManager()
void
start(IndexManagerStartContext context)
Start any resource necessary to operate the index manager at runtime.void
stop()
Stop and release any resource necessary to operate the backend at runtime.IndexManager
toAPI()
-
-
-
Method Detail
-
start
void start(IndexManagerStartContext context)
Start any resource necessary to operate the index manager at runtime.Called by the engine once after bootstrap, after
BackendImplementor.start(BackendStartContext)
was called on the corresponding backend.- Parameters:
context
- The start context.
-
preStop
CompletableFuture<?> preStop()
Prepare forstop()
.- Returns:
- A future that completes when ongoing works complete.
-
stop
void stop()
Stop and release any resource necessary to operate the backend at runtime.Called by the engine once before shutdown.
-
toAPI
IndexManager toAPI()
- Returns:
- The object that should be exposed as API to users.
-
schemaManager
IndexSchemaManager schemaManager()
-
createIndexingPlan
<R> IndexIndexingPlan<R> createIndexingPlan(BackendSessionContext sessionContext, EntityReferenceFactory<R> entityReferenceFactory, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy)
-
createIndexer
IndexIndexer createIndexer(BackendSessionContext sessionContext)
-
createWorkspace
IndexWorkspace createWorkspace(DetachedBackendSessionContext sessionContext)
-
createScopeBuilder
IndexScopeBuilder createScopeBuilder(BackendMappingContext mappingContext)
-
addTo
void addTo(IndexScopeBuilder builder)
-
-