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 java.lang.Object
implements HikariPoolMBean, ConcurrentBag.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
java.lang.String	catalog
boolean	isAutoCommit
boolean	isReadOnly
int	transactionIsolation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addBagItem()
void	evictConnection(IHikariConnectionProxy proxyConnection) Evict a connection from the pool.
int	getActiveConnections()
HikariConfig	getConfiguration() Get the pool configuration object.
java.sql.Connection	getConnection() Get a connection from the pool, or timeout trying.
javax.sql.DataSource	getDataSource() Get the wrapped DataSource.
int	getIdleConnections()
int	getThreadsAwaitingConnection()
int	getTotalConnections()
void	logPoolState(java.lang.String... prefix)
void	releaseConnection(PoolBagEntry bagEntry, 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.
void	softEvictConnections()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

catalog

public final java.lang.String catalog

isReadOnly

public final boolean isReadOnly

isAutoCommit

public final boolean isAutoCommit

transactionIsolation

public int transactionIsolation

Constructor Detail

HikariPool

public HikariPool(HikariConfig configuration)

Construct a HikariPool with the specified configuration.

Parameters:

configuration - a HikariConfig instance

HikariPool

public HikariPool(HikariConfig configuration,
                  java.lang.String username,
                  java.lang.String password)

Construct a HikariPool with the specified configuration.

Parameters:

configuration - a HikariConfig instance

username - authentication username

password - authentication password

Method Detail

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Get a connection from the pool, or timeout trying.

Returns:

a java.sql.Connection instance

Throws:

java.sql.SQLException - thrown if a timeout occurs trying to obtain a connection

releaseConnection

public void releaseConnection(PoolBagEntry bagEntry,
                              boolean isBroken)

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

isBroken - true if the connection was detected as broken

shutdown

public void shutdown()
              throws java.lang.InterruptedException

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

Throws:

java.lang.InterruptedException - thrown if the thread is interrupted during shutdown

evictConnection

public void evictConnection(IHikariConnectionProxy proxyConnection)

Evict a connection from the pool.

Parameters:

proxyConnection - the connection to evict

getDataSource

public javax.sql.DataSource getDataSource()

Get the wrapped DataSource.

Returns:

the wrapped DataSource

getConfiguration

public HikariConfig getConfiguration()

Get the pool configuration object.

Returns:

the HikariConfig for this pool

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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

softEvictConnections

public void softEvictConnections()

Specified by:

softEvictConnections in interface HikariPoolMBean

logPoolState

public void logPoolState(java.lang.String... prefix)