Class LocalTransactionHandler

java.lang.Object

org.jdbi.v3.core.transaction.LocalTransactionHandler

All Implemented Interfaces:

TransactionHandler

public class LocalTransactionHandler
extends Object
implements TransactionHandler

This TransactionHandler uses local JDBC transactions demarcated explicitly on the handle and passed through to be handled directly on the JDBC Connection instance.

Constructor Summary

Constructors

Constructor	Description
LocalTransactionHandler()

Method Summary

Modifier and Type	Method	Description
void	begin(Handle handle)	Begin a transaction.
static LocalTransactionHandler	binding()
void	commit(Handle handle)	Commit the transaction.
<R, X extends Exception> R	inTransaction(Handle handle, HandleCallback<R,X> callback)	Run a transaction.
<R, X extends Exception> R	inTransaction(Handle handle, TransactionIsolationLevel level, HandleCallback<R,X> callback)	Run a transaction.
boolean	isInTransaction(Handle handle)	Returns whether a given Handle is in the transaction.
void	releaseSavepoint(Handle handle, String savepointName)	Release a previously created savepoint.
void	reset(Handle handle)
void	rollback(Handle handle)	Roll back the transaction.
void	rollbackToSavepoint(Handle handle, String savepointName)	Roll back to a named savepoint.
void	savepoint(Handle handle, String savepointName)	Create a new savepoint.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jdbi.v3.core.transaction.TransactionHandler

specialize

Constructor Details

LocalTransactionHandler

public LocalTransactionHandler()

Method Details

begin

public void begin(Handle handle)

Description copied from interface: TransactionHandler

Begin a transaction.

Specified by:

begin in interface TransactionHandler

Parameters:

handle - the handle the transaction is being started on

commit

public void commit(Handle handle)

Description copied from interface: TransactionHandler

Commit the transaction.

Specified by:

commit in interface TransactionHandler

Parameters:

handle - the handle the commit is being performed on

rollback

public void rollback(Handle handle)

Description copied from interface: TransactionHandler

Roll back the transaction.

Specified by:

rollback in interface TransactionHandler

Parameters:

handle - the handle the rollback is being performed on

isInTransaction

public boolean isInTransaction(Handle handle)

Description copied from interface: TransactionHandler

Returns whether a given Handle is in the transaction.

Specified by:

isInTransaction in interface TransactionHandler

Parameters:

handle - the handle to test

Returns:

whether the given handle is in a transaction

savepoint

public void savepoint(Handle handle,
 String savepointName)

Description copied from interface: TransactionHandler

Create a new savepoint.

Specified by:

savepoint in interface TransactionHandler

Parameters:

handle - the handle on which the transaction is being savepointed

savepointName - The name of the savepoint, used to rollback to or release later

rollbackToSavepoint

public void rollbackToSavepoint(Handle handle,
 String savepointName)

Description copied from interface: TransactionHandler

Roll back to a named savepoint.

Specified by:

rollbackToSavepoint in interface TransactionHandler

Parameters:

handle - the handle the rollback is being performed on

savepointName - the name of the savepoint to rollback to

releaseSavepoint

public void releaseSavepoint(Handle handle,
 String savepointName)

Description copied from interface: TransactionHandler

Release a previously created savepoint.

Specified by:

releaseSavepoint in interface TransactionHandler

Parameters:

handle - the handle on which the savepoint is being released

savepointName - the savepoint to release

inTransaction

public <R,
X extends Exception> R inTransaction(Handle handle,
 HandleCallback<R,X> callback)
                                         throws X

Description copied from interface: TransactionHandler

Run a transaction.

Specified by:

inTransaction in interface TransactionHandler

Type Parameters:

R - the callback return type

X - the exception type thrown by the callback, if any

Parameters:

handle - the handle to the database

callback - a callback which will receive the open handle, in a transaction.

Returns:

the value returned by the callback.

Throws:

X - any exception thrown by the callback.

See Also:

• Handle.inTransaction(HandleCallback)

inTransaction

public <R,
X extends Exception> R inTransaction(Handle handle,
 TransactionIsolationLevel level,
 HandleCallback<R,X> callback)
                                         throws X

Description copied from interface: TransactionHandler

Run a transaction.

Specified by:

inTransaction in interface TransactionHandler

Type Parameters:

R - the callback return type

X - the exception type thrown by the callback, if any

Parameters:

handle - the handle to the database

level - the isolation level for the transaction

callback - a callback which will receive the open handle, in a transaction.

Returns:

the value returned by the callback.

Throws:

X - any exception thrown by the callback.

See Also:

• Handle.inTransaction(TransactionIsolationLevel, HandleCallback)

binding

public static LocalTransactionHandler binding()

reset

public void reset(Handle handle)