Top Description Methods
org.apache.commons.pool2.impl

public Interface GenericKeyedObjectPoolMXBean<K>

Known Direct Implementers
org.apache.commons.pool2.impl.GenericKeyedObjectPool
Type Parameters
<K>
The type of keys maintained by the pool.
Imports
java.util.List, .Map
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

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

See GenericKeyedObjectPool#getBlockWhenExhausted().
getBlockWhenExhausted()

See GenericKeyedObjectPool#getBlockWhenExhausted().

public long

Returns:

See GenericKeyedObjectPool#getBorrowedCount().
getBorrowedCount()

See GenericKeyedObjectPool#getBorrowedCount().

public long

Returns:

See GenericKeyedObjectPool#getCreatedCount().
getCreatedCount()

See GenericKeyedObjectPool#getCreatedCount().

public String

Returns:

See GenericKeyedObjectPool#getCreationStackTrace().
getCreationStackTrace()

See GenericKeyedObjectPool#getCreationStackTrace().

public long

Returns:

See GenericKeyedObjectPool#getDestroyedByBorrowValidationCount().
getDestroyedByBorrowValidationCount()

See GenericKeyedObjectPool#getDestroyedByBorrowValidationCount().

public long

Returns:

See GenericKeyedObjectPool#getDestroyedByEvictorCount().
getDestroyedByEvictorCount()

See GenericKeyedObjectPool#getDestroyedByEvictorCount().

public long

Returns:

See GenericKeyedObjectPool#getDestroyedCount().
getDestroyedCount()

See GenericKeyedObjectPool#getDestroyedCount().

public boolean

Returns:

See GenericKeyedObjectPool#getFairness().
getFairness()

See GenericKeyedObjectPool#getFairness().

public boolean

Returns:

See GenericKeyedObjectPool#getLifo().
getLifo()

See GenericKeyedObjectPool#getLifo().

public default boolean

Returns:

See GenericKeyedObjectPool#getLogAbandoned().
getLogAbandoned()

See GenericKeyedObjectPool#getLogAbandoned().

public long

Returns:

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().
getMaxBorrowWaitTimeMillis()

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().

public int

Returns:

See GenericKeyedObjectPool#getMaxIdlePerKey().
getMaxIdlePerKey()

See GenericKeyedObjectPool#getMaxIdlePerKey().

public int

Returns:

See GenericKeyedObjectPool#getMaxTotal().
getMaxTotal()

See GenericKeyedObjectPool#getMaxTotal().

public int

Returns:

See GenericKeyedObjectPool#getMaxTotalPerKey().
getMaxTotalPerKey()

See GenericKeyedObjectPool#getMaxTotalPerKey().

public long

Returns:

See GenericKeyedObjectPool#getMaxWaitDuration().
getMaxWaitMillis()

See GenericKeyedObjectPool#getMaxWaitDuration().

public long

Returns:

See GenericKeyedObjectPool#getMeanActiveTimeMillis().
getMeanActiveTimeMillis()

See GenericKeyedObjectPool#getMeanActiveTimeMillis().

public long

Returns:

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().
getMeanBorrowWaitTimeMillis()

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().

public long

Returns:

See GenericKeyedObjectPool#getMeanIdleTimeMillis().
getMeanIdleTimeMillis()

See GenericKeyedObjectPool#getMeanIdleTimeMillis().

public long

Returns:

See GenericKeyedObjectPool#getMinEvictableIdleDuration().
getMinEvictableIdleTimeMillis()

See GenericKeyedObjectPool#getMinEvictableIdleDuration().

public int

Returns:

See GenericKeyedObjectPool#getMinIdlePerKey().
getMinIdlePerKey()

See GenericKeyedObjectPool#getMinIdlePerKey().

public int

Returns:

See GenericKeyedObjectPool#getNumActive().
getNumActive()

See GenericKeyedObjectPool#getNumActive().

public Map<String, Integer>

Returns:

See GenericKeyedObjectPool#getNumActivePerKey().
getNumActivePerKey()

See GenericKeyedObjectPool#getNumActivePerKey().

public int

Returns:

See GenericKeyedObjectPool#getNumIdle().
getNumIdle()

See GenericKeyedObjectPool#getNumIdle().

public int

Returns:

See GenericKeyedObjectPool#getNumTestsPerEvictionRun().
getNumTestsPerEvictionRun()

See GenericKeyedObjectPool#getNumTestsPerEvictionRun().

public int

Returns:

See GenericKeyedObjectPool#getNumWaiters().
getNumWaiters()

See GenericKeyedObjectPool#getNumWaiters().

public Map<String, Integer>

Returns:

See GenericKeyedObjectPool#getNumWaitersByKey().
getNumWaitersByKey()

See GenericKeyedObjectPool#getNumWaitersByKey().

public default boolean

Returns:

See GenericKeyedObjectPool#getRemoveAbandonedOnBorrow().
getRemoveAbandonedOnBorrow()

See GenericKeyedObjectPool#getRemoveAbandonedOnBorrow().

public default boolean

Returns:

See GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance().
getRemoveAbandonedOnMaintenance()

See GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance().

public default int

Returns:

See GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration().
getRemoveAbandonedTimeout()

See GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration().

public long

Returns:

See GenericKeyedObjectPool#getReturnedCount().
getReturnedCount()

See GenericKeyedObjectPool#getReturnedCount().

public boolean

Returns:

See GenericKeyedObjectPool#getTestOnBorrow().
getTestOnBorrow()

See GenericKeyedObjectPool#getTestOnBorrow().

public boolean

Returns:

See GenericKeyedObjectPool#getTestOnCreate().
getTestOnCreate()

See GenericKeyedObjectPool#getTestOnCreate().

public boolean

Returns:

See GenericKeyedObjectPool#getTestOnReturn().
getTestOnReturn()

See GenericKeyedObjectPool#getTestOnReturn().

public boolean

Returns:

See GenericKeyedObjectPool#getTestWhileIdle().
getTestWhileIdle()

See GenericKeyedObjectPool#getTestWhileIdle().

public long

Returns:

See GenericKeyedObjectPool#getDurationBetweenEvictionRuns().
getTimeBetweenEvictionRunsMillis()

See GenericKeyedObjectPool#getDurationBetweenEvictionRuns

public default boolean

Returns:

See GenericKeyedObjectPool#isAbandonedConfig().
isAbandonedConfig()

See GenericKeyedObjectPool#isAbandonedConfig().

public boolean

Returns:

See GenericKeyedObjectPool#isClosed().
isClosed()

See GenericKeyedObjectPool#isClosed().

public Map<String, List<DefaultPooledObjectInfo>>

Returns:

See GenericKeyedObjectPool#listAllObjects().
listAllObjects()

See GenericKeyedObjectPool#listAllObjects().

Method Detail

getBlockWhenExhaustedback to summary
public boolean getBlockWhenExhausted()

See GenericKeyedObjectPool#getBlockWhenExhausted().

Returns:boolean

See GenericKeyedObjectPool#getBlockWhenExhausted().

getBorrowedCountback to summary
public long getBorrowedCount()

See GenericKeyedObjectPool#getBorrowedCount().

Returns:long

See GenericKeyedObjectPool#getBorrowedCount().

getCreatedCountback to summary
public long getCreatedCount()

See GenericKeyedObjectPool#getCreatedCount().

Returns:long

See GenericKeyedObjectPool#getCreatedCount().

getCreationStackTraceback to summary
public String getCreationStackTrace()

See GenericKeyedObjectPool#getCreationStackTrace().

Returns:String

See GenericKeyedObjectPool#getCreationStackTrace().

getDestroyedByBorrowValidationCountback to summary
public long getDestroyedByBorrowValidationCount()

See GenericKeyedObjectPool#getDestroyedByBorrowValidationCount().

Returns:long

See GenericKeyedObjectPool#getDestroyedByBorrowValidationCount().

getDestroyedByEvictorCountback to summary
public long getDestroyedByEvictorCount()

See GenericKeyedObjectPool#getDestroyedByEvictorCount().

Returns:long

See GenericKeyedObjectPool#getDestroyedByEvictorCount().

getDestroyedCountback to summary
public long getDestroyedCount()

See GenericKeyedObjectPool#getDestroyedCount().

Returns:long

See GenericKeyedObjectPool#getDestroyedCount().

getFairnessback to summary
public boolean getFairness()

See GenericKeyedObjectPool#getFairness().

Returns:boolean

See GenericKeyedObjectPool#getFairness().

getLifoback to summary
public boolean getLifo()

See GenericKeyedObjectPool#getLifo().

Returns:boolean

See GenericKeyedObjectPool#getLifo().

getLogAbandonedback to summary
public default boolean getLogAbandoned()

See GenericKeyedObjectPool#getLogAbandoned().

Returns:boolean

See GenericKeyedObjectPool#getLogAbandoned().

Since
2.10.0
getMaxBorrowWaitTimeMillisback to summary
public long getMaxBorrowWaitTimeMillis()

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().

Returns:long

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().

getMaxIdlePerKeyback to summary
public int getMaxIdlePerKey()

See GenericKeyedObjectPool#getMaxIdlePerKey().

Returns:int

See GenericKeyedObjectPool#getMaxIdlePerKey().

getMaxTotalback to summary
public int getMaxTotal()

See GenericKeyedObjectPool#getMaxTotal().

Returns:int

See GenericKeyedObjectPool#getMaxTotal().

getMaxTotalPerKeyback to summary
public int getMaxTotalPerKey()

See GenericKeyedObjectPool#getMaxTotalPerKey().

Returns:int

See GenericKeyedObjectPool#getMaxTotalPerKey().

getMaxWaitMillisback to summary
public long getMaxWaitMillis()

See GenericKeyedObjectPool#getMaxWaitDuration().

Returns:long

See GenericKeyedObjectPool#getMaxWaitDuration().

getMeanActiveTimeMillisback to summary
public long getMeanActiveTimeMillis()

See GenericKeyedObjectPool#getMeanActiveTimeMillis().

Returns:long

See GenericKeyedObjectPool#getMeanActiveTimeMillis().

getMeanBorrowWaitTimeMillisback to summary
public long getMeanBorrowWaitTimeMillis()

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().

Returns:long

See GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis().

getMeanIdleTimeMillisback to summary
public long getMeanIdleTimeMillis()

See GenericKeyedObjectPool#getMeanIdleTimeMillis().

Returns:long

See GenericKeyedObjectPool#getMeanIdleTimeMillis().

getMinEvictableIdleTimeMillisback to summary
public long getMinEvictableIdleTimeMillis()

See GenericKeyedObjectPool#getMinEvictableIdleDuration().

Returns:long

See GenericKeyedObjectPool#getMinEvictableIdleDuration().

getMinIdlePerKeyback to summary
public int getMinIdlePerKey()

See GenericKeyedObjectPool#getMinIdlePerKey().

Returns:int

See GenericKeyedObjectPool#getMinIdlePerKey().

getNumActiveback to summary
public int getNumActive()

See GenericKeyedObjectPool#getNumActive().

Returns:int

See GenericKeyedObjectPool#getNumActive().

getNumActivePerKeyback to summary
public Map<String, Integer> getNumActivePerKey()

See GenericKeyedObjectPool#getNumActivePerKey().

Returns:Map<String, Integer>

See GenericKeyedObjectPool#getNumActivePerKey().

getNumIdleback to summary
public int getNumIdle()

See GenericKeyedObjectPool#getNumIdle().

Returns:int

See GenericKeyedObjectPool#getNumIdle().

getNumTestsPerEvictionRunback to summary
public int getNumTestsPerEvictionRun()

See GenericKeyedObjectPool#getNumTestsPerEvictionRun().

Returns:int

See GenericKeyedObjectPool#getNumTestsPerEvictionRun().

getNumWaitersback to summary
public int getNumWaiters()

See GenericKeyedObjectPool#getNumWaiters().

Returns:int

See GenericKeyedObjectPool#getNumWaiters().

getNumWaitersByKeyback to summary
public Map<String, Integer> getNumWaitersByKey()

See GenericKeyedObjectPool#getNumWaitersByKey().

Returns:Map<String, Integer>

See GenericKeyedObjectPool#getNumWaitersByKey().

getRemoveAbandonedOnBorrowback to summary
public default boolean getRemoveAbandonedOnBorrow()

See GenericKeyedObjectPool#getRemoveAbandonedOnBorrow().

Returns:boolean

See GenericKeyedObjectPool#getRemoveAbandonedOnBorrow().

Since
2.10.0
getRemoveAbandonedOnMaintenanceback to summary
public default boolean getRemoveAbandonedOnMaintenance()

See GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance().

Returns:boolean

See GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance().

Since
2.10.0
getRemoveAbandonedTimeoutback to summary
public default int getRemoveAbandonedTimeout()

See GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration().

Returns:int

See GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration().

Since
2.10.0
getReturnedCountback to summary
public long getReturnedCount()

See GenericKeyedObjectPool#getReturnedCount().

Returns:long

See GenericKeyedObjectPool#getReturnedCount().

getTestOnBorrowback to summary
public boolean getTestOnBorrow()

See GenericKeyedObjectPool#getTestOnBorrow().

Returns:boolean

See GenericKeyedObjectPool#getTestOnBorrow().

getTestOnCreateback to summary
public boolean getTestOnCreate()

See GenericKeyedObjectPool#getTestOnCreate().

Returns:boolean

See GenericKeyedObjectPool#getTestOnCreate().

Since
2.2
getTestOnReturnback to summary
public boolean getTestOnReturn()

See GenericKeyedObjectPool#getTestOnReturn().

Returns:boolean

See GenericKeyedObjectPool#getTestOnReturn().

getTestWhileIdleback to summary
public boolean getTestWhileIdle()

See GenericKeyedObjectPool#getTestWhileIdle().

Returns:boolean

See GenericKeyedObjectPool#getTestWhileIdle().

getTimeBetweenEvictionRunsMillisback to summary
public long getTimeBetweenEvictionRunsMillis()

See GenericKeyedObjectPool#getDurationBetweenEvictionRuns

Returns:long

See GenericKeyedObjectPool#getDurationBetweenEvictionRuns().

isAbandonedConfigback to summary
public default boolean isAbandonedConfig()

See GenericKeyedObjectPool#isAbandonedConfig().

Returns:boolean

See GenericKeyedObjectPool#isAbandonedConfig().

Since
2.10.0
isClosedback to summary
public boolean isClosed()

See GenericKeyedObjectPool#isClosed().

Returns:boolean

See GenericKeyedObjectPool#isClosed().

listAllObjectsback to summary
public Map<String, List<DefaultPooledObjectInfo>> listAllObjects()

See GenericKeyedObjectPool#listAllObjects().

Returns:Map<String, List<DefaultPooledObjectInfo>>

See GenericKeyedObjectPool#listAllObjects().