com.mulesoft.mule.runtime.module.batch.engine

Interface BatchStepAdapter

All Superinterfaces:

BatchStep

All Known Implementing Classes:

DefaultBatchStep

public interface BatchStepAdapter
extends BatchStep

Adapter interface to access BatchStep related functionality that we don't want exposed as part of the API

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
boolean	finishIfCompleted(BatchJobInstanceAdapter jobInstance, BatchTransactionContext ctx) If the step has processed all the records for the given BatchJobInstanceAdapter, then it fires a BatchNotification.STEP_JOB_END notification and flushes the step's commit (if any)
BatchStepAggregator	getBatchStepAggregator() If this step has an aggregator block, then this method returns the underlying BatchStepAggregator
ExceptionHistory	getExceptionHistory(BatchJobInstanceAdapter jobInstance) Returns the ExceptionHistory associated to the given BatchJobInstanceAdapter
org.mule.runtime.api.component.location.ComponentLocation	getLocation()
BatchStep	getNextStep() Returns the BatchStep that follows right after this one
boolean	isLast() Whether this step is the last in its BatchJob or not
Record	onRecord(Record record, BatchTransactionContext ctx) Process the given Record for the given BatchJobInstanceAdapter
void	releaseResources(BatchJobInstanceAdapter jobInstance) Releases any resources that the step has allocated for the given jobInstance, such as ExceptionHistory, AggregatorRecordBuffer, etc.

Methods inherited from interface com.mulesoft.mule.runtime.module.batch.api.BatchStep

getName

Method Detail

onRecord

Record onRecord(Record record,
                BatchTransactionContext ctx)
         throws org.mule.runtime.api.exception.MuleException

Process the given Record for the given BatchJobInstanceAdapter

Parameters:

record - a Record

ctx - the BatchTransactionContext in wich the record is to be executed

Returns:

an updated version of the Record

Throws:

org.mule.runtime.api.exception.MuleException

finishIfCompleted

boolean finishIfCompleted(BatchJobInstanceAdapter jobInstance,
                          BatchTransactionContext ctx)

If the step has processed all the records for the given BatchJobInstanceAdapter, then it fires a BatchNotification.STEP_JOB_END notification and flushes the step's commit (if any)

Parameters:

jobInstance - a BatchJobInstanceAdapter

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

Returns:

true if all records were processed. false otherwise

releaseResources

void releaseResources(BatchJobInstanceAdapter jobInstance)

Releases any resources that the step has allocated for the given jobInstance, such as ExceptionHistory, AggregatorRecordBuffer, etc.

Parameters:

jobInstance - a not null BatchJobInstanceAdapter

getExceptionHistory

ExceptionHistory getExceptionHistory(BatchJobInstanceAdapter jobInstance)

Returns the ExceptionHistory associated to the given BatchJobInstanceAdapter

Returns:

a ExceptionHistory or null

getBatchStepAggregator

BatchStepAggregator getBatchStepAggregator()

If this step has an aggregator block, then this method returns the underlying BatchStepAggregator

Returns:

a BatchStepAggregator or null

isLast

boolean isLast()

Whether this step is the last in its BatchJob or not

getNextStep

BatchStep getNextStep()

Returns the BatchStep that follows right after this one

Returns:

a BatchStep or null if this is the last one

getLocation

org.mule.runtime.api.component.location.ComponentLocation getLocation()

Returns:

the location properties of this component in the mule app configuration, or null if this object was generated programmatically and not from a configuration element.