com.zaxxer.hikari.pool

Class HikariPool

java.lang.Object

com.zaxxer.hikari.pool.HikariPool

All Implemented Interfaces:

HikariPoolMBean, ConcurrentBag.IBagStateListener

public final class HikariPool
extends Object
implements HikariPoolMBean, ConcurrentBag.IBagStateListener

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

Author:

Brett Wooldridge

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addBagItem()
void	closeConnection(IHikariConnectionProxy connectionProxy) Permanently close the real (underlying) connection (eat any exception).
void	closeIdleConnections()
int	getActiveConnections()
Connection	getConnection() Get a connection from the pool, or timeout trying.
DataSource	getDataSource() Get the wrapped DataSource.
int	getIdleConnections()
int	getThreadsAwaitingConnection()
int	getTotalConnections()
void	releaseConnection(IHikariConnectionProxy connectionProxy, boolean isBroken) Release a connection back to the pool, or permanently close it if it is broken.
void	shutdown() Shutdown the pool, closing all idle connections and aborting or closing active connections.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HikariPool

public HikariPool(HikariConfig configuration)

Construct a HikariPool with the specified configuration.

Parameters:

configuration - a HikariConfig instance

HikariPool

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

Construct a HikariPool with the specified configuration.

Parameters:

configuration - a HikariConfig instance

username - authentication username

password - authentication password

Method Detail

getConnection

public Connection getConnection()
                         throws SQLException

Get a connection from the pool, or timeout trying.

Returns:

a java.sql.Connection instance

Throws:

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

releaseConnection

public void releaseConnection(IHikariConnectionProxy connectionProxy,
                     boolean isBroken)

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

Parameters:

connectionProxy - the connection to release back to the pool

isBroken - true if the connection was detected as broken

shutdown

public 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

getDataSource

public DataSource getDataSource()

Get the wrapped DataSource.

Returns:

the wrapped DataSource

closeConnection

public void closeConnection(IHikariConnectionProxy connectionProxy)

Permanently close the real (underlying) connection (eat any exception).

Parameters:

connectionProxy - the connection to actually close

toString

public String toString()

Overrides:

toString in class Object

addBagItem

public void addBagItem()

Specified by:

addBagItem in interface ConcurrentBag.IBagStateListener

getActiveConnections

public int getActiveConnections()

Specified by:

getActiveConnections in interface HikariPoolMBean

getIdleConnections

public int getIdleConnections()

Specified by:

getIdleConnections in interface HikariPoolMBean

getTotalConnections

public int getTotalConnections()

Specified by:

getTotalConnections in interface HikariPoolMBean

getThreadsAwaitingConnection

public int getThreadsAwaitingConnection()

Specified by:

getThreadsAwaitingConnection in interface HikariPoolMBean

closeIdleConnections

public void closeIdleConnections()

Specified by:

closeIdleConnections in interface HikariPoolMBean