Module is.codion.common.db

Package is.codion.common.db.pool

Class AbstractConnectionPoolWrapper<T>

java.lang.Object

is.codion.common.db.pool.AbstractConnectionPoolWrapper<T>

Type Parameters:

T - the type representing the actual pool object

All Implemented Interfaces:

ConnectionPoolWrapper

public abstract class AbstractConnectionPoolWrapper<T>
extends Object
implements ConnectionPoolWrapper

A default base implementation of the ConnectionPool wrapper, handling the collection of statistics

Field Summary

Fields inherited from interface is.codion.common.db.pool.ConnectionPoolWrapper

CHECK_OUT_TIMEOUT, IDLE_TIMEOUT, MAXIMUM_POOL_SIZE, MINIMUM_POOL_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConnectionPoolWrapper(ConnectionFactory connectionFactory, User user, DataSource dataSource, Function<DataSource,T> poolFactory)	Instantiates a new AbstractConnectionPoolWrapper instance.

Method Summary

Modifier and Type	Method	Description
protected abstract int	available()
protected final void	closeStatisticsCollection()	Marks this pool as closed (causing subsequent connection(User) calls to throw IllegalStateException) and cleans up statistics collection resources to prevent resource leaks.
final boolean	collectCheckOutTimes()	Returns true if connection check out times are being collected.
final void	collectCheckOutTimes(boolean collectCheckOutTimes)	Specifies whether to collect connection check out times.
final boolean	collectSnapshotStatistics()	Returns true if snapshot statistics are being collected.
final void	collectSnapshotStatistics(boolean collectSnapshotStatistics)	Specifies whether to collect usage statistics for a snapshot.
final Connection	connection(User user)	Fetches a connection from the pool.
protected final T	connectionPool()
protected abstract Connection	fetchConnection()	Fetches a connection from the underlying pool.
protected abstract int	inUse()
final void	resetStatistics()	Resets the collected usage statistics
final ConnectionPoolStatistics	statistics(long since)	Retrieves usage statistics for the connection pool.
final User	user()
protected abstract int	waiting()

Methods inherited from class java.lang.Object

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

Methods inherited from interface is.codion.common.db.pool.ConnectionPoolWrapper

cleanupInterval, cleanupInterval, close, idleTimeout, idleTimeout, maximumCheckOutTime, maximumCheckOutTime, maximumPoolSize, maximumPoolSize, minimumPoolSize, minimumPoolSize

Constructor Details

AbstractConnectionPoolWrapper

protected AbstractConnectionPoolWrapper(ConnectionFactory connectionFactory,
 User user,
 DataSource dataSource,
 Function<DataSource,T> poolFactory)

Instantiates a new AbstractConnectionPoolWrapper instance.

Parameters:

connectionFactory - the connection factory

user - the connection pool user

dataSource - the data source

poolFactory - creates the actual connection pool based on the given data source

Method Details

user

public final User user()

Specified by:

user in interface ConnectionPoolWrapper

Returns:

the user this connection pool is based on.

connection

public final Connection connection(User user)

Description copied from interface: ConnectionPoolWrapper

Fetches a connection from the pool. Close the connection to return it to the pool.

Note that user is a credentials check, not a selector: the pool serves a single ConnectionPoolWrapper.user(), and the given credentials are verified against it (username case-insensitively, password exactly) before a connection is handed out.

Specified by:

connection in interface ConnectionPoolWrapper

Parameters:

user - the credentials to verify against the pool user

Returns:

a database connection retrieved from the pool

See Also:

• ConnectionPoolWrapper.maximumCheckOutTime(int)
• Connection.close()

resetStatistics

public final void resetStatistics()

Description copied from interface: ConnectionPoolWrapper

Resets the collected usage statistics

Specified by:

resetStatistics in interface ConnectionPoolWrapper

collectSnapshotStatistics

public final boolean collectSnapshotStatistics()

Description copied from interface: ConnectionPoolWrapper

Returns true if snapshot statistics are being collected.

Specified by:

collectSnapshotStatistics in interface ConnectionPoolWrapper

Returns:

true if pool usage statistics for a snapshot should be collected

See Also:

• ConnectionPoolWrapper.statistics(long)
• ConnectionPoolStatistics.snapshot()

collectSnapshotStatistics

public final void collectSnapshotStatistics(boolean collectSnapshotStatistics)

Description copied from interface: ConnectionPoolWrapper

Specifies whether to collect usage statistics for a snapshot.

Specified by:

collectSnapshotStatistics in interface ConnectionPoolWrapper

Parameters:

collectSnapshotStatistics - the value

See Also:

• ConnectionPoolWrapper.statistics(long)
• ConnectionPoolStatistics.snapshot()

collectCheckOutTimes

public final boolean collectCheckOutTimes()

Description copied from interface: ConnectionPoolWrapper

Returns true if connection check out times are being collected.

Specified by:

collectCheckOutTimes in interface ConnectionPoolWrapper

Returns:

true if connection check out times should be collected

See Also:

• ConnectionPoolWrapper.statistics(long)

collectCheckOutTimes

public final void collectCheckOutTimes(boolean collectCheckOutTimes)

Description copied from interface: ConnectionPoolWrapper

Specifies whether to collect connection check out times.

Specified by:

collectCheckOutTimes in interface ConnectionPoolWrapper

Parameters:

collectCheckOutTimes - the value

See Also:

• ConnectionPoolWrapper.statistics(long)

statistics

public final ConnectionPoolStatistics statistics(long since)

Description copied from interface: ConnectionPoolWrapper

Retrieves usage statistics for the connection pool.

Note that this is a destructive read: it resets the per-second counters and consumes the collected check-out times. The since parameter only filters the snapshot statistics list; the counters ignore it. Concurrent monitoring clients polling the same pool will steal each other's data.

Specified by:

statistics in interface ConnectionPoolWrapper

Parameters:

since - the time from which the snapshot statistics should be retrieved

Returns:

connection pool usage statistics

fetchConnection

protected abstract Connection fetchConnection()
                                       throws SQLException

Fetches a connection from the underlying pool.

Returns:

a connection from the underlying pool

Throws:

SQLException - in case of an exception.

connectionPool

protected final T connectionPool()

Returns:

the underlying connection pool instance

available

protected abstract int available()

Returns:

the number of available connections in this pool

inUse

protected abstract int inUse()

Returns:

the number of connections in active use

waiting

protected abstract int waiting()

Returns:

the number of waiting connection requests

closeStatisticsCollection

protected final void closeStatisticsCollection()

Marks this pool as closed (causing subsequent connection(User) calls to throw IllegalStateException) and cleans up statistics collection resources to prevent resource leaks. This method should be called by concrete implementations in their close() methods.