Package org.hibernate.search.mapper.pojo.work.spi

Class ConfiguredIndexingPlanSynchronizationStrategy.Builder

java.lang.Object

org.hibernate.search.mapper.pojo.work.spi.ConfiguredIndexingPlanSynchronizationStrategy.Builder

All Implemented Interfaces:

IndexingPlanSynchronizationStrategyConfigurationContext

Enclosing class:

ConfiguredIndexingPlanSynchronizationStrategy

public static final class ConfiguredIndexingPlanSynchronizationStrategy.Builder
extends Object
implements IndexingPlanSynchronizationStrategyConfigurationContext

Constructor Summary

Constructors

Constructor	Description
Builder(org.hibernate.search.engine.reporting.FailureHandler failureHandler)

Method Summary

Modifier and Type	Method	Description
ConfiguredIndexingPlanSynchronizationStrategy	build()
void	documentCommitStrategy(org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy strategy)
void	documentRefreshStrategy(org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy strategy)
org.hibernate.search.engine.reporting.FailureHandler	failureHandler()
void	indexingFutureHandler(Consumer<? super CompletableFuture<? extends SearchIndexingPlanExecutionReport>> handler)	Set the handler for the (asynchronous) indexing future.
void	operationSubmitter(org.hibernate.search.engine.backend.work.execution.OperationSubmitter operationSubmitter)	Set operation submitter to be applied while executing underlying plans.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(org.hibernate.search.engine.reporting.FailureHandler failureHandler)

Method Details

documentCommitStrategy

public void documentCommitStrategy(org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy strategy)

Specified by:

documentCommitStrategy in interface IndexingPlanSynchronizationStrategyConfigurationContext

Parameters:

strategy - A strategy describing how commits should be handled after document changes are applied. Defaults to DocumentCommitStrategy.NONE.

documentRefreshStrategy

public void documentRefreshStrategy(org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy strategy)

Specified by:

documentRefreshStrategy in interface IndexingPlanSynchronizationStrategyConfigurationContext

Parameters:

strategy - A strategy describing how refresh should be handled after document changes are applied. Defaults to DocumentRefreshStrategy.NONE.

indexingFutureHandler

public void indexingFutureHandler(Consumer<? super CompletableFuture<? extends SearchIndexingPlanExecutionReport>> handler)

Description copied from interface: IndexingPlanSynchronizationStrategyConfigurationContext

Set the handler for the (asynchronous) indexing future.

This typically involves waiting on the given future, to prevent the thread from resuming execution until indexing is complete.

Specified by:

indexingFutureHandler in interface IndexingPlanSynchronizationStrategyConfigurationContext

Parameters:

handler - A handler that will be passed a future representing the progress of indexing. Defaults to a no-op handler. The future will be completed with an execution report once all document changes are applied. If any document change or the commit/refresh required byIndexingPlanSynchronizationStrategyConfigurationContext.documentCommitStrategy(DocumentCommitStrategy) and IndexingPlanSynchronizationStrategyConfigurationContext.documentRefreshStrategy(DocumentRefreshStrategy) failed, the report will contain a throwable and (if applicable) a list of failing entities.

failureHandler

public org.hibernate.search.engine.reporting.FailureHandler failureHandler()

Specified by:

failureHandler in interface IndexingPlanSynchronizationStrategyConfigurationContext

Returns:

The failure handler. Use this to report failures that cannot be propagated by the IndexingPlanSynchronizationStrategyConfigurationContext.indexingFutureHandler(Consumer).

operationSubmitter

public void operationSubmitter(org.hibernate.search.engine.backend.work.execution.OperationSubmitter operationSubmitter)

Description copied from interface: IndexingPlanSynchronizationStrategyConfigurationContext

Set operation submitter to be applied while executing underlying plans.

Using OperationSubmitter.BLOCKING by default.

Specified by:

operationSubmitter in interface IndexingPlanSynchronizationStrategyConfigurationContext

Parameters:

operationSubmitter - How to handle request to submit operation when the queue is full

See Also:

• OperationSubmitter

build

public ConfiguredIndexingPlanSynchronizationStrategy build()