Package org.verapdf.processor

Interface BatchProcessingHandler

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractBatchHandler, AbstractXmlHandler, JsonHandler

public interface BatchProcessingHandler
extends Closeable

Interface that should be implemented by developers wishing to write custom result handlers for the veraPDF BatchProcessor. The interface effectively defines a set of processing callbacks that are invoked by the batch processor at specific points during processing.

Version:

0.1 Created 8 Nov 2016:22:54:02

Author:

Carl Wilson carlwilson AT github

Method Summary

Modifier and Type	Method	Description
void	handleBatchEnd(BatchSummary summary)	This method is called by the BatchProcessor at the end of the batch process and allows custom action to be taken informed by the summary of the batch process.
void	handleBatchStart(ProcessorConfig config)	This method is called by the BatchProcessor at the start of processing.
void	handleResult(ProcessorResult result, Boolean isLogsEnabled)	This method is called by the BatchProcessor after each item in the batch is processed allowing the implementor to take specific action for each item processed.

Methods inherited from interface java.io.Closeable

close

Method Details

handleBatchStart

void handleBatchStart(ProcessorConfig config)
               throws VeraPDFException

This method is called by the BatchProcessor at the start of processing. The processor passes it ProcessorConfig allowing the handler to read the config details and take action.

Parameters:

config - the ProcessorConfig supplied by the caller of the batch process.

Throws:

VeraPDFException - if there's a problem setting up the batch process.

handleResult

void handleResult(ProcessorResult result,
 Boolean isLogsEnabled)
           throws VeraPDFException

This method is called by the BatchProcessor after each item in the batch is processed allowing the implementor to take specific action for each item processed.

Parameters:

result - the ProcessorResult for the last item processed.

Throws:

VeraPDFException - if there's a problem with the particular result.

handleBatchEnd

void handleBatchEnd(BatchSummary summary)
             throws VeraPDFException

This method is called by the BatchProcessor at the end of the batch process and allows custom action to be taken informed by the summary of the batch process.

Parameters:

summary - the BatchSummary for the batch process just completed.

Throws:

VeraPDFException - if there's a problem handling the BatchSummary