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 /**
24 * An interface used to manage the transactions mechanism in B-trees. Transactions are cross
25 * B-trees.
26 *
27 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
28 */
29 public interface TransactionManager<K, V>
30 {
31 /**
32 * Starts a transaction
33 */
34 void beginTransaction();
35
36
37 /**
38 * Commits a transaction
39 */
40 void commit();
41
42
43 /**
44 * Rollback a transaction
45 */
46 void rollback();
47
48
49 /**
50 * Gets the current BtreeHeader for a given BTree.
51 *
52 * @param btreeName The Btree name we are looking the BtreeHeader for
53 * @return the current BTreeHeader
54 */
55 BTreeHeader<K, V> getBTreeHeader( String btreeName );
56
57
58 /**
59 * Updates the map of new BTreeHeaders
60 *
61 * @param btreeHeader The new BtreeHeader
62 */
63 void updateNewBTreeHeaders( BTreeHeader<K, V> btreeHeader );
64 }