Package org.apache.tomcat.dbcp.pool2.impl

Class BaseObjectPoolConfig<T>

java.lang.Object
org.apache.tomcat.dbcp.pool2.BaseObject
org.apache.tomcat.dbcp.pool2.impl.BaseObjectPoolConfig<T>
Type Parameters:
T - Type of element pooled.
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
GenericKeyedObjectPoolConfig, GenericObjectPoolConfig
public abstract class BaseObjectPoolConfig<T> extends BaseObject implements 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
    DEFAULT_BLOCK_WHEN_EXHAUSTED
    The default value for the blockWhenExhausted configuration attribute.
    static final String
    DEFAULT_EVICTION_POLICY_CLASS_NAME
    The default value for the evictionPolicyClassName configuration attribute.
    static final long
    DEFAULT_EVICTOR_SHUTDOWN_TIMEOUT_MILLIS
    The default value for evictorShutdownTimeoutMillis configuration attribute.
    static final boolean
    DEFAULT_FAIRNESS
    The default value for the fairness configuration attribute.
    static final boolean
    DEFAULT_JMX_ENABLE
    The default value for enabling JMX for pools created with a configuration instance.
    static final 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 final String
    DEFAULT_JMX_NAME_PREFIX
    The default value for the prefix used to name JMX enabled pools created with a configuration instance.
    static final boolean
    DEFAULT_LIFO
    The default value for the lifo configuration attribute.
    static final long
    DEFAULT_MAX_WAIT_MILLIS
    The default value for the maxWait configuration attribute.
    static final long
    DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS
    The default value for the minEvictableIdleTimeMillis configuration attribute.
    static final int
    DEFAULT_NUM_TESTS_PER_EVICTION_RUN
    The default value for the numTestsPerEvictionRun configuration attribute.
    static final long
    DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS
    The default value for the softMinEvictableIdleTimeMillis configuration attribute.
    static final boolean
    DEFAULT_TEST_ON_BORROW
    The default value for the testOnBorrow configuration attribute.
    static final boolean
    DEFAULT_TEST_ON_CREATE
    The default value for the testOnCreate configuration attribute.
    static final boolean
    DEFAULT_TEST_ON_RETURN
    The default value for the testOnReturn configuration attribute.
    static final boolean
    DEFAULT_TEST_WHILE_IDLE
    The default value for the testWhileIdle configuration attribute.
    static final long
    DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS
    The default value for the timeBetweenEvictionRunsMillis configuration attribute.

  • Constructor Summary

    Constructors
    Constructor
    Description
    BaseObjectPoolConfig()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getBlockWhenExhausted()
    Get the value for the blockWhenExhausted configuration attribute for pools created with this configuration instance.
    EvictionPolicy<T>
    getEvictionPolicy()
    Get the value for the evictionPolicyClass configuration attribute for pools created with this configuration instance.
    String
    getEvictionPolicyClassName()
    Get the value for the evictionPolicyClassName configuration attribute for pools created with this configuration instance.
    long
    getEvictorShutdownTimeoutMillis()
    Get the value for the evictorShutdownTimeoutMillis configuration attribute for pools created with this configuration instance.
    boolean
    getFairness()
    Get the value for the fairness 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.
    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.
    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 the lifo configuration attribute for pools created with this configuration instance.
    long
    getMaxWaitMillis()
    Get the value for the maxWait configuration attribute for pools created with this configuration instance.
    long
    getMinEvictableIdleTimeMillis()
    Get the value for the minEvictableIdleTimeMillis configuration attribute for pools created with this configuration instance.
    int
    getNumTestsPerEvictionRun()
    Get the value for the numTestsPerEvictionRun configuration attribute for pools created with this configuration instance.
    long
    getSoftMinEvictableIdleTimeMillis()
    Get the value for the softMinEvictableIdleTimeMillis configuration attribute for pools created with this configuration instance.
    boolean
    getTestOnBorrow()
    Get the value for the testOnBorrow configuration attribute for pools created with this configuration instance.
    boolean
    getTestOnCreate()
    Get the value for the testOnCreate configuration attribute for pools created with this configuration instance.
    boolean
    getTestOnReturn()
    Get the value for the testOnReturn configuration attribute for pools created with this configuration instance.
    boolean
    getTestWhileIdle()
    Get the value for the testWhileIdle configuration attribute for pools created with this configuration instance.
    long
    getTimeBetweenEvictionRunsMillis()
    Get the value for the timeBetweenEvictionRunsMillis configuration attribute for pools created with this configuration instance.
    void
    setBlockWhenExhausted(boolean blockWhenExhausted)
    Set the value for the blockWhenExhausted configuration attribute for pools created with this configuration instance.
    void
    setEvictionPolicy(EvictionPolicy<T> evictionPolicy)
    Set the value for the evictionPolicyClass configuration attribute for pools created with this configuration instance.
    void
    setEvictionPolicyClassName(String evictionPolicyClassName)
    Set the value for the evictionPolicyClassName configuration attribute for pools created with this configuration instance.
    void
    setEvictorShutdownTimeoutMillis(long evictorShutdownTimeoutMillis)
    Set the value for the evictorShutdownTimeoutMillis configuration attribute for pools created with this configuration instance.
    void
    setFairness(boolean fairness)
    Set the value for the fairness 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(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(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 the lifo configuration attribute for pools created with this configuration instance.
    void
    setMaxWaitMillis(long maxWaitMillis)
    Set the value for the maxWait configuration attribute for pools created with this configuration instance.
    void
    setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
    Set the value for the minEvictableIdleTimeMillis configuration attribute for pools created with this configuration instance.
    void
    setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
    Set the value for the numTestsPerEvictionRun configuration attribute for pools created with this configuration instance.
    void
    setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
    Set the value for the softMinEvictableIdleTimeMillis configuration attribute for pools created with this configuration instance.
    void
    setTestOnBorrow(boolean testOnBorrow)
    Set the value for the testOnBorrow configuration attribute for pools created with this configuration instance.
    void
    setTestOnCreate(boolean testOnCreate)
    Set the value for the testOnCreate configuration attribute for pools created with this configuration instance.
    void
    setTestOnReturn(boolean testOnReturn)
    Set the value for the testOnReturn configuration attribute for pools created with this configuration instance.
    void
    setTestWhileIdle(boolean testWhileIdle)
    Set the value for the testWhileIdle configuration attribute for pools created with this configuration instance.
    void
    setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
    Set the value for the timeBetweenEvictionRunsMillis configuration attribute for pools created with this configuration instance.
    protected void
    toStringAppendFields(StringBuilder builder)
    Used by sub-classes to include the fields defined by the sub-class in the BaseObject.toString() output.

    Methods inherited from class org.apache.tomcat.dbcp.pool2.BaseObject

    toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait