Module io.agroal.api

Package io.agroal.api.configuration

Interface AgroalConnectionPoolConfiguration.ConnectionValidator

Enclosing interface:

AgroalConnectionPoolConfiguration

public static interface AgroalConnectionPoolConfiguration.ConnectionValidator

Interface for custom connection validation strategies.

Method Summary

Modifier and Type	Method	Description
static AgroalConnectionPoolConfiguration.ConnectionValidator	defaultValidator()	The default validation strategy Connection.isValid(int)
static AgroalConnectionPoolConfiguration.ConnectionValidator	defaultValidatorWithTimeout(int timeout)	The default validation strategy with a timeout (in seconds).
static AgroalConnectionPoolConfiguration.ConnectionValidator	emptyValidator()	A validator that never invalidates connections.
boolean	isValid(Connection connection)
static AgroalConnectionPoolConfiguration.ConnectionValidator	sqlValidator(String sql, int timeoutSeconds)	A validator that uses the provided SQL statement for validation with a timeout (in seconds).

Method Details

defaultValidator

static AgroalConnectionPoolConfiguration.ConnectionValidator defaultValidator()

The default validation strategy Connection.isValid(int)

defaultValidatorWithTimeout

static AgroalConnectionPoolConfiguration.ConnectionValidator defaultValidatorWithTimeout(int timeout)

The default validation strategy with a timeout (in seconds). If the timeout period expires before the operation completes, the connection is invalidated.

emptyValidator

static AgroalConnectionPoolConfiguration.ConnectionValidator emptyValidator()

A validator that never invalidates connections.

sqlValidator

static AgroalConnectionPoolConfiguration.ConnectionValidator sqlValidator(String sql,
 int timeoutSeconds)

A validator that uses the provided SQL statement for validation with a timeout (in seconds). If the timeout period expires before the operation completes, the connection is invalidated. A timeout of 0 means no timeout.

isValid

boolean isValid(Connection connection)

Returns:

true if a connection is valid, false otherwise