[FILEUPLOAD-155] Fix documentation on resource clean up in conjunction with DiskFileItemFactory

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.2.1
• Fix Version/s: 1.2.2
• Assignee: Jochen Wiedmann
• Reporter: Jörg Heinicke
• Created: 02/May/08 16:28
• Updated: 06/Jun/17 04:56
• Resolved: 18/Jan/09 02:18

Description

1. http://commons.apache.org/fileupload/using.html:

"return new DiskFileItemFactory(fileCleaningTracker, DiskFileItemFactory.DEFAULT_SIZE_THRESHOLD, repository);"

DiskFileItemFactory does not have such a constructor.

2. http://commons.apache.org/fileupload/apidocs/org/apache/commons/fileupload/disk/DiskFileItemFactory.html

"When using the DiskFileItemFactory, then you should consider the following: Temporary files are automatically deleted as soon as they are no longer needed. (More precisely, when the corresponding instance of File is garbage collected.) Cleaning up those files is done by an instance of FileCleaningTracker, and an associated thread. In a complex environment, for example in a web application, you should consider terminating this thread, for example, when your web application ends. See the section on "Resource cleanup" in the users guide of commons-fileupload."

That's at least not precise. By default there is no FileCleaningTracker.

3. http://commons.apache.org/fileupload/apidocs/org/apache/commons/fileupload/disk/DiskFileItemFactory.html#getFileCleaningTracker()

"Returns: An instance of FileCleaningTracker, defaults to FileCleaner.getInstance(). Null, if temporary files aren't tracked."

There is no default tracker.

4. http://commons.apache.org/fileupload/apidocs/org/apache/commons/fileupload/disk/DiskFileItemFactory.html#setFileCleaningTracker(org.apache.commons.io.FileCleaningTracker)

"Returns the tracker, which is responsible for deleting temporary files."

Obviously wrong for setter. Copy&Paste error from getter.

Issue Links

• is duplicated by: FILEUPLOAD-147 Incorrect Information in documentation.