com.zaxxer.hikari.pool

Class PoolUtilities

java.lang.Object

com.zaxxer.hikari.pool.PoolUtilities

public final class PoolUtilities
extends Object

Constructor Summary

Constructors

Constructor and Description
PoolUtilities(HikariConfig configuration)

Method Summary

Modifier and Type	Method and Description
void	executeSql(Connection connection, String sql, boolean isAutoCommit) Execute the user-specified init SQL.
int	getAndSetNetworkTimeout(Connection connection, long timeoutMs) Set the network timeout, if isUseNetworkTimeout is true and the driver supports it.
DataSource	initializeDataSource(String dsClassName, DataSource dataSource, Properties dataSourceProperties, String driverClassName, String jdbcUrl, String username, String password) Create/initialize the underlying DataSource.
boolean	isJdbc4ValidationSupported(Connection connection) Return true if the driver appears to be JDBC 4.0 compliant.
void	quietlyCloseConnection(Connection connection, String closureReason) Close connection and eat any exception.
void	setLoginTimeout(DataSource dataSource, long connectionTimeout) Set the loginTimeout on the specified DataSource.
void	setNetworkTimeout(Connection connection, long timeoutMs) Set the network timeout, if isUseNetworkTimeout is true and the driver supports it.
void	setQueryTimeout(Statement statement, int timeoutSec) Set the query timeout, if it is supported by the driver.
void	setupConnection(Connection connection, boolean isAutoCommit, boolean isReadOnly, int transactionIsolation, String catalog) Setup a connection intial state.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolUtilities

public PoolUtilities(HikariConfig configuration)

Method Detail

quietlyCloseConnection

public void quietlyCloseConnection(Connection connection,
                                   String closureReason)

Close connection and eat any exception.

Parameters:

connection - the connection to close

executeSql

public void executeSql(Connection connection,
                       String sql,
                       boolean isAutoCommit)
                throws SQLException

Execute the user-specified init SQL.

Parameters:

connection - the connection to initialize

sql - the SQL to execute

isAutoCommit - whether to commit the SQL after execution or not

Throws:

SQLException - throws if the init SQL execution fails

initializeDataSource

public DataSource initializeDataSource(String dsClassName,
                                       DataSource dataSource,
                                       Properties dataSourceProperties,
                                       String driverClassName,
                                       String jdbcUrl,
                                       String username,
                                       String password)

Create/initialize the underlying DataSource.

Parameters:

dsClassName - a DataSource class name (optional)

dataSource - a DataSource instance (optional)

dataSourceProperties - a Properties instance of DataSource properties

driverClassName - the JDBC driver class name (optional)

jdbcUrl - a JDBC connection URL (optional)

username - a username (optional)

password - a password (optional)

Returns:

a DataSource instance

setupConnection

public void setupConnection(Connection connection,
                            boolean isAutoCommit,
                            boolean isReadOnly,
                            int transactionIsolation,
                            String catalog)
                     throws SQLException

Setup a connection intial state.

Parameters:

connection - a Connection

isAutoCommit - auto-commit state

isReadOnly - read-only state

transactionIsolation - transaction isolation

catalog - default catalog

Throws:

SQLException - thrown from driver

isJdbc4ValidationSupported

public boolean isJdbc4ValidationSupported(Connection connection)

Return true if the driver appears to be JDBC 4.0 compliant.

Parameters:

connection - a Connection to check

Returns:

true if JDBC 4.1 compliance, false otherwise

setQueryTimeout

public void setQueryTimeout(Statement statement,
                            int timeoutSec)

Set the query timeout, if it is supported by the driver.

Parameters:

statement - a statement to set the query timeout on

timeoutSec - the number of seconds before timeout

getAndSetNetworkTimeout

public int getAndSetNetworkTimeout(Connection connection,
                                   long timeoutMs)

Set the network timeout, if isUseNetworkTimeout is true and the driver supports it. Return the pre-existing value of the network timeout.

Parameters:

connection - the connection to set the network timeout on

timeoutMs - the number of milliseconds before timeout

Returns:

the pre-existing network timeout value

setNetworkTimeout

public void setNetworkTimeout(Connection connection,
                              long timeoutMs)

Set the network timeout, if isUseNetworkTimeout is true and the driver supports it.

Parameters:

connection - the connection to set the network timeout on

timeoutMs - the number of milliseconds before timeout

setLoginTimeout

public void setLoginTimeout(DataSource dataSource,
                            long connectionTimeout)

Set the loginTimeout on the specified DataSource.

Parameters:

dataSource - the DataSource

connectionTimeout - the timeout in milliseconds