org.hibernate.search.engine.mapper.mapping.spi

Interface MappingImplementor<M>

Type Parameters:

M - The concrete type for this implementor.

public interface MappingImplementor<M>

Interface used by the engine to manipulate mappings

Publicly exposed mapping interfaces do not have to extend this interface; only the implementations have to implement it.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<?>	preStop(MappingPreStopContext context) Prepare for stop(), executing any operations that needs to be executed before shutdown.
CompletableFuture<?>	start(MappingStartContext context) Start any resource necessary to operate the mapping at runtime.
void	stop() Stop and release any resource necessary to operate the mapping at runtime.
M	toConcreteType()

Method Detail

toConcreteType

M toConcreteType()

start

CompletableFuture<?> start(MappingStartContext context)

Start any resource necessary to operate the mapping at runtime.

Called by the engine once during bootstrap, after backends and index managers were started.

Parameters:

context - The start context.

Returns:

A future that completes when the mapper is completely started.

preStop

CompletableFuture<?> preStop(MappingPreStopContext context)

Prepare for stop(), executing any operations that needs to be executed before shutdown.

Parameters:

context - The pre-stop context.

Returns:

A future that completes when pre-stop operations complete.

stop

void stop()

Stop and release any resource necessary to operate the mapping at runtime.

Called by the engine once before shutdown.