org.ldaptive.pool

Class IdlePruneStrategy

java.lang.Object

org.ldaptive.pool.IdlePruneStrategy

All Implemented Interfaces:

PruneStrategy

public class IdlePruneStrategy
extends Object
implements PruneStrategy

Removes connections from the pool based on how long they have been idle in the available queue. By default this implementation executes every 5 minutes and prunes connections that have been idle for more than 10 minutes.

Author:

Middleware Services

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Logger for this class.

Constructor Summary

Constructors

Constructor and Description
IdlePruneStrategy() Creates a new idle prune strategy.
IdlePruneStrategy(long period, long idle) Creates a new idle prune strategy.

Method Summary

Modifier and Type	Method and Description
long	getIdleTime() Returns the idle time.
long	getPrunePeriod() Returns the interval at which the prune task will be executed in seconds.
int	getStatisticsSize() Returns the number of statistics to store for this prune strategy.
boolean	prune(PooledConnectionProxy conn) Invoked to determine whether a connection should be pruned from the pool.
void	setIdleTime(long time) Sets the idle time.
void	setPrunePeriod(long period) Sets the prune period.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.slf4j.Logger logger

Logger for this class.

Constructor Detail

IdlePruneStrategy

public IdlePruneStrategy()

Creates a new idle prune strategy.

IdlePruneStrategy

public IdlePruneStrategy(long period,
                         long idle)

Creates a new idle prune strategy.

Parameters:

period - to execute the prune task

idle - time at which a connection should be pruned

Method Detail

prune

public boolean prune(PooledConnectionProxy conn)

Description copied from interface: PruneStrategy

Invoked to determine whether a connection should be pruned from the pool.

Specified by:

prune in interface PruneStrategy

Parameters:

conn - that is available for pruning

Returns:

whether the connection should be pruned

getStatisticsSize

public int getStatisticsSize()

Description copied from interface: PruneStrategy

Returns the number of statistics to store for this prune strategy. See PooledConnectionStatistics.

Specified by:

getStatisticsSize in interface PruneStrategy

Returns:

number of statistics to store

getPrunePeriod

public long getPrunePeriod()

Description copied from interface: PruneStrategy

Returns the interval at which the prune task will be executed in seconds.

Specified by:

getPrunePeriod in interface PruneStrategy

Returns:

prune period in seconds

setPrunePeriod

public void setPrunePeriod(long period)

Sets the prune period.

Parameters:

period - to set

getIdleTime

public long getIdleTime()

Returns the idle time.

Returns:

idle time

setIdleTime

public void setIdleTime(long time)

Sets the idle time.

Parameters:

time - that a connection has been idle and should be pruned

toString

public String toString()

Overrides:

toString in class Object