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.

Field Summary

Fields

Modifier and Type	Field and Description
private static Duration	DEFAULT_IDLE_TIME Default idle time.
private static Duration	DEFAULT_PRUNE_PERIOD Default prune period in seconds.
private static int	DEFAULT_STATISTICS_SIZE Default number of statistics to store.
private Duration	idleTime Idle time.
protected Logger	logger Logger for this class.
private Duration	prunePeriod Prune period.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Duration	getIdleTime() Returns the idle time.
Duration	getPrunePeriod() Returns the interval at which the prune task will be executed.
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(Duration time) Sets the idle time.
void	setPrunePeriod(Duration 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

DEFAULT_STATISTICS_SIZE

private static final int DEFAULT_STATISTICS_SIZE

Default number of statistics to store. Value is 1.

See Also:

Constant Field Values

DEFAULT_PRUNE_PERIOD

private static final Duration DEFAULT_PRUNE_PERIOD

Default prune period in seconds. Value is 5 minutes.

DEFAULT_IDLE_TIME

private static final Duration DEFAULT_IDLE_TIME

Default idle time. Value is 10 minutes.

logger

protected final Logger logger

Logger for this class.

prunePeriod

private Duration prunePeriod

Prune period.

idleTime

private Duration idleTime

Idle time.

Constructor Detail

IdlePruneStrategy

public IdlePruneStrategy()

Creates a new idle prune strategy.

IdlePruneStrategy

public IdlePruneStrategy(Duration period,
                         Duration 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 Duration getPrunePeriod()

Description copied from interface: PruneStrategy

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

Specified by:

getPrunePeriod in interface PruneStrategy

Returns:

prune period

setPrunePeriod

public void setPrunePeriod(Duration period)

Sets the prune period.

Parameters:

period - to set

getIdleTime

public Duration getIdleTime()

Returns the idle time.

Returns:

idle time

setIdleTime

public void setIdleTime(Duration 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