GenericKeyedObjectPoolConfig (Apache Tomcat 8.0.53 API Documentation)

java.lang.Object
- org.apache.tomcat.dbcp.pool2.BaseObject
- - org.apache.tomcat.dbcp.pool2.impl.BaseObjectPoolConfig<T>
  - - org.apache.tomcat.dbcp.pool2.impl.GenericKeyedObjectPoolConfig<T>

Type Parameters:
T - Type of element pooled.

All Implemented Interfaces:

java.lang.Cloneable
```
public class GenericKeyedObjectPoolConfig<T>
extends BaseObjectPoolConfig<T>
```
A simple "struct" encapsulating the configuration for a GenericKeyedObjectPool.
This class is not thread-safe; it is only intended to be used to provide attributes used when creating a pool.

Since:

2.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_IDLE_PER_KEY` The default value for the `maxIdlePerKey` configuration attribute.
`static int`	`DEFAULT_MAX_TOTAL` The default value for the `maxTotal` configuration attribute.
`static int`	`DEFAULT_MAX_TOTAL_PER_KEY` The default value for the `maxTotalPerKey` configuration attribute.
`static int`	`DEFAULT_MIN_IDLE_PER_KEY` The default value for the `minIdlePerKey` configuration attribute.

Fields inherited from class org.apache.tomcat.dbcp.pool2.impl.BaseObjectPoolConfig
DEFAULT_BLOCK_WHEN_EXHAUSTED, DEFAULT_EVICTION_POLICY_CLASS_NAME, DEFAULT_EVICTOR_SHUTDOWN_TIMEOUT_MILLIS, 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

GenericKeyedObjectPoolConfig()
Create a new configuration with default settings.

Constructors
Constructor and Description
`GenericKeyedObjectPoolConfig()` Create a new configuration with default settings.

Method Summary

Methods
Modifier and Type	Method and Description
`GenericKeyedObjectPoolConfig<T>`	`clone()`
`int`	`getMaxIdlePerKey()` Get the value for the `maxIdlePerKey` 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`	`getMaxTotalPerKey()` Get the value for the `maxTotalPerKey` configuration attribute for pools created with this configuration instance.
`int`	`getMinIdlePerKey()` Get the value for the `minIdlePerKey` configuration attribute for pools created with this configuration instance.
`void`	`setMaxIdlePerKey(int maxIdlePerKey)` Set the value for the `maxIdlePerKey` 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`	`setMaxTotalPerKey(int maxTotalPerKey)` Set the value for the `maxTotalPerKey` configuration attribute for pools created with this configuration instance.
`void`	`setMinIdlePerKey(int minIdlePerKey)` Set the value for the `minIdlePerKey` configuration attribute for pools created with this configuration instance.
`protected void`	`toStringAppendFields(java.lang.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.impl.BaseObjectPoolConfig
getBlockWhenExhausted, getEvictionPolicy, getEvictionPolicyClassName, getEvictorShutdownTimeoutMillis, getFairness, getJmxEnabled, getJmxNameBase, getJmxNamePrefix, getLifo, getMaxWaitMillis, getMinEvictableIdleTimeMillis, getNumTestsPerEvictionRun, getSoftMinEvictableIdleTimeMillis, getTestOnBorrow, getTestOnCreate, getTestOnReturn, getTestWhileIdle, getTimeBetweenEvictionRunsMillis, setBlockWhenExhausted, setEvictionPolicy, setEvictionPolicyClassName, setEvictorShutdownTimeoutMillis, setFairness, setJmxEnabled, setJmxNameBase, setJmxNamePrefix, setLifo, setMaxWaitMillis, setMinEvictableIdleTimeMillis, setNumTestsPerEvictionRun, setSoftMinEvictableIdleTimeMillis, setTestOnBorrow, setTestOnCreate, setTestOnReturn, setTestWhileIdle, setTimeBetweenEvictionRunsMillis

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

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

- Field Detail
  - DEFAULT_MAX_TOTAL_PER_KEY
```
public static final int DEFAULT_MAX_TOTAL_PER_KEY
```
    The default value for the maxTotalPerKey configuration attribute.
    
    See Also:
    GenericKeyedObjectPool.getMaxTotalPerKey(), Constant Field Values
  - 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_MIN_IDLE_PER_KEY
```
public static final int DEFAULT_MIN_IDLE_PER_KEY
```
    The default value for the minIdlePerKey configuration attribute.
    
    See Also:
    GenericKeyedObjectPool.getMinIdlePerKey(), Constant Field Values
  - DEFAULT_MAX_IDLE_PER_KEY
```
public static final int DEFAULT_MAX_IDLE_PER_KEY
```
    The default value for the maxIdlePerKey configuration attribute.
    
    See Also:
    GenericKeyedObjectPool.getMaxIdlePerKey(), Constant Field Values
- Constructor Detail
  - GenericKeyedObjectPoolConfig
```
public GenericKeyedObjectPoolConfig()
```
    Create a new configuration with default settings.
- 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)
  - getMaxTotalPerKey
```
public int getMaxTotalPerKey()
```
    Get the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.
    
    Returns:
    The current setting of maxTotalPerKey for this configuration instance
    See Also:
    GenericKeyedObjectPool.getMaxTotalPerKey()
  - setMaxTotalPerKey
```
public void setMaxTotalPerKey(int maxTotalPerKey)
```
    Set the value for the maxTotalPerKey configuration attribute for pools created with this configuration instance.
    
    Parameters:
    maxTotalPerKey - The new setting of maxTotalPerKey for this configuration instance
    See Also:
    GenericKeyedObjectPool.setMaxTotalPerKey(int)
  - getMinIdlePerKey
```
public int getMinIdlePerKey()
```
    Get the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.
    
    Returns:
    The current setting of minIdlePerKey for this configuration instance
    See Also:
    GenericKeyedObjectPool.getMinIdlePerKey()
  - setMinIdlePerKey
```
public void setMinIdlePerKey(int minIdlePerKey)
```
    Set the value for the minIdlePerKey configuration attribute for pools created with this configuration instance.
    
    Parameters:
    minIdlePerKey - The new setting of minIdlePerKey for this configuration instance
    See Also:
    GenericKeyedObjectPool.setMinIdlePerKey(int)
  - getMaxIdlePerKey
```
public int getMaxIdlePerKey()
```
    Get the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.
    
    Returns:
    The current setting of maxIdlePerKey for this configuration instance
    See Also:
    GenericKeyedObjectPool.getMaxIdlePerKey()
  - setMaxIdlePerKey
```
public void setMaxIdlePerKey(int maxIdlePerKey)
```
    Set the value for the maxIdlePerKey configuration attribute for pools created with this configuration instance.
    
    Parameters:
    maxIdlePerKey - The new setting of maxIdlePerKey for this configuration instance
    See Also:
    GenericKeyedObjectPool.setMaxIdlePerKey(int)
  - clone
```
public GenericKeyedObjectPoolConfig<T> clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - toStringAppendFields
```
protected void toStringAppendFields(java.lang.StringBuilder builder)
```
    Description copied from class: BaseObject
    
    Used by sub-classes to include the fields defined by the sub-class in the BaseObject.toString() output.
    
    Overrides:
    
    toStringAppendFields in class BaseObjectPoolConfig<T>
    
    Parameters:
    builder - Field names and values are appended to this object

Class GenericKeyedObjectPoolConfig<T>

Field Summary

Fields inherited from class org.apache.tomcat.dbcp.pool2.impl.BaseObjectPoolConfig

Constructor Summary

Method Summary

Methods inherited from class org.apache.tomcat.dbcp.pool2.impl.BaseObjectPoolConfig

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

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_TOTAL_PER_KEY

DEFAULT_MAX_TOTAL

DEFAULT_MIN_IDLE_PER_KEY

DEFAULT_MAX_IDLE_PER_KEY

Constructor Detail

GenericKeyedObjectPoolConfig

Method Detail

getMaxTotal

setMaxTotal

getMaxTotalPerKey

setMaxTotalPerKey

getMinIdlePerKey

setMinIdlePerKey

getMaxIdlePerKey

setMaxIdlePerKey

clone

toStringAppendFields