AbstractAggregator (Mule Core 4.0.0-BETA.4 API)

java.lang.Object
- org.mule.runtime.api.meta.AbstractAnnotatedObject
- - org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase
  - - org.mule.runtime.core.processor.AbstractInterceptingMessageProcessor
    - - org.mule.runtime.core.routing.AbstractAggregator

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.meta.AnnotatedObject, FlowConstructAware, MuleContextAware, InterceptingMessageProcessor, Processor, ReactiveProcessor, Aggregator

Direct Known Subclasses:

AbstractCorrelationAggregator, MessageChunkAggregator, Resequencer, SimpleCollectionAggregator
```
public abstract class AbstractAggregator
extends AbstractInterceptingMessageProcessor
implements org.mule.runtime.api.lifecycle.Initialisable, MuleContextAware, FlowConstructAware, Aggregator, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.lifecycle.Disposable
```
AbstractEventAggregator will aggregate a set of messages into a single message. EIP Reference: http://www.eaipatterns.com/Aggregator.html

Nested Class Summary
- Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor
  ReactiveProcessor.ProcessingType

Field Summary

Fields
Modifier and Type	Field and Description
`protected EventCorrelator`	`eventCorrelator`
`static String`	`EVENTS_STORE_REGISTRY_KEY_PREFIX`
`protected String`	`eventsObjectStoreKey`
`static int`	`MAX_PROCESSED_GROUPS`
`protected MuleContext`	`muleContext`
`protected boolean`	`persistentStores`
`protected String`	`storePrefix`

Fields inherited from class org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase
flowConstruct, logger, next

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject
LOCATION_KEY

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable
PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable
PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable
PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable
PHASE_NAME

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject
PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description

AbstractAggregator()

Constructors
Constructor and Description
`AbstractAggregator()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`org.reactivestreams.Publisher<Event>`	`apply(org.reactivestreams.Publisher<Event> publisher)` Applies a `Publisher` function transforming a stream of `Event`'s.
`void`	`dispose()`
`void`	`expireAggregation(String groupId)`
`protected abstract EventCorrelatorCallback`	`getCorrelatorCallback(MuleContext muleContext)`
`String`	`getStorePrefix()`
`long`	`getTimeout()`
`protected void`	`initEventGroupsObjectStore()`
`void`	`initialise()`
`protected void`	`initProcessedGroupsObjectStore()`
`boolean`	`isFailOnTimeout()`
`boolean`	`isPersistentStores()`
`Event`	`process(Event event)` Invokes the MessageProcessor.
`void`	`setEventGroupsObjectStore(PartitionableObjectStore<Event> eventGroupsObjectStore)`
`void`	`setFailOnTimeout(boolean failOnTimeout)`
`void`	`setMuleContext(MuleContext context)`
`void`	`setPersistentStores(boolean persistentStores)`
`void`	`setProcessedGroupsObjectStore(org.mule.runtime.api.store.ObjectStore<Long> processedGroupsObjectStore)`
`void`	`setStorePrefix(String storePrefix)`
`void`	`setTimeout(long timeout)`
`void`	`start()`
`void`	`stop()`

Methods inherited from class org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase
applyNext, getListener, getMuleContext, isEventValid, processNext, setFlowConstruct, setListener, toString

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject
getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.mule.runtime.core.api.construct.FlowConstructAware
setFlowConstruct

Methods inherited from interface org.mule.runtime.core.api.processor.InterceptingMessageProcessor
setListener

Methods inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor
getProcessingType

Methods inherited from interface java.util.function.Function
andThen, compose, identity

- Field Detail
  - MAX_PROCESSED_GROUPS
```
public static final int MAX_PROCESSED_GROUPS
```
    See Also:
    
    Constant Field Values
  - EVENTS_STORE_REGISTRY_KEY_PREFIX
```
public static final String EVENTS_STORE_REGISTRY_KEY_PREFIX
```
    See Also:
    
    Constant Field Values
  - eventCorrelator
```
protected EventCorrelator eventCorrelator
```
  - muleContext
```
protected MuleContext muleContext
```
  - persistentStores
```
protected boolean persistentStores
```
  - storePrefix
```
protected String storePrefix
```
  - eventsObjectStoreKey
```
protected String eventsObjectStoreKey
```
- Constructor Detail
  - AbstractAggregator
```
public AbstractAggregator()
```
- Method Detail
  - initialise
```
public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException
```
    Specified by:
    
    initialise in interface org.mule.runtime.api.lifecycle.Initialisable
    
    Throws:
    
    org.mule.runtime.api.lifecycle.InitialisationException
  - initProcessedGroupsObjectStore
```
protected void initProcessedGroupsObjectStore()
```
  - initEventGroupsObjectStore
```
protected void initEventGroupsObjectStore()
                                   throws org.mule.runtime.api.lifecycle.InitialisationException
```
    Throws:
    
    org.mule.runtime.api.lifecycle.InitialisationException
  - start
```
public void start()
           throws org.mule.runtime.api.exception.MuleException
```
    Specified by:
    
    start in interface org.mule.runtime.api.lifecycle.Startable
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - stop
```
public void stop()
          throws org.mule.runtime.api.exception.MuleException
```
    Specified by:
    
    stop in interface org.mule.runtime.api.lifecycle.Stoppable
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - setMuleContext
```
public void setMuleContext(MuleContext context)
```
    Specified by:
    
    setMuleContext in interface MuleContextAware
    
    Overrides:
    
    setMuleContext in class AbstractInterceptingMessageProcessorBase
    
    Parameters:
    
    context - the Mule node.
  - getCorrelatorCallback
```
protected abstract EventCorrelatorCallback getCorrelatorCallback(MuleContext muleContext)
```
  - process
```
public Event process(Event event)
              throws org.mule.runtime.api.exception.MuleException
```
    Description copied from interface: Processor
    
    Invokes the MessageProcessor.
    
    Specified by:
    
    process in interface Processor
    
    Parameters:
    
    event - MuleEvent to be processed
    
    Returns:
    
    optional response MuleEvent
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - apply
```
public org.reactivestreams.Publisher<Event> apply(org.reactivestreams.Publisher<Event> publisher)
```
    Description copied from interface: Processor
    Applies a Publisher function transforming a stream of Event's.
    The default implementation delegates to Processor.process(Event) and will:
    1. propagate any exception thrown
    2. drop events if invocation of Processor.process(Event) returns null.
    Specified by:
    
    apply in interface Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>
    
    Specified by:
    
    apply in interface Processor
    
    Parameters:
    
    publisher - the event stream to transform
    
    Returns:
    
    the transformed event stream
  - expireAggregation
```
public void expireAggregation(String groupId)
                       throws org.mule.runtime.api.exception.MuleException
```
    Specified by:
    
    expireAggregation in interface Aggregator
    
    Throws:
    
    org.mule.runtime.api.exception.MuleException
  - getTimeout
```
public long getTimeout()
```
  - setTimeout
```
public void setTimeout(long timeout)
```
    Specified by:
    
    setTimeout in interface Aggregator
  - isFailOnTimeout
```
public boolean isFailOnTimeout()
```
  - setFailOnTimeout
```
public void setFailOnTimeout(boolean failOnTimeout)
```
    Specified by:
    
    setFailOnTimeout in interface Aggregator
  - setProcessedGroupsObjectStore
```
public void setProcessedGroupsObjectStore(org.mule.runtime.api.store.ObjectStore<Long> processedGroupsObjectStore)
```
  - setEventGroupsObjectStore
```
public void setEventGroupsObjectStore(PartitionableObjectStore<Event> eventGroupsObjectStore)
```
  - isPersistentStores
```
public boolean isPersistentStores()
```
  - setPersistentStores
```
public void setPersistentStores(boolean persistentStores)
```
  - getStorePrefix
```
public String getStorePrefix()
```
  - setStorePrefix
```
public void setStorePrefix(String storePrefix)
```
  - dispose
```
public void dispose()
```
    Specified by:
    
    dispose in interface org.mule.runtime.api.lifecycle.Disposable

Class AbstractAggregator

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

Field Summary

Fields inherited from class org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

Constructor Summary

Method Summary

Methods inherited from class org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.mule.runtime.core.api.construct.FlowConstructAware

Methods inherited from interface org.mule.runtime.core.api.processor.InterceptingMessageProcessor

Methods inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

Methods inherited from interface java.util.function.Function

Field Detail

MAX_PROCESSED_GROUPS

EVENTS_STORE_REGISTRY_KEY_PREFIX

eventCorrelator

muleContext

persistentStores

storePrefix

eventsObjectStoreKey

Constructor Detail

AbstractAggregator

Method Detail

initialise

initProcessedGroupsObjectStore

initEventGroupsObjectStore

start

stop

setMuleContext

getCorrelatorCallback

process

apply

expireAggregation

getTimeout

setTimeout

isFailOnTimeout

setFailOnTimeout

setProcessedGroupsObjectStore

setEventGroupsObjectStore

isPersistentStores

setPersistentStores

getStorePrefix

setStorePrefix

dispose