com.zaxxer.hikari.util

Class PoolUtilities

java.lang.Object

com.zaxxer.hikari.util.PoolUtilities

public final class PoolUtilities
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PoolUtilities()

Method Summary

Modifier and Type	Method and Description
static <T> T	createInstance(java.lang.String className, java.lang.Class<T> clazz, java.lang.Object... args) Create and instance of the specified class using the constructor matching the specified arguments.
static java.util.concurrent.ThreadPoolExecutor	createThreadPoolExecutor(int queueSize, java.lang.String threadName, java.util.concurrent.ThreadFactory threadFactory, java.util.concurrent.RejectedExecutionHandler policy) Create a ThreadPoolExecutor.
static long	elapsedTimeMs(long start) Get the elapsed time in millisecond between the specified start time and now.
static void	executeSql(java.sql.Connection connection, java.lang.String sql, boolean isAutoCommit) Execute the user-specified init SQL.
static int	getTransactionIsolation(java.lang.String transactionIsolationName) Get the int value of a transaction isolation level by name.
static javax.sql.DataSource	initializeDataSource(java.lang.String dsClassName, javax.sql.DataSource dataSource, java.util.Properties dataSourceProperties, java.lang.String jdbcUrl, java.lang.String username, java.lang.String password) Create/initialize the underlying DataSource.
static boolean	isJdbc40Compliant(java.sql.Connection connection) Return true if the driver appears to be JDBC 4.0 compliant.
static void	quietlyCloseConnection(java.sql.Connection connection) Close connection and eat any exception.
static void	quietlySleep(long millis) Sleep and transform an InterruptedException into a RuntimeException.
static void	setLoginTimeout(javax.sql.DataSource dataSource, long connectionTimeout, org.slf4j.Logger logger) Set the loginTimeout on the specified DataSource.
static int	setNetworkTimeout(java.util.concurrent.Executor executor, java.sql.Connection connection, long timeoutMs, boolean isUseNetworkTimeout) Set the network timeout, if isUseNetworkTimeout is true, and return the pre-existing value of the network timeout.
static void	setQueryTimeout(java.sql.Statement statement, int timeoutSec) Set the query timeout, if it is supported by the driver.
static void	setupConnection(java.sql.Connection connection, boolean isAutoCommit, boolean isReadOnly, int transactionIsolation, java.lang.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()

Method Detail

quietlyCloseConnection

public static void quietlyCloseConnection(java.sql.Connection connection)

Close connection and eat any exception.

Parameters:

connection - the connection to close

elapsedTimeMs

public static long elapsedTimeMs(long start)

Get the elapsed time in millisecond between the specified start time and now.

Parameters:

start - the start time

Returns:

the elapsed milliseconds

executeSql

public static void executeSql(java.sql.Connection connection,
                              java.lang.String sql,
                              boolean isAutoCommit)
                       throws java.sql.SQLException

Execute the user-specified init SQL.

Parameters:

connection - the connection to initialize

sql - the SQL to execute

Throws:

java.sql.SQLException - throws if the init SQL execution fails

quietlySleep

public static void quietlySleep(long millis)

Sleep and transform an InterruptedException into a RuntimeException.

Parameters:

millis - the number of milliseconds to sleep

createInstance

public static <T> T createInstance(java.lang.String className,
                                   java.lang.Class<T> clazz,
                                   java.lang.Object... args)

Create and instance of the specified class using the constructor matching the specified arguments.

Parameters:

className - the name of the classto instantiate

clazz - a class to cast the result as

args - arguments to a constructor

Returns:

an instance of the specified class

initializeDataSource

public static javax.sql.DataSource initializeDataSource(java.lang.String dsClassName,
                                                        javax.sql.DataSource dataSource,
                                                        java.util.Properties dataSourceProperties,
                                                        java.lang.String jdbcUrl,
                                                        java.lang.String username,
                                                        java.lang.String password)

Create/initialize the underlying DataSource.

Returns:

the DataSource

getTransactionIsolation

public static int getTransactionIsolation(java.lang.String transactionIsolationName)

Get the int value of a transaction isolation level by name.

Parameters:

transactionIsolationName - the name of the transaction isolation level

Returns:

the int value of the isolation level or -1

setupConnection

public static void setupConnection(java.sql.Connection connection,
                                   boolean isAutoCommit,
                                   boolean isReadOnly,
                                   int transactionIsolation,
                                   java.lang.String catalog)
                            throws java.sql.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:

java.sql.SQLException - thrown from driver

createThreadPoolExecutor

public static java.util.concurrent.ThreadPoolExecutor createThreadPoolExecutor(int queueSize,
                                                                               java.lang.String threadName,
                                                                               java.util.concurrent.ThreadFactory threadFactory,
                                                                               java.util.concurrent.RejectedExecutionHandler policy)

Create a ThreadPoolExecutor.

Parameters:

queueSize - the queue size

threadName - the thread name

threadFactory - an optional ThreadFactory

Returns:

a ThreadPoolExecutor

isJdbc40Compliant

public static boolean isJdbc40Compliant(java.sql.Connection connection)
                                 throws java.sql.SQLException

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

Throws:

java.sql.SQLException - re-thrown exception from Connection.getNetworkTimeout()

setQueryTimeout

public static void setQueryTimeout(java.sql.Statement statement,
                                   int timeoutSec)
                            throws java.sql.SQLException

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

Throws:

java.sql.SQLException - re-thrown exception from Statement.setQueryTimeout()

setNetworkTimeout

public static int setNetworkTimeout(java.util.concurrent.Executor executor,
                                    java.sql.Connection connection,
                                    long timeoutMs,
                                    boolean isUseNetworkTimeout)
                             throws java.sql.SQLException

Set the network timeout, if isUseNetworkTimeout is true, and return the pre-existing value of the network timeout.

Parameters:

executor - an Executor

connection - the connection to set the network timeout on

timeoutMs - the number of milliseconds before timeout

isUseNetworkTimeout - true if the network timeout should be set, false otherwise

Returns:

the pre-existing network timeout value

Throws:

java.sql.SQLException - thrown if the network timeout cannot be set

setLoginTimeout

public static void setLoginTimeout(javax.sql.DataSource dataSource,
                                   long connectionTimeout,
                                   org.slf4j.Logger logger)

Set the loginTimeout on the specified DataSource.

Parameters:

dataSource - the DataSource

connectionTimeout - the timeout in milliseconds

logger - a logger to use for a warning