com.mulesoft.mule.runtime.module.batch.internal

Class DefaultBatchStep

java.lang.Object

org.mule.runtime.api.component.AbstractComponent

org.mule.runtime.core.api.processor.AbstractMuleObjectOwner<org.mule.runtime.core.api.processor.Processor>

org.mule.runtime.core.api.processor.AbstractMessageProcessorOwner

com.mulesoft.mule.runtime.module.batch.internal.DefaultBatchStep

All Implemented Interfaces:

BatchStep, BatchStepAdapter, org.mule.runtime.api.component.Component, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.core.api.context.MuleContextAware

public class DefaultBatchStep
extends org.mule.runtime.core.api.processor.AbstractMessageProcessorOwner
implements BatchStepAdapter

Default implementation of BatchStep

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.api.component.Component

org.mule.runtime.api.component.Component.Annotations

Field Summary

Fields inherited from class org.mule.runtime.core.api.processor.AbstractMuleObjectOwner

logger, muleContext

Fields inherited from class org.mule.runtime.api.component.AbstractComponent

ANNOTATION_NAME, LOCATION_KEY, ROOT_CONTAINER_NAME_KEY

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.component.Component

ANNOTATIONS_PROPERTY_NAME, NS_MULE_DOCUMENTATION, NS_MULE_PARSER_METADATA

Constructor Summary

Constructors

Constructor and Description
DefaultBatchStep()

Method Summary

Modifier and Type	Method and Description
void	dispose()
boolean	equals(Object obj)
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)
BatchEngine	getBatchEngine()
DefaultBatchStepAggregator	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
String	getName() The name of the step.
BatchStep	getNextStep() Returns the BatchStep that follows right after this one
protected List<org.mule.runtime.core.api.processor.Processor>	getOwnedMessageProcessors()
int	hashCode()
void	initialise()
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.
void	setAcceptExpression(String expression)
void	setAcceptPolicy(com.mulesoft.mule.runtime.module.batch.internal.record.AcceptRecordPolicy acceptPolicy)
void	setBatchEngine(BatchEngine batchEngine)
void	setBatchStepAggregator(DefaultBatchStepAggregator batchStepAggregator)
void	setExceptionReporter(StepExceptionReporter exceptionReporter)
void	setExpressionManager(org.mule.runtime.core.api.el.ExpressionManager expressionManager)
void	setJob(BatchJobAdapter job)
void	setLast(boolean last)
void	setMessageProcessors(List<org.mule.runtime.core.api.processor.Processor> messageProcessors)
void	setName(String name)
void	setNextStep(BatchStep nextStep)
void	setNotificationDispatcher(org.mule.runtime.api.notification.NotificationDispatcher notificationFirer)
void	start()
void	stop()

Methods inherited from class org.mule.runtime.core.api.processor.AbstractMessageProcessorOwner

getOwnedObjects

Methods inherited from class org.mule.runtime.core.api.processor.AbstractMuleObjectOwner

getMuleContext, setMuleContext

Methods inherited from class org.mule.runtime.api.component.AbstractComponent

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, initRootContainerName, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mulesoft.mule.runtime.module.batch.engine.BatchStepAdapter

getLocation

Methods inherited from interface org.mule.runtime.core.api.context.MuleContextAware

setMuleContext

Methods inherited from interface org.mule.runtime.api.component.Component

getAnnotation, getAnnotations, getDslSource, getIdentifier, getLocation, getRepresentation, getRootContainerLocation, setAnnotations

Constructor Detail

DefaultBatchStep

public DefaultBatchStep()

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Overrides:

initialise in class org.mule.runtime.core.api.processor.AbstractMuleObjectOwner<org.mule.runtime.core.api.processor.Processor>

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

releaseResources

public void releaseResources(BatchJobInstanceAdapter jobInstance)

Description copied from interface: BatchStepAdapter

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

Specified by:

releaseResources in interface BatchStepAdapter

Parameters:

jobInstance - a not null BatchJobInstanceAdapter

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Overrides:

start in class org.mule.runtime.core.api.processor.AbstractMuleObjectOwner<org.mule.runtime.core.api.processor.Processor>

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Overrides:

stop in class org.mule.runtime.core.api.processor.AbstractMuleObjectOwner<org.mule.runtime.core.api.processor.Processor>

Throws:

org.mule.runtime.api.exception.MuleException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

Overrides:

dispose in class org.mule.runtime.core.api.processor.AbstractMuleObjectOwner<org.mule.runtime.core.api.processor.Processor>

onRecord

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

Process the given Record for the given BatchJobInstanceAdapter

Specified by:

onRecord in interface BatchStepAdapter

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

public 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)

Specified by:

finishIfCompleted in interface BatchStepAdapter

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

getOwnedMessageProcessors

protected List<org.mule.runtime.core.api.processor.Processor> getOwnedMessageProcessors()

Specified by:

getOwnedMessageProcessors in class org.mule.runtime.core.api.processor.AbstractMessageProcessorOwner

setMessageProcessors

public void setMessageProcessors(List<org.mule.runtime.core.api.processor.Processor> messageProcessors)

setBatchStepAggregator

public void setBatchStepAggregator(DefaultBatchStepAggregator batchStepAggregator)

setAcceptPolicy

public void setAcceptPolicy(com.mulesoft.mule.runtime.module.batch.internal.record.AcceptRecordPolicy acceptPolicy)

setAcceptExpression

public void setAcceptExpression(String expression)

Parameters:

expression - a MEL a MEL expression that if evaluated to false filters the incoming record

getName

public String getName()

Description copied from interface: BatchStep

The name of the step. There cannot be two steps with the same id in the same BatchJob

Specified by:

getName in interface BatchStep

Returns:

a non empty String

setName

public void setName(String name)

setBatchEngine

@Inject
public void setBatchEngine(BatchEngine batchEngine)

setLast

public void setLast(boolean last)

isLast

public boolean isLast()

Description copied from interface: BatchStepAdapter

Whether this step is the last in its BatchJob or not

Specified by:

isLast in interface BatchStepAdapter

setNextStep

public void setNextStep(BatchStep nextStep)

getNextStep

public BatchStep getNextStep()

Description copied from interface: BatchStepAdapter

Returns the BatchStep that follows right after this one

Specified by:

getNextStep in interface BatchStepAdapter

Returns:

a BatchStep or null if this is the last one

getExceptionHistory

public ExceptionHistory getExceptionHistory(BatchJobInstanceAdapter jobInstance)

Description copied from interface: BatchStepAdapter

Returns the ExceptionHistory associated to the given BatchJobInstanceAdapter

Specified by:

getExceptionHistory in interface BatchStepAdapter

Returns:

a ExceptionHistory or null

getBatchStepAggregator

public DefaultBatchStepAggregator getBatchStepAggregator()

Description copied from interface: BatchStepAdapter

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

Specified by:

getBatchStepAggregator in interface BatchStepAdapter

Returns:

a BatchStepAggregator or null

getBatchEngine

public BatchEngine getBatchEngine()

setJob

public void setJob(BatchJobAdapter job)

setExceptionReporter

public void setExceptionReporter(StepExceptionReporter exceptionReporter)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setExpressionManager

public void setExpressionManager(org.mule.runtime.core.api.el.ExpressionManager expressionManager)

setNotificationDispatcher

public void setNotificationDispatcher(org.mule.runtime.api.notification.NotificationDispatcher notificationFirer)