Class FileCleaningTracker
This utility creates a background thread to handle file deletion. Each file to be deleted is registered with a handler object. When the handler object is garbage collected, the file is deleted.
 In an environment with multiple class loaders (a servlet container, for
 example), you should consider stopping the background thread if it is no
 longer needed. This is done by invoking the method
 exitWhenFinished, typically in
 javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent) or similar.
 
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidCall this method to cause the file cleaner thread to terminate when there are no more objects being tracked for deletion.Gets a copy of the file paths that failed to delete.intGets the number of files currently being tracked, and therefore awaiting deletion.voidTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.voidtrack(File file, Object marker, FileDeleteStrategy deleteStrategy) Tracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.voidTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.voidtrack(String path, Object marker, FileDeleteStrategy deleteStrategy) Tracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.voidTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.voidtrack(Path file, Object marker, FileDeleteStrategy deleteStrategy) Tracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected.
- 
Constructor Details- 
FileCleaningTrackerpublic FileCleaningTracker()Construct a new instance.
 
- 
- 
Method Details- 
exitWhenFinishedCall this method to cause the file cleaner thread to terminate when there are no more objects being tracked for deletion.In a simple environment, you don't need this method as the file cleaner thread will simply exit when the JVM exits. In a more complex environment, with multiple class loaders (such as an application server), you should be aware that the file cleaner thread will continue running even if the class loader it was started from terminates. This can constitute a memory leak. For example, suppose that you have developed a web application, which contains the commons-io jar file in your WEB-INF/lib directory. In other words, the FileCleaner class is loaded through the class loader of your web application. If the web application is terminated, but the servlet container is still running, then the file cleaner thread will still exist, posing a memory leak. This method allows the thread to be terminated. Simply call this method in the resource cleanup code, such as javax.servlet.ServletContextListener.contextDestroyed(javax.servlet.ServletContextEvent). Once called, no new objects can be tracked by the file cleaner.
- 
getDeleteFailuresGets a copy of the file paths that failed to delete.- Returns:
- a copy of the file paths that failed to delete
- Since:
- 2.0
 
- 
getTrackCountGets the number of files currently being tracked, and therefore awaiting deletion.- Returns:
- the number of files being tracked
 
- 
trackTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. Thenormaldeletion strategy will be used.- Parameters:
- file- the file to be tracked, not null
- marker- the marker object used to track the file, not null
- Throws:
- NullPointerException- if the file is null
 
- 
trackTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. The specified deletion strategy is used.- Parameters:
- file- the file to be tracked, not null
- marker- the marker object used to track the file, not null
- deleteStrategy- the strategy to delete the file, null means normal
- Throws:
- NullPointerException- if the file is null
 
- 
trackTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. Thenormaldeletion strategy will be used.- Parameters:
- file- the file to be tracked, not null
- marker- the marker object used to track the file, not null
- Throws:
- NullPointerException- if the file is null
- Since:
- 2.14.0
 
- 
trackTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. The specified deletion strategy is used.- Parameters:
- file- the file to be tracked, not null
- marker- the marker object used to track the file, not null
- deleteStrategy- the strategy to delete the file, null means normal
- Throws:
- NullPointerException- if the file is null
- Since:
- 2.14.0
 
- 
trackTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. Thenormaldeletion strategy will be used.- Parameters:
- path- the full path to the file to be tracked, not null
- marker- the marker object used to track the file, not null
- Throws:
- NullPointerException- if the path is null
 
- 
trackTracks the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. The specified deletion strategy is used.- Parameters:
- path- the full path to the file to be tracked, not null
- marker- the marker object used to track the file, not null
- deleteStrategy- the strategy to delete the file, null means normal
- Throws:
- NullPointerException- if the path is null
 
 
-