View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.directory.mavibot.btree;
21  
22  /**
23   * An interface used to manage the transactions mechanism in B-trees. Transactions are cross
24   * B-trees.
25   *
26   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27   */
28  public interface TransactionManager
29  {
30      /**
31       * Starts a transaction
32       */
33      void beginTransaction();
34  
35  
36      /**
37       * Commits a transaction
38       */
39      void commit();
40  
41  
42      /**
43       * Rollback a transaction
44       */
45      void rollback();
46      
47      
48      /**
49       * Gets the current BtreeHeader for a given BTree.
50       * 
51       * @param btreeName The Btree name we are looking the BtreeHeader for
52       * @return the current BTreeHeader
53       */
54      BTreeHeader<?, ?> getBTreeHeader( String btreeName );
55      
56      
57      /**
58       * Updates the map of new BTreeHeaders
59       * 
60       * @param btreeHeader The new BtreeHeader
61       */
62      void updateNewBTreeHeaders( BTreeHeader<?, ?> btreeHeader );
63  }