Class EvictionTimer

java.lang.Object
org.apache.commons.pool.impl.EvictionTimer

class EvictionTimer extends Object

Provides a shared idle object eviction timer for all pools. This class wraps the standard Timer and keeps track of how many pools are using it. If no pools are using the timer, it is canceled. This prevents a thread being left running which, in application server environments, can lead to memory leads and/or prevent applications from shutting down or reloading cleanly.

This class has package scope to prevent its inclusion in the pool public API. The class declaration below should *not* be changed to public.

  • Field Details

    • _timer

      private static Timer _timer
      Timer instance
    • _usageCount

      private static int _usageCount
      Static usage count tracker
  • Constructor Details

    • EvictionTimer

      private EvictionTimer()
      Prevent instantiation
  • Method Details

    • schedule

      static void schedule(TimerTask task, long delay, long period)
      Add the specified eviction task to the timer. Tasks that are added with a call to this method *must* call cancel(TimerTask) to cancel the task to prevent memory and/or thread leaks in application server environments.
      Parameters:
      task - Task to be scheduled
      delay - Delay in milliseconds before task is executed
      period - Time in milliseconds between executions
    • cancel

      static void cancel(TimerTask task)
      Remove the specified eviction task from the timer.
      Parameters:
      task - Task to be scheduled