Home » synapse-1.2-src » org.apache.synapse.mediators.eip.aggregator » [javadoc | source]
org.apache.synapse.mediators.eip.aggregator
public class: AggregateMediator [javadoc | source]
java.lang.Object
   org.apache.synapse.mediators.AbstractMediator
      org.apache.synapse.mediators.eip.aggregator.AggregateMediator

All Implemented Interfaces:
    Mediator

Aggregate a number of messages that are determined to be for a particular group, and combine them to form a single message which is then processed through the 'onComplete' sequence. Thus an aggregator acts like a filter, and may look at a correlation XPath expression to select messages for aggregation - or look at messageSequence number properties for aggregation or let any other (i.e. non aggregatable) messages flow through An instance of this mediator will register with a Timer to be notified after a specified timeout, so that aggregations that never would complete could be timed out and cleared from memory and any fault conditions handled
Fields inherited from org.apache.synapse.mediators.AbstractMediator:
log,  trace,  traceState
Constructor:
 public AggregateMediator() 
Method from org.apache.synapse.mediators.eip.aggregator.AggregateMediator Summary:
completeAggregate,   getActiveAggregates,   getAggregationExpression,   getCompletionTimeoutMillis,   getCorrelateExpression,   getMaxMessagesToComplete,   getMinMessagesToComplete,   getOnCompleteSequence,   getOnCompleteSequenceRef,   mediate,   setAggregationExpression,   setCompletionTimeoutMillis,   setCorrelateExpression,   setMaxMessagesToComplete,   setMinMessagesToComplete,   setOnCompleteSequence,   setOnCompleteSequenceRef
Methods from org.apache.synapse.mediators.AbstractMediator:
auditLog,   auditWarn,   getTraceState,   getType,   handleException,   handleException,   isTraceOn,   isTraceOrDebugOn,   setEffectiveTraceState,   setTraceState,   shouldTrace,   traceOrDebug,   traceOrDebugWarn
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.synapse.mediators.eip.aggregator.AggregateMediator Detail:
 public synchronized  void completeAggregate(Aggregate aggregate) 
    Invoked by the Aggregate objects that are timed out, to signal timeout/completion of itself
 public Map getActiveAggregates() 
 public SynapseXPath getAggregationExpression() 
 public long getCompletionTimeoutMillis() 
 public SynapseXPath getCorrelateExpression() 
 public int getMaxMessagesToComplete() 
 public int getMinMessagesToComplete() 
 public SequenceMediator getOnCompleteSequence() 
 public String getOnCompleteSequenceRef() 
 public boolean mediate(MessageContext synCtx) 
    Aggregate messages flowing through this mediator according to the correlation criteria and the aggregation algorithm specified to it
 public  void setAggregationExpression(SynapseXPath aggregationExpression) 
 public  void setCompletionTimeoutMillis(long completionTimeoutMillis) 
 public  void setCorrelateExpression(SynapseXPath correlateExpression) 
 public  void setMaxMessagesToComplete(int maxMessagesToComplete) 
 public  void setMinMessagesToComplete(int minMessagesToComplete) 
 public  void setOnCompleteSequence(SequenceMediator onCompleteSequence) 
 public  void setOnCompleteSequenceRef(String onCompleteSequenceRef)