HikariConfigMBean (HikariCP 1.1.3 API)

All Known Implementing Classes:

HikariConfig
```
public interface HikariConfigMBean
```
The javax.management MBean for a Hikiri pool configuration.

Author:

Brett Wooldridge

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`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 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.
`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`	`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`	`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.

- Method Detail
  - getAcquireIncrement
```
int getAcquireIncrement()
```
    This property controls the maximum number of connections that are acquired at one time, with the exception of pool initialization.
    
    Returns:
    the acquire increment
  - setAcquireIncrement
```
void setAcquireIncrement(int acquireIncrement)
```
    This property controls the maximum number of connections that are acquired at one time, with the exception of pool initialization.
    
    Parameters:
    acquireIncrement - the acquire increment
  - getAcquireRetries
```
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 getAcquireRetryDelay() milliseconds followed by another attempt, up to the number of retries configured by this property.
    
    Returns:
    the acquire retry count
  - setAcquireRetries
```
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 setAcquireRetryDelay(long) milliseconds followed by another attempt, up to the number of retries configured by this property.
    
    Parameters:
    acquireRetries - the acquire retry count
  - getAcquireRetryDelay
```
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.
    
    Returns:
    the acquire retry delay in milliseconds
  - setAcquireRetryDelay
```
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.
    
    Parameters:
    acquireRetryDelayMs - the acquire retry delay in milliseconds
  - 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
  - getMinimumPoolSize
```
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.
    
    Returns:
    the minimum number of connections in the pool
  - setMinimumPoolSize
```
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.
    
    Parameters:
    minPoolSize - the minimum number of connections in the pool
  - getMaximumPoolSize
```
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.
    
    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

Interface HikariConfigMBean

Method Summary

Method Detail

getAcquireIncrement

setAcquireIncrement

getAcquireRetries

setAcquireRetries

getAcquireRetryDelay

setAcquireRetryDelay

getConnectionTimeout

setConnectionTimeout

getIdleTimeout

setIdleTimeout

getLeakDetectionThreshold

setLeakDetectionThreshold

getMaxLifetime

setMaxLifetime

getMinimumPoolSize

setMinimumPoolSize

getMaximumPoolSize

setMaximumPoolSize

getPoolName