com.zaxxer.hikari

Class HikariConfig

java.lang.Object

com.zaxxer.hikari.HikariConfig

All Implemented Interfaces:

HikariConfigMBean

public final class HikariConfig
extends Object
implements HikariConfigMBean

Constructor Summary

Constructors

Constructor and Description
HikariConfig() Default constructor
HikariConfig(String propertyFileName) Construct a HikariConfig from the specified property file name.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDataSourceProperty(String propertyName, String value)
int	getAcquireIncrement() This property controls the maximum number of connections that are acquired at one time, with the exception of pool initialization.
int	getAcquireRetries() This is a per-connection attempt retry count used during new connection creation (acquisition).
long	getAcquireRetryDelay() This property controls the number of milliseconds to delay between attempts to acquire a connection to the database.
String	getConnectionTestQuery()
long	getConnectionTimeout() This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API.
String	getDataSourceClassName()
Properties	getDataSourceProperties()
long	getIdleTimeout() This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool.
long	getLeakDetectionThreshold() This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
int	getMaximumPoolSize() The property controls the minimum number of connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.
long	getMaxLifetime() This property controls the maximum lifetime of a connection in the pool.
int	getMinimumPoolSize() The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections.
String	getPoolName() The name of the connection pool.
boolean	isAutoCommit()
boolean	isJdbc4ConnectionTest()
void	setAcquireIncrement(int acquireIncrement) This property controls the maximum number of connections that are acquired at one time, with the exception of pool initialization.
void	setAcquireRetries(int acquireRetries) This is a per-connection attempt retry count used during new connection creation (acquisition).
void	setAcquireRetryDelay(long acquireRetryDelayMs) This property controls the number of milliseconds to delay between attempts to acquire a connection to the database.
void	setAutoCommit(boolean isAutoCommit)
void	setConnectionTestQuery(String connectionTestQuery)
void	setConnectionTimeout(long connectionTimeoutMs) This is for "legacy" databases that do not support the JDBC4 {code Connection.isValid()} API.
void	setDataSourceClassName(String className)
void	setIdleTimeout(long idleTimeoutMs) This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool.
void	setJdbc4ConnectionTest(boolean useIsValid)
void	setLeakDetectionThreshold(long leakDetectionThresholdMs) This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
void	setMaximumPoolSize(int maxPoolSize) The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections.
void	setMaxLifetime(long maxLifetimeMs) This property controls the maximum lifetime of a connection in the pool.
void	setMinimumPoolSize(int minPoolSize) The property controls the minimum number of connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.
void	setPoolName(String poolName) Set the name of the connection pool.
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

HikariConfig

public HikariConfig()

Default constructor

HikariConfig

public HikariConfig(String propertyFileName)

Construct a HikariConfig from the specified property file name.

Parameters:

propertyFileName - the name of the property file

Method Detail

addDataSourceProperty

public void addDataSourceProperty(String propertyName,
                         String value)

getDataSourceProperties

public Properties getDataSourceProperties()

getAcquireIncrement

public int getAcquireIncrement()

This property controls the maximum number of connections that are acquired at one time, with the exception of pool initialization.

Specified by:

getAcquireIncrement in interface HikariConfigMBean

Returns:

the acquire increment

setAcquireIncrement

public void setAcquireIncrement(int acquireIncrement)

This property controls the maximum number of connections that are acquired at one time, with the exception of pool initialization.

Specified by:

setAcquireIncrement in interface HikariConfigMBean

Parameters:

acquireIncrement - the acquire increment

getAcquireRetries

public int getAcquireRetries()

This is a per-connection attempt retry count used during new connection creation (acquisition). If a connection creation attempt fails there will be a wait of HikariConfigMBean.getAcquireRetryDelay() milliseconds followed by another attempt, up to the number of retries configured by this property.

Specified by:

getAcquireRetries in interface HikariConfigMBean

Returns:

the acquire retry count

setAcquireRetries

public void setAcquireRetries(int acquireRetries)

This is a per-connection attempt retry count used during new connection creation (acquisition). If a connection creation attempt fails there will be a wait of HikariConfigMBean.setAcquireRetryDelay(long) milliseconds followed by another attempt, up to the number of retries configured by this property.

Specified by:

setAcquireRetries in interface HikariConfigMBean

Parameters:

acquireRetries - the acquire retry count

getAcquireRetryDelay

public long getAcquireRetryDelay()

This property controls the number of milliseconds to delay between attempts to acquire a connection to the database. If acquireRetries is 0, this property has no effect.

Specified by:

getAcquireRetryDelay in interface HikariConfigMBean

Returns:

the acquire retry delay in milliseconds

setAcquireRetryDelay

public void setAcquireRetryDelay(long acquireRetryDelayMs)

This property controls the number of milliseconds to delay between attempts to acquire a connection to the database. If acquireRetries is 0, this property has no effect.

Specified by:

setAcquireRetryDelay in interface HikariConfigMBean

Parameters:

acquireRetryDelayMs - the acquire retry delay in milliseconds

getConnectionTestQuery

public String getConnectionTestQuery()

setConnectionTestQuery

public void setConnectionTestQuery(String connectionTestQuery)

getConnectionTimeout

public long getConnectionTimeout()

This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API. This is the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive. It is database dependent and should be a query that takes very little processing by the database (eg. "VALUES 1"). See the {code getJdbc4ConnectionTest()} property for a more efficent alive test. One of either this property or jdbc4ConnectionTest must be specified.

Specified by:

getConnectionTimeout in interface HikariConfigMBean

Returns:

the connection timeout in milliseconds

setConnectionTimeout

public void setConnectionTimeout(long connectionTimeoutMs)

This is for "legacy" databases that do not support the JDBC4 {code Connection.isValid()} API. This is the query that will be executed just before a connection is given to you from the pool to validate that the connection to the database is still alive. It is database dependent and should be a query that takes very little processing by the database (eg. "VALUES 1"). See the setJdbc4ConnectionTest() property for a more efficent alive test. One of either this property or jdbc4ConnectionTest must be specified.

Specified by:

setConnectionTimeout in interface HikariConfigMBean

Parameters:

connectionTimeoutMs - the connection timeout in milliseconds

getDataSourceClassName

public String getDataSourceClassName()

setDataSourceClassName

public void setDataSourceClassName(String className)

getIdleTimeout

public long getIdleTimeout()

This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 means that idle connections are never removed from the pool.

Specified by:

getIdleTimeout in interface HikariConfigMBean

Returns:

the idle timeout in milliseconds

setIdleTimeout

public void setIdleTimeout(long idleTimeoutMs)

This property controls the maximum amount of time (in milliseconds) that a connection is allowed to sit idle in the pool. Whether a connection is retired as idle or not is subject to a maximum variation of +30 seconds, and average variation of +15 seconds. A connection will never be retired as idle before this timeout. A value of 0 means that idle connections are never removed from the pool.

Specified by:

setIdleTimeout in interface HikariConfigMBean

Parameters:

idleTimeoutMs - the idle timeout in milliseconds

isAutoCommit

public boolean isAutoCommit()

setAutoCommit

public void setAutoCommit(boolean isAutoCommit)

isJdbc4ConnectionTest

public boolean isJdbc4ConnectionTest()

setJdbc4ConnectionTest

public void setJdbc4ConnectionTest(boolean useIsValid)

getLeakDetectionThreshold

public long getLeakDetectionThreshold()

This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. A value of 0 means leak detection is disabled.

Specified by:

getLeakDetectionThreshold in interface HikariConfigMBean

Returns:

the connection leak detection threshold in milliseconds

setLeakDetectionThreshold

public void setLeakDetectionThreshold(long leakDetectionThresholdMs)

This property controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. A value of 0 means leak detection is disabled.

Specified by:

setLeakDetectionThreshold in interface HikariConfigMBean

Parameters:

leakDetectionThresholdMs - the connection leak detection threshold in milliseconds

getMaxLifetime

public long getMaxLifetime()

This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed.

Specified by:

getMaxLifetime in interface HikariConfigMBean

Returns:

the maximum connection lifetime in milliseconds

setMaxLifetime

public void setMaxLifetime(long maxLifetimeMs)

This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed.

Specified by:

setMaxLifetime in interface HikariConfigMBean

Parameters:

maxLifetimeMs - the maximum connection lifetime in milliseconds

getMinimumPoolSize

public int getMinimumPoolSize()

The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections. Basically this value will determine the maximum number of actual connections to the database backend.

When the pool reaches this size, and no idle connections are available, calls to getConnection() will block for up to connectionTimeout milliseconds before timing out.

Specified by:

getMinimumPoolSize in interface HikariConfigMBean

Returns:

the minimum number of connections in the pool

setMinimumPoolSize

public void setMinimumPoolSize(int minPoolSize)

The property controls the minimum number of connections that HikariCP tries to maintain in the pool, including both idle and in-use connections. If the connections dip below this value, HikariCP will make a best effort to restore them quickly and efficiently.

Specified by:

setMinimumPoolSize in interface HikariConfigMBean

Parameters:

minPoolSize - the minimum number of connections in the pool

getMaximumPoolSize

public int getMaximumPoolSize()

The property controls the minimum number of connections that HikariCP tries to maintain in the pool, including both idle and in-use connections. If the connections dip below this value, HikariCP will make a best effort to restore them quickly and efficiently.

Specified by:

getMaximumPoolSize in interface HikariConfigMBean

Returns:

the maximum number of connections in the pool

setMaximumPoolSize

public void setMaximumPoolSize(int maxPoolSize)

The property controls the maximum size that the pool is allowed to reach, including both idle and in-use connections. Basically this value will determine the maximum number of actual connections to the database backend.

When the pool reaches this size, and no idle connections are available, calls to getConnection() will block for up to connectionTimeout milliseconds before timing out.

Specified by:

setMaximumPoolSize in interface HikariConfigMBean

Parameters:

maxPoolSize - the maximum number of connections in the pool

getPoolName

public String getPoolName()

The name of the connection pool.

Specified by:

getPoolName in interface HikariConfigMBean

Returns:

the name of the connection pool

setPoolName

public void setPoolName(String poolName)

Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration.

Parameters:

poolName - the name of the connection pool to use

validate

public void validate()