Class EvictionConfig
- java.lang.Object
-
- org.apache.tomcat.dbcp.pool2.impl.EvictionConfig
-
public class EvictionConfig extends java.lang.Object
This class is used by pool implementations to pass configuration information toEvictionPolicy
instances. TheEvictionPolicy
may also have its own specific configuration attributes.This class is immutable and thread-safe.
- Since:
- 2.0
-
-
Constructor Summary
Constructors Constructor Description EvictionConfig(long poolIdleEvictTime, long poolIdleSoftEvictTime, int minIdle)
Create a new eviction configuration with the specified parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
getIdleEvictTime()
Obtain theidleEvictTime
for this eviction configuration instance.long
getIdleSoftEvictTime()
Obtain theidleSoftEvictTime
for this eviction configuration instance.int
getMinIdle()
Obtain theminIdle
for this eviction configuration instance.java.lang.String
toString()
-
-
-
Constructor Detail
-
EvictionConfig
public EvictionConfig(long poolIdleEvictTime, long poolIdleSoftEvictTime, int minIdle)
Create a new eviction configuration with the specified parameters. Instances are immutable.- Parameters:
poolIdleEvictTime
- Expected to be provided byBaseGenericObjectPool.getMinEvictableIdleTimeMillis()
poolIdleSoftEvictTime
- Expected to be provided byBaseGenericObjectPool.getSoftMinEvictableIdleTimeMillis()
minIdle
- Expected to be provided byGenericObjectPool.getMinIdle()
orGenericKeyedObjectPool.getMinIdlePerKey()
-
-
Method Detail
-
getIdleEvictTime
public long getIdleEvictTime()
Obtain theidleEvictTime
for this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured
EvictionPolicy
.- Returns:
- The
idleEvictTime
in milliseconds
-
getIdleSoftEvictTime
public long getIdleSoftEvictTime()
Obtain theidleSoftEvictTime
for this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured
EvictionPolicy
.- Returns:
- The (@code idleSoftEvictTime} in milliseconds
-
getMinIdle
public int getMinIdle()
Obtain theminIdle
for this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured
EvictionPolicy
.- Returns:
- The
minIdle
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
- Since:
- 2.4
-
-