001/** 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache License, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the License for the specific language governing permissions and 015 * limitations under the License. 016 */ 017package org.apache.camel.processor.aggregate; 018 019import org.apache.camel.Exchange; 020 021/** 022 * A specialized {@link org.apache.camel.processor.aggregate.AggregationStrategy} which can handle timeouts as well. 023 * 024 * @version 025 */ 026public interface TimeoutAwareAggregationStrategy extends AggregationStrategy { 027 028 // TODO: In Camel 3.0 we should move this to org.apache.camel package 029 030 /** 031 * A timeout occurred. 032 * <p/> 033 * <b>Important: </b> This method must <b>not</b> throw any exceptions. 034 * 035 * @param oldExchange the current aggregated exchange, or the original {@link Exchange} if no aggregation 036 * has been done before the timeout occurred 037 * @param index the index, may be <tt>-1</tt> if not possible to determine the index 038 * @param total the total, may be <tt>-1</tt> if not possible to determine the total 039 * @param timeout the timeout value in millis, may be <tt>-1</tt> if not possible to determine the timeout 040 */ 041 void timeout(Exchange oldExchange, int index, int total, long timeout); 042}