GenericObjectPoolConfig (Apache Commons Pool 2.4 API)

java.lang.Object
+
- org.apache.commons.pool2.impl.BaseObjectPoolConfig
- +
  - org.apache.commons.pool2.impl.GenericObjectPoolConfig
  +
+

+
+
All Implemented Interfaces:
+
Cloneable
+
+
+
+
```
public class GenericObjectPoolConfig
+extends BaseObjectPoolConfig
```
+
A simple "struct" encapsulating the configuration for a + GenericObjectPool. + +
+ This class is not thread-safe; it is only intended to be used to provide + attributes used when creating a pool.
+
+
Since:
+
2.0
+
Version:
+
$Revision: $
+
+

+ +

Field Summary

+ + + + + + + + + + + + + + + + + + +

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_IDLE` + The default value for the `maxIdle` configuration attribute. +
`static int`	`DEFAULT_MAX_TOTAL` + The default value for the `maxTotal` configuration attribute. +
`static int`	`DEFAULT_MIN_IDLE` + The default value for the `minIdle` configuration attribute. +

+ + +
Fields inherited from class org.apache.commons.pool2.impl.BaseObjectPoolConfig
+DEFAULT_BLOCK_WHEN_EXHAUSTED, DEFAULT_EVICTION_POLICY_CLASS_NAME, DEFAULT_FAIRNESS, DEFAULT_JMX_ENABLE, DEFAULT_JMX_NAME_BASE, DEFAULT_JMX_NAME_PREFIX, DEFAULT_LIFO, DEFAULT_MAX_WAIT_MILLIS, DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_NUM_TESTS_PER_EVICTION_RUN, DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS, DEFAULT_TEST_ON_BORROW, DEFAULT_TEST_ON_CREATE, DEFAULT_TEST_ON_RETURN, DEFAULT_TEST_WHILE_IDLE, DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
GenericObjectPoolConfig()
+

Constructors
Constructor and Description
`GenericObjectPoolConfig()`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenericObjectPoolConfig`	`clone()`
`int`	`getMaxIdle()` + Get the value for the `maxIdle` configuration attribute + for pools created with this configuration instance. +
`int`	`getMaxTotal()` + Get the value for the `maxTotal` configuration attribute + for pools created with this configuration instance. +
`int`	`getMinIdle()` + Get the value for the `minIdle` configuration attribute + for pools created with this configuration instance. +
`void`	`setMaxIdle(int maxIdle)` + Set the value for the `maxIdle` configuration attribute for + pools created with this configuration instance. +
`void`	`setMaxTotal(int maxTotal)` + Set the value for the `maxTotal` configuration attribute for + pools created with this configuration instance. +
`void`	`setMinIdle(int minIdle)` + Set the value for the `minIdle` configuration attribute for + pools created with this configuration instance. +

+ +

+ + +
Methods inherited from class java.lang.Object
+equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    DEFAULT_MAX_TOTAL
    +
```
public static final int DEFAULT_MAX_TOTAL
```
    +
    The default value for the maxTotal configuration attribute.
    +
    +
    See Also:
    +
    BaseGenericObjectPool.getMaxTotal(), +Constant Field Values
    +
    +
  + + + +
  - +
    DEFAULT_MAX_IDLE
    +
```
public static final int DEFAULT_MAX_IDLE
```
    +
    The default value for the maxIdle configuration attribute.
    +
    +
    See Also:
    +
    GenericObjectPool.getMaxIdle(), +Constant Field Values
    +
    +
  + + + +
  - +
    DEFAULT_MIN_IDLE
    +
```
public static final int DEFAULT_MIN_IDLE
```
    +
    The default value for the minIdle configuration attribute.
    +
    +
    See Also:
    +
    GenericObjectPool.getMinIdle(), +Constant Field Values
    +
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    GenericObjectPoolConfig
    +
```
public GenericObjectPoolConfig()
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    getMaxTotal
    +
```
public int getMaxTotal()
```
    +
    Get the value for the maxTotal configuration attribute + for pools created with this configuration instance.
    +
    +
    Returns:
    +
    The current setting of maxTotal for this + configuration instance
    +
    See Also:
    +
    BaseGenericObjectPool.getMaxTotal()
    +
    +
  + + + +
  - +
    setMaxTotal
    +
```
public void setMaxTotal(int maxTotal)
```
    +
    Set the value for the maxTotal configuration attribute for + pools created with this configuration instance.
    +
    +
    Parameters:
    +
    maxTotal - The new setting of maxTotal + for this configuration instance
    +
    See Also:
    +
    BaseGenericObjectPool.setMaxTotal(int)
    +
    +
  + + + +
  - +
    getMaxIdle
    +
```
public int getMaxIdle()
```
    +
    Get the value for the maxIdle configuration attribute + for pools created with this configuration instance.
    +
    +
    Returns:
    +
    The current setting of maxIdle for this + configuration instance
    +
    See Also:
    +
    GenericObjectPool.getMaxIdle()
    +
    +
  + + + +
  - +
    setMaxIdle
    +
```
public void setMaxIdle(int maxIdle)
```
    +
    Set the value for the maxIdle configuration attribute for + pools created with this configuration instance.
    +
    +
    Parameters:
    +
    maxIdle - The new setting of maxIdle + for this configuration instance
    +
    See Also:
    +
    GenericObjectPool.setMaxIdle(int)
    +
    +
  + + + +
  - +
    getMinIdle
    +
```
public int getMinIdle()
```
    +
    Get the value for the minIdle configuration attribute + for pools created with this configuration instance.
    +
    +
    Returns:
    +
    The current setting of minIdle for this + configuration instance
    +
    See Also:
    +
    GenericObjectPool.getMinIdle()
    +
    +
  + + + +
  - +
    setMinIdle
    +
```
public void setMinIdle(int minIdle)
```
    +
    Set the value for the minIdle configuration attribute for + pools created with this configuration instance.
    +
    +
    Parameters:
    +
    minIdle - The new setting of minIdle + for this configuration instance
    +
    See Also:
    +
    GenericObjectPool.setMinIdle(int)
    +
    +
  + + + +
  - +
    clone
    +
```
public GenericObjectPoolConfig clone()
```
    +
    +
    Overrides:
    +
    clone in class Object
    +
    +
  +
+

+
+
All Known Implementing Classes:
+
GenericObjectPool
+
+
+
+
```
public interface GenericObjectPoolMXBean
```
+
Defines the methods that will be made available via JMX. + + NOTE: This interface exists only to define those attributes and methods that + will be made available via JMX. It must not be implemented by clients + as it is subject to change between major, minor and patch version + releases of commons pool. Clients that implement this interface may + not, therefore, be able to upgrade to a new minor or patch release + without requiring code changes.
+
+
Since:
+
2.0
+
Version:
+
$Revision: $
+
+

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`getBlockWhenExhausted()` + See `BaseGenericObjectPool.getBlockWhenExhausted()` +
`long`	`getBorrowedCount()` + See `BaseGenericObjectPool.getBorrowedCount()` +
`long`	`getCreatedCount()` + See `BaseGenericObjectPool.getCreatedCount()` +
`String`	`getCreationStackTrace()` + See `BaseGenericObjectPool.getCreationStackTrace()` +
`long`	`getDestroyedByBorrowValidationCount()` + See `BaseGenericObjectPool.getDestroyedByBorrowValidationCount()` +
`long`	`getDestroyedByEvictorCount()` + See `BaseGenericObjectPool.getDestroyedByEvictorCount()` +
`long`	`getDestroyedCount()` + See `BaseGenericObjectPool.getDestroyedCount()` +
`String`	`getFactoryType()` + See `GenericObjectPool.getFactoryType()` +
`boolean`	`getFairness()` + See `BaseGenericObjectPool.getLifo()` +
`boolean`	`getLifo()` + See `BaseGenericObjectPool.getFairness()` +
`boolean`	`getLogAbandoned()` + See `GenericObjectPool.getLogAbandoned()` +
`long`	`getMaxBorrowWaitTimeMillis()` + See `BaseGenericObjectPool.getMaxBorrowWaitTimeMillis()` +
`int`	`getMaxIdle()` + See `GenericObjectPool.getMaxIdle()` +
`int`	`getMaxTotal()` + See `BaseGenericObjectPool.getMaxTotal()` +
`long`	`getMaxWaitMillis()` + See `BaseGenericObjectPool.getMaxWaitMillis()` +
`long`	`getMeanActiveTimeMillis()` + See `BaseGenericObjectPool.getMeanActiveTimeMillis()` +
`long`	`getMeanBorrowWaitTimeMillis()` + See `BaseGenericObjectPool.getMeanBorrowWaitTimeMillis()` +
`long`	`getMeanIdleTimeMillis()` + See `BaseGenericObjectPool.getMeanIdleTimeMillis()` +
`long`	`getMinEvictableIdleTimeMillis()` + See `BaseGenericObjectPool.getMinEvictableIdleTimeMillis()` +
`int`	`getMinIdle()` + See `GenericObjectPool.getMinIdle()` +
`int`	`getNumActive()` + See `GenericObjectPool.getNumActive()` +
`int`	`getNumIdle()` + See `GenericObjectPool.getNumIdle()` +
`int`	`getNumTestsPerEvictionRun()` + See `BaseGenericObjectPool.getNumTestsPerEvictionRun()` +
`int`	`getNumWaiters()` + See `GenericObjectPool.getNumWaiters()` +
`boolean`	`getRemoveAbandonedOnBorrow()` + See `GenericObjectPool.getRemoveAbandonedOnBorrow()` +
`boolean`	`getRemoveAbandonedOnMaintenance()` + See `GenericObjectPool.getRemoveAbandonedOnMaintenance()` +
`int`	`getRemoveAbandonedTimeout()` + See `GenericObjectPool.getRemoveAbandonedTimeout()` +
`long`	`getReturnedCount()` + See `BaseGenericObjectPool.getReturnedCount()` +
`boolean`	`getTestOnBorrow()` + See `BaseGenericObjectPool.getTestOnBorrow()` +
`boolean`	`getTestOnCreate()` + See `BaseGenericObjectPool.getTestOnCreate()` +
`boolean`	`getTestOnReturn()` + See `BaseGenericObjectPool.getTestOnReturn()` +
`boolean`	`getTestWhileIdle()` + See `BaseGenericObjectPool.getTestWhileIdle()` +
`long`	`getTimeBetweenEvictionRunsMillis()` + See `BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()` +
`boolean`	`isAbandonedConfig()` + See `GenericObjectPool.isAbandonedConfig()` +
`boolean`	`isClosed()` + See `BaseGenericObjectPool.isClosed()` +
`Set<DefaultPooledObjectInfo>`	`listAllObjects()` + See `GenericObjectPool.listAllObjects()` +

+ +
- + + +
  Method Detail
  + + + +
  - +
    getBlockWhenExhausted
    +
```
boolean getBlockWhenExhausted()
```
    +
    See BaseGenericObjectPool.getBlockWhenExhausted()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getBlockWhenExhausted()
    +
    +
  + + + +
  - +
    getFairness
    +
```
boolean getFairness()
```
    +
    See BaseGenericObjectPool.getLifo()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getLifo()
    +
    +
  + + + +
  - +
    getLifo
    +
```
boolean getLifo()
```
    +
    See BaseGenericObjectPool.getFairness()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getFairness()
    +
    +
  + + + +
  - +
    getMaxIdle
    +
```
int getMaxIdle()
```
    +
    See GenericObjectPool.getMaxIdle()
    +
    +
    Returns:
    +
    See GenericObjectPool.getMaxIdle()
    +
    +
  + + + +
  - +
    getMaxTotal
    +
```
int getMaxTotal()
```
    +
    See BaseGenericObjectPool.getMaxTotal()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getMaxTotal()
    +
    +
  + + + +
  - +
    getMaxWaitMillis
    +
```
long getMaxWaitMillis()
```
    +
    See BaseGenericObjectPool.getMaxWaitMillis()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getMaxWaitMillis()
    +
    +
  + + + +
  - +
    getMinEvictableIdleTimeMillis
    +
```
long getMinEvictableIdleTimeMillis()
```
    +
    See BaseGenericObjectPool.getMinEvictableIdleTimeMillis()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getMinEvictableIdleTimeMillis()
    +
    +
  + + + +
  - +
    getMinIdle
    +
```
int getMinIdle()
```
    +
    See GenericObjectPool.getMinIdle()
    +
    +
    Returns:
    +
    See GenericObjectPool.getMinIdle()
    +
    +
  + + + +
  - +
    getNumActive
    +
```
int getNumActive()
```
    +
    See GenericObjectPool.getNumActive()
    +
    +
    Returns:
    +
    See GenericObjectPool.getNumActive()
    +
    +
  + + + +
  - +
    getNumIdle
    +
```
int getNumIdle()
```
    +
    See GenericObjectPool.getNumIdle()
    +
    +
    Returns:
    +
    See GenericObjectPool.getNumIdle()
    +
    +
  + + + +
  - +
    getNumTestsPerEvictionRun
    +
```
int getNumTestsPerEvictionRun()
```
    +
    See BaseGenericObjectPool.getNumTestsPerEvictionRun()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getNumTestsPerEvictionRun()
    +
    +
  + + + +
  - +
    getTestOnCreate
    +
```
boolean getTestOnCreate()
```
    +
    See BaseGenericObjectPool.getTestOnCreate()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getTestOnCreate()
    +
    Since:
    +
    2.2
    +
    +
  + + + +
  - +
    getTestOnBorrow
    +
```
boolean getTestOnBorrow()
```
    +
    See BaseGenericObjectPool.getTestOnBorrow()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getTestOnBorrow()
    +
    +
  + + + +
  - +
    getTestOnReturn
    +
```
boolean getTestOnReturn()
```
    +
    See BaseGenericObjectPool.getTestOnReturn()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getTestOnReturn()
    +
    +
  + + + +
  - +
    getTestWhileIdle
    +
```
boolean getTestWhileIdle()
```
    +
    See BaseGenericObjectPool.getTestWhileIdle()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getTestWhileIdle()
    +
    +
  + + + +
  - +
    getTimeBetweenEvictionRunsMillis
    +
```
long getTimeBetweenEvictionRunsMillis()
```
    +
    See BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()
    +
    +
  + + + +
  - +
    isClosed
    +
```
boolean isClosed()
```
    +
    See BaseGenericObjectPool.isClosed()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.isClosed()
    +
    +
  + + + +
  - +
    getBorrowedCount
    +
```
long getBorrowedCount()
```
    +
    See BaseGenericObjectPool.getBorrowedCount()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getBorrowedCount()
    +
    +
  + + + +
  - +
    getReturnedCount
    +
```
long getReturnedCount()
```
    +
    See BaseGenericObjectPool.getReturnedCount()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getReturnedCount()
    +
    +
  + + + +
  - +
    getCreatedCount
    +
```
long getCreatedCount()
```
    +
    See BaseGenericObjectPool.getCreatedCount()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getCreatedCount()
    +
    +
  + + + +
  - +
    getDestroyedCount
    +
```
long getDestroyedCount()
```
    +
    See BaseGenericObjectPool.getDestroyedCount()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getDestroyedCount()
    +
    +
  + + + +
  - +
    getDestroyedByEvictorCount
    +
```
long getDestroyedByEvictorCount()
```
    +
    See BaseGenericObjectPool.getDestroyedByEvictorCount()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getDestroyedByEvictorCount()
    +
    +
  + + + +
  - +
    getDestroyedByBorrowValidationCount
    +
```
long getDestroyedByBorrowValidationCount()
```
    +
    See BaseGenericObjectPool.getDestroyedByBorrowValidationCount()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getDestroyedByBorrowValidationCount()
    +
    +
  + + + +
  - +
    getMeanActiveTimeMillis
    +
```
long getMeanActiveTimeMillis()
```
    +
    See BaseGenericObjectPool.getMeanActiveTimeMillis()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getMeanActiveTimeMillis()
    +
    +
  + + + +
  - +
    getMeanIdleTimeMillis
    +
```
long getMeanIdleTimeMillis()
```
    +
    See BaseGenericObjectPool.getMeanIdleTimeMillis()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getMeanIdleTimeMillis()
    +
    +
  + + + +
  - +
    getMeanBorrowWaitTimeMillis
    +
```
long getMeanBorrowWaitTimeMillis()
```
    +
    See BaseGenericObjectPool.getMeanBorrowWaitTimeMillis()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getMeanBorrowWaitTimeMillis()
    +
    +
  + + + +
  - +
    getMaxBorrowWaitTimeMillis
    +
```
long getMaxBorrowWaitTimeMillis()
```
    +
    See BaseGenericObjectPool.getMaxBorrowWaitTimeMillis()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getMaxBorrowWaitTimeMillis()
    +
    +
  + + + +
  - +
    getCreationStackTrace
    +
```
String getCreationStackTrace()
```
    +
    See BaseGenericObjectPool.getCreationStackTrace()
    +
    +
    Returns:
    +
    See BaseGenericObjectPool.getCreationStackTrace()
    +
    +
  + + + +
  - +
    getNumWaiters
    +
```
int getNumWaiters()
```
    +
    See GenericObjectPool.getNumWaiters()
    +
    +
    Returns:
    +
    See GenericObjectPool.getNumWaiters()
    +
    +
  + + + +
  - +
    isAbandonedConfig
    +
```
boolean isAbandonedConfig()
```
    +
    See GenericObjectPool.isAbandonedConfig()
    +
    +
    Returns:
    +
    See GenericObjectPool.isAbandonedConfig()
    +
    +
  + + + +
  - +
    getLogAbandoned
    +
```
boolean getLogAbandoned()
```
    +
    See GenericObjectPool.getLogAbandoned()
    +
    +
    Returns:
    +
    See GenericObjectPool.getLogAbandoned()
    +
    +
  + + + +
  - +
    getRemoveAbandonedOnBorrow
    +
```
boolean getRemoveAbandonedOnBorrow()
```
    +
    See GenericObjectPool.getRemoveAbandonedOnBorrow()
    +
    +
    Returns:
    +
    See GenericObjectPool.getRemoveAbandonedOnBorrow()
    +
    +
  + + + +
  - +
    getRemoveAbandonedOnMaintenance
    +
```
boolean getRemoveAbandonedOnMaintenance()
```
    +
    See GenericObjectPool.getRemoveAbandonedOnMaintenance()
    +
    +
    Returns:
    +
    See GenericObjectPool.getRemoveAbandonedOnMaintenance()
    +
    +
  + + + +
  - +
    getRemoveAbandonedTimeout
    +
```
int getRemoveAbandonedTimeout()
```
    +
    See GenericObjectPool.getRemoveAbandonedTimeout()
    +
    +
    Returns:
    +
    See GenericObjectPool.getRemoveAbandonedTimeout()
    +
    +
  + + + +
  - +
    getFactoryType
    +
```
String getFactoryType()
```
    +
    See GenericObjectPool.getFactoryType()
    +
    +
    Returns:
    +
    See GenericObjectPool.getFactoryType()
    +
    +
  + + + +
  - +
    listAllObjects
    +
```
Set<DefaultPooledObjectInfo> listAllObjects()
```
    +
    See GenericObjectPool.listAllObjects()
    +
    +
    Returns:
    +
    See GenericObjectPool.listAllObjects()
    +
    +
  +
+

Class GenericObjectPoolConfig

Field Summary

Fields inherited from class org.apache.commons.pool2.impl.BaseObjectPoolConfig

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.pool2.impl.BaseObjectPoolConfig

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_TOTAL

DEFAULT_MAX_IDLE

DEFAULT_MIN_IDLE

Constructor Detail

GenericObjectPoolConfig

Method Detail

getMaxTotal

setMaxTotal

getMaxIdle

setMaxIdle

getMinIdle

setMinIdle

clone

Interface GenericObjectPoolMXBean

Method Summary

Method Detail

getBlockWhenExhausted

getFairness

getLifo

getMaxIdle

getMaxTotal

getMaxWaitMillis

getMinEvictableIdleTimeMillis

getMinIdle

getNumActive

getNumIdle

getNumTestsPerEvictionRun

getTestOnCreate

getTestOnBorrow

getTestOnReturn

getTestWhileIdle

getTimeBetweenEvictionRunsMillis

isClosed

getBorrowedCount

getReturnedCount

getCreatedCount

getDestroyedCount

getDestroyedByEvictorCount

getDestroyedByBorrowValidationCount

getMeanActiveTimeMillis

getMeanIdleTimeMillis

getMeanBorrowWaitTimeMillis

getMaxBorrowWaitTimeMillis

getCreationStackTrace

getNumWaiters

isAbandonedConfig

getLogAbandoned

getRemoveAbandonedOnBorrow

getRemoveAbandonedOnMaintenance

getRemoveAbandonedTimeout

getFactoryType

listAllObjects