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

Interface IndexingPlanSynchronizationStrategyConfigurationContext

All Known Implementing Classes:
ConfiguredIndexingPlanSynchronizationStrategy.Builder
@Incubating public interface IndexingPlanSynchronizationStrategyConfigurationContext

  • Method Details

    • documentCommitStrategy

      void documentCommitStrategy(org.hibernate.search.engine.backend.work.execution.DocumentCommitStrategy strategy)
      Parameters:
      strategy - A strategy describing how commits should be handled after document changes are applied. Defaults to DocumentCommitStrategy.NONE.

    • documentRefreshStrategy

      void documentRefreshStrategy(org.hibernate.search.engine.backend.work.execution.DocumentRefreshStrategy strategy)
      Parameters:
      strategy - A strategy describing how refresh should be handled after document changes are applied. Defaults to DocumentRefreshStrategy.NONE.

    • indexingFutureHandler

      void indexingFutureHandler(Consumer<? super CompletableFuture<? extends SearchIndexingPlanExecutionReport>> handler)
      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.

      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 bydocumentCommitStrategy(DocumentCommitStrategy) and documentRefreshStrategy(DocumentRefreshStrategy) failed, the report will contain a throwable and (if applicable) a list of failing entities.

    • failureHandler

      org.hibernate.search.engine.reporting.FailureHandler failureHandler()
      Returns:
      The failure handler. Use this to report failures that cannot be propagated by the indexingFutureHandler(Consumer).

    • operationSubmitter

      @Incubating void operationSubmitter(org.hibernate.search.engine.backend.work.execution.OperationSubmitter operationSubmitter)
      Set operation submitter to be applied while executing underlying plans.

      Using OperationSubmitter.BLOCKING by default.

      Parameters:
      operationSubmitter - How to handle request to submit operation when the queue is full
      See Also:
      • OperationSubmitter