org.jdbi.v3.sqlobject.mixins

Interface Transactional<This extends Transactional<This>>

Type Parameters:

This - must match the interface that is extending this one.

public interface Transactional<This extends Transactional<This>>

A mixin interface to expose transaction methods on the sql object.

Use caution with on-demand Transactional instances. Handle throws TransactionException if closed while a transaction is open. Since on-demand extensions open and close a handle around each method invocation, calling begin() on an on-demand Transactional will always leave a transaction open, and thus always throw this exception.

Users of on-demand Transactional instances should use the inTransaction and useTransaction methods to execute transactions. It is safe to call other Transactional methods from inside these callbacks.

Method Summary

Modifier and Type	Method and Description
void	begin() Begins a transaction.
void	commit() Commits the open transaction.
<R,X extends Exception> R	inTransaction(TransactionalCallback<R,This,X> callback) Executes the given callback within a transaction, returning the value returned by the callback.
<R,X extends Exception> R	inTransaction(TransactionIsolationLevel isolation, TransactionalCallback<R,This,X> callback) Executes the given callback within a transaction, returning the value returned by the callback.
void	releaseSavepoint(String savepointName) Releases the given savepoint.
void	rollback() Rolls back the open transaction.
void	rollbackToSavepoint(String savepointName) Rolls back to the given savepoint.
void	savepoint(String savepointName) Creates a savepoint with the given name on the transaction.
default <X extends Exception> void	useTransaction(TransactionalConsumer<This,X> callback) Executes the given callback within a transaction.
default <X extends Exception> void	useTransaction(TransactionIsolationLevel isolation, TransactionalConsumer<This,X> callback) Executes the given callback within a transaction.

Method Detail

begin

void begin()

Begins a transaction.

Throws:

TransactionException - if called on an on-demand Transactional instance.

commit

void commit()

Commits the open transaction.

rollback

void rollback()

Rolls back the open transaction.

savepoint

void savepoint(String savepointName)

Creates a savepoint with the given name on the transaction.

Parameters:

savepointName - the savepoint name.

rollbackToSavepoint

void rollbackToSavepoint(String savepointName)

Rolls back to the given savepoint.

Parameters:

savepointName - the savepoint name.

releaseSavepoint

void releaseSavepoint(String savepointName)

Releases the given savepoint.

Parameters:

savepointName - the savepoint name.

inTransaction

<R,X extends Exception> R inTransaction(TransactionalCallback<R,This,X> callback)
                                 throws X extends Exception

Executes the given callback within a transaction, returning the value returned by the callback.

Type Parameters:

R - method return type

X - exception optionally thrown by the callback.

Parameters:

callback - the callback to execute

Returns:

the value returned by the callback.

Throws:

X - any exception thrown by the callback.

X extends Exception

inTransaction

<R,X extends Exception> R inTransaction(TransactionIsolationLevel isolation,
                                        TransactionalCallback<R,This,X> callback)
                                 throws X extends Exception

Executes the given callback within a transaction, returning the value returned by the callback.

Type Parameters:

R - method return type

X - exception optionally thrown by the callback.

Parameters:

isolation - the transaction isolation level.

callback - the callback to execute

Returns:

the value returned by the callback.

Throws:

X - any exception thrown by the callback.

X extends Exception

useTransaction

default <X extends Exception> void useTransaction(TransactionalConsumer<This,X> callback)
                                           throws X extends Exception

Executes the given callback within a transaction.

Type Parameters:

X - exception optionally thrown by the callback.

Parameters:

callback - the callback to execute

Throws:

X - any exception thrown by the callback.

X extends Exception

useTransaction

default <X extends Exception> void useTransaction(TransactionIsolationLevel isolation,
                                                  TransactionalConsumer<This,X> callback)
                                           throws X extends Exception

Executes the given callback within a transaction.

Type Parameters:

X - exception optionally thrown by the callback.

Parameters:

isolation - the transaction isolation level.

callback - the callback to execute

Throws:

X - any exception thrown by the callback.

X extends Exception