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

Class FixedAggregatorTransactionRecordBuffer

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

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

All Implemented Interfaces:

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

public class FixedAggregatorTransactionRecordBuffer
extends AggregatorRecordBuffer

Implementation of AggregatorRecordBuffer for non streaming DefaultBatchStepAggregator. This buffer works with in memory Record blocks of a fixed size

Since:

3.5.0

Field Summary

Fields inherited from class com.mulesoft.mule.runtime.module.batch.internal.engine.buffer.AggregatorRecordBuffer

batchEngine, exceptionReporter, muleContext, notificationDispatcher, step

Constructor Summary

Constructors

Constructor and Description
FixedAggregatorTransactionRecordBuffer(int blockSize, boolean preserveMimeTypes, 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 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 AggregatorRecordBuffer.chain
void	flushAndForget(BatchJobInstanceAdapter jobInstance) Atomically performs a InMemoryRecordBuffer.flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) followed by a InMemoryRecordBuffer.forget(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter).
void	forget(BatchJobInstanceAdapter jobInstance) For this implementation, to forget means to flush whatever records are currently buffered.
protected BatchProcessingTemplate	makeProcessingTemplate(com.google.common.collect.Multimap<BatchTransactionContext,Record> contexts, org.mule.runtime.core.api.processor.Processor processor, org.mule.runtime.core.api.MuleContext muleContext) Returns the BatchProcessingTemplate through which AggregatorRecordBuffer.chain will be executed
long	size(BatchJobInstanceAdapter jobInstance) Returns how many records are buffered for the given BatchJobInstanceAdapter

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

doFlush, getLocation, markError, setExceptionReporter

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

add, flush, getHolderLock

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

Constructor Detail

FixedAggregatorTransactionRecordBuffer

public FixedAggregatorTransactionRecordBuffer(int blockSize,
                                              boolean preserveMimeTypes,
                                              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

forget

public void forget(BatchJobInstanceAdapter jobInstance)

For this implementation, to forget means to flush whatever records are currently buffered. This needs to be so that the records are put back into the queue avoiding record loss and/or memory leaks

Specified by:

forget in interface RecordBuffer

Overrides:

forget in class InMemoryRecordBuffer

Parameters:

jobInstance - the BatchJobInstanceAdapter owning the records

configureChainEvent

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

Description copied from class: AggregatorRecordBuffer

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

Specified by:

configureChainEvent in class AggregatorRecordBuffer

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

makeProcessingTemplate

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

Description copied from class: AggregatorRecordBuffer

Returns the BatchProcessingTemplate through which AggregatorRecordBuffer.chain will be executed

Specified by:

makeProcessingTemplate in class AggregatorRecordBuffer

Parameters:

contexts - the aggregated Records

processor - the Processor to be executed

muleContext - the current MuleContext

Returns:

size

public long size(BatchJobInstanceAdapter jobInstance)

Description copied from class: InMemoryRecordBuffer

Returns how many records are buffered for the given BatchJobInstanceAdapter

Specified by:

size in interface RecordBuffer

Overrides:

size in class InMemoryRecordBuffer

Parameters:

jobInstance - a BatchJobInstanceAdapter

Returns:

a long value

flushAndForget

public void flushAndForget(BatchJobInstanceAdapter jobInstance)

Description copied from class: InMemoryRecordBuffer

Atomically performs a InMemoryRecordBuffer.flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) followed by a InMemoryRecordBuffer.forget(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter).

You MUST use this method when you know that the given jobInstance will no longer be executed in order to avoid a memory leak on its tracking information

This is NOT a thread-safe operation. You must be careful to not have several threads invoking this method at the same time for the same BatchJobInstanceAdapter

Specified by:

flushAndForget in interface RecordBuffer

Overrides:

flushAndForget in class InMemoryRecordBuffer

Parameters:

jobInstance - a BatchJobInstanceAdapter which you no longer need to track