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

Class InMemoryRecordBuffer

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorRecordBuffer, LoadingQueueBuffer

public abstract class InMemoryRecordBuffer
extends AbstractRecordBuffer

Implementation of RecordBuffer which stores the records in memory until such time in which they're to be flushed.

This class already contains an implementation of the flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) method which can be manually invoked or can be automatically invoked when the buffer is full. However, implementations must override the doFlush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter, com.google.common.collect.Multimap) method to implement the actual flushing logic

Since:

3.5.0

Constructor Summary

Constructors

Constructor and Description
InMemoryRecordBuffer(String name, int size)

Method Summary

Modifier and Type	Method and Description
int	add(BatchJobInstanceAdapter jobInstance, BatchTransactionContext ctx, Record record) buffers the given Record for the given BatchJobInstanceAdapter
protected abstract void	doFlush(BatchJobInstanceAdapter jobInstance, com.google.common.collect.Multimap<BatchTransactionContext,Record> records) Implement this logic to perform specific flushing logic
void	flush(BatchJobInstanceAdapter jobInstance) Flushes the buffered Records for the given BatchJobInstanceAdapter.
void	flushAndForget(BatchJobInstanceAdapter jobInstance) Atomically performs a flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) followed by a forget(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter).
void	forget(BatchJobInstanceAdapter jobInstance) Releases all tracking information for the given BatchJobInstanceAdapter
protected Object	getHolderLock()
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.AbstractRecordBuffer

add, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryRecordBuffer

public InMemoryRecordBuffer(String name,
                            int size)

Method Detail

doFlush

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

Implement this logic to perform specific flushing logic

Parameters:

jobInstance - a BatchJobInstanceAdapter

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

flush

public void flush(BatchJobInstanceAdapter jobInstance)

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.

This is a thread-safe operation.

Parameters:

jobInstance - the BatchJobInstanceAdapter which records you want flushed

flushAndForget

public void flushAndForget(BatchJobInstanceAdapter jobInstance)

Atomically performs a flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) followed by a 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

Parameters:

jobInstance - a BatchJobInstanceAdapter which you no longer need to track

forget

public void forget(BatchJobInstanceAdapter jobInstance)

Releases all tracking information for the given BatchJobInstanceAdapter

Parameters:

jobInstance - a BatchJobInstanceAdapter which you no longer need to track

getHolderLock

protected Object getHolderLock()

Returns:

the holders object without exposing the implementation class

add

public int add(BatchJobInstanceAdapter jobInstance,
               BatchTransactionContext ctx,
               Record record)

buffers the given Record for the given BatchJobInstanceAdapter

Parameters:

jobInstance - a BatchJobInstanceAdapter

record - a BatchJobInstanceAdapter

Returns:

how many records are still buffered for the given job instance

size

public long size(BatchJobInstanceAdapter jobInstance)

Returns how many records are buffered for the given BatchJobInstanceAdapter

Parameters:

jobInstance - a BatchJobInstanceAdapter

Returns:

a long value