Package org.apache.jackrabbit.oak.plugins.document.check

Class AsyncDocumentProcessor

java.lang.Object

org.apache.jackrabbit.oak.plugins.document.check.AsyncDocumentProcessor

All Implemented Interfaces:

DocumentProcessor

Direct Known Subclasses:

AsyncNodeStateProcessor, ConsistencyCheck, OrphanedNodeCheck

public abstract class AsyncDocumentProcessor
extends Object
implements DocumentProcessor

Base class for DocumentProcessor implementations that create tasks executed by an executor service.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AsyncDocumentProcessor(ExecutorService executorService)

Method Summary

Modifier and Type	Method	Description
protected abstract Optional<Callable<Void>>	createTask(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)
void	processDocument(@NotNull NodeDocument document, @NotNull BlockingQueue<Result> results)	Process the given document and publish the result to the results queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jackrabbit.oak.plugins.document.check.DocumentProcessor

end

Constructor Detail

AsyncDocumentProcessor

protected AsyncDocumentProcessor(ExecutorService executorService)

Method Detail

processDocument

public final void processDocument(@NotNull
                                  @NotNull NodeDocument document,
                                  @NotNull
                                  @NotNull BlockingQueue<Result> results)

Description copied from interface: DocumentProcessor

Process the given document and publish the result to the results queue. An implementation is not required to publish a result for each processed document.

Specified by:

processDocument in interface DocumentProcessor

Parameters:

document - the document to process.

results - the queue to publish results if necessary.

createTask

protected abstract Optional<Callable<Void>> createTask(@NotNull
                                                       @NotNull NodeDocument document,
                                                       @NotNull
                                                       @NotNull BlockingQueue<Result> results)