Package org.apache.commons.pool2.impl
Class BaseObjectPoolConfig
- java.lang.Object
-
- org.apache.commons.pool2.impl.BaseObjectPoolConfig
-
- All Implemented Interfaces:
java.lang.Cloneable
- Direct Known Subclasses:
GenericKeyedObjectPoolConfig
,GenericObjectPoolConfig
public abstract class BaseObjectPoolConfig extends java.lang.Object implements java.lang.Cloneable
Provides the implementation for the common attributes shared by the sub-classes. New instances of this class will be created using the defaults defined by the public constants.This class is not thread-safe.
- Since:
- 2.0
- Version:
- $Revision: $
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
blockWhenExhausted
static boolean
DEFAULT_BLOCK_WHEN_EXHAUSTED
The default value for theblockWhenExhausted
configuration attribute.static java.lang.String
DEFAULT_EVICTION_POLICY_CLASS_NAME
The default value for theevictionPolicyClassName
configuration attribute.static boolean
DEFAULT_FAIRNESS
The default value for thefairness
configuration attribute.static boolean
DEFAULT_JMX_ENABLE
The default value for enabling JMX for pools created with a configuration instance.static java.lang.String
DEFAULT_JMX_NAME_BASE
The default value for the base name to use to name JMX enabled pools created with a configuration instance.static java.lang.String
DEFAULT_JMX_NAME_PREFIX
The default value for the prefix used to name JMX enabled pools created with a configuration instance.static boolean
DEFAULT_LIFO
The default value for thelifo
configuration attribute.static long
DEFAULT_MAX_WAIT_MILLIS
The default value for themaxWait
configuration attribute.static long
DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS
The default value for theminEvictableIdleTimeMillis
configuration attribute.static int
DEFAULT_NUM_TESTS_PER_EVICTION_RUN
The default value for thenumTestsPerEvictionRun
configuration attribute.static long
DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS
The default value for thesoftMinEvictableIdleTimeMillis
configuration attribute.static boolean
DEFAULT_TEST_ON_BORROW
The default value for thetestOnBorrow
configuration attribute.static boolean
DEFAULT_TEST_ON_CREATE
The default value for thetestOnCreate
configuration attribute.static boolean
DEFAULT_TEST_ON_RETURN
The default value for thetestOnReturn
configuration attribute.static boolean
DEFAULT_TEST_WHILE_IDLE
The default value for thetestWhileIdle
configuration attribute.static long
DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
The default value for thetimeBetweenEvictionRunsMillis
configuration attribute.private java.lang.String
evictionPolicyClassName
private boolean
fairness
private boolean
jmxEnabled
private java.lang.String
jmxNameBase
private java.lang.String
jmxNamePrefix
private boolean
lifo
private long
maxWaitMillis
private long
minEvictableIdleTimeMillis
private int
numTestsPerEvictionRun
private long
softMinEvictableIdleTimeMillis
private boolean
testOnBorrow
private boolean
testOnCreate
private boolean
testOnReturn
private boolean
testWhileIdle
private long
timeBetweenEvictionRunsMillis
-
Constructor Summary
Constructors Constructor Description BaseObjectPoolConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getBlockWhenExhausted()
Get the value for theblockWhenExhausted
configuration attribute for pools created with this configuration instance.java.lang.String
getEvictionPolicyClassName()
Get the value for theevictionPolicyClassName
configuration attribute for pools created with this configuration instance.boolean
getFairness()
Get the value for thefairness
configuration attribute for pools created with this configuration instance.boolean
getJmxEnabled()
Gets the value of the flag that determines if JMX will be enabled for pools created with this configuration instance.java.lang.String
getJmxNameBase()
Gets the value of the JMX name base that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.java.lang.String
getJmxNamePrefix()
Gets the value of the JMX name prefix that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.boolean
getLifo()
Get the value for thelifo
configuration attribute for pools created with this configuration instance.long
getMaxWaitMillis()
Get the value for themaxWait
configuration attribute for pools created with this configuration instance.long
getMinEvictableIdleTimeMillis()
Get the value for theminEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.int
getNumTestsPerEvictionRun()
Get the value for thenumTestsPerEvictionRun
configuration attribute for pools created with this configuration instance.long
getSoftMinEvictableIdleTimeMillis()
Get the value for thesoftMinEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.boolean
getTestOnBorrow()
Get the value for thetestOnBorrow
configuration attribute for pools created with this configuration instance.boolean
getTestOnCreate()
Get the value for thetestOnCreate
configuration attribute for pools created with this configuration instance.boolean
getTestOnReturn()
Get the value for thetestOnReturn
configuration attribute for pools created with this configuration instance.boolean
getTestWhileIdle()
Get the value for thetestWhileIdle
configuration attribute for pools created with this configuration instance.long
getTimeBetweenEvictionRunsMillis()
Get the value for thetimeBetweenEvictionRunsMillis
configuration attribute for pools created with this configuration instance.void
setBlockWhenExhausted(boolean blockWhenExhausted)
Set the value for theblockWhenExhausted
configuration attribute for pools created with this configuration instance.void
setEvictionPolicyClassName(java.lang.String evictionPolicyClassName)
Set the value for theevictionPolicyClassName
configuration attribute for pools created with this configuration instance.void
setFairness(boolean fairness)
Set the value for thefairness
configuration attribute for pools created with this configuration instance.void
setJmxEnabled(boolean jmxEnabled)
Sets the value of the flag that determines if JMX will be enabled for pools created with this configuration instance.void
setJmxNameBase(java.lang.String jmxNameBase)
Sets the value of the JMX name base that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.void
setJmxNamePrefix(java.lang.String jmxNamePrefix)
Sets the value of the JMX name prefix that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.void
setLifo(boolean lifo)
Set the value for thelifo
configuration attribute for pools created with this configuration instance.void
setMaxWaitMillis(long maxWaitMillis)
Set the value for themaxWait
configuration attribute for pools created with this configuration instance.void
setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
Set the value for theminEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.void
setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
Set the value for thenumTestsPerEvictionRun
configuration attribute for pools created with this configuration instance.void
setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
Set the value for thesoftMinEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.void
setTestOnBorrow(boolean testOnBorrow)
Set the value for thetestOnBorrow
configuration attribute for pools created with this configuration instance.void
setTestOnCreate(boolean testOnCreate)
Set the value for thetestOnCreate
configuration attribute for pools created with this configuration instance.void
setTestOnReturn(boolean testOnReturn)
Set the value for thetestOnReturn
configuration attribute for pools created with this configuration instance.void
setTestWhileIdle(boolean testWhileIdle)
Set the value for thetestWhileIdle
configuration attribute for pools created with this configuration instance.void
setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
Set the value for thetimeBetweenEvictionRunsMillis
configuration attribute for pools created with this configuration instance.
-
-
-
Field Detail
-
DEFAULT_LIFO
public static final boolean DEFAULT_LIFO
The default value for thelifo
configuration attribute.
-
DEFAULT_FAIRNESS
public static final boolean DEFAULT_FAIRNESS
The default value for thefairness
configuration attribute.
-
DEFAULT_MAX_WAIT_MILLIS
public static final long DEFAULT_MAX_WAIT_MILLIS
The default value for themaxWait
configuration attribute.
-
DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS
public static final long DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS
The default value for theminEvictableIdleTimeMillis
configuration attribute.
-
DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS
public static final long DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS
The default value for thesoftMinEvictableIdleTimeMillis
configuration attribute.
-
DEFAULT_NUM_TESTS_PER_EVICTION_RUN
public static final int DEFAULT_NUM_TESTS_PER_EVICTION_RUN
The default value for thenumTestsPerEvictionRun
configuration attribute.
-
DEFAULT_TEST_ON_CREATE
public static final boolean DEFAULT_TEST_ON_CREATE
The default value for thetestOnCreate
configuration attribute.- Since:
- 2.2
- See Also:
BaseGenericObjectPool.getTestOnCreate()
,BaseGenericObjectPool.getTestOnCreate()
, Constant Field Values
-
DEFAULT_TEST_ON_BORROW
public static final boolean DEFAULT_TEST_ON_BORROW
The default value for thetestOnBorrow
configuration attribute.
-
DEFAULT_TEST_ON_RETURN
public static final boolean DEFAULT_TEST_ON_RETURN
The default value for thetestOnReturn
configuration attribute.
-
DEFAULT_TEST_WHILE_IDLE
public static final boolean DEFAULT_TEST_WHILE_IDLE
The default value for thetestWhileIdle
configuration attribute.
-
DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
public static final long DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
The default value for thetimeBetweenEvictionRunsMillis
configuration attribute.
-
DEFAULT_BLOCK_WHEN_EXHAUSTED
public static final boolean DEFAULT_BLOCK_WHEN_EXHAUSTED
The default value for theblockWhenExhausted
configuration attribute.
-
DEFAULT_JMX_ENABLE
public static final boolean DEFAULT_JMX_ENABLE
The default value for enabling JMX for pools created with a configuration instance.- See Also:
- Constant Field Values
-
DEFAULT_JMX_NAME_PREFIX
public static final java.lang.String DEFAULT_JMX_NAME_PREFIX
The default value for the prefix used to name JMX enabled pools created with a configuration instance.
-
DEFAULT_JMX_NAME_BASE
public static final java.lang.String DEFAULT_JMX_NAME_BASE
The default value for the base name to use to name JMX enabled pools created with a configuration instance. The default isnull
which means the pool will provide the base name to use.
-
DEFAULT_EVICTION_POLICY_CLASS_NAME
public static final java.lang.String DEFAULT_EVICTION_POLICY_CLASS_NAME
The default value for theevictionPolicyClassName
configuration attribute.
-
lifo
private boolean lifo
-
fairness
private boolean fairness
-
maxWaitMillis
private long maxWaitMillis
-
minEvictableIdleTimeMillis
private long minEvictableIdleTimeMillis
-
softMinEvictableIdleTimeMillis
private long softMinEvictableIdleTimeMillis
-
numTestsPerEvictionRun
private int numTestsPerEvictionRun
-
evictionPolicyClassName
private java.lang.String evictionPolicyClassName
-
testOnCreate
private boolean testOnCreate
-
testOnBorrow
private boolean testOnBorrow
-
testOnReturn
private boolean testOnReturn
-
testWhileIdle
private boolean testWhileIdle
-
timeBetweenEvictionRunsMillis
private long timeBetweenEvictionRunsMillis
-
blockWhenExhausted
private boolean blockWhenExhausted
-
jmxEnabled
private boolean jmxEnabled
-
jmxNamePrefix
private java.lang.String jmxNamePrefix
-
jmxNameBase
private java.lang.String jmxNameBase
-
-
Method Detail
-
getLifo
public boolean getLifo()
Get the value for thelifo
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
lifo
for this configuration instance - See Also:
BaseGenericObjectPool.getLifo()
,BaseGenericObjectPool.getLifo()
-
getFairness
public boolean getFairness()
Get the value for thefairness
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
fairness
for this configuration instance - See Also:
BaseGenericObjectPool.getFairness()
,BaseGenericObjectPool.getFairness()
-
setLifo
public void setLifo(boolean lifo)
Set the value for thelifo
configuration attribute for pools created with this configuration instance.- Parameters:
lifo
- The new setting oflifo
for this configuration instance- See Also:
BaseGenericObjectPool.getLifo()
,BaseGenericObjectPool.getLifo()
-
setFairness
public void setFairness(boolean fairness)
Set the value for thefairness
configuration attribute for pools created with this configuration instance.- Parameters:
fairness
- The new setting offairness
for this configuration instance- See Also:
BaseGenericObjectPool.getFairness()
,BaseGenericObjectPool.getFairness()
-
getMaxWaitMillis
public long getMaxWaitMillis()
Get the value for themaxWait
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
maxWait
for this configuration instance - See Also:
BaseGenericObjectPool.getMaxWaitMillis()
,BaseGenericObjectPool.getMaxWaitMillis()
-
setMaxWaitMillis
public void setMaxWaitMillis(long maxWaitMillis)
Set the value for themaxWait
configuration attribute for pools created with this configuration instance.- Parameters:
maxWaitMillis
- The new setting ofmaxWaitMillis
for this configuration instance- See Also:
BaseGenericObjectPool.getMaxWaitMillis()
,BaseGenericObjectPool.getMaxWaitMillis()
-
getMinEvictableIdleTimeMillis
public long getMinEvictableIdleTimeMillis()
Get the value for theminEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
minEvictableIdleTimeMillis
for this configuration instance - See Also:
BaseGenericObjectPool.getMinEvictableIdleTimeMillis()
,BaseGenericObjectPool.getMinEvictableIdleTimeMillis()
-
setMinEvictableIdleTimeMillis
public void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
Set the value for theminEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.- Parameters:
minEvictableIdleTimeMillis
- The new setting ofminEvictableIdleTimeMillis
for this configuration instance- See Also:
BaseGenericObjectPool.getMinEvictableIdleTimeMillis()
,BaseGenericObjectPool.getMinEvictableIdleTimeMillis()
-
getSoftMinEvictableIdleTimeMillis
public long getSoftMinEvictableIdleTimeMillis()
Get the value for thesoftMinEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
softMinEvictableIdleTimeMillis
for this configuration instance - See Also:
BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()
,BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()
-
setSoftMinEvictableIdleTimeMillis
public void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
Set the value for thesoftMinEvictableIdleTimeMillis
configuration attribute for pools created with this configuration instance.- Parameters:
softMinEvictableIdleTimeMillis
- The new setting ofsoftMinEvictableIdleTimeMillis
for this configuration instance- See Also:
BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()
,BaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()
-
getNumTestsPerEvictionRun
public int getNumTestsPerEvictionRun()
Get the value for thenumTestsPerEvictionRun
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
numTestsPerEvictionRun
for this configuration instance - See Also:
BaseGenericObjectPool.getNumTestsPerEvictionRun()
,BaseGenericObjectPool.getNumTestsPerEvictionRun()
-
setNumTestsPerEvictionRun
public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
Set the value for thenumTestsPerEvictionRun
configuration attribute for pools created with this configuration instance.- Parameters:
numTestsPerEvictionRun
- The new setting ofnumTestsPerEvictionRun
for this configuration instance- See Also:
BaseGenericObjectPool.getNumTestsPerEvictionRun()
,BaseGenericObjectPool.getNumTestsPerEvictionRun()
-
getTestOnCreate
public boolean getTestOnCreate()
Get the value for thetestOnCreate
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
testOnCreate
for this configuration instance - Since:
- 2.2
- See Also:
BaseGenericObjectPool.getTestOnCreate()
,BaseGenericObjectPool.getTestOnCreate()
-
setTestOnCreate
public void setTestOnCreate(boolean testOnCreate)
Set the value for thetestOnCreate
configuration attribute for pools created with this configuration instance.- Parameters:
testOnCreate
- The new setting oftestOnCreate
for this configuration instance- Since:
- 2.2
- See Also:
BaseGenericObjectPool.getTestOnCreate()
,BaseGenericObjectPool.getTestOnCreate()
-
getTestOnBorrow
public boolean getTestOnBorrow()
Get the value for thetestOnBorrow
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
testOnBorrow
for this configuration instance - See Also:
BaseGenericObjectPool.getTestOnBorrow()
,BaseGenericObjectPool.getTestOnBorrow()
-
setTestOnBorrow
public void setTestOnBorrow(boolean testOnBorrow)
Set the value for thetestOnBorrow
configuration attribute for pools created with this configuration instance.- Parameters:
testOnBorrow
- The new setting oftestOnBorrow
for this configuration instance- See Also:
BaseGenericObjectPool.getTestOnBorrow()
,BaseGenericObjectPool.getTestOnBorrow()
-
getTestOnReturn
public boolean getTestOnReturn()
Get the value for thetestOnReturn
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
testOnReturn
for this configuration instance - See Also:
BaseGenericObjectPool.getTestOnReturn()
,BaseGenericObjectPool.getTestOnReturn()
-
setTestOnReturn
public void setTestOnReturn(boolean testOnReturn)
Set the value for thetestOnReturn
configuration attribute for pools created with this configuration instance.- Parameters:
testOnReturn
- The new setting oftestOnReturn
for this configuration instance- See Also:
BaseGenericObjectPool.getTestOnReturn()
,BaseGenericObjectPool.getTestOnReturn()
-
getTestWhileIdle
public boolean getTestWhileIdle()
Get the value for thetestWhileIdle
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
testWhileIdle
for this configuration instance - See Also:
BaseGenericObjectPool.getTestWhileIdle()
,BaseGenericObjectPool.getTestWhileIdle()
-
setTestWhileIdle
public void setTestWhileIdle(boolean testWhileIdle)
Set the value for thetestWhileIdle
configuration attribute for pools created with this configuration instance.- Parameters:
testWhileIdle
- The new setting oftestWhileIdle
for this configuration instance- See Also:
BaseGenericObjectPool.getTestWhileIdle()
,BaseGenericObjectPool.getTestWhileIdle()
-
getTimeBetweenEvictionRunsMillis
public long getTimeBetweenEvictionRunsMillis()
Get the value for thetimeBetweenEvictionRunsMillis
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
timeBetweenEvictionRunsMillis
for this configuration instance - See Also:
BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()
,BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()
-
setTimeBetweenEvictionRunsMillis
public void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
Set the value for thetimeBetweenEvictionRunsMillis
configuration attribute for pools created with this configuration instance.- Parameters:
timeBetweenEvictionRunsMillis
- The new setting oftimeBetweenEvictionRunsMillis
for this configuration instance- See Also:
BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()
,BaseGenericObjectPool.getTimeBetweenEvictionRunsMillis()
-
getEvictionPolicyClassName
public java.lang.String getEvictionPolicyClassName()
Get the value for theevictionPolicyClassName
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
evictionPolicyClassName
for this configuration instance - See Also:
BaseGenericObjectPool.getEvictionPolicyClassName()
,BaseGenericObjectPool.getEvictionPolicyClassName()
-
setEvictionPolicyClassName
public void setEvictionPolicyClassName(java.lang.String evictionPolicyClassName)
Set the value for theevictionPolicyClassName
configuration attribute for pools created with this configuration instance.- Parameters:
evictionPolicyClassName
- The new setting ofevictionPolicyClassName
for this configuration instance- See Also:
BaseGenericObjectPool.getEvictionPolicyClassName()
,BaseGenericObjectPool.getEvictionPolicyClassName()
-
getBlockWhenExhausted
public boolean getBlockWhenExhausted()
Get the value for theblockWhenExhausted
configuration attribute for pools created with this configuration instance.- Returns:
- The current setting of
blockWhenExhausted
for this configuration instance - See Also:
BaseGenericObjectPool.getBlockWhenExhausted()
,BaseGenericObjectPool.getBlockWhenExhausted()
-
setBlockWhenExhausted
public void setBlockWhenExhausted(boolean blockWhenExhausted)
Set the value for theblockWhenExhausted
configuration attribute for pools created with this configuration instance.- Parameters:
blockWhenExhausted
- The new setting ofblockWhenExhausted
for this configuration instance- See Also:
BaseGenericObjectPool.getBlockWhenExhausted()
,BaseGenericObjectPool.getBlockWhenExhausted()
-
getJmxEnabled
public boolean getJmxEnabled()
Gets the value of the flag that determines if JMX will be enabled for pools created with this configuration instance.- Returns:
- The current setting of
jmxEnabled
for this configuration instance
-
setJmxEnabled
public void setJmxEnabled(boolean jmxEnabled)
Sets the value of the flag that determines if JMX will be enabled for pools created with this configuration instance.- Parameters:
jmxEnabled
- The new setting ofjmxEnabled
for this configuration instance
-
getJmxNameBase
public java.lang.String getJmxNameBase()
Gets the value of the JMX name base that will be used as part of the name assigned to JMX enabled pools created with this configuration instance. A value ofnull
means that the pool will define the JMX name base.- Returns:
- The current setting of
jmxNameBase
for this configuration instance
-
setJmxNameBase
public void setJmxNameBase(java.lang.String jmxNameBase)
Sets the value of the JMX name base that will be used as part of the name assigned to JMX enabled pools created with this configuration instance. A value ofnull
means that the pool will define the JMX name base.- Parameters:
jmxNameBase
- The new setting ofjmxNameBase
for this configuration instance
-
getJmxNamePrefix
public java.lang.String getJmxNamePrefix()
Gets the value of the JMX name prefix that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.- Returns:
- The current setting of
jmxNamePrefix
for this configuration instance
-
setJmxNamePrefix
public void setJmxNamePrefix(java.lang.String jmxNamePrefix)
Sets the value of the JMX name prefix that will be used as part of the name assigned to JMX enabled pools created with this configuration instance.- Parameters:
jmxNamePrefix
- The new setting ofjmxNamePrefix
for this configuration instance
-
-