Package io.agroal.api.configuration.supplier

Class AgroalConnectionPoolConfigurationSupplier

java.lang.Object

io.agroal.api.configuration.supplier.AgroalConnectionPoolConfigurationSupplier

All Implemented Interfaces:

Supplier<AgroalConnectionPoolConfiguration>

public class AgroalConnectionPoolConfigurationSupplier
extends Object
implements Supplier<AgroalConnectionPoolConfiguration>

Builder of AgroalConnectionPoolConfiguration.

Author:

Luis Barreiro

Constructor Summary

Constructors

Constructor	Description
AgroalConnectionPoolConfigurationSupplier()
AgroalConnectionPoolConfigurationSupplier(AgroalConnectionPoolConfiguration existingConfiguration)

Method Summary

Modifier and Type	Method	Description
AgroalConnectionPoolConfigurationSupplier	acquisitionTimeout(Duration timeout)	Sets the duration of the acquisition timeout.
AgroalConnectionPoolConfigurationSupplier	connectionCache(ConnectionCache cache)	Sets the connection cache implementation.
AgroalConnectionFactoryConfigurationSupplier	connectionFactoryConfiguration()	Allows access to the configuration builder for the connection pool.
AgroalConnectionPoolConfigurationSupplier	connectionFactoryConfiguration(Function<? super AgroalConnectionFactoryConfigurationSupplier,? extends AgroalConnectionFactoryConfigurationSupplier> function)	Modifies the configuration of the connection pool.
AgroalConnectionPoolConfigurationSupplier	connectionFactoryConfiguration(Supplier<? extends AgroalConnectionFactoryConfiguration> supplier)	Sets the configuration for the connection factory.
AgroalConnectionPoolConfigurationSupplier	connectionValidator(AgroalConnectionPoolConfiguration.ConnectionValidator validator)	Sets the connection validation method.
AgroalConnectionPoolConfigurationSupplier	enhancedLeakReport()	Enables enhanced leak report.
AgroalConnectionPoolConfigurationSupplier	enhancedLeakReport(boolean enhanced)	Enables or disables enhanced leak report.
AgroalConnectionPoolConfigurationSupplier	exceptionSorter(AgroalConnectionPoolConfiguration.ExceptionSorter sorter)	Sets the exception sorter.
AgroalConnectionPoolConfigurationSupplier	flushOnClose()	Enables flushing of connections on close.
AgroalConnectionPoolConfigurationSupplier	flushOnClose(boolean flush)	Enables or disables flushing of connections on close.
AgroalConnectionPoolConfiguration	get()
AgroalConnectionPoolConfigurationSupplier	idleValidationTimeout(Duration timeout)	Sets the duration of idle time for foreground validation to be executed.
AgroalConnectionPoolConfigurationSupplier	initialSize(int size)	Sets the number of connections when the pool starts.
AgroalConnectionPoolConfigurationSupplier	leakTimeout(Duration timeout)	Sets the duration of the leak timeout detection.
AgroalConnectionPoolConfigurationSupplier	maxLifetime(Duration time)	Sets the duration for the lifetime of connections.
AgroalConnectionPoolConfigurationSupplier	maxSize(int size)	Sets the maximum number of connections on the pool.
AgroalConnectionPoolConfigurationSupplier	minSize(int size)	Sets the minimum number of connections on the pool.
AgroalConnectionPoolConfigurationSupplier	multipleAcquisition(AgroalConnectionPoolConfiguration.MultipleAcquisitionAction action)	Sets the behaviour of the pool when a thread tries to acquire multiple connections.
AgroalConnectionPoolConfigurationSupplier	reapTimeout(Duration timeout)	Sets the duration for eviction of idle connections.
AgroalConnectionPoolConfigurationSupplier	recoveryEnable()
AgroalConnectionPoolConfigurationSupplier	recoveryEnable(boolean enable)
AgroalConnectionPoolConfigurationSupplier	transactionIntegration(TransactionIntegration integration)	Sets the transaction integration instance to use.
AgroalConnectionPoolConfigurationSupplier	transactionRequirement(AgroalConnectionPoolConfiguration.TransactionRequirement requirement)	Sets the transaction requirements for the pool.
AgroalConnectionPoolConfigurationSupplier	validateOnBorrow(boolean validate)	Enables validation on borrow.
AgroalConnectionPoolConfigurationSupplier	validationTimeout(Duration timeout)	Sets the duration of background validation interval.

Methods inherited from class java.lang.Object

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

Constructor Details

AgroalConnectionPoolConfigurationSupplier

public AgroalConnectionPoolConfigurationSupplier()

AgroalConnectionPoolConfigurationSupplier

public AgroalConnectionPoolConfigurationSupplier(AgroalConnectionPoolConfiguration existingConfiguration)

Method Details

connectionFactoryConfiguration

public AgroalConnectionPoolConfigurationSupplier connectionFactoryConfiguration(Supplier<? extends AgroalConnectionFactoryConfiguration> supplier)

Sets the configuration for the connection factory.

connectionFactoryConfiguration

public AgroalConnectionPoolConfigurationSupplier connectionFactoryConfiguration(Function<? super AgroalConnectionFactoryConfigurationSupplier,? extends AgroalConnectionFactoryConfigurationSupplier> function)

Modifies the configuration of the connection pool.

connectionFactoryConfiguration

public AgroalConnectionFactoryConfigurationSupplier connectionFactoryConfiguration()

Allows access to the configuration builder for the connection pool.

connectionCache

public AgroalConnectionPoolConfigurationSupplier connectionCache(ConnectionCache cache)

Sets the connection cache implementation. Default is LocalConnectionCache.single().

transactionIntegration

public AgroalConnectionPoolConfigurationSupplier transactionIntegration(TransactionIntegration integration)

Sets the transaction integration instance to use. Default is TransactionIntegration.none().

transactionRequirement

public AgroalConnectionPoolConfigurationSupplier transactionRequirement(AgroalConnectionPoolConfiguration.TransactionRequirement requirement)

Sets the transaction requirements for the pool. Default is AgroalConnectionPoolConfiguration.TransactionRequirement.OFF.

enhancedLeakReport

public AgroalConnectionPoolConfigurationSupplier enhancedLeakReport()

Enables enhanced leak report.

multipleAcquisition

public AgroalConnectionPoolConfigurationSupplier multipleAcquisition(AgroalConnectionPoolConfiguration.MultipleAcquisitionAction action)

Sets the behaviour of the pool when a thread tries to acquire multiple connections. Default is AgroalConnectionPoolConfiguration.MultipleAcquisitionAction.OFF

enhancedLeakReport

public AgroalConnectionPoolConfigurationSupplier enhancedLeakReport(boolean enhanced)

Enables or disables enhanced leak report. Default is false.

flushOnClose

public AgroalConnectionPoolConfigurationSupplier flushOnClose()

Enables flushing of connections on close.

flushOnClose

public AgroalConnectionPoolConfigurationSupplier flushOnClose(boolean flush)

Enables or disables flushing of connections on close. Default is false.

recoveryEnable

public AgroalConnectionPoolConfigurationSupplier recoveryEnable()

recoveryEnable

public AgroalConnectionPoolConfigurationSupplier recoveryEnable(boolean enable)

initialSize

public AgroalConnectionPoolConfigurationSupplier initialSize(int size)

Sets the number of connections when the pool starts. Must not be negative. Default is zero.

minSize

public AgroalConnectionPoolConfigurationSupplier minSize(int size)

Sets the minimum number of connections on the pool. Must not be negative and smaller than max. Default is zero.

maxSize

public AgroalConnectionPoolConfigurationSupplier maxSize(int size)

Sets the maximum number of connections on the pool. Must not be negative. Required.

validateOnBorrow

public AgroalConnectionPoolConfigurationSupplier validateOnBorrow(boolean validate)

Enables validation on borrow. Default is false.

connectionValidator

public AgroalConnectionPoolConfigurationSupplier connectionValidator(AgroalConnectionPoolConfiguration.ConnectionValidator validator)

Sets the connection validation method. Default AgroalConnectionPoolConfiguration.ConnectionValidator.emptyValidator()

exceptionSorter

public AgroalConnectionPoolConfigurationSupplier exceptionSorter(AgroalConnectionPoolConfiguration.ExceptionSorter sorter)

Sets the exception sorter. Default AgroalConnectionPoolConfiguration.ExceptionSorter.emptyExceptionSorter()

acquisitionTimeout

public AgroalConnectionPoolConfigurationSupplier acquisitionTimeout(Duration timeout)

Sets the duration of the acquisition timeout. Default is Duration.ZERO meaning that a thread will wait indefinitely.

idleValidationTimeout

public AgroalConnectionPoolConfigurationSupplier idleValidationTimeout(Duration timeout)

Sets the duration of idle time for foreground validation to be executed. Default is Duration.ZERO meaning that this feature is disabled.

leakTimeout

public AgroalConnectionPoolConfigurationSupplier leakTimeout(Duration timeout)

Sets the duration of the leak timeout detection. Default is Duration.ZERO meaning that this feature is disabled.

validationTimeout

public AgroalConnectionPoolConfigurationSupplier validationTimeout(Duration timeout)

Sets the duration of background validation interval. Default is Duration.ZERO meaning that this feature is disabled.

reapTimeout

public AgroalConnectionPoolConfigurationSupplier reapTimeout(Duration timeout)

Sets the duration for eviction of idle connections. Default is Duration.ZERO meaning that this feature is disabled.

maxLifetime

public AgroalConnectionPoolConfigurationSupplier maxLifetime(Duration time)

Sets the duration for the lifetime of connections. Default is Duration.ZERO meaning that this feature is disabled.

get

public AgroalConnectionPoolConfiguration get()

Specified by:

get in interface Supplier<AgroalConnectionPoolConfiguration>