org.mule.routing.AggregationStrategy Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mule-core Show documentation

Mule server and core classes

There is a newer version: 3.9.0

/*
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.routing;

import org.mule.VoidMuleEvent;
import org.mule.api.MuleEvent;
import org.mule.api.MuleException;
import org.mule.api.routing.AggregationContext;

/**
 * Strategy pattern for aggregating a list of {@link MuleEvent} passed through a
 * {@link AggregationContext} into a single one
 * 
 * @since 3.5.0
 */
public interface AggregationStrategy
{

    /**
     * aggregates the events in the given context into a single one
     * 
     * @param context an instance of {@link AggregationContext}
     * @return a resulting {@link MuleEvent}. It can be a new event, an enriched
     *         version of {@link AggregationContext#getOriginalEvent()} or whatever
     *         makes sense in your use case. It cannot be null, return
     *         {@link VoidMuleEvent} instead
     * @throws MuleException if unexpected exception occurs or business error
     *             condition is met
     */
    public MuleEvent aggregate(AggregationContext context) throws MuleException;

}