org.apache.wicket.util.upload

Class DiskFileItemFactory

java.lang.Object

org.apache.wicket.util.upload.DiskFileItemFactory

All Implemented Interfaces:

FileItemFactory

public class DiskFileItemFactory
extends Object
implements FileItemFactory

The default FileItemFactory implementation. This implementation creates FileItem instances which keep their content either in memory, for smaller items, or in a temporary file on disk, for larger items. The size threshold, above which content will be stored on disk, is configurable, as is the directory in which temporary files will be created.

If not otherwise configured, the default configuration values are as follows:

• Size threshold is 10KB.
• Repository is the system default temp directory, as returned by System.getProperty("java.io.tmpdir").

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.

Author:

Martin Cooper

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SIZE_THRESHOLD The default threshold above which uploads will be stored on disk.

Constructor Summary

Constructors

Constructor and Description
DiskFileItemFactory(IFileCleaner fileUploadCleaner) Constructs an unconfigured instance of this class.
DiskFileItemFactory(int sizeThreshold, File repository, IFileCleaner fileUploadCleaner) Constructs a preconfigured instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
FileItem	createItem(String fieldName, String contentType, boolean isFormField, String fileName) Create a new DiskFileItem instance from the supplied parameters and the local factory configuration.
File	getRepository() Returns the directory used to temporarily store files that are larger than the configured size threshold.
int	getSizeThreshold() Returns the size threshold beyond which files are written directly to disk.
void	setRepository(File repository) Sets the directory used to temporarily store files that are larger than the configured size threshold.
void	setSizeThreshold(int sizeThreshold) Sets the size threshold beyond which files are written directly to disk.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIZE_THRESHOLD

public static final int DEFAULT_SIZE_THRESHOLD

The default threshold above which uploads will be stored on disk.

See Also:

Constant Field Values

Constructor Detail

DiskFileItemFactory

public DiskFileItemFactory(IFileCleaner fileUploadCleaner)

Constructs an unconfigured instance of this class. The resulting factory may be configured by calling the appropriate setter methods.

Parameters:

fileUploadCleaner -

DiskFileItemFactory

public DiskFileItemFactory(int sizeThreshold,
                   File repository,
                   IFileCleaner fileUploadCleaner)

Constructs a preconfigured instance of this class.

Parameters:

sizeThreshold - The threshold, in bytes, below which items will be retained in memory and above which they will be stored as a file.

repository - The data repository, which is the directory in which files will be created, should the item size exceed the threshold.

fileUploadCleaner -

Method Detail

getRepository

public File getRepository()

Returns the directory used to temporarily store files that are larger than the configured size threshold.

Returns:

The directory in which temporary files will be located.

See Also:

setRepository(java.io.File)

setRepository

public void setRepository(File repository)

Sets the directory used to temporarily store files that are larger than the configured size threshold.

Parameters:

repository - The directory in which temporary files will be located.

See Also:

getRepository()

getSizeThreshold

public int getSizeThreshold()

Returns the size threshold beyond which files are written directly to disk. The default value is 10240 bytes.

Returns:

The size threshold, in bytes.

See Also:

setSizeThreshold(int)

setSizeThreshold

public void setSizeThreshold(int sizeThreshold)

Sets the size threshold beyond which files are written directly to disk.

Parameters:

sizeThreshold - The size threshold, in bytes.

See Also:

getSizeThreshold()

createItem

public FileItem createItem(String fieldName,
                  String contentType,
                  boolean isFormField,
                  String fileName)

Create a new DiskFileItem instance from the supplied parameters and the local factory configuration.

Specified by:

createItem in interface FileItemFactory

Parameters:

fieldName - The name of the form field.

contentType - The content type of the form field.

isFormField - true if this is a plain form field; false otherwise.

fileName - The name of the uploaded file, if any, as supplied by the browser or other client.

Returns:

The newly created file item.