org.apache.commons.fileupload: public class: FileUpload

org.apache.commons.fileupload
public class: FileUpload [javadoc | source]

java.lang.Object
   org.apache.commons.fileupload.FileUploadBase
      org.apache.commons.fileupload.FileUpload

Direct Known Subclasses:
PortletFileUpload, ServletFileUpload

High level API for processing file uploads.

This class handles multiple files per single HTML widget, sent using multipart/mixed encoding type, as specified by RFC 1867. Use #parseRequest(javax.servlet.http.HttpServletRequest) to acquire a list of FileItems associated with a given HTML widget.

How the data for individual parts is stored is determined by the factory used to create them; a given part may be in memory, on disk, or somewhere else.

author: < - a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski

author: < - a href="mailto:dlr@collab.net">Daniel Rall

author: < - a href="mailto:jvanzyl@apache.org">Jason van Zyl

author: < - a href="mailto:jmcnally@collab.net">John McNally

author: < - a href="mailto:martinc@apache.org">Martin Cooper

author: Sean - C. Sullivan

version: $ - Id: FileUpload.java 479484 2006-11-27 01:06:53Z jochen $

Fields inherited from org.apache.commons.fileupload.FileUploadBase:
CONTENT_TYPE, CONTENT_DISPOSITION, FORM_DATA, ATTACHMENT, MULTIPART, MULTIPART_FORM_DATA, MULTIPART_MIXED, MAX_HEADER_SIZE

Constructor:

Constructor:
public FileUpload() { super(); } Constructs an uninitialised instance of this class. A factory must be configured, using `setFileItemFactory()`, before attempting to parse requests. Also see: FileUpload(FileItemFactory)
public FileUpload(FileItemFactory fileItemFactory) { super(); this.fileItemFactory = fileItemFactory; } Constructs an instance of this class which uses the supplied factory to create `FileItem` instances. Parameters: `fileItemFactory` - The factory to use for creating file items. Also see: FileUpload()

 public FileUpload() {
        super();
}

Constructs an uninitialised instance of this class. A factory must be configured, using setFileItemFactory(), before attempting to parse requests.

Also see:

FileUpload(FileItemFactory)

 public FileUpload(FileItemFactory fileItemFactory) {
        super();
        this.fileItemFactory = fileItemFactory;
}

FileItem

Parameters:

fileItemFactory - The factory to use for creating file items.

Also see:

FileUpload()

Method from org.apache.commons.fileupload.FileUpload Summary:
getFileItemFactory, setFileItemFactory

Methods from org.apache.commons.fileupload.FileUploadBase:
createItem, getBoundary, getFieldName, getFileItemFactory, getFileName, getFileSizeMax, getHeader, getHeaderEncoding, getItemIterator, getProgressListener, getSizeMax, isMultipartContent, isMultipartContent, parseHeaders, parseRequest, parseRequest, setFileItemFactory, setFileSizeMax, setHeaderEncoding, setProgressListener, setSizeMax

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.commons.fileupload.FileUpload Detail:
public FileItemFactory getFileItemFactory() { return fileItemFactory; } Returns the factory class used when creating file items.
public void setFileItemFactory(FileItemFactory factory) { this.fileItemFactory = factory; } Sets the factory class to use when creating file items.

Method from org.apache.commons.fileupload.FileUpload Detail:

 public FileItemFactory getFileItemFactory() {
        return fileItemFactory;
}

Returns the factory class used when creating file items.

 public  void setFileItemFactory(FileItemFactory factory) {
        this.fileItemFactory = factory;
}

Sets the factory class to use when creating file items.