org.skife.jdbi.v2.tweak

Interface TransactionHandler

All Known Implementing Classes:

CMTTransactionHandler, DelegatingTransactionHandler, LocalTransactionHandler, SerializableTransactionRunner

public interface TransactionHandler

Interface which defines callbacks to be used when transaction methods are called on a handle. Used by specifying on an IDBI instance. All Handle instances opened from that IDBI will use the handler specified.

The default implementation, ConnectionTransactionHandler, explicitely manages the transactions on the underlying JDBC Connection.

Method Summary

Modifier and Type	Method and Description
void	begin(Handle handle) Called when a transaction is started
void	checkpoint(Handle handle, String name) Create a new checkpoint (savepoint in JDBC terminology)
void	commit(Handle handle) Called when a transaction is committed
<ReturnType> ReturnType	inTransaction(Handle handle, TransactionCallback<ReturnType> callback) Run a transaction.
<ReturnType> ReturnType	inTransaction(Handle handle, TransactionIsolationLevel level, TransactionCallback<ReturnType> callback) Run a transaction.
boolean	isInTransaction(Handle handle) Called to test if a handle is in a transaction
void	release(Handle handle, String checkpointName) Release a previously created checkpoint
void	rollback(Handle handle) Called when a transaction is rolled back
void	rollback(Handle handle, String name) Roll back to a named checkpoint

Method Detail

begin

void begin(Handle handle)

Called when a transaction is started

checkpoint

void checkpoint(Handle handle,
                String name)

Create a new checkpoint (savepoint in JDBC terminology)

Parameters:

handle - the handle on which the transaction is being checkpointed

name - The name of the chckpoint, used to rollback to or release late

commit

void commit(Handle handle)

Called when a transaction is committed

inTransaction

<ReturnType> ReturnType inTransaction(Handle handle,
                                      TransactionCallback<ReturnType> callback)

Run a transaction.

See Also:

Handle.inTransaction(TransactionCallback)

inTransaction

<ReturnType> ReturnType inTransaction(Handle handle,
                                      TransactionIsolationLevel level,
                                      TransactionCallback<ReturnType> callback)

Run a transaction.

See Also:

Handle.inTransaction(TransactionIsolationLevel, TransactionCallback)

isInTransaction

boolean isInTransaction(Handle handle)

Called to test if a handle is in a transaction

release

void release(Handle handle,
             String checkpointName)

Release a previously created checkpoint

Parameters:

handle - the handle on which the checkpoint is being released

checkpointName - the checkpoint to release

rollback

void rollback(Handle handle)

Called when a transaction is rolled back

rollback

void rollback(Handle handle,
              String name)

Roll back to a named checkpoint

Parameters:

handle - the handle the rollback is being performed on

name - the name of the checkpoint to rollback to