org.mule.extension.aggregator.internal.operations

Class SizeBasedAggregatorOperations

java.lang.Object

org.mule.extension.aggregator.internal.operations.AbstractAggregatorOperations

org.mule.extension.aggregator.internal.operations.SingleGroupAggregatorOperations

org.mule.extension.aggregator.internal.operations.SizeBasedAggregatorOperations

public class SizeBasedAggregatorOperations
extends SingleGroupAggregatorOperations

Operations defined for a Size Based Aggregator.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
SizeBasedAggregatorOperations()

Method Summary

Modifier and Type	Method and Description
void	aggregateBySize(SizeBasedAggregatorParameterGroup aggregatorParameters, IncrementalAggregationRoute incrementalAggregationRoute, AggregationCompleteRoute onAggregationCompleteRoute, org.mule.runtime.extension.api.runtime.process.RouterCompletionCallback completionCallback) Aggregates a new event and executes the routes and listeners if it corresponds.

Methods inherited from class java.lang.Object

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

Constructor Detail

SizeBasedAggregatorOperations

public SizeBasedAggregatorOperations()

Method Detail

aggregateBySize

@Alias(value="sizeBasedAggregator")
 @Throws(value=AggregatorErrorProvider.class)
public void aggregateBySize(@ParameterGroup(name="Aggregator config")
                                                                                                              SizeBasedAggregatorParameterGroup aggregatorParameters,
                                                                                                              @ChainInputResolver(value=AggregationChainInputResolver.class) @ExecutionOccurrence(value=ONCE_OR_NONE) @Alias(value="incrementalAggregation") @Optional
                                                                                                              IncrementalAggregationRoute incrementalAggregationRoute,
                                                                                                              @ChainInputResolver(value=AggregationChainInputResolver.class) @ExecutionOccurrence(value=ONCE_OR_NONE) @Alias(value="aggregationComplete")
                                                                                                              AggregationCompleteRoute onAggregationCompleteRoute,
                                                                                                              org.mule.runtime.extension.api.runtime.process.RouterCompletionCallback completionCallback)

Aggregates a new event and executes the routes and listeners if it corresponds.

If the event reaches the maxSize specified in aggregatorParameters, 2 things will happen:

• The elements in the storage will be removed and the next event will belong to the new aggregation
• onAggregationCompleteRoute will be executed with the aggregated elements

Additionally, if there is a listener registered to this aggregator, it's callback will be executed with the same set of elements

If the route incrementalAggregationRoute is not null, and the maxSize was not reached, then it's chain will be executed with all aggregated events, including the last one.

The aggregator can also have a timeout defined. In that case, an scheduled task with that timeout as delay will be registered for execution. The time will be computed from the time in which the first element arrives and no extra tasks will be scheduled if there is another one waiting to be executed.

In the case of a timeout, the hooked listener will be executed only if it supports being called by timeout.

Parameters:

aggregatorParameters - the parameters that define the aggregator behaviour

incrementalAggregationRoute - the route executed for every new event, if present

onAggregationCompleteRoute - the route executed when the group is complete

completionCallback - router callback