org.apache.camel.processor.aggregate.TimeoutAwareAggregationStrategy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.processor.aggregate;
import org.apache.camel.Exchange;
/**
* A specialized {@link org.apache.camel.processor.aggregate.AggregationStrategy} which can handle timeouts as well.
*
* @version
*/
public interface TimeoutAwareAggregationStrategy extends AggregationStrategy {
// TODO: In Camel 3.0 we should move this to org.apache.camel package
/**
* A timeout occurred.
*
* Important: This method must not throw any exceptions.
*
* @param oldExchange the current aggregated exchange, or the original {@link Exchange} if no aggregation
* has been done before the timeout occurred
* @param index the index, may be -1 if not possible to determine the index
* @param total the total, may be -1 if not possible to determine the total
* @param timeout the timeout value in millis, may be -1 if not possible to determine the timeout
*/
void timeout(Exchange oldExchange, int index, int total, long timeout);
}