PortletFileUpload

java.lang.Object
- org.apache.commons.fileupload.FileUploadBase
- - org.apache.commons.fileupload.FileUpload
  - - org.apache.commons.fileupload.portlet.PortletFileUpload

```
public class PortletFileUpload
extends FileUpload
```
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 FileUploadBase.parseRequest(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.

Since:

FileUpload 1.1

Version:

$Id: PortletFileUpload.java 350090 2005-12-01 00:56:20Z martinc $

Author:

Rafal Krzewski, Daniel Rall, Jason van Zyl, John McNally, Martin Cooper, Sean C. Sullivan

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.commons.fileupload.FileUploadBase
  FileUploadBase.InvalidContentTypeException, FileUploadBase.SizeLimitExceededException, FileUploadBase.UnknownSizeException

Field Summary
- Fields inherited from class org.apache.commons.fileupload.FileUploadBase
  ATTACHMENT, CONTENT_DISPOSITION, CONTENT_TYPE, FORM_DATA, MAX_HEADER_SIZE, MULTIPART, MULTIPART_FORM_DATA, MULTIPART_MIXED

Constructor Summary

Constructors
Constructor	Description
`PortletFileUpload()`	Constructs an uninitialised instance of this class.
`PortletFileUpload(FileItemFactory fileItemFactory)`	Constructs an instance of this class which uses the supplied factory to create `FileItem` instances.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static boolean`	`isMultipartContent(javax.portlet.ActionRequest request)`	Utility method that determines whether the request contains multipart content.
`java.util.List`	`parseRequest(javax.portlet.ActionRequest request)`	Processes an RFC 1867 compliant `multipart/form-data` stream.

Methods inherited from class org.apache.commons.fileupload.FileUpload
getFileItemFactory, setFileItemFactory

Methods inherited from class org.apache.commons.fileupload.FileUploadBase
createItem, getBoundary, getFieldName, getFileName, getHeader, getHeaderEncoding, getSizeMax, isMultipartContent, isMultipartContent, parseHeaders, parseRequest, parseRequest, setHeaderEncoding, setSizeMax

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PortletFileUpload
```
public PortletFileUpload()
```
    Constructs an uninitialised instance of this class. A factory must be configured, using setFileItemFactory(), before attempting to parse requests.
    
    See Also:
    
    FileUpload(FileItemFactory)
  - PortletFileUpload
```
public PortletFileUpload(FileItemFactory fileItemFactory)
```
    Constructs an instance of this class which uses the supplied factory to create FileItem instances.
    
    See Also:
    
    FileUpload()
- Method Detail
  - isMultipartContent
```
public static final boolean isMultipartContent(javax.portlet.ActionRequest request)
```
    Utility method that determines whether the request contains multipart content.
    
    Parameters:
    
    request - The portlet request to be evaluated. Must be non-null.
    
    Returns:
    
    true if the request is multipart; false otherwise.
  - parseRequest
```
public java.util.List parseRequest(javax.portlet.ActionRequest request)
                            throws FileUploadException
```
    Processes an RFC 1867 compliant multipart/form-data stream.
    
    Parameters:
    
    request - The portlet request to be parsed.
    
    Returns:
    
    A list of FileItem instances parsed from the request, in the order that they were transmitted.
    
    Throws:
    
    FileUploadException - if there are problems reading/parsing the request or storing files.