Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.io.FileCleaningTracker
public class FileCleaningTracker
extends java.lang.Object
exitWhenFinished
, typically in
javax.servlet.ServletContextListener.contextDestroyed
or similar.
Nested Class Summary | |
private class |
|
private static class |
|
Field Summary | |
(package private) boolean |
|
(package private) ReferenceQueue |
|
(package private) Thread |
|
(package private) Collection |
|
Method Summary | |
private void |
|
void |
|
int |
|
void |
|
void |
|
void |
|
void |
|
(package private) boolean exitWhenFinished
Whether to terminate the thread when the tracking is complete.
(package private) ReferenceQueue q
Queue ofTracker
instances being watched.
(package private) Thread reaper
The thread that will clean up registered files.
(package private) final Collection trackers
Collection ofTracker
instances in existence.
private void addTracker(String path, Object marker, FileDeleteStrategy deleteStrategy)
Adds a tracker to the list of trackers.
- Parameters:
path
- the full path to the file to be tracked, not nullmarker
- the marker object used to track the file, not nulldeleteStrategy
- the strategy to delete the file, null means normal
public void exitWhenFinished()
Call 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 consitute 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 asjavax.servlet.ServletContextListener.contextDestroyed
. One called, no new objects can be tracked by the file cleaner.
public int getTrackCount()
Retrieve the number of files currently being tracked, and therefore awaiting deletion.
- Returns:
- the number of files being tracked
public void track(File file, Object marker)
Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. Thenormal
deletion strategy will be used.
- Parameters:
file
- the file to be tracked, not nullmarker
- the marker object used to track the file, not null
public void track(File file, Object marker, FileDeleteStrategy deleteStrategy)
Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. The speified deletion strategy is used.
- Parameters:
file
- the file to be tracked, not nullmarker
- the marker object used to track the file, not nulldeleteStrategy
- the strategy to delete the file, null means normal
public void track(String path, Object marker)
Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. Thenormal
deletion strategy will be used.
- Parameters:
path
- the full path to the file to be tracked, not nullmarker
- the marker object used to track the file, not null
public void track(String path, Object marker, FileDeleteStrategy deleteStrategy)
Track the specified file, using the provided marker, deleting the file when the marker instance is garbage collected. The speified deletion strategy is used.
- Parameters:
path
- the full path to the file to be tracked, not nullmarker
- the marker object used to track the file, not nulldeleteStrategy
- the strategy to delete the file, null means normal