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

Class DefaultBatchStepAggregator

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.DefaultBatchStepAggregator

All Implemented Interfaces:

BatchStepAggregator, 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 DefaultBatchStepAggregator
extends org.mule.runtime.core.api.processor.AbstractMessageProcessorOwner
implements BatchStepAggregator

A semi-transactional boundary in which records are aggregated and processed as a block instead of a Record by Record basis.

This component has two modes of operation:

• non streaming: records are aggregated in blocks of fixed size and processed as a whole. Partial error matching functionality is also available if the resulting payload is an instance of BulkOperationResult
• streaming: All records in the BatchJobInstance are exposed through an Iterator so that they can all be processed together. Although this Iterator has streaming capabilities and is able to handle millions of records without running out of memory, you should be careful not to use any stateful components that might generate an OutOfMemoryError. Streaming aggregators "have an all or nothing" error handling policy. If one record fails, all records will be failed. Also, no record will be exposed to the next step until all of them have been processed by this aggregator

Since:

3.5.0

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

locator, 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
DefaultBatchStepAggregator()

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.
protected List<org.mule.runtime.core.api.processor.Processor>	getOwnedMessageProcessors()
Integer	getSize()
void	initialise()
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	setBatchEngine(BatchEngine batchEngine)
void	setExceptionReporter(StepExceptionReporter exceptionReporter) Allows to customize how the exceptions are reported
void	setMessageProcessors(List<org.mule.runtime.core.api.processor.Processor> messageProcessors)
void	setNotificationDispatcher(org.mule.runtime.api.notification.NotificationDispatcher notificationDispatcher)
void	setPreserveMimeTypes(boolean preserveMimeTypes)
void	setSize(Integer size)
void	setStep(BatchStepAdapter step)
void	setStreaming(boolean streaming)
long	size(BatchJobInstanceAdapter jobInstance)

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

getOwnedObjects

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

dispose, getMuleContext, setMuleContext, start, stop

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

start

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

stop

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

dispose

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

DefaultBatchStepAggregator

public DefaultBatchStepAggregator()

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

flush

public void flush(BatchJobInstanceAdapter jobInstance)

Description copied from interface: BatchStepAggregator

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.

Specified by:

flush in interface BatchStepAggregator

Parameters:

jobInstance - job to be flushed.

releaseResources

public void releaseResources(BatchJobInstanceAdapter jobInstance)

Description copied from interface: BatchStepAggregator

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

Specified by:

releaseResources in interface BatchStepAggregator

Parameters:

jobInstance - a BatchJobInstanceAdapter

add

public int add(Record record,
               BatchTransactionContext ctx)

Description copied from interface: BatchStepAggregator

Adds a new record

Specified by:

add in interface BatchStepAggregator

Parameters:

record - record to add.

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

Returns:

how many records are maintained

size

public long size(BatchJobInstanceAdapter jobInstance)

Specified by:

size in interface BatchStepAggregator

Parameters:

jobInstance - job for which the size is consulted

Returns:

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

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)

setSize

public void setSize(Integer size)

isStreaming

public boolean isStreaming()

Specified by:

isStreaming in interface BatchStepAggregator

Returns:

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

setStreaming

public void setStreaming(boolean streaming)

setPreserveMimeTypes

public void setPreserveMimeTypes(boolean preserveMimeTypes)

getSize

public Integer getSize()

Specified by:

getSize in interface BatchStepAggregator

Returns:

number of records to be aggregated

setStep

public void setStep(BatchStepAdapter step)

setBatchEngine

public void setBatchEngine(BatchEngine batchEngine)

setExceptionReporter

public void setExceptionReporter(StepExceptionReporter exceptionReporter)

Description copied from interface: BatchStepAggregator

Allows to customize how the exceptions are reported

Specified by:

setExceptionReporter in interface BatchStepAggregator

Parameters:

exceptionReporter - exception reporter to configure on the aggregator

setNotificationDispatcher

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