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     */
017    package org.apache.camel.spi;
018    
019    import org.apache.camel.Component;
020    import org.apache.camel.Exchange;
021    import org.apache.camel.Processor;
022    
023    /**
024     * Provides a hook for custom {@link Processor} or {@link Component} instances to respond to
025     * completed or failed processing of an {@link Exchange} rather like Spring's
026     * <a href="http://static.springframework.org/spring/docs/2.0.x/api/org/springframework/transaction/support/TransactionSynchronization.html">TransactionSynchronization</a>
027     *
028     * @version $Revision: 36321 $
029     */
030    public interface Synchronization {
031    
032        /**
033         * Called when the processing of the message exchange is complete
034         *
035         * @param exchange the excahnge being processed
036         */
037        void onComplete(Exchange exchange);
038    
039        /**
040         * Called when the processing of the message exchange has failed for some reason.
041         * The exception which caused the problem is in {@link Exchange#getException()} and
042         * there could be a fault message via {@link Exchange#getFault()}
043         *
044         * @param exchange the excahnge being processed
045         */
046        void onFailure(Exchange exchange);
047    }