org.hibernate.search.engine.backend.index.spi

Interface IndexManagerImplementor<D extends DocumentElement>

public interface IndexManagerImplementor<D extends DocumentElement>

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

Modifier and Type	Method and Description
void	addTo(IndexScopeBuilder builder)
IndexIndexer<D>	createIndexer(BackendSessionContext sessionContext, DocumentCommitStrategy commitStrategy)
IndexIndexingPlan<D>	createIndexingPlan(BackendSessionContext sessionContext, DocumentCommitStrategy commitStrategy, DocumentRefreshStrategy refreshStrategy)
IndexScopeBuilder	createScopeBuilder(BackendMappingContext mappingContext)
IndexWorkspace	createWorkspace(DetachedBackendSessionContext sessionContext)
CompletableFuture<?>	preStop() Prepare for stop().
CompletableFuture<?>	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

CompletableFuture<?> 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.

Returns:

A future that completes when the index manager is completely started.

preStop

CompletableFuture<?> preStop()

Prepare for stop().

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.

createIndexingPlan

IndexIndexingPlan<D> createIndexingPlan(BackendSessionContext sessionContext,
                                        DocumentCommitStrategy commitStrategy,
                                        DocumentRefreshStrategy refreshStrategy)

createIndexer

IndexIndexer<D> createIndexer(BackendSessionContext sessionContext,
                              DocumentCommitStrategy commitStrategy)

createWorkspace

IndexWorkspace createWorkspace(DetachedBackendSessionContext sessionContext)

createScopeBuilder

IndexScopeBuilder createScopeBuilder(BackendMappingContext mappingContext)

addTo

void addTo(IndexScopeBuilder builder)