org.apache.tomcat.util.http.fileupload

Class DefaultFileItemFactory

public class DefaultFileItemFactory 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:

Version: $Id: DefaultFileItemFactory.java 467222 2006-10-24 03:17:11Z markt $

Author: Martin Cooper

Field Summary
static intDEFAULT_SIZE_THRESHOLD
The default threshold above which uploads will be stored on disk.
Constructor Summary
DefaultFileItemFactory()
Constructs an unconfigured instance of this class.
DefaultFileItemFactory(int sizeThreshold, File repository)
Constructs a preconfigured instance of this class.
Method Summary
FileItemcreateItem(String fieldName, String contentType, boolean isFormField, String fileName)
Create a new DefaultFileItem instance from the supplied parameters and the local factory configuration.
FilegetRepository()
Returns the directory used to temporarily store files that are larger than the configured size threshold.
intgetSizeThreshold()
Returns the size threshold beyond which files are written directly to disk.
voidsetRepository(File repository)
Sets the directory used to temporarily store files that are larger than the configured size threshold.
voidsetSizeThreshold(int sizeThreshold)
Sets the size threshold beyond which files are written directly to disk.

Field Detail

DEFAULT_SIZE_THRESHOLD

public static final int DEFAULT_SIZE_THRESHOLD
The default threshold above which uploads will be stored on disk.

Constructor Detail

DefaultFileItemFactory

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

DefaultFileItemFactory

public DefaultFileItemFactory(int sizeThreshold, File repository)
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.

Method Detail

createItem

public FileItem createItem(String fieldName, String contentType, boolean isFormField, String fileName)
Create a new DefaultFileItem instance from the supplied parameters and the local factory configuration.

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.

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:

getSizeThreshold

public int getSizeThreshold()
Returns the size threshold beyond which files are written directly to disk. The default value is 1024 bytes.

Returns: The size threshold, in bytes.

See Also: DefaultFileItemFactory

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:

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:

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.