A TransactionProvider that implements thread-bound transaction semantics.

Use this TransactionProvider if your transactions are thread-bound, meaning that a transaction and its underlying Connection will never leave the thread that started the transaction.

When this TransactionProvider is used, users must pass their custom ConnectionProvider implementations to this TransactionProvider, instead of passing it to the Configuration.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	ThreadLocalTransactionProvider.ThreadLocalConnectionProvider

Field Summary

Modifier and Type	Field and Description
pack-priv final DefaultTransactionProvider	delegateTransactionProvider
pack-priv final ThreadLocal<Deque<Configuration>>	localConfigurations
pack-priv final ThreadLocalTransactionProvider.ThreadLocalConnectionProvider	localConnectionProvider
pack-priv final ThreadLocal<Connection>	localTxConnection

Access	Constructor and Description
public	ThreadLocalTransactionProvider(ConnectionProvider connectionProvider)
public	ThreadLocalTransactionProvider(ConnectionProvider connectionProvider, boolean Whether nested transactions via `Savepoint`s are supported. nested)

Method Summary

Modifier and Type	Method and Description
public void	begin(TransactionContext the configuration scoped to this transaction and its nested transactions. ctx) Implements org.jooq.TransactionProvider.begin. Begin a new transaction.
public void	commit(TransactionContext the configuration scoped to this transaction and its nested transactions. ctx) Implements org.jooq.TransactionProvider.commit. Commit a transaction.
pack-priv Configuration	configuration(Configuration fallback)
private Deque<Configuration>	configurations()
public void	rollback(TransactionContext the configuration scoped to this transaction and its nested transactions. ctx) Implements org.jooq.TransactionProvider.rollback. Rollback a transaction.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegateTransactionProvider	back to summary
pack-priv final DefaultTransactionProvider delegateTransactionProvider

localConfigurations	back to summary
pack-priv final ThreadLocal<Deque<Configuration>> localConfigurations

localConnectionProvider	back to summary
pack-priv final ThreadLocalTransactionProvider.ThreadLocalConnectionProvider localConnectionProvider

localTxConnection	back to summary
pack-priv final ThreadLocal<Connection> localTxConnection

ThreadLocalTransactionProvider	back to summary
public ThreadLocalTransactionProvider(ConnectionProvider connectionProvider)

ThreadLocalTransactionProvider	back to summary
public ThreadLocalTransactionProvider(ConnectionProvider connectionProvider, boolean nested) Parameters nested:boolean Whether nested transactions via `Savepoint`s are supported.

Method Detail

begin back to summary

begin	back to summary
public void begin(TransactionContext ctx) Implements org.jooq.TransactionProvider.begin. Doc from org.jooq.TransactionProvider.begin. Begin a new transaction. This method begins a new transaction with a `Configuration` scoped for this transaction. The resulting `Transaction` object may be used by implementors to identify the transaction when `commit(TransactionContext)` or `rollback(TransactionContext)` is called. Parameters ctx:TransactionContext the configuration scoped to this transaction and its nested transactions. Annotations @Override

public void begin(TransactionContext ctx)

Implements org.jooq.TransactionProvider.begin.

Doc from org.jooq.TransactionProvider.begin.

Begin a new transaction.

This method begins a new transaction with a Configuration scoped for this transaction. The resulting Transaction object may be used by implementors to identify the transaction when commit(TransactionContext) or rollback(TransactionContext) is called.

Parameters

ctx:TransactionContext: the configuration scoped to this transaction and its nested transactions.

Annotations

@Override

commit	back to summary
public void commit(TransactionContext ctx) Implements org.jooq.TransactionProvider.commit. Doc from org.jooq.TransactionProvider.commit. Commit a transaction. Parameters ctx:TransactionContext the configuration scoped to this transaction and its nested transactions. Annotations @Override

commit

back to summary

public void commit(TransactionContext ctx)

Implements org.jooq.TransactionProvider.commit.

Doc from org.jooq.TransactionProvider.commit.

Commit a transaction.

Parameters

ctx:TransactionContext: the configuration scoped to this transaction and its nested transactions.

Annotations

@Override

configuration	back to summary
pack-priv Configuration configuration(Configuration fallback)

configurations	back to summary
private Deque<Configuration> configurations()

rollback	back to summary
public void rollback(TransactionContext ctx) Implements org.jooq.TransactionProvider.rollback. Doc from org.jooq.TransactionProvider.rollback. Rollback a transaction. Parameters ctx:TransactionContext the configuration scoped to this transaction and its nested transactions. Annotations @Override

rollback

back to summary

public void rollback(TransactionContext ctx)

Implements org.jooq.TransactionProvider.rollback.

Doc from org.jooq.TransactionProvider.rollback.

Rollback a transaction.

Parameters

ctx:TransactionContext: the configuration scoped to this transaction and its nested transactions.

Annotations

@Override

org.jooq.impl back to summary

pack-priv final Class ThreadLocalTransactionProvider.ThreadLocalConnectionProvider

Class Inheritance

extends Object
implements ConnectionProvider

java.lang.Object
org.jooq.impl.ThreadLocalTransactionProvider.ThreadLocalConnectionProvider

All Implemented Interfaces

org.jooq.ConnectionProvider

Field Summary

Modifier and Type	Field and Description
pack-priv final ConnectionProvider	delegateConnectionProvider

Constructor Summary

Access	Constructor and Description
public	ThreadLocalConnectionProvider(ConnectionProvider delegate)

Method Summary

Modifier and Type	Method and Description
public final Connection	acquire() Implements org.jooq.ConnectionProvider.acquire. Acquire a connection from the connection lifecycle handler.
public final void	release(Connection A connection that was previously obtained from `acquire()`. This is never `null`. connection) Implements org.jooq.ConnectionProvider.release. Release a connection to the connection lifecycle handler.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegateConnectionProvider	back to summary
pack-priv final ConnectionProvider delegateConnectionProvider

Constructor Detail

ThreadLocalConnectionProvider	back to summary
public ThreadLocalConnectionProvider(ConnectionProvider delegate)

Method Detail

acquire back to summary

acquire	back to summary
public final Connection acquire() Implements org.jooq.ConnectionProvider.acquire. Doc from org.jooq.ConnectionProvider.acquire. Acquire a connection from the connection lifecycle handler. This method is called by jOOQ exactly once per execution lifecycle, i.e. per `ExecuteContext`. Implementations may freely chose, whether subsequent calls to this method: return the same connection instance return the same connection instance for the same thread return the same connection instance for the same transaction (e.g. a `javax.transaction.UserTransaction`) return a fresh connection instance every time jOOQ will guarantee that every acquired connection is released through `release(Connection)` exactly once. Returns:Connection A connection for the current `ExecuteContext`. If `null` is returned (e.g. by NoConnectionProvider), then statements cannot be executed. Attempts to execute statements will result in a `DetachedException`. Annotations @Override

public final Connection acquire()

Implements org.jooq.ConnectionProvider.acquire.

Doc from org.jooq.ConnectionProvider.acquire.

Acquire a connection from the connection lifecycle handler.

This method is called by jOOQ exactly once per execution lifecycle, i.e. per ExecuteContext. Implementations may freely chose, whether subsequent calls to this method:

return the same connection instance
return the same connection instance for the same thread
return the same connection instance for the same transaction (e.g. a javax.transaction.UserTransaction)
return a fresh connection instance every time

jOOQ will guarantee that every acquired connection is released through release(Connection) exactly once.

Returns:Connection

A connection for the current ExecuteContext. If null is returned (e.g. by NoConnectionProvider), then statements cannot be executed. Attempts to execute statements will result in a DetachedException.

Annotations

@Override

release back to summary

release	back to summary
public final void release(Connection connection) Implements org.jooq.ConnectionProvider.release. Doc from org.jooq.ConnectionProvider.release. Release a connection to the connection lifecycle handler. jOOQ will guarantee that every acquired connection is released exactly once. Parameters connection:Connection A connection that was previously obtained from `acquire()`. This is never `null`. Annotations @Override

public final void release(Connection connection)

Implements org.jooq.ConnectionProvider.release.

Doc from org.jooq.ConnectionProvider.release.

Release a connection to the connection lifecycle handler.

jOOQ will guarantee that every acquired connection is released exactly once.

Parameters

connection:Connection: A connection that was previously obtained from acquire(). This is never null.

Annotations

@Override

public Class ThreadLocalTransactionProvider

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ThreadLocalTransactionProvider.ThreadLocalConnectionProvider

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail