Top Description Fields Constructors Methods
io.r2dbc.pool

public Class PoolingConnectionFactoryProvider

extends Object
implements ConnectionFactoryProvider
Class Inheritance
All Implemented Interfaces
io.r2dbc.spi.ConnectionFactoryProvider
Imports
io.r2dbc.spi.Connection, .ConnectionFactories, .ConnectionFactory, .ConnectionFactoryOptions, .ConnectionFactoryProvider, .Option, .ValidationDepth, org.reactivestreams.Publisher, java.time.Duration, java.util.function.Function

An implementation of ConnectionFactory for creating pooled connections to a delegated ConnectionFactory.
Authors
Mark Paluch, Rodolfo Beletatti, Rodolpho S. Couto, Todd Ginsberg, Gabriel Calin

Field Summary

Modifier and TypeField and Description
public static final Option<Integer>
ACQUIRE_RETRY

AcquireRetry Option.

public static final Option<Duration>
BACKGROUND_EVICTION_INTERVAL

Background eviction interval Option.

private static final String
public static final Option<Integer>
INITIAL_SIZE

InitialSize Option.

public static final Option<Duration>
MAX_ACQUIRE_TIME

MaxAcquireTime Option.

public static final Option<Duration>
MAX_CREATE_CONNECTION_TIME

MaxCreateConnectionTime Option.

public static final Option<Duration>
MAX_IDLE_TIME

MaxIdleTime Option.

public static final Option<Duration>
MAX_LIFE_TIME

MaxLifeTime Option.

public static final Option<Integer>
MAX_SIZE

MaxSize Option.

public static final Option<Duration>
MAX_VALIDATION_TIME

MaxValidationTime Option.

public static final Option<Integer>
MIN_IDLE

MinIdle Option.

public static final Option<String>
POOL_NAME

Name of the Connection Pool Option

public static final String
public static final Option<Function<? super Connection, ? extends Publisher<Void>>>
POST_ALLOCATE

Option to configure a Lifecycle.postAllocate function.

public static final Option<Function<? super Connection, ? extends Publisher<Void>>>
PRE_RELEASE

Option to configure a Lifecycle.preRelease function.

public static final Option<Boolean>
REGISTER_JMX

Option to configure whether to register to JMX.

public static final Option<ValidationDepth>
VALIDATION_DEPTH

ValidationDepth Option.

public static final Option<String>
VALIDATION_QUERY

ValidationQuery Option.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
pack-priv static ConnectionPoolConfiguration
buildConfiguration(ConnectionFactoryOptions connectionFactoryOptions)

public ConnectionPool

Returns:

the pooling ConnectionFactory
create
(ConnectionFactoryOptions
a collection of ConnectionFactoryOptions
connectionFactoryOptions
)

Implements io.r2dbc.spi.ConnectionFactoryProvider.create.

Create a new pooling ConnectionFactory from given ConnectionFactoryOptions.
public String
getDriver()

Implements io.r2dbc.spi.ConnectionFactoryProvider.getDriver.

Returns the driver identifier used by the driver.
public boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ACQUIRE_RETRYback to summary
public static final Option<Integer> ACQUIRE_RETRY

AcquireRetry Option.

BACKGROUND_EVICTION_INTERVALback to summary
public static final Option<Duration> BACKGROUND_EVICTION_INTERVAL

Background eviction interval Option.

Since
0.8.7
COLONback to summary
private static final String COLON
INITIAL_SIZEback to summary
public static final Option<Integer> INITIAL_SIZE

InitialSize Option.

MAX_ACQUIRE_TIMEback to summary
public static final Option<Duration> MAX_ACQUIRE_TIME

MaxAcquireTime Option.

Since
0.8.3
MAX_CREATE_CONNECTION_TIMEback to summary
public static final Option<Duration> MAX_CREATE_CONNECTION_TIME

MaxCreateConnectionTime Option.

Since
0.8.3
MAX_IDLE_TIMEback to summary
public static final Option<Duration> MAX_IDLE_TIME

MaxIdleTime Option.

Since
0.8.3
MAX_LIFE_TIMEback to summary
public static final Option<Duration> MAX_LIFE_TIME

MaxLifeTime Option.

Since
0.8.3
MAX_SIZEback to summary
public static final Option<Integer> MAX_SIZE

MaxSize Option.

MAX_VALIDATION_TIMEback to summary
public static final Option<Duration> MAX_VALIDATION_TIME

MaxValidationTime Option.

Since
0.9.2
MIN_IDLEback to summary
public static final Option<Integer> MIN_IDLE

MinIdle Option.

Since
0.9.1
POOL_NAMEback to summary
public static final Option<String> POOL_NAME

Name of the Connection Pool Option

Since
0.8.5
POOLING_DRIVERback to summary
public static final String POOLING_DRIVER
POST_ALLOCATEback to summary
public static final Option<Function<? super Connection, ? extends Publisher<Void>>> POST_ALLOCATE

Option to configure a Lifecycle.postAllocate function.

Since
0.9
PRE_RELEASEback to summary
public static final Option<Function<? super Connection, ? extends Publisher<Void>>> PRE_RELEASE

Option to configure a Lifecycle.preRelease function.

Since
0.9
REGISTER_JMXback to summary
public static final Option<Boolean> REGISTER_JMX

Option to configure whether to register to JMX.

Since
0.8.5
VALIDATION_DEPTHback to summary
public static final Option<ValidationDepth> VALIDATION_DEPTH

ValidationDepth Option.

VALIDATION_QUERYback to summary
public static final Option<String> VALIDATION_QUERY

ValidationQuery Option.

Constructor Detail

PoolingConnectionFactoryProviderback to summary
public PoolingConnectionFactoryProvider()

Method Detail

buildConfigurationback to summary
pack-priv static ConnectionPoolConfiguration buildConfiguration(ConnectionFactoryOptions connectionFactoryOptions)
createback to summary
public ConnectionPool create(ConnectionFactoryOptions connectionFactoryOptions)

Implements io.r2dbc.spi.ConnectionFactoryProvider.create.

Create a new pooling ConnectionFactory from given ConnectionFactoryOptions.

Parameters
connectionFactoryOptions:ConnectionFactoryOptions

a collection of ConnectionFactoryOptions

Returns:ConnectionPool

the pooling ConnectionFactory

Annotations
@Override
Exceptions
IllegalArgumentException:
IllegalStateException:
if there is no value for ConnectionFactoryOptions#PROTOCOL
getDriverback to summary
public String getDriver()

Implements io.r2dbc.spi.ConnectionFactoryProvider.getDriver.

Doc from io.r2dbc.spi.ConnectionFactoryProvider.getDriver.

Returns the driver identifier used by the driver. The identifier for drivers would be the value applicable to ConnectionFactoryOptions#DRIVER

Returns:String

the driver identifier used by the driver

Annotations
@Override
supportsback to summary
public boolean supports(ConnectionFactoryOptions connectionFactoryOptions)

Implements io.r2dbc.spi.ConnectionFactoryProvider.supports.

Doc from io.r2dbc.spi.ConnectionFactoryProvider.supports.

Whether this ConnectionFactoryProvider supports this collection of ConnectionFactoryOptions.

Parameters
connectionFactoryOptions:ConnectionFactoryOptions

a collection of ConnectionFactoryOptions

Returns:boolean

true if this ConnectionFactoryProvider supports this collection of ConnectionFactoryOptions, false otherwise

Annotations
@Override