com.zaxxer.hikari

Interface HikariConfigMBean

All Known Implementing Classes:

HikariConfig, HikariDataSource

public interface HikariConfigMBean

The javax.management MBean for a Hikiri pool configuration.

Author:

Brett Wooldridge

Method Summary

Methods

Modifier and Type	Method and Description
long	getConnectionTimeout() This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API.
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 maximum number of connections that HikariCP will keep 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	getMinimumIdle() 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.
void	setConnectionTimeout(long connectionTimeoutMs) This is for "legacy" databases that do not support the JDBC4 {code Connection.isValid()} API.
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	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	setMinimumIdle(int minIdle) The property controls the minimum number of idle connections that HikariCP tries to maintain in the pool, including both idle and in-use connections.

Method Detail

getConnectionTimeout

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.

Returns:

the connection timeout in milliseconds

setConnectionTimeout

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.

Parameters:

connectionTimeoutMs - the connection timeout in milliseconds

getIdleTimeout

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.

Returns:

the idle timeout in milliseconds

setIdleTimeout

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.

Parameters:

idleTimeoutMs - the idle timeout in milliseconds

getLeakDetectionThreshold

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.

Returns:

the connection leak detection threshold in milliseconds

setLeakDetectionThreshold

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.

Parameters:

leakDetectionThresholdMs - the connection leak detection threshold in milliseconds

getMaxLifetime

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.

Returns:

the maximum connection lifetime in milliseconds

setMaxLifetime

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.

Parameters:

maxLifetimeMs - the maximum connection lifetime in milliseconds

getMinimumIdle

int getMinimumIdle()

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.

Returns:

the minimum number of connections in the pool

setMinimumIdle

void setMinimumIdle(int minIdle)

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

Parameters:

minIdle - the minimum number of idle connections in the pool to maintain

getMaximumPoolSize

int getMaximumPoolSize()

The property controls the maximum number of connections that HikariCP will keep in the pool, including both idle and in-use connections.

Returns:

the maximum number of connections in the pool

setMaximumPoolSize

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.

Parameters:

maxPoolSize - the maximum number of connections in the pool

getPoolName

String getPoolName()

The name of the connection pool.

Returns:

the name of the connection pool