Class EvictionConfig
- java.lang.Object
-
- org.apache.tomcat.dbcp.pool2.impl.EvictionConfig
-
public class EvictionConfig extends java.lang.ObjectThis class is used by pool implementations to pass configuration information toEvictionPolicyinstances. TheEvictionPolicymay 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 longgetIdleEvictTime()Obtain theidleEvictTimefor this eviction configuration instance.longgetIdleSoftEvictTime()Obtain theidleSoftEvictTimefor this eviction configuration instance.intgetMinIdle()Obtain theminIdlefor this eviction configuration instance.java.lang.StringtoString()
-
-
-
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 theidleEvictTimefor this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured
EvictionPolicy.- Returns:
- The
idleEvictTimein milliseconds
-
getIdleSoftEvictTime
public long getIdleSoftEvictTime()
Obtain theidleSoftEvictTimefor 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 theminIdlefor 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:
toStringin classjava.lang.Object- Since:
- 2.4
-
-