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

Interface PojoMassIndexerAgent

public interface PojoMassIndexerAgent

  • Method Details

    • noOp

      static PojoMassIndexerAgent noOp()

    • start

      CompletableFuture<?> start(PojoMassIndexerAgentStartContext context)
      Starts requesting from other agents that could possibly perform indexing (e.g. indexing plans) that they suspend themselves.

      Other agents can be considered suspended when the returned future completes successfully; they will remain suspended until this agent is pre-stoppped or stopped.

      Returns:
      A future that completes successfully when other agents have been successfully suspended. If no agents can be suspended (e.g. no coordination), returns a successfully completed future immediately.

    • preStop

      CompletableFuture<?> preStop()
      Performs preliminary operations necessary to safely stop this agent.

      This should be called before stop(), unless other errors are forcing us to make an emergency stop.

      Returns:
      A future that completes successfully when the agent has stopped.

    • stop

      void stop()
      Stops this agent.