org.hibernate.search.mapper.pojo.massindexing.MassIndexingFailureHandler Maven / Gradle / Ivy
Show all versions of hibernate-search-mapper-pojo-base Show documentation
/*
* SPDX-License-Identifier: Apache-2.0
* Copyright Red Hat Inc. and Hibernate Authors
*/
package org.hibernate.search.mapper.pojo.massindexing;
import org.hibernate.search.util.common.annotation.Incubating;
/**
* A handler for failures occurring during mass indexing.
*
* The handler should be used to report failures to application maintainers.
* The default failure handler simply delegates to the configured {@link org.hibernate.search.engine.reporting.FailureHandler},
* which by default logs failures at the {@code ERROR} level,
* but it can be replaced with a custom implementations
* by configuring the mass indexer.
*
* Handlers can be called from multiple threads simultaneously: implementations must be thread-safe.
*/
public interface MassIndexingFailureHandler {
/**
* 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.
*
* @param context Contextual information about the failure (throwable, operation, ...)
*/
void handle(MassIndexingFailureContext context);
/**
* Handle a failure when indexing an entity.
*
* 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.
*
* @param context Contextual information about the failure (throwable, operation, ...)
*/
default void handle(MassIndexingEntityFailureContext context) {
handle( (MassIndexingFailureContext) context );
}
/**
* Returns the number of failures during one mass indexing beyond which
* the failure handler will no longer be notified.
* This threshold is reached separately for each indexed type.
*
* May be overridden by mass indexer parameters
* (see {@code failureFloodingThreshold(long)} in the {@code MassIndexer} interface).
*/
@Incubating
default long failureFloodingThreshold() {
return Long.MAX_VALUE;
}
}