Class EvictionTimer


  • class EvictionTimer
    extends java.lang.Object
    Provides a shared idle object eviction timer for all pools.

    This class is currently implemented using ScheduledThreadPoolExecutor. This implementation may change in any future release. This class keeps track of how many pools are using it. If no pools are using the timer, it is cancelled. 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.

    This class is intended to be thread-safe.

    Since:
    2.0
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      private static class  EvictionTimer.EvictorThreadFactory
      Thread factory that creates a daemon thread, with the context class loader from this class.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static java.util.concurrent.ScheduledThreadPoolExecutor executor
      Executor instance
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private EvictionTimer()
      Prevents instantiation
    • Field Detail

      • executor

        private static java.util.concurrent.ScheduledThreadPoolExecutor executor
        Executor instance
    • Constructor Detail

      • EvictionTimer

        private EvictionTimer()
        Prevents instantiation
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Since:
        2.4.3
      • schedule

        static void schedule​(BaseGenericObjectPool.Evictor task,
                             long delay,
                             long period)
        Adds the specified eviction task to the timer. Tasks that are added with a call to this method *must* call #cancel() 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​(BaseGenericObjectPool.Evictor evictor,
                           long timeout,
                           java.util.concurrent.TimeUnit unit)
        Removes the specified eviction task from the timer.
        Parameters:
        evictor - Task to be cancelled.
        timeout - If the associated executor is no longer required, how long should this thread wait for the executor to terminate?
        unit - The units for the specified timeout.