com.mulesoft.mule.runtime.module.batch

Interface BatchStepAggregator

All Known Implementing Classes:

DefaultBatchStepAggregator

public interface BatchStepAggregator

Aggregates all the steps in a batch process

Since:

4.0

Method Summary

Modifier and Type	Method and Description
int	add(Record record, BatchTransactionContext ctx) Adds a new record
void	flush(BatchJobInstanceAdapter jobInstance) Flushes the buffered Records for the given BatchJobInstanceAdapter.
Integer	getSize()
boolean	isStreaming()
void	releaseResources(BatchJobInstanceAdapter jobInstance) Use this method when processing for the given BatchJobInstanceAdapter should stop and thus any allocated resources related to it should be freed.
void	setExceptionReporter(StepExceptionReporter exceptionReporter) Allows to customize how the exceptions are reported
long	size(BatchJobInstanceAdapter jobInstance)

Method Detail

flush

void flush(BatchJobInstanceAdapter jobInstance)

Flushes the buffered Records for the given BatchJobInstanceAdapter.

Use this method when you want to flush the info but you still expect more records from the same job instance to come. In this way, you flush the records but you avoid constantly recreating the internal tracking information.

Parameters:

jobInstance - job to be flushed.

releaseResources

void releaseResources(BatchJobInstanceAdapter jobInstance)

Use this method when processing for the given BatchJobInstanceAdapter should stop and thus any allocated resources related to it should be freed.

Parameters:

jobInstance - a BatchJobInstanceAdapter

add

int add(Record record,
        BatchTransactionContext ctx)

Adds a new record

Parameters:

record - record to add.

ctx - the tx context that is being used for this work run.

Returns:

how many records are maintained

size

long size(BatchJobInstanceAdapter jobInstance)

Parameters:

jobInstance - job for which the size is consulted

Returns:

how many records are maintained on the aggregator for the given job

isStreaming

boolean isStreaming()

Returns:

{code true} if streaming is being used, false otherwise

getSize

Integer getSize()

Returns:

number of records to be aggregated

setExceptionReporter

void setExceptionReporter(StepExceptionReporter exceptionReporter)

Allows to customize how the exceptions are reported

Parameters:

exceptionReporter - exception reporter to configure on the aggregator