com.zaxxer.hikari.pool

Class HikariPool

java.lang.Object

com.zaxxer.hikari.pool.HikariPool

All Implemented Interfaces:

HikariPoolMXBean, ConcurrentBag.IBagStateListener

public class HikariPool
extends Object
implements HikariPoolMXBean, ConcurrentBag.IBagStateListener

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

Author:

Brett Wooldridge

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HikariPool.CompletableFuture<T>
static class	HikariPool.PoolInitializationException

Constructor Summary

Constructors

Constructor and Description
HikariPool(HikariConfig config) Construct a HikariPool with the specified configuration.

Method Summary

Methods

Modifier and Type	Method and Description
Future<Boolean>	addBagItem(int waiting)
void	evictConnection(Connection connection) Evict a connection from the pool.
int	getActiveConnections()
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.
int	getIdleConnections()
int	getThreadsAwaitingConnection()
int	getTotalConnections()
DataSource	getUnwrappedDataSource()
void	resumePool()
void	setHealthCheckRegistry(Object healthCheckRegistry)
void	setMetricRegistry(Object metricRegistry)
void	setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory)
void	shutdown() Shutdown the pool, closing all idle connections and aborting or closing active connections.
void	softEvictConnections()
void	suspendPool()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HikariPool

public HikariPool(HikariConfig config)

Construct a HikariPool with the specified configuration.

Parameters:

config - a HikariConfig instance

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

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(Connection connection)

Evict a connection from the pool.

Parameters:

connection - the connection to evict

setMetricRegistry

public void setMetricRegistry(Object metricRegistry)

setMetricsTrackerFactory

public void setMetricsTrackerFactory(MetricsTrackerFactory metricsTrackerFactory)

setHealthCheckRegistry

public void setHealthCheckRegistry(Object healthCheckRegistry)

addBagItem

public Future<Boolean> addBagItem(int waiting)

Specified by:

addBagItem in interface ConcurrentBag.IBagStateListener

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

softEvictConnections

public void softEvictConnections()

Specified by:

softEvictConnections 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

toString

public String toString()

Overrides:

toString in class Object

getUnwrappedDataSource

public DataSource getUnwrappedDataSource()