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

Class TransactionalQueueBuffer

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractStreamingAggregatorQueueBuffer, SteppingQueueBuffer

public abstract class TransactionalQueueBuffer
extends AbstractRecordBuffer
implements BatchContextTransactionManager

Implementation of RecordBuffer that writes to a Queue when flushed. Abstract method getDelegate(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) allows specifying the target queue using the BatchQueueDelegate abstraction.

When this buffer is flushed, it will attempt writing to a persistent queue using a BatchTransactionContext. If the queue is successfully written, then the transaction context will be committed. Otherwise it will be rolled back

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected BatchQueueManager	batchQueueManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransactionalQueueBuffer(String name, BatchEngine batchEngine)

Method Summary

Modifier and Type	Method and Description
int	add(BatchJobInstanceAdapter jobInstance, BatchTransactionContext ctx, Record record) buffers the given Record for the given BatchJobInstanceAdapter
void	commit(BatchTransactionContext context) commit
protected void	doFlush(BatchJobInstanceAdapter jobInstance, BatchTransactionContext ctx, List<Record> records)
protected void	doForget(BatchJobInstanceAdapter jobInstance)
void	flush(BatchJobInstanceAdapter jobInstance) Flushes the buffered Records for the given BatchJobInstanceAdapter.
void	flushAndForget(BatchJobInstanceAdapter jobInstance) Atomically performs a RecordBuffer.flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) followed by a RecordBuffer.forget(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter).
void	forget(BatchJobInstanceAdapter jobInstance) Releases all tracking information for the given BatchJobInstanceAdapter
protected abstract BatchQueueDelegate	getDelegate(BatchJobInstanceAdapter jobInstance) Returns the BatchQueueDelegate through which information will be written into the queue
void	rollback(BatchTransactionContext ctx, BatchJobInstanceAdapter jobInstance, List<Record> records, org.mule.runtime.api.exception.MuleException e) rollback
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

Field Detail

batchQueueManager

protected final BatchQueueManager batchQueueManager

Constructor Detail

TransactionalQueueBuffer

protected TransactionalQueueBuffer(String name,
                                   BatchEngine batchEngine)

Method Detail

add

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

buffers the given Record for the given BatchJobInstanceAdapter

Specified by:

add in interface RecordBuffer

Parameters:

jobInstance - a BatchJobInstanceAdapter

record - a Record

Returns:

how many records are still buffered for the given job instance

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.

Specified by:

flush in interface RecordBuffer

Parameters:

jobInstance - the BatchJobInstanceAdapter which records you want flushed

doFlush

protected void doFlush(BatchJobInstanceAdapter jobInstance,
                       BatchTransactionContext ctx,
                       List<Record> records)

forget

public void forget(BatchJobInstanceAdapter jobInstance)

Releases all tracking information for the given BatchJobInstanceAdapter

Specified by:

forget in interface RecordBuffer

Parameters:

jobInstance - a BatchJobInstanceAdapter which you no longer need to track

doForget

protected void doForget(BatchJobInstanceAdapter jobInstance)

flushAndForget

public void flushAndForget(BatchJobInstanceAdapter jobInstance)

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

Parameters:

jobInstance - a BatchJobInstanceAdapter which you no longer need to track

size

public long size(BatchJobInstanceAdapter jobInstance)

Returns how many records are buffered for the given BatchJobInstanceAdapter

Specified by:

size in interface RecordBuffer

Parameters:

jobInstance - a BatchJobInstanceAdapter

Returns:

a long value

getDelegate

protected abstract BatchQueueDelegate getDelegate(BatchJobInstanceAdapter jobInstance)

Returns the BatchQueueDelegate through which information will be written into the queue

Returns:

a BatchQueueDelegate

commit

public void commit(BatchTransactionContext context)

Description copied from interface: BatchContextTransactionManager

commit

Specified by:

commit in interface BatchContextTransactionManager

Parameters:

context - a batch transaction context

rollback

public void rollback(BatchTransactionContext ctx,
                     BatchJobInstanceAdapter jobInstance,
                     List<Record> records,
                     org.mule.runtime.api.exception.MuleException e)

Description copied from interface: BatchContextTransactionManager

rollback

Specified by:

rollback in interface BatchContextTransactionManager

Parameters:

ctx - a batch transaction context

jobInstance - a job Iinstance

records - a list o records

e - an exception