Package org.apache.commons.fileupload2.javax

Class JavaxFileCleaner

  • All Implemented Interfaces:
    java.util.EventListener, javax.servlet.ServletContextListener
    public class JavaxFileCleaner
extends java.lang.Object
implements javax.servlet.ServletContextListener
    A servlet context listener, which ensures that the FileCleaningTracker's reaper thread is terminated, when the web application is destroyed.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String FILE_CLEANING_TRACKER_ATTRIBUTE
      Attribute name, which is used for storing an instance of FileCleaningTracker in the web application.

    • Constructor Summary

      Constructors 
      Constructor Description
      JavaxFileCleaner()
      Constructs a new instance.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void contextDestroyed​(javax.servlet.ServletContextEvent sce)
      Called when the web application is being destroyed.
      void contextInitialized​(javax.servlet.ServletContextEvent sce)
      Called when the web application is initialized.
      static org.apache.commons.io.FileCleaningTracker getFileCleaningTracker​(javax.servlet.ServletContext servletContext)
      Gets the instance of FileCleaningTracker, which is associated with the given ServletContext.
      static void setFileCleaningTracker​(javax.servlet.ServletContext servletContext, org.apache.commons.io.FileCleaningTracker tracker)
      Sets the instance of FileCleaningTracker, which is associated with the given ServletContext.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • FILE_CLEANING_TRACKER_ATTRIBUTE

        public static final java.lang.String FILE_CLEANING_TRACKER_ATTRIBUTE
        Attribute name, which is used for storing an instance of FileCleaningTracker in the web application.

    • Constructor Detail

    • Method Detail

      • getFileCleaningTracker

        public static org.apache.commons.io.FileCleaningTracker getFileCleaningTracker​(javax.servlet.ServletContext servletContext)
        Gets the instance of FileCleaningTracker, which is associated with the given ServletContext.
        Parameters:
        servletContext - The servlet context to query
        Returns:
        The contexts tracker

      • setFileCleaningTracker

        public static void setFileCleaningTracker​(javax.servlet.ServletContext servletContext,
                                          org.apache.commons.io.FileCleaningTracker tracker)
        Sets the instance of FileCleaningTracker, which is associated with the given ServletContext.
        Parameters:
        servletContext - The servlet context to modify
        tracker - The tracker to set

      • contextDestroyed

        public void contextDestroyed​(javax.servlet.ServletContextEvent sce)
        Called when the web application is being destroyed. Calls FileCleaningTracker.exitWhenFinished().
        Specified by:
        contextDestroyed in interface javax.servlet.ServletContextListener
        Parameters:
        sce - The servlet context, used for calling getFileCleaningTracker(ServletContext).