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

Class AbstractBatchQueueDelegate

java.lang.Object

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

All Implemented Interfaces:

BatchQueueDelegate

Direct Known Subclasses:

AbstractStreamingAggregatorQueueDelegate, SteppingQueueDelegate

public abstract class AbstractBatchQueueDelegate
extends Object
implements BatchQueueDelegate

Base class for implementation of BatchQueueDelegate

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected BatchJobInstanceAdapter	jobInstance

Constructor Summary

Constructors

Constructor and Description
AbstractBatchQueueDelegate(BatchJobInstanceAdapter jobInstance, org.mule.runtime.core.api.util.queue.QueueManager queueManager, long queueTimeout, org.mule.runtime.api.serialization.ObjectSerializer serializer, org.mule.runtime.core.api.MuleContext muleContext)

Method Summary

Modifier and Type	Method and Description
protected abstract String	buildQueueName() Implementors uses this method to construct the name of the underlying queue
void	dispatch(BatchTransactionContext ctx, Collection<Record> records) Writes the given records into the queue
void	dispatchAndCommit(BatchTransactionContext ctx, BatchJobInstanceAdapter jobInstance, List<Record> records, BatchContextTransactionManager manager) 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

Methods inherited from class java.lang.Object

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

Field Detail

jobInstance

protected final BatchJobInstanceAdapter jobInstance

Constructor Detail

AbstractBatchQueueDelegate

public AbstractBatchQueueDelegate(BatchJobInstanceAdapter jobInstance,
                                  org.mule.runtime.core.api.util.queue.QueueManager queueManager,
                                  long queueTimeout,
                                  org.mule.runtime.api.serialization.ObjectSerializer serializer,
                                  org.mule.runtime.core.api.MuleContext muleContext)

Method Detail

dispatch

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

Writes the given records into the queue

Specified by:

dispatch in interface BatchQueueDelegate

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

dispatchAndCommit

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

Description copied from interface: BatchQueueDelegate

Writes the given records into the queue and commits the transaction

Specified by:

dispatchAndCommit in interface BatchQueueDelegate

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

manager - performs logic associated with batch transaction

poll

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

Retrieves a block of Record

Specified by:

poll in interface BatchQueueDelegate

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

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

Returns the size of the underlying queue

Specified by:

size in interface BatchQueueDelegate

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

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

Description copied from interface: BatchQueueDelegate

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

Specified by:

iterator in interface BatchQueueDelegate

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

public void dispose(BatchTransactionContext ctx)

Disposes the underlying Queues for the given BatchJobInstanceAdapter

Specified by:

dispose in interface BatchQueueDelegate

Parameters:

ctx - a non null BatchTransactionContext

getQueueName

public final String getQueueName()

Returns the underlying Queue's name

Specified by:

getQueueName in interface BatchQueueDelegate

Returns:

a non empty String

buildQueueName

protected abstract String buildQueueName()

Implementors uses this method to construct the name of the underlying queue

Returns:

a non-empty String