Class NoOpTransactionHandler

java.lang.Object

org.jdbi.v3.core.transaction.NoOpTransactionHandler

All Implemented Interfaces:

TransactionHandler

Direct Known Subclasses:

CMTTransactionHandler

public class NoOpTransactionHandler
extends Object
implements TransactionHandler

A TransactionHandler for connections whose transactions are managed completely outside of Jdbi, for example by a proxy data source or an XA transaction manager. This handler never reads or changes the transaction state of the connection:

• begin(Handle) and commit(Handle) do nothing. The external manager decides when a transaction starts and when it commits.
• rollback(Handle) throws a TransactionException. Jdbi cannot roll the external transaction back, so the exception propagates to the external manager, which then does the rollback.
• isInTransaction(Handle) returns false and does not examine the connection. On a wrapped connection, the autocommit flag does not show the real transaction state, so this handler never reads it.
• inTransaction(Handle, HandleCallback) runs the callback on the handle directly.
• Savepoints are not supported.

Because the handle never reports an open transaction, the transaction callbacks (Handle.afterCommit, Handle.afterRollback) cannot be registered under this handler.

See Also:

• CMTTransactionHandler

Constructor Summary

Constructors

Constructor	Description
NoOpTransactionHandler()

Method Summary

Modifier and Type	Method	Description
void	begin(Handle handle)	Begin a transaction.
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)	Savepoints are not supported.
void	rollback(Handle handle)	Called when a transaction is rolled back.
void	rollbackToSavepoint(Handle handle, String name)	Savepoints are not supported.
void	savepoint(Handle handle, String name)	Savepoints are not supported.

Methods inherited from class Object

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

Methods inherited from interface TransactionHandler

specialize

Constructor Details

NoOpTransactionHandler

public NoOpTransactionHandler()

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)

Called when a transaction is rolled back. Will throw a RuntimeException to force transactional rollback.

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 name)

Savepoints are not supported.

Specified by:

savepoint in interface TransactionHandler

Parameters:

handle - the handle on which the transaction is being savepointed

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

rollbackToSavepoint

public void rollbackToSavepoint(Handle handle,
 String name)

Savepoints are not supported.

Specified by:

rollbackToSavepoint in interface TransactionHandler

Parameters:

handle - the handle the rollback is being performed on

name - the name of the savepoint to rollback to

releaseSavepoint

public void releaseSavepoint(Handle handle,
 String savepointName)

Savepoints are not supported.

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)