com.helger.web.fileupload.servlet

Class ServletFileUpload

java.lang.Object

com.helger.web.fileupload.parse.AbstractFileUploadBase

com.helger.web.fileupload.parse.FileUpload

com.helger.web.fileupload.servlet.ServletFileUpload

public class ServletFileUpload
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 parseRequest(HttpServletRequest) to acquire a list of IFileItems 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.

Version:

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

Author:

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

Constructor Summary

Constructors

Constructor and Description
ServletFileUpload(IFileItemFactory aFileItemFactory) Constructs an instance of this class which uses the supplied factory to create FileItem instances.

Method Summary

Modifier and Type	Method and Description
IFileItemIterator	getItemIterator(javax.servlet.http.HttpServletRequest aHttpRequest) Processes an RFC 1867 compliant multipart/form-data stream.
com.helger.commons.collection.impl.ICommonsList<IFileItem>	parseRequest(javax.servlet.http.HttpServletRequest aHttpRequest) Processes an RFC 1867 compliant multipart/form-data stream.

Methods inherited from class com.helger.web.fileupload.parse.FileUpload

getFileItemFactory

Methods inherited from class com.helger.web.fileupload.parse.AbstractFileUploadBase

createFileItemHeaders, getBoundary, getFieldName, getFileName, getFileSizeMax, getHeaderEncoding, getItemIterator, getParsedHeaders, getProgressListener, getSizeMax, parseRequest, setFileSizeMax, setHeaderEncoding, setProgressListener, setSizeMax

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletFileUpload

public ServletFileUpload(@Nonnull
                         IFileItemFactory aFileItemFactory)

Constructs an instance of this class which uses the supplied factory to create FileItem instances.

Parameters:

aFileItemFactory - The factory to use for creating file items.

Method Detail

parseRequest

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IFileItem> parseRequest(@Nonnull
                                                                                                               javax.servlet.http.HttpServletRequest aHttpRequest)
                                                                                                        throws FileUploadException

Processes an RFC 1867 compliant multipart/form-data stream.

Parameters:

aHttpRequest - The servlet 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.

getItemIterator

@Nonnull
public IFileItemIterator getItemIterator(@Nonnull
                                                   javax.servlet.http.HttpServletRequest aHttpRequest)
                                            throws FileUploadException,
                                                   IOException

Processes an RFC 1867 compliant multipart/form-data stream.

Parameters:

aHttpRequest - The servlet request to be parsed.

Returns:

An iterator to instances of FileItemStream parsed from the request, in the order that they were transmitted.

Throws:

FileUploadException - if there are problems reading/parsing the request or storing files.

IOException - An I/O error occurred. This may be a network error while communicating with the client or a problem while storing the uploaded content.