org.mule.routing.inbound

Class AbstractEventResequencer

java.lang.Object

org.mule.routing.AbstractRouter

org.mule.routing.inbound.SelectiveConsumer

org.mule.routing.inbound.AbstractEventResequencer

All Implemented Interfaces:

MuleContextAware, Disposable, Initialisable, InboundRouter, Router

Direct Known Subclasses:

CorrelationEventResequencer

public abstract class AbstractEventResequencer
extends SelectiveConsumer

AbstractEventResequencer is used to receive a set of events, resequence them and forward them on to their destination

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NO_CORRELATION_ID

Fields inherited from class org.mule.routing.inbound.SelectiveConsumer

logger

Fields inherited from class org.mule.routing.AbstractRouter

muleContext

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

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractEventResequencer()

Method Summary

Methods

Modifier and Type	Method and Description
protected EventGroup	addEventGroup(EventGroup group)
protected EventGroup	createEventGroup(MuleEvent event, Object groupId)
Comparator	getComparator()
protected EventGroup	getEventGroup(Object groupId)
protected Object	getEventGroupIdForEvent(MuleEvent event)
MuleEvent[]	process(MuleEvent event) A received MuleEvent is passed to this method for processing.
protected void	removeEventGroup(EventGroup group)
protected MuleEvent[]	resequenceEvents(EventGroup events) Reorder collected events according to the configured Comparator.
void	setComparator(Comparator eventComparator)
protected abstract boolean	shouldResequenceEvents(EventGroup events) Determines whether the events in the passed EventGroup are ready to be reordered.

Methods inherited from class org.mule.routing.inbound.SelectiveConsumer

getFilter, getMessageInfoMapping, isMatch, isTransformFirst, setFilter, setMessageInfoMapping, setTransformFirst

Methods inherited from class org.mule.routing.AbstractRouter

dispose, getMuleContext, getRouterStatistics, initialise, setMuleContext, setRouterStatistics

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.routing.Router

getRouterStatistics, setRouterStatistics

Methods inherited from interface org.mule.api.lifecycle.Initialisable

initialise

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Field Detail

NO_CORRELATION_ID

protected static final String NO_CORRELATION_ID

See Also:

Constant Field Values

Constructor Detail

AbstractEventResequencer

public AbstractEventResequencer()

Method Detail

getComparator

public Comparator getComparator()

setComparator

public void setComparator(Comparator eventComparator)

process

public MuleEvent[] process(MuleEvent event)
                    throws MessagingException

Description copied from interface: InboundRouter

A received MuleEvent is passed to this method for processing. The router can control processing by either 1. passing back a null to indicate that the router has either discarded the event of the event has been stored for further processing. A reaosn for storing the event might be that other events in it's correlation group are expected to be received. 2. Pass back an array of one or more events to be processed by the service. Often 1 event is returned, i.e. in the case of event aggregation. The router may return an array of events if a set of events have been resequenced or multiple events have been generated from a single event.

Specified by:

process in interface InboundRouter

Overrides:

process in class SelectiveConsumer

Parameters:

event - the event received by the inbound endpoint before it is passed to the service

Returns:

null to indicate the event has been stored/destroyed or an array of events to be processed by the service

Throws:

MessagingException - if an error occurs during processing of the event

createEventGroup

protected EventGroup createEventGroup(MuleEvent event,
                          Object groupId)

See Also:

AbstractEventAggregator#createEventGroup(MuleEvent, Object)

getEventGroupIdForEvent

protected Object getEventGroupIdForEvent(MuleEvent event)

See Also:

AbstractEventAggregator#getEventGroupIdForEvent(MuleEvent)

getEventGroup

protected EventGroup getEventGroup(Object groupId)

See Also:

AbstractEventAggregator#getEventGroup(Object)

addEventGroup

protected EventGroup addEventGroup(EventGroup group)

See Also:

AbstractEventAggregator#addEventGroup(EventGroup)

removeEventGroup

protected void removeEventGroup(EventGroup group)

See Also:

AbstractEventAggregator#removeEventGroup(EventGroup)

resequenceEvents

protected MuleEvent[] resequenceEvents(EventGroup events)

Reorder collected events according to the configured Comparator.

Parameters:

events - the EventGroup used for collecting the events

Returns:

an array of events reordered according to the Comparator returned by getComparator(). If no comparator is configured, the events are returned unsorted.

shouldResequenceEvents

protected abstract boolean shouldResequenceEvents(EventGroup events)

Determines whether the events in the passed EventGroup are ready to be reordered.

See Also:

AbstractEventAggregator#shouldAggregateEvents(EventGroup)