org.hibernate.search.engine.backend.spi

Interface BackendImplementor

public interface BackendImplementor

Method Summary

Modifier and Type	Method and Description
IndexManagerBuilder	createIndexManagerBuilder(String indexName, String mappedTypeName, boolean multiTenancyEnabled, BackendBuildContext context, ConfigurationPropertySource propertySource)
CompletableFuture<?>	preStop() Prepare for stop().
void	start(BackendStartContext context) Start any resource necessary to operate the backend at runtime.
void	stop() Stop and release any resource necessary to operate the backend at runtime.
Backend	toAPI()

Method Detail

start

void start(BackendStartContext context)

Start any resource necessary to operate the backend at runtime.

Called by the engine once after bootstrap, before IndexManagerImplementor.start(IndexManagerStartContext) is called on the index managers.

Parameters:

context - The start context.

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

Backend toAPI()

Returns:

The object that should be exposed as API to users.

createIndexManagerBuilder

IndexManagerBuilder createIndexManagerBuilder(String indexName,
                                              String mappedTypeName,
                                              boolean multiTenancyEnabled,
                                              BackendBuildContext context,
                                              ConfigurationPropertySource propertySource)

Parameters:

indexName - The name of the index from the point of view of Hibernate Search. A slightly different name may be used by the backend internally, but indexName is the one that will appear everywhere the index is mentioned to the user.

mappedTypeName - The name of the type mapped to this index. This is the type name that will be assigned to search query hits for this index, allowing the mapper to resolve the type of each hit in multi-index searches. Each index is mapped to one and only one type.

multiTenancyEnabled - true if multi-tenancy is enabled for this index, false otherwise.

context - The build context

propertySource - A configuration property source, appropriately masked so that the backend doesn't need to care about Hibernate Search prefixes (hibernate.search.*, etc.). All the properties can be accessed at the root. CAUTION: the property keys listed in IndexSettings are reserved for use by the engine.

Returns:

A builder for index managers targeting this backend.