Interface FailureHandler


  • public interface FailureHandler
    A handler for failures occurring during background operations, which may not have been reported to the caller due to being executed asynchronously.

    The handler should be used to report failures to application maintainers. The default failure handler simply logs failures at the ERROR level, but it can be replaced with a custom implementations through a configuration property.

    Handlers can be called from multiple threads simultaneously: implementations must be thread-safe.

    Author:
    Amin Mohammed-Coleman
    • Method Detail

      • handle

        void handle​(FailureContext context)
        Handle a generic failure.

        This method is expected to report the failure somewhere (logs, ...), then return as quickly as possible. Heavy error processing (sending emails, ...), if any, should be done asynchronously.

        Any error or exception thrown by this method will be caught by Hibernate Search and logged.

        Parameters:
        context - Contextual information about the failure (throwable, operation, ...)
      • handle

        void handle​(EntityIndexingFailureContext context)
        Handle the failure of entity indexing.

        This method is expected to report the failure somewhere (logs, ...), then return as quickly as possible. Heavy error processing (sending emails, ...), if any, should be done asynchronously.

        Any error or exception thrown by this method will be caught by Hibernate Search and logged.

        Parameters:
        context - Contextual information about the failure (throwable, operation, ...)