org.springframework.r2dbc.connection

Class TransactionAwareConnectionFactoryProxy

java.lang.Object

org.springframework.r2dbc.connection.DelegatingConnectionFactory

org.springframework.r2dbc.connection.TransactionAwareConnectionFactoryProxy

All Implemented Interfaces:

io.r2dbc.spi.ConnectionFactory, io.r2dbc.spi.Wrapped<io.r2dbc.spi.ConnectionFactory>

public class TransactionAwareConnectionFactoryProxy
extends DelegatingConnectionFactory

Proxy for a target R2DBC ConnectionFactory, adding awareness of Spring-managed transactions.

Data access code that should remain unaware of Spring's data access support can work with this proxy to seamlessly participate in Spring-managed transactions. Note that the transaction manager, for example R2dbcTransactionManager, still needs to work with the underlying ConnectionFactory, not with this proxy.

Make sure that TransactionAwareConnectionFactoryProxy is the outermost ConnectionFactory of a chain of ConnectionFactory proxies/adapters. TransactionAwareConnectionFactoryProxy can delegate either directly to the target connection pool or to some intermediary proxy/adapter.

Delegates to ConnectionFactoryUtils for automatically participating in thread-bound transactions, for example managed by R2dbcTransactionManager. create() calls and close calls on returned Connection will behave properly within a transaction, i.e. always operate on the transactional Connection. If not within a transaction, normal ConnectionFactory behavior applies.

This proxy allows data access code to work with the plain R2DBC API. However, if possible, use Spring's ConnectionFactoryUtils or DatabaseClient to get transaction participation even without a proxy for the target ConnectionFactory, avoiding the need to define such a proxy in the first place.

NOTE: This ConnectionFactory proxy needs to return wrapped Connections (which implement the ConnectionProxy interface) in order to handle close calls properly. Use Wrapped.unwrap() to retrieve the native R2DBC Connection.

Since:

5.3

Author:

Mark Paluch, Christoph Strobl

See Also:

ConnectionFactory.create(), Connection.close(), ConnectionFactoryUtils.doGetConnection(io.r2dbc.spi.ConnectionFactory), ConnectionFactoryUtils.doReleaseConnection(io.r2dbc.spi.Connection, io.r2dbc.spi.ConnectionFactory)

Constructor Summary

Constructors

Constructor and Description
TransactionAwareConnectionFactoryProxy(io.r2dbc.spi.ConnectionFactory targetConnectionFactory) Create a new TransactionAwareConnectionFactoryProxy.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<io.r2dbc.spi.Connection>	create() Delegates to ConnectionFactoryUtils for automatically participating in Spring-managed transactions.
protected reactor.core.publisher.Mono<io.r2dbc.spi.Connection>	getTransactionAwareConnectionProxy(io.r2dbc.spi.ConnectionFactory targetConnectionFactory) Wraps the given Connection with a proxy that delegates every method call to it but delegates close() calls to ConnectionFactoryUtils.

Methods inherited from class org.springframework.r2dbc.connection.DelegatingConnectionFactory

getMetadata, getTargetConnectionFactory, obtainTargetConnectionFactory, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionAwareConnectionFactoryProxy

public TransactionAwareConnectionFactoryProxy(io.r2dbc.spi.ConnectionFactory targetConnectionFactory)

Create a new TransactionAwareConnectionFactoryProxy.

Parameters:

targetConnectionFactory - the target ConnectionFactory.

Throws:

IllegalArgumentException - if given ConnectionFactory is null.

Method Detail

create

public reactor.core.publisher.Mono<io.r2dbc.spi.Connection> create()

Delegates to ConnectionFactoryUtils for automatically participating in Spring-managed transactions.

The returned ConnectionFactory handle implements the ConnectionProxy interface, allowing to retrieve the underlying target Connection.

Specified by:

create in interface io.r2dbc.spi.ConnectionFactory

Overrides:

create in class DelegatingConnectionFactory

Returns:

a transactional Connection if any, a new one else.

See Also:

ConnectionFactoryUtils.doGetConnection(io.r2dbc.spi.ConnectionFactory), ConnectionProxy#getTargetConnection

getTransactionAwareConnectionProxy

protected reactor.core.publisher.Mono<io.r2dbc.spi.Connection> getTransactionAwareConnectionProxy(io.r2dbc.spi.ConnectionFactory targetConnectionFactory)

Wraps the given Connection with a proxy that delegates every method call to it but delegates close() calls to ConnectionFactoryUtils.

Parameters:

targetConnectionFactory - the ConnectionFactory that the Connection came from.

Returns:

the wrapped Connection.

See Also:

Connection.close(), ConnectionFactoryUtils.doReleaseConnection(io.r2dbc.spi.Connection, io.r2dbc.spi.ConnectionFactory)