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 java.util.List;
020    
021    /**
022     * A sub unit of work is a way of implement sub-transactions in Camel routing.
023     * This is needed by some EIPs where you can have sub routes such as the Splitter.
024     * The Camel end user may want to indicate that the Splitter should act as a
025     * <b>single combined</b> unit of work.
026     *
027     * @see SubUnitOfWorkCallback
028     */
029    public interface SubUnitOfWork {
030    
031        /**
032         * Is the {@link SubUnitOfWork} marked as failed.
033         *
034         * @return <tt>true</tt> to indicate this sub unit of work is failed.
035         */
036        boolean isFailed();
037    
038        /**
039         * If failed then a number of exceptions could have occurred, causing the {@link SubUnitOfWork} to fail.
040         *
041         * @return the caused exceptions.
042         */
043        List<Exception> getExceptions();
044    
045    }