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

Interface BatchQueueManager

All Superinterfaces:

BatchProcessingListenersOwner

All Known Implementing Classes:

DefaultBatchQueueManager

public interface BatchQueueManager
extends BatchProcessingListenersOwner

This component is responsible for managing all the queue's related functionality of the batch engine without exposing any details about the underlying queueing mechanism. Although batch relies on several different queues used for different purposes, we still want those queues to respond to the same behavioral contract. For that reason, the BatchQueueDelegate abstraction is used to separate behavior from the actual queue being used. This manager acts as a facilitator to access the corresponding delegates

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
long	brokersSize()
void	disposeBroker(BatchJobInstanceAdapter jobInstance) Disposes just the broker for the queues.
void	disposeQueues(BatchTransactionContext ctx) Disposes all initialized queues associated to the given BatchJobInstanceAdapter
org.mule.runtime.core.api.util.queue.QueueSession	newQueueSession()
BatchQueueDelegate	steppingQueue(BatchJobInstanceAdapter jobInstance) Stepping queues are the ones used to move a Record from one BatchStep to the next.
BatchQueueDelegate	streamingAggregatorInputQueue(BatchJobInstanceAdapter jobInstance, BatchStepAdapter step) Returns a BatchQueueDelegate to access the input queue of a streaming BatchStepAggregator
BatchQueueDelegate	streamingAggregatorOutputQueue(BatchJobInstanceAdapter jobInstance, BatchStepAdapter step) Returns a BatchQueueDelegate to access the output queue of a streaming BatchStepAggregator

Methods inherited from interface com.mulesoft.mule.runtime.module.batch.BatchProcessingListenersOwner

addBatchProcessingListener, addBatchProcessingListener, removeBatchProcessingListener, removeBatchProcessingListener

Method Detail

steppingQueue

BatchQueueDelegate steppingQueue(BatchJobInstanceAdapter jobInstance)

Stepping queues are the ones used to move a Record from one BatchStep to the next.

Parameters:

jobInstance - the BatchJobInstanceAdapter which records we want to step

Returns:

a BatchQueueDelegate

streamingAggregatorInputQueue

BatchQueueDelegate streamingAggregatorInputQueue(BatchJobInstanceAdapter jobInstance,
                                                 BatchStepAdapter step)

Returns a BatchQueueDelegate to access the input queue of a streaming BatchStepAggregator

Parameters:

jobInstance - the BatchJobInstanceAdapter which records we want to stream

step - the BatchStepAdapter owning the aggregator block

Returns:

a BatchQueueDelegate

streamingAggregatorOutputQueue

BatchQueueDelegate streamingAggregatorOutputQueue(BatchJobInstanceAdapter jobInstance,
                                                  BatchStepAdapter step)

Returns a BatchQueueDelegate to access the output queue of a streaming BatchStepAggregator

Parameters:

jobInstance - the BatchJobInstanceAdapter which records we want to stream

step - the BatchStepAdapter owning the aggregator block

Returns:

a BatchQueueDelegate

newQueueSession

org.mule.runtime.core.api.util.queue.QueueSession newQueueSession()

disposeQueues

void disposeQueues(BatchTransactionContext ctx)

Disposes all initialized queues associated to the given BatchJobInstanceAdapter

Parameters:

ctx - a not null BatchTransactionContext

disposeBroker

void disposeBroker(BatchJobInstanceAdapter jobInstance)

Disposes just the broker for the queues. This will not dispose any queues.

This is just to be used when a dispose is needed before any queues were created.

Parameters:

jobInstance - the instance to dispose the broker for.

brokersSize

long brokersSize()

Returns:

the number of queue brokers that are currently active.