org.nuxeo.lib.stream.computation

Class AbstractBatchComputation

java.lang.Object

org.nuxeo.lib.stream.computation.AbstractComputation

org.nuxeo.lib.stream.computation.AbstractBatchComputation

All Implemented Interfaces:

Computation

Direct Known Subclasses:

StreamAuditWriter.AuditLogWriterComputation

public abstract class AbstractBatchComputation
extends AbstractComputation

An abstract Computation that processes records by batch.

The batch capacity and threshold are defined in the computation policy.

Since:

10.3

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Record>	batchRecords
protected String	currentInputStream
protected boolean	newBatch
protected boolean	removeLastRecordOnRetry
protected long	thresholdMillis
static String	TIMER_BATCH

Fields inherited from class org.nuxeo.lib.stream.computation.AbstractComputation

INPUT_1, INPUT_2, INPUT_3, metadata, OUTPUT_1, OUTPUT_2, OUTPUT_3, OUTPUT_4

Constructor Summary

Constructors

Constructor and Description
AbstractBatchComputation(String name, int nbInputStreams, int nbOutputStreams) Constructor

Method Summary

Modifier and Type	Method and Description
abstract void	batchFailure(ComputationContext context, String inputStreamName, List<Record> records) Called when the retry policy has failed.
protected abstract void	batchProcess(ComputationContext context, String inputStreamName, List<Record> records) Called when: - the batch capacity is reached - the time threshold is reached - the inputStreamName has changed If this method raises an exception the retry policy is applied.
protected void	checkpointBatch(ComputationContext context)
void	init(ComputationContext context) Called when the framework has registered the computation successfully.
void	processFailure(ComputationContext context, Throwable failure) Called when Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) fails and cannot be retried.
void	processRecord(ComputationContext context, String inputStreamName, Record record) Process an incoming record on one of the computation's input streams.
void	processRetry(ComputationContext context, Throwable failure) Called after a failure in Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) before retrying.
void	processTimer(ComputationContext context, String key, long timestamp) Process a timer callback previously set via ComputationContext.setTimer(String, long).

Methods inherited from class org.nuxeo.lib.stream.computation.AbstractComputation

metadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.lib.stream.computation.Computation

destroy, signalStop

Field Detail

TIMER_BATCH

public static final String TIMER_BATCH

See Also:

Constant Field Values

batchRecords

protected List<Record> batchRecords

currentInputStream

protected String currentInputStream

newBatch

protected boolean newBatch

thresholdMillis

protected long thresholdMillis

removeLastRecordOnRetry

protected boolean removeLastRecordOnRetry

Constructor Detail

AbstractBatchComputation

public AbstractBatchComputation(String name,
                                int nbInputStreams,
                                int nbOutputStreams)

Constructor

Parameters:

name - the name of the computation

nbInputStreams - the number of input streams

nbOutputStreams - the number of output streams

Method Detail

batchProcess

protected abstract void batchProcess(ComputationContext context,
                                     String inputStreamName,
                                     List<Record> records)

Called when:
- the batch capacity is reached
- the time threshold is reached
- the inputStreamName has changed
If this method raises an exception the retry policy is applied.

Parameters:

context - used to send records to output streams, note that the checkpoint is managed automatically.

inputStreamName - the input streams where the records are coming from

records - the batch of records

batchFailure

public abstract void batchFailure(ComputationContext context,
                                  String inputStreamName,
                                  List<Record> records)

Called when the retry policy has failed.

init

public void init(ComputationContext context)

Description copied from interface: Computation

Called when the framework has registered the computation successfully. Gives users a first opportunity to schedule timer callbacks and produce records.

Specified by:

init in interface Computation

Overrides:

init in class AbstractComputation

Parameters:

context - The computation context object provided by the system.

processTimer

public void processTimer(ComputationContext context,
                         String key,
                         long timestamp)

Description copied from interface: Computation

Process a timer callback previously set via ComputationContext.setTimer(String, long).

Specified by:

processTimer in interface Computation

Overrides:

processTimer in class AbstractComputation

Parameters:

context - The computation context object provided by the system.

key - The name of the timer.

timestamp - The timestamp (in ms) for which the callback was scheduled.

processRecord

public void processRecord(ComputationContext context,
                          String inputStreamName,
                          Record record)

Description copied from interface: Computation

Process an incoming record on one of the computation's input streams.

Parameters:

context - The computation context object provided by the system.

inputStreamName - Name of the input stream that provides the record.

record - The record.

checkpointBatch

protected void checkpointBatch(ComputationContext context)

processRetry

public void processRetry(ComputationContext context,
                         Throwable failure)

Description copied from interface: Computation

Called after a failure in Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) before retrying.

Specified by:

processRetry in interface Computation

Overrides:

processRetry in class AbstractComputation

processFailure

public void processFailure(ComputationContext context,
                           Throwable failure)

Description copied from interface: Computation

Called when Computation.processRecord(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, org.nuxeo.lib.stream.computation.Record) or Computation.processTimer(org.nuxeo.lib.stream.computation.ComputationContext, java.lang.String, long) fails and cannot be retried.

Specified by:

processFailure in interface Computation

Overrides:

processFailure in class AbstractComputation