Package org.hibernate.search.engine.backend.orchestration.spi

Class AbstractWorkOrchestrator<W>

java.lang.Object

org.hibernate.search.engine.backend.orchestration.spi.AbstractWorkOrchestrator<W>

Type Parameters:

W - The type of batched works.

Direct Known Subclasses:

ElasticsearchBatchingWorkOrchestrator, ElasticsearchSimpleWorkOrchestrator, LuceneParallelWorkOrchestratorImpl, LuceneSerialWorkOrchestratorImpl, LuceneSyncWorkOrchestratorImpl

public abstract class AbstractWorkOrchestrator<W>
extends Object

An abstract base for orchestrator implementations, implementing a thread-safe shutdown.

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<? super W>	blockingRetryProducer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWorkOrchestrator(String name)

Method Summary

Modifier and Type	Method	Description
protected abstract CompletableFuture<?>	completion()
protected abstract void	doStart(ConfigurationPropertySource propertySource)
protected abstract void	doStop()
protected abstract void	doSubmit(W work, OperationSubmitter operationSubmitter)
protected String	name()
CompletableFuture<?>	preStop()	Stop accepting works and return a future that completes when all works have been completely executed.
void	start(ConfigurationPropertySource propertySource)	Start any resource necessary to operate the orchestrator at runtime.
void	stop()	Forcibly shut down ongoing work and release any resource necessary to operate the orchestrator at runtime.
void	submit(W work, OperationSubmitter operationSubmitter)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

blockingRetryProducer

protected final Consumer<? super W> blockingRetryProducer

Constructor Detail

AbstractWorkOrchestrator

protected AbstractWorkOrchestrator(String name)

Method Detail

name

protected final String name()

start

public final void start(ConfigurationPropertySource propertySource)

Start any resource necessary to operate the orchestrator at runtime.

Called by the owner of this orchestrator once after bootstrap, before any other method is called.

Parameters:

propertySource - The property source to extract configuration from.

preStop

public final CompletableFuture<?> preStop()

Stop accepting works and return a future that completes when all works have been completely executed.

Optionally called by the owner of this orchestrator before stop(), if it needs to wait for work completion.

Returns:

A future that completes when all ongoing works have been completely executed.

stop

public final void stop()

Forcibly shut down ongoing work and release any resource necessary to operate the orchestrator at runtime.

Called by the owner of this orchestrator on shutdown.

doStart

protected abstract void doStart(ConfigurationPropertySource propertySource)

doSubmit

protected abstract void doSubmit(W work,
                                 OperationSubmitter operationSubmitter)
                          throws InterruptedException

Throws:

InterruptedException

completion

protected abstract CompletableFuture<?> completion()

doStop

protected abstract void doStop()

submit

public final void submit(W work,
                         OperationSubmitter operationSubmitter)