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;
018
019/**
020 * Callback for sending a exchange message to a endpoint using an {@link AsyncProcessor} capable producer.
021 * <p/>
022 * Using this callback as a template pattern ensures that Camel handles the resource handling and will
023 * start and stop the given producer, to avoid resource leaks.
024 *
025 * @version 
026 */
027public interface AsyncProducerCallback {
028
029    /**
030     * Performs operation on the given producer to send the given exchange.
031     *
032     * @param producer        the producer, is newer <tt>null</tt>
033     * @param asyncProducer   the async producer, is newer <tt>null</tt>
034     * @param exchange        the exchange, can be <tt>null</tt> if so then create a new exchange from the producer
035     * @param exchangePattern the exchange pattern, can be <tt>null</tt>
036     * @param callback        the async callback
037     * @return (doneSync) <tt>true</tt> to continue execute synchronously, <tt>false</tt> to continue being executed asynchronously
038     */
039    boolean doInAsyncProducer(Producer producer, AsyncProcessor asyncProducer, Exchange exchange,
040                              ExchangePattern exchangePattern, AsyncCallback callback);
041}