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

Class AggregatorRecordBuffer

java.lang.Object

com.mulesoft.mule.runtime.module.batch.internal.engine.buffer.AbstractRecordBuffer

com.mulesoft.mule.runtime.module.batch.internal.engine.buffer.InMemoryRecordBuffer

com.mulesoft.mule.runtime.module.batch.internal.engine.buffer.AggregatorRecordBuffer

All Implemented Interfaces:

RecordBuffer, org.mule.runtime.api.meta.NamedObject

Direct Known Subclasses:

FixedAggregatorRecordBuffer, FixedAggregatorTransactionRecordBuffer, StreamingAggregatorBuffer

public abstract class AggregatorRecordBuffer
extends InMemoryRecordBuffer

An implementation of RecordBuffer to be used by DefaultBatchStepAggregator instances.

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected BatchEngine	batchEngine
protected StepExceptionReporter	exceptionReporter
protected org.mule.runtime.core.api.MuleContext	muleContext
protected org.mule.runtime.api.notification.NotificationDispatcher	notificationDispatcher
protected BatchStepAdapter	step

Constructor Summary

Constructors

Constructor and Description
AggregatorRecordBuffer(String name, int size, BatchEngine batchEngine, BatchStepAdapter step, org.mule.runtime.core.api.processor.Processor chain, org.mule.runtime.api.component.location.ComponentLocation location, org.mule.runtime.api.notification.NotificationDispatcher notificationDispatcher, org.mule.runtime.core.api.MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
protected abstract org.mule.runtime.core.api.event.CoreEvent	configureChainEvent(org.mule.runtime.core.api.event.CoreEvent event, BatchJobInstanceAdapter jobInstance, com.google.common.collect.Multimap<BatchTransactionContext,Record> records) Configures the event (set payload, properties, etc) to is going to be used when flushing the aggregated records through the chain
protected void	doFlush(BatchJobInstanceAdapter jobInstance, com.google.common.collect.Multimap<BatchTransactionContext,Record> records) Executes the template returned by makeProcessingTemplate(com.google.common.collect.Multimap, Processor, MuleContext) using the CoreEvent returned by configureChainEvent(CoreEvent, BatchJobInstanceAdapter, Multimap)
protected org.mule.runtime.api.component.location.ComponentLocation	getLocation()
protected abstract BatchProcessingTemplate	makeProcessingTemplate(com.google.common.collect.Multimap<BatchTransactionContext,Record> records, org.mule.runtime.core.api.processor.Processor processor, org.mule.runtime.core.api.MuleContext muleContext) Returns the BatchProcessingTemplate through which chain will be executed
protected void	markError(BatchJobInstanceAdapter jobInstance, List<Record> records, Exception e) Sets the records as failed in this step
void	setExceptionReporter(StepExceptionReporter exceptionReporter)

Methods inherited from class com.mulesoft.mule.runtime.module.batch.internal.engine.buffer.InMemoryRecordBuffer

add, flush, flushAndForget, forget, getHolderLock, size

Methods inherited from class com.mulesoft.mule.runtime.module.batch.internal.engine.buffer.AbstractRecordBuffer

add, getName

Methods inherited from class java.lang.Object

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

Field Detail

muleContext

protected final org.mule.runtime.core.api.MuleContext muleContext

batchEngine

protected final BatchEngine batchEngine

step

protected final BatchStepAdapter step

exceptionReporter

protected StepExceptionReporter exceptionReporter

notificationDispatcher

protected final org.mule.runtime.api.notification.NotificationDispatcher notificationDispatcher

Constructor Detail

AggregatorRecordBuffer

public AggregatorRecordBuffer(String name,
                              int size,
                              BatchEngine batchEngine,
                              BatchStepAdapter step,
                              org.mule.runtime.core.api.processor.Processor chain,
                              org.mule.runtime.api.component.location.ComponentLocation location,
                              org.mule.runtime.api.notification.NotificationDispatcher notificationDispatcher,
                              org.mule.runtime.core.api.MuleContext muleContext)

Method Detail

doFlush

protected void doFlush(BatchJobInstanceAdapter jobInstance,
                       com.google.common.collect.Multimap<BatchTransactionContext,Record> records)

Executes the template returned by makeProcessingTemplate(com.google.common.collect.Multimap, Processor, MuleContext) using the CoreEvent returned by configureChainEvent(CoreEvent, BatchJobInstanceAdapter, Multimap)

Specified by:

doFlush in class InMemoryRecordBuffer

Parameters:

jobInstance - a BatchJobInstanceAdapter

records - a Multimap relating a BatchTransactionContext to its corresponding buffered Records

configureChainEvent

protected abstract org.mule.runtime.core.api.event.CoreEvent configureChainEvent(org.mule.runtime.core.api.event.CoreEvent event,
                                                                                 BatchJobInstanceAdapter jobInstance,
                                                                                 com.google.common.collect.Multimap<BatchTransactionContext,Record> records)
                                                                          throws org.mule.runtime.api.exception.MuleException

Configures the event (set payload, properties, etc) to is going to be used when flushing the aggregated records through the chain

Parameters:

event - a CoreEvent

jobInstance - the BatchJobInstanceAdapter being executed

records - the aggregated Records

Returns:

a configured CoreEvent or null, which means that the chain should be skipped for this event

Throws:

org.mule.runtime.api.exception.MuleException - if anything goes wrong

makeProcessingTemplate

protected abstract BatchProcessingTemplate makeProcessingTemplate(com.google.common.collect.Multimap<BatchTransactionContext,Record> records,
                                                                  org.mule.runtime.core.api.processor.Processor processor,
                                                                  org.mule.runtime.core.api.MuleContext muleContext)

Returns the BatchProcessingTemplate through which chain will be executed

Parameters:

records - the aggregated Records

processor - the Processor to be executed

muleContext - the current MuleContext

Returns:

markError

protected void markError(BatchJobInstanceAdapter jobInstance,
                         List<Record> records,
                         Exception e)

Sets the records as failed in this step

Parameters:

jobInstance - a BatchJobInstanceAdapter

records - a List of Records

e - a Exception

setExceptionReporter

public void setExceptionReporter(StepExceptionReporter exceptionReporter)

getLocation

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