org.neo4j.kernel

Class TopLevelTransaction

java.lang.Object

org.neo4j.kernel.TopLevelTransaction

All Implemented Interfaces:

AutoCloseable, Transaction

Direct Known Subclasses:

PlaceboTransaction

public class TopLevelTransaction
extends Object
implements Transaction

Constructor Summary

Constructors

Constructor and Description
TopLevelTransaction(org.neo4j.kernel.impl.transaction.AbstractTransactionManager transactionManager, org.neo4j.kernel.impl.core.TransactionState state)

Method Summary

Methods

Modifier and Type	Method and Description
Lock	acquireReadLock(PropertyContainer entity) Acquires a read lock for entity for this transaction.
Lock	acquireWriteLock(PropertyContainer entity) Acquires a write lock for entity for this transaction.
void	close() Commits or marks this transaction for rollback, depending on whether Transaction.success() or Transaction.failure() has been previously invoked.
void	failure() Marks this transaction as failed, which means that it will unconditionally be rolled back when Transaction.close() is called.
void	finish() Commits or marks this transaction for rollback, depending on whether Transaction.success() or Transaction.failure() has been previously invoked.
void	success() Marks this transaction as successful, which means that it will be committed upon invocation of Transaction.close() unless Transaction.failure() has or will be invoked before then.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopLevelTransaction

public TopLevelTransaction(org.neo4j.kernel.impl.transaction.AbstractTransactionManager transactionManager,
                   org.neo4j.kernel.impl.core.TransactionState state)

Method Detail

failure

public void failure()

Description copied from interface: Transaction

Marks this transaction as failed, which means that it will unconditionally be rolled back when Transaction.close() is called. Once this method has been invoked, it doesn't matter if Transaction.success() is invoked afterwards -- the transaction will still be rolled back.

Specified by:

failure in interface Transaction

success

public void success()

Description copied from interface: Transaction

Marks this transaction as successful, which means that it will be committed upon invocation of Transaction.close() unless Transaction.failure() has or will be invoked before then.

Specified by:

success in interface Transaction

finish

public final void finish()

Description copied from interface: Transaction

Commits or marks this transaction for rollback, depending on whether Transaction.success() or Transaction.failure() has been previously invoked. All ResourceIterables that where returned from operations executed inside this transaction will be automatically closed by this method. Preferably this method will not be used, instead a Transaction should participate in a try-with-resource statement so that Transaction.close() is automatically called instead. Invoking Transaction.close() (which is unnecessary when in try-with-resource statement) or Transaction.finish() has the exact same effect.

Specified by:

finish in interface Transaction

close

public void close()

Description copied from interface: Transaction

Commits or marks this transaction for rollback, depending on whether Transaction.success() or Transaction.failure() has been previously invoked. All ResourceIterables that where returned from operations executed inside this transaction will be automatically closed by this method. This method comes from AutoCloseable so that a Transaction can participate in try-with-resource statements. It will not throw any declared exception, just like Transaction.finish(). Invoking Transaction.close() (which is unnecessary when in try-with-resource statement) or Transaction.finish() has the exact same effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Transaction

acquireWriteLock

public Lock acquireWriteLock(PropertyContainer entity)

Description copied from interface: Transaction

Acquires a write lock for entity for this transaction. The lock (returned from this method) can be released manually, but if not it's released automatically when the transaction finishes.

Specified by:

acquireWriteLock in interface Transaction

Parameters:

entity - the entity to acquire a lock for. If another transaction currently holds a write lock to that entity this call will wait until it's released.

Returns:

a Lock which optionally can be used to release this lock earlier than when the transaction finishes. If not released (with Lock.release() it's going to be released with the transaction finishes.

acquireReadLock

public Lock acquireReadLock(PropertyContainer entity)

Description copied from interface: Transaction

Acquires a read lock for entity for this transaction. The lock (returned from this method) can be released manually, but if not it's released automatically when the transaction finishes.

Specified by:

acquireReadLock in interface Transaction

Parameters:

entity - the entity to acquire a lock for. If another transaction currently hold a write lock to that entity this call will wait until it's released.

Returns:

a Lock which optionally can be used to release this lock earlier than when the transaction finishes. If not released (with Lock.release() it's going to be released with the transaction finishes.