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.server.core.api.partition;
21
22 import java.io.Closeable;
23 import java.io.IOException;
24
25 /**
26 * The Transaction interface that partitions have to implement.
27 *
28 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
29 */
30 public interface PartitionTxn extends Closeable
31 {
32 /**
33 * Commit a write transaction. It will apply the changes on
34 * the database.Last, not least, a new version will be created.
35 * If called by a Read transaction, it will simply close it.
36 *
37 * @throws IOException If the commit failed
38 */
39 void commit() throws IOException;
40
41
42 /**
43 * Abort a transaction. If it's a {@link PartitionReadTxn}, it will unlink this transaction
44 * from the version it used. If it's a {@link PartitionWriteTxn}; it will drop all the pending
45 * changes. The latest version will remain the same.
46 *
47 * @throws IOException If the abort failed
48 */
49 void abort() throws IOException;
50
51
52 /**
53 * Tells if the transaction has been committed/aborted or not.
54 *
55 * @return <tt>true</tt> if the transaction has been completed.
56 */
57 boolean isClosed();
58
59
60 /**
61 * Commit the transaction. It's called when we get out of a try-with-resource.
62 */
63 void close() throws IOException;
64 }