001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.directory.mavibot.btree;
021
022
023/**
024 * An interface used to manage the transactions mechanism in B-trees. Transactions are cross
025 * B-trees.
026 *
027 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028 */
029public interface TransactionManager<K, V>
030{
031    /**
032     * Starts a transaction
033     */
034    void beginTransaction();
035
036
037    /**
038     * Commits a transaction
039     */
040    void commit();
041
042
043    /**
044     * Rollback a transaction
045     */
046    void rollback();
047
048
049    /**
050     * Gets the current BtreeHeader for a given BTree.
051     * 
052     * @param btreeName The Btree name we are looking the BtreeHeader for
053     * @return the current BTreeHeader
054     */
055    BTreeHeader<K, V> getBTreeHeader( String btreeName );
056
057
058    /**
059     * Updates the map of new BTreeHeaders
060     * 
061     * @param btreeHeader The new BtreeHeader
062     */
063    void updateNewBTreeHeaders( BTreeHeader<K, V> btreeHeader );
064}