001    /*
002     * ============================================================================
003     * GNU Lesser General Public License
004     * ============================================================================
005     *
006     * Beanlet - JSE Application Container.
007     * Copyright (C) 2006  Leon van Zantvoort
008     * 
009     * This library is free software; you can redistribute it and/or
010     * modify it under the terms of the GNU Lesser General Public
011     * License as published by the Free Software Foundation; either
012     * version 2.1 of the License, or (at your option) any later version.
013     * 
014     * This library is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
017     * Lesser General Public License for more details.
018     * 
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this library; if not, write to the Free Software
021     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
022     * 
023     * Leon van Zantvoort
024     * 243 Acalanes Drive #11
025     * Sunnyvale, CA 94086
026     * USA
027     *
028     * zantvoort@users.sourceforge.net
029     * http://beanlet.org
030     */
031    package org.beanlet.transaction;
032    
033    /**
034     * Allows a beanlet instance to synchronize its state with the transactions
035     * performed on it. Beanlets are not required to implement this interface.
036     *
037     * @see AfterBegin
038     * @see BeforeCompletion
039     * @see AfterCompletion
040     * @author Leon van Zantvoort
041     */
042    public interface TransactionSynchronization {
043    
044        /**
045         * The {@code afterBegin} method notifies a beanlet instance that a new 
046         * transaction has started, and that the subsequent business methods on the 
047         * instance will be invoked in the context of the transaction.
048         */
049        void afterBegin();
050        
051        /**
052         * The {@code beforeCompletion} method notifies a beanlet instance that a 
053         * transaction is about to be committed.
054         */
055        void beforeCompletion();
056        
057        /**
058         * The {@code afterCompletion} method notifies a beanlet instance that 
059         * the transaction commit protocol has completed, and tells the instance 
060         * whether the transaction has been committed or rolled back.
061         * Param {@code committed} is {@code true} if the transaction has been 
062         * committed, {@code false} if it has been rolled back.
063         */
064        void afterCompletion(boolean committed);
065    }