io.r2dbc.pool

Class ConnectionPoolConfiguration.Builder

java.lang.Object

io.r2dbc.pool.ConnectionPoolConfiguration.Builder

Enclosing class:

ConnectionPoolConfiguration

public static final class ConnectionPoolConfiguration.Builder
extends Object

A builder for ConnectionPoolConfiguration instances.

This class is not threadsafe

Method Summary

Modifier and Type	Method and Description
ConnectionPoolConfiguration.Builder	acquireRetry(int retryAttempts) Configure the number of acquire retries if the first acquiry attempt fails.
ConnectionPoolConfiguration.Builder	allocatorSubscribeOn(Scheduler scheduler) Configure Scheduler to use for allocation.
ConnectionPoolConfiguration.Builder	backgroundEvictionInterval(Duration backgroundEvictionInterval) Configure the background eviction interval to evict idle connections while the pool isn't actively used for allocations/releases.
ConnectionPoolConfiguration	build() Returns a configured ConnectionPoolConfiguration.
ConnectionPoolConfiguration.Builder	clock(Clock clock) Configure the Clock used for allocation and eviction timing.
ConnectionPoolConfiguration.Builder	connectionFactory(ConnectionFactory connectionFactory) Configure connection factory.
ConnectionPoolConfiguration.Builder	customizer(Consumer<reactor.pool.PoolBuilder<Connection,? extends reactor.pool.PoolConfig<? extends Connection>>> customizer) Configure a customizer for PoolBuilder that constructs the Connection pool.
ConnectionPoolConfiguration.Builder	initialSize(int initialSize) Configure the initial connection pool size.
ConnectionPoolConfiguration.Builder	maxAcquireTime(Duration maxAcquireTime) Configure timeout for acquiring a Connection from pool.
ConnectionPoolConfiguration.Builder	maxCreateConnectionTime(Duration maxCreateConnectionTime) Configure timeout for creating a new Connection from ConnectionFactory.
ConnectionPoolConfiguration.Builder	maxIdleTime(Duration maxIdleTime) Configure a idle timeout.
ConnectionPoolConfiguration.Builder	maxLifeTime(Duration maxLifeTime) Configure lifetime of the pooled Connection in the pool.
ConnectionPoolConfiguration.Builder	maxSize(int maxSize) Configure the maximal connection pool size.
ConnectionPoolConfiguration.Builder	maxValidationTime(Duration maxValidationTime) Configure timeout for validating a Connection from pool.
ConnectionPoolConfiguration.Builder	metricsRecorder(reactor.pool.PoolMetricsRecorder recorder) Configure PoolMetricsRecorder to calculate elapsed time and instrumentation data
ConnectionPoolConfiguration.Builder	minIdle(int minIdle) Configure the minimal number of idle connections.
ConnectionPoolConfiguration.Builder	name(String name) Configure the name of the connection pool.
ConnectionPoolConfiguration.Builder	postAllocate(Function<? super Connection,? extends Publisher<Void>> postAllocate) Configure a Lifecycle.postAllocate() callback function.
ConnectionPoolConfiguration.Builder	preRelease(Function<? super Connection,? extends Publisher<Void>> preRelease) Configure a Lifecycle.preRelease() callback function.
ConnectionPoolConfiguration.Builder	registerJmx(boolean registerJmx) Configure whether to register to JMX.
String	toString()
ConnectionPoolConfiguration.Builder	validationDepth(ValidationDepth validationDepth) Configure validation depth for connection validation.
ConnectionPoolConfiguration.Builder	validationQuery(String validationQuery) Configure a validation query.

Methods inherited from class java.lang.Object

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

Method Detail

allocatorSubscribeOn

public ConnectionPoolConfiguration.Builder allocatorSubscribeOn(Scheduler scheduler)

Configure Scheduler to use for allocation. Defaults to Schedulers.single(). Configuring the scheduler can be relevant to coordinate thread co-location.

Parameters:

scheduler - the scheduler to use.

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if scheduler is null.

Since:

1.0.1

See Also:

Schedulers.single()

acquireRetry

public ConnectionPoolConfiguration.Builder acquireRetry(int retryAttempts)

Configure the number of acquire retries if the first acquiry attempt fails.

Parameters:

retryAttempts - the number of retries. Can be zero or any positive number

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if retryAttempts is less than zero.

See Also:

Mono.retry(long)

backgroundEvictionInterval

public ConnectionPoolConfiguration.Builder backgroundEvictionInterval(@Nullable
                                                                      Duration backgroundEvictionInterval)

Configure the background eviction interval to evict idle connections while the pool isn't actively used for allocations/releases.

Parameters:

backgroundEvictionInterval - background eviction interval. Duration.ZERO, a negative or a null value results in disabling background eviction.

Returns:

this ConnectionPoolConfiguration.Builder

Since:

0.8.7

clock

public ConnectionPoolConfiguration.Builder clock(Clock clock)

Configure the Clock used for allocation and eviction timing.

Parameters:

clock - the Clock to use.

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if clock is null.

customizer

public ConnectionPoolConfiguration.Builder customizer(Consumer<reactor.pool.PoolBuilder<Connection,? extends reactor.pool.PoolConfig<? extends Connection>>> customizer)

Configure a customizer for PoolBuilder that constructs the Connection pool.

Parameters:

customizer - customizer for PoolBuilder that creates the Connection pool, must not be null.

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if customizer is null

initialSize

public ConnectionPoolConfiguration.Builder initialSize(int initialSize)

Configure the initial connection pool size. Defaults to 10.

Parameters:

initialSize - the initial pool size, must be equal or greater than zero.

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if maxSize is negative or zero.

minIdle

public ConnectionPoolConfiguration.Builder minIdle(int minIdle)

Configure the minimal number of idle connections. Defaults to 0.

Parameters:

minIdle - the minimal amount of idle connections in the pool, must not be negative.

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if minIdle is negative.

Since:

0.9.1

maxSize

public ConnectionPoolConfiguration.Builder maxSize(int maxSize)

Configure the maximal connection pool size. Defaults to 10.

Parameters:

maxSize - the maximal pool size, must be greater than zero.

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if maxSize is negative or zero.

maxAcquireTime

public ConnectionPoolConfiguration.Builder maxAcquireTime(@Nullable
                                                          Duration maxAcquireTime)

Configure timeout for acquiring a Connection from pool. Default is no timeout.

When acquiring a Connection requires obtaining a new Connection from underlying ConnectionFactory, this timeout also applies to get the new one.

Parameters:

maxAcquireTime - the maximum time to acquire connection from pool. Duration.ZERO indicates that the connection must be immediately available otherwise acquisition fails. A negative or a null value results in not applying a timeout.

Returns:

this ConnectionPoolConfiguration.Builder

maxCreateConnectionTime

public ConnectionPoolConfiguration.Builder maxCreateConnectionTime(@Nullable
                                                                   Duration maxCreateConnectionTime)

Configure timeout for creating a new Connection from ConnectionFactory. Default is no timeout.

Parameters:

maxCreateConnectionTime - the maximum time to create a new Connection from ConnectionFactory. Duration.ZERO indicates immediate failure if the connection is not created immediately. A negative or a null value results in not applying a timeout.

Returns:

this ConnectionPoolConfiguration.Builder

maxIdleTime

public ConnectionPoolConfiguration.Builder maxIdleTime(@Nullable
                                                       Duration maxIdleTime)

Configure a idle timeout. Defaults to 30 minutes. Configuring maxIdleTime enables background eviction using the configured idle time as interval unless backgroundEvictionInterval(Duration) is configured.

Parameters:

maxIdleTime - the maximum idle time. Duration.ZERO means immediate connection disposal. A negative or a null value results in not applying a timeout.

Returns:

this ConnectionPoolConfiguration.Builder

maxLifeTime

public ConnectionPoolConfiguration.Builder maxLifeTime(Duration maxLifeTime)

Configure lifetime of the pooled Connection in the pool. Default is no timeout.

Parameters:

maxLifeTime - the maximum lifetime of the connection in the pool,. Duration.ZERO indicates immediate connection disposal. A negative or a null value results in not applying a timeout.

Returns:

this ConnectionPoolConfiguration.Builder

maxValidationTime

public ConnectionPoolConfiguration.Builder maxValidationTime(Duration maxValidationTime)

Configure timeout for validating a Connection from pool. Default is no timeout.

Parameters:

maxValidationTime - the maximum time to validate connection from pool. Duration.ZERO indicates that the connection must be immediately validated otherwise validation fails. A negative or a null value results in not applying a timeout.

Returns:

this ConnectionPoolConfiguration.Builder

Since:

0.9.2

See Also:

Connection.validate(ValidationDepth), validationQuery(String), validationDepth(ValidationDepth)

metricsRecorder

public ConnectionPoolConfiguration.Builder metricsRecorder(reactor.pool.PoolMetricsRecorder recorder)

Configure PoolMetricsRecorder to calculate elapsed time and instrumentation data

Parameters:

recorder - the PoolMetricsRecorder

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if recorder is null

name

public ConnectionPoolConfiguration.Builder name(String name)

Configure the name of the connection pool.

Parameters:

name - pool name

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if name is null

postAllocate

public ConnectionPoolConfiguration.Builder postAllocate(Function<? super Connection,? extends Publisher<Void>> postAllocate)

Configure a Lifecycle.postAllocate() callback function. This Function is called with a Connection object that was allocated from the pool before emitting it through ConnectionFactory.create(). The connection emission is delayed until the returned Publisher has completed. Any error signals from this publisher lead to immediate disposal of the connection. If a Connection implements Lifecycle, the given function is called once Lifecycle.postAllocate() has completed.

Parameters:

postAllocate - function applied to Connection returning a publisher to perform actions before returning the connection to the caller

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if postAllocate is null

Since:

0.9

preRelease

public ConnectionPoolConfiguration.Builder preRelease(Function<? super Connection,? extends Publisher<Void>> preRelease)

Configure a Lifecycle.preRelease() callback function. This Function is called with a Connection object that is about to be returned to the pool right before releasing it. through Connection.close(). The connection release is delayed until the returned Publisher has completed. Any error signals from this publisher lead to immediate disposal of the connection instead of returning it to the pool. If a Connection implements Lifecycle, the given function is called before invoking Lifecycle.preRelease().

Parameters:

preRelease - function applied to Connection returning a publisher to perform actions before releasing the connection

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if preRelease is null

Since:

0.9

registerJmx

public ConnectionPoolConfiguration.Builder registerJmx(boolean registerJmx)

Configure whether to register to JMX. Defaults to false.

Parameters:

registerJmx - register the pool to JMX

Returns:

this ConnectionPoolConfiguration.Builder

validationDepth

public ConnectionPoolConfiguration.Builder validationDepth(ValidationDepth validationDepth)

Configure validation depth for connection validation.

Parameters:

validationDepth - the depth of validation, must not be null

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if validationDepth is null

connectionFactory

public ConnectionPoolConfiguration.Builder connectionFactory(ConnectionFactory connectionFactory)

Configure connection factory.

Parameters:

connectionFactory - the connection factory to connect to the db, must not be null

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if connectionFactory is null

Since:

0.9

validationQuery

public ConnectionPoolConfiguration.Builder validationQuery(String validationQuery)

Configure a validation query. When a validation query is used, then Connection.validate(ValidationDepth) is not used.

Parameters:

validationQuery - the validation query to run before returning a Connection from the pool, must not be null.

Returns:

this ConnectionPoolConfiguration.Builder

Throws:

IllegalArgumentException - if validationQuery is null

build

public ConnectionPoolConfiguration build()

Returns a configured ConnectionPoolConfiguration.

Returns:

a configured ConnectionPoolConfiguration

Throws:

IllegalArgumentException - if registerJmx is true AND name is null

toString

public String toString()

Overrides:

toString in class Object