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 poolIdleEvictMillis, long poolIdleSoftEvictMillis, int minIdle)
Deprecated.EvictionConfig(java.time.Duration idleEvictDuration, java.time.Duration idleSoftEvictDuration, int minIdle)
Creates a new eviction configuration with the specified parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.time.Duration
getIdleEvictDuration()
Gets theidleEvictTime
for this eviction configuration instance.long
getIdleEvictTime()
Deprecated.java.time.Duration
getIdleEvictTimeDuration()
Deprecated.java.time.Duration
getIdleSoftEvictDuration()
Gets theidleSoftEvictTime
for this eviction configuration instance.long
getIdleSoftEvictTime()
Deprecated.java.time.Duration
getIdleSoftEvictTimeDuration()
Deprecated.int
getMinIdle()
Gets theminIdle
for this eviction configuration instance.java.lang.String
toString()
-
-
-
Constructor Detail
-
EvictionConfig
public EvictionConfig(java.time.Duration idleEvictDuration, java.time.Duration idleSoftEvictDuration, int minIdle)
Creates a new eviction configuration with the specified parameters. Instances are immutable.- Parameters:
idleEvictDuration
- Expected to be provided byBaseGenericObjectPool.getMinEvictableIdleDuration()
idleSoftEvictDuration
- Expected to be provided byBaseGenericObjectPool.getSoftMinEvictableIdleDuration()
minIdle
- Expected to be provided byGenericObjectPool.getMinIdle()
orGenericKeyedObjectPool.getMinIdlePerKey()
- Since:
- 2.10.0
-
EvictionConfig
@Deprecated public EvictionConfig(long poolIdleEvictMillis, long poolIdleSoftEvictMillis, int minIdle)
Deprecated.Creates a new eviction configuration with the specified parameters. Instances are immutable.- Parameters:
poolIdleEvictMillis
- Expected to be provided byBaseGenericObjectPool.getMinEvictableIdleDuration()
poolIdleSoftEvictMillis
- Expected to be provided byBaseGenericObjectPool.getSoftMinEvictableIdleDuration()
minIdle
- Expected to be provided byGenericObjectPool.getMinIdle()
orGenericKeyedObjectPool.getMinIdlePerKey()
-
-
Method Detail
-
getIdleEvictDuration
public java.time.Duration getIdleEvictDuration()
Gets theidleEvictTime
for this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured
EvictionPolicy
.- Returns:
- The
idleEvictTime
. - Since:
- 2.11.0
-
getIdleEvictTime
@Deprecated public long getIdleEvictTime()
Deprecated.Gets 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
-
getIdleEvictTimeDuration
@Deprecated public java.time.Duration getIdleEvictTimeDuration()
Deprecated.Gets theidleEvictTime
for this eviction configuration instance.How the evictor behaves based on this value will be determined by the configured
EvictionPolicy
.- Returns:
- The
idleEvictTime
. - Since:
- 2.10.0
-
getIdleSoftEvictDuration
public java.time.Duration getIdleSoftEvictDuration()
Gets 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
- Since:
- 2.11.0
-
getIdleSoftEvictTime
@Deprecated public long getIdleSoftEvictTime()
Deprecated.Gets 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
-
getIdleSoftEvictTimeDuration
@Deprecated public java.time.Duration getIdleSoftEvictTimeDuration()
Deprecated.Gets 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()
Gets 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
-
-