com.mulesoft.mule.runtime.module.batch.engine.queue

Interface BatchQueueDelegate

All Known Implementing Classes:

AbstractBatchQueueDelegate, AbstractStreamingAggregatorQueueDelegate, SteppingQueueDelegate, StreamingAggregatorInputQueueDelegate, StreamingAggregatorOutputQueueDelegate

public interface BatchQueueDelegate

Implementation of the delegate design pattern to separate batch related behavior over a Queue from the queue itself. This interface allows different clients to perform common operations without the need to know which queue is actually being manipulated

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
void	dispatch(BatchTransactionContext ctx, Collection<Record> records) Writes the given records into the queue
void	dispatchAndCommit(BatchTransactionContext ctx, BatchJobInstanceAdapter jobInstance, List<Record> records, BatchContextTransactionManager committer) Writes the given records into the queue and commits the transaction
void	dispose(BatchTransactionContext ctx) Disposes the underlying Queues for the given BatchJobInstanceAdapter
String	getQueueName() Returns the underlying Queue's name
Iterator<List<Record>>	iterator(BatchTransactionContext ctx) Returns a streaming Iterator to access the contents of the queue.
List<Record>	poll(BatchTransactionContext ctx) Retrieves a block of Record
long	size(BatchTransactionContext ctx) Returns the size of the underlying queue

Method Detail

dispatchAndCommit

void dispatchAndCommit(BatchTransactionContext ctx,
                       BatchJobInstanceAdapter jobInstance,
                       List<Record> records,
                       BatchContextTransactionManager committer)

Writes the given records into the queue and commits the transaction

Parameters:

ctx - a BatchTransactionContext which links to the transaction existing on the queue to be written on

jobInstance - a job instance

records - a list of Record

committer - performs logic associated with batch transaction

dispatch

void dispatch(BatchTransactionContext ctx,
              Collection<Record> records)
       throws org.mule.runtime.api.exception.MuleException

Writes the given records into the queue

Parameters:

ctx - a BatchTransactionContext which links to the transaction existing on the queue to be written on

records - a list of Record

Throws:

org.mule.runtime.api.exception.MuleException

poll

List<Record> poll(BatchTransactionContext ctx)
           throws org.mule.runtime.api.exception.MuleException

Retrieves a block of Record

Parameters:

ctx - a BatchTransactionContext which links to the transaction existing on the queue to be written on

Returns:

a list of Records

Throws:

org.mule.runtime.api.exception.MuleException

size

long size(BatchTransactionContext ctx)
   throws org.mule.runtime.api.exception.MuleException

Returns the size of the underlying queue

Parameters:

ctx - a BatchTransactionContext which links to the transaction existing on the queue to be written on

Returns:

a long value greater or equal than zero

Throws:

org.mule.runtime.api.exception.MuleException

iterator

Iterator<List<Record>> iterator(BatchTransactionContext ctx)
                         throws org.mule.runtime.api.exception.MuleException

Returns a streaming Iterator to access the contents of the queue. Notice that each invocation to Iterator.next() will actually remove the item from the underlying Queue

Parameters:

ctx - a BatchTransactionContext which links to the transaction existing on the queue to be written on

Returns:

a list of Record

Throws:

org.mule.runtime.api.exception.MuleException

dispose

void dispose(BatchTransactionContext ctx)

Disposes the underlying Queues for the given BatchJobInstanceAdapter

Parameters:

ctx - a non null BatchTransactionContext

getQueueName

String getQueueName()

Returns the underlying Queue's name

Returns:

a non empty String