org.apache.directory.server.core.api.partition

Class PartitionReadTxn

java.lang.Object

org.apache.directory.server.core.api.partition.PartitionReadTxn

All Implemented Interfaces:

Closeable, AutoCloseable, PartitionTxn

public class PartitionReadTxn
extends Object
implements PartitionTxn

The Read Transaction interface

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
PartitionReadTxn()

Method Summary

Modifier and Type	Method and Description
void	abort() Abort a transaction.
void	close() Commit the transaction.
void	commit() Commit a write transaction.
boolean	isClosed() Tells if the transaction has been committed/aborted or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartitionReadTxn

public PartitionReadTxn()

Method Detail

commit

public void commit()
            throws IOException

Commit a write transaction. It will apply the changes on the database.Last, not least, a new version will be created. If called by a Read transaction, it will simply close it.

Specified by:

commit in interface PartitionTxn

Throws:

IOException - If the commit failed

abort

public void abort()
           throws IOException

Abort a transaction. If it's a PartitionReadTxn, it will unlink this transaction from the version it used. If it's a PartitionWriteTxn; it will drop all the pending changes. The latest version will remain the same.

Specified by:

abort in interface PartitionTxn

Throws:

IOException - If the abort failed

isClosed

public boolean isClosed()

Tells if the transaction has been committed/aborted or not.

Specified by:

isClosed in interface PartitionTxn

Returns:

true if the transaction has been completed.

close

public void close()
           throws IOException

Commit the transaction. It's called when we get out of a try-with-resource.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface PartitionTxn

Throws:

IOException