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