com.zaxxer.hikari.pool

Class BaseHikariPool

java.lang.Object

com.zaxxer.hikari.pool.BaseHikariPool

All Implemented Interfaces:

HikariPoolMXBean, IBagStateListener

public abstract class BaseHikariPool
extends Object
implements HikariPoolMXBean, IBagStateListener

This is the primary connection pool class that provides the basic pooling behavior for HikariCP.

Author:

Brett Wooldridge

Field Summary

Fields

Modifier and Type	Field and Description
String	catalog
boolean	isAutoCommit
boolean	isReadOnly
int	transactionIsolation

Constructor Summary

Constructors

Constructor and Description
BaseHikariPool(HikariConfig configuration) Construct a HikariPool with the specified configuration.
BaseHikariPool(HikariConfig configuration, String username, String password) Construct a HikariPool with the specified configuration.

Method Summary

Modifier and Type	Method and Description
Future<Boolean>	addBagItem()
void	evictConnection(IHikariConnectionProxy proxyConnection) Evict a connection from the pool.
int	getActiveConnections()
HikariConfig	getConfiguration() Get the pool configuration object.
Connection	getConnection() Get a connection from the pool, or timeout after connectionTimeout milliseconds.
Connection	getConnection(long hardTimeout) Get a connection from the pool, or timeout after the specified number of milliseconds.
DataSource	getDataSource() Get the wrapped DataSource.
int	getIdleConnections()
int	getThreadsAwaitingConnection()
int	getTotalConnections()
void	logPoolState(String... prefix)
void	releaseConnection(PoolBagEntry bagEntry) Release a connection back to the pool, or permanently close it if it is broken.
void	resumePool()
void	setHealthCheckRegistry(Object healthCheckRegistry)
void	setMetricRegistry(Object metricRegistry)
void	shutdown() Shutdown the pool, closing all idle connections and aborting or closing active connections.
void	suspendPool()
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.zaxxer.hikari.pool.HikariPoolMXBean

softEvictConnections

Field Detail

catalog

public final String catalog

isReadOnly

public final boolean isReadOnly

isAutoCommit

public final boolean isAutoCommit

transactionIsolation

public int transactionIsolation

Constructor Detail

BaseHikariPool

public BaseHikariPool(HikariConfig configuration)

Construct a HikariPool with the specified configuration.

Parameters:

configuration - a HikariConfig instance

BaseHikariPool

public BaseHikariPool(HikariConfig configuration,
                      String username,
                      String password)

Construct a HikariPool with the specified configuration. We cache lots of configuration items in class-local final members for speed.

Parameters:

configuration - a HikariConfig instance

username - authentication username

password - authentication password

Method Detail

getConnection

public final Connection getConnection()
                               throws SQLException

Get a connection from the pool, or timeout after connectionTimeout milliseconds.

Returns:

a java.sql.Connection instance

Throws:

SQLException - thrown if a timeout occurs trying to obtain a connection

getConnection

public final Connection getConnection(long hardTimeout)
                               throws SQLException

Get a connection from the pool, or timeout after the specified number of milliseconds.

Parameters:

hardTimeout - the maximum time to wait for a connection from the pool

Returns:

a java.sql.Connection instance

Throws:

SQLException - thrown if a timeout occurs trying to obtain a connection

releaseConnection

public final void releaseConnection(PoolBagEntry bagEntry)

Release a connection back to the pool, or permanently close it if it is broken.

Parameters:

bagEntry - the PoolBagEntry to release back to the pool

shutdown

public final void shutdown()
                    throws InterruptedException

Shutdown the pool, closing all idle connections and aborting or closing active connections.

Throws:

InterruptedException - thrown if the thread is interrupted during shutdown

evictConnection

public final void evictConnection(IHikariConnectionProxy proxyConnection)

Evict a connection from the pool.

Parameters:

proxyConnection - the connection to evict

getDataSource

public final DataSource getDataSource()

Get the wrapped DataSource.

Returns:

the wrapped DataSource

getConfiguration

public final HikariConfig getConfiguration()

Get the pool configuration object.

Returns:

the HikariConfig for this pool

toString

public String toString()

Overrides:

toString in class Object

getActiveConnections

public final int getActiveConnections()

Specified by:

getActiveConnections in interface HikariPoolMXBean

getIdleConnections

public final int getIdleConnections()

Specified by:

getIdleConnections in interface HikariPoolMXBean

getTotalConnections

public final int getTotalConnections()

Specified by:

getTotalConnections in interface HikariPoolMXBean

getThreadsAwaitingConnection

public final int getThreadsAwaitingConnection()

Specified by:

getThreadsAwaitingConnection in interface HikariPoolMXBean

suspendPool

public final void suspendPool()

Specified by:

suspendPool in interface HikariPoolMXBean

resumePool

public final void resumePool()

Specified by:

resumePool in interface HikariPoolMXBean

setMetricRegistry

public void setMetricRegistry(Object metricRegistry)

setHealthCheckRegistry

public void setHealthCheckRegistry(Object healthCheckRegistry)

addBagItem

public Future<Boolean> addBagItem()

Specified by:

addBagItem in interface IBagStateListener

logPoolState

public final void logPoolState(String... prefix)