org.hibernate.search.engine.reporting

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 should never throw any exception: doing so will lead to undetermined behavior in Hibernate Search background threads.

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

Author:

Amin Mohammed-Coleman

Method Summary

Modifier and Type	Method and Description
void	handle(EntityIndexingFailureContext context) Handle the failure of entity indexing.
void	handle(FailureContext context) Handle a generic failure.
void	handle(IndexFailureContext context) Handle the failure of an index operation.

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.

This method should never throw any exception: doing so will lead to undetermined behavior in Hibernate Search background threads.

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.

This method should never throw any exception: doing so will lead to undetermined behavior in Hibernate Search background threads.

Parameters:

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

handle

void handle(IndexFailureContext context)

Handle the failure of an index operation.

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.

This method should never throw any exception: doing so will lead to undetermined behavior in Hibernate Search background threads.

Parameters:

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