org.restlet.ext.fileupload
Class RestletFileUpload

java.lang.Object
  extended by org.apache.commons.fileupload.FileUploadBase
      extended by org.apache.commons.fileupload.FileUpload
          extended by org.restlet.ext.fileupload.RestletFileUpload

public class RestletFileUpload
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(Call) 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:
Jerome Louvel

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.commons.fileupload.FileUploadBase
FileUploadBase.FileSizeLimitExceededException, FileUploadBase.FileUploadIOException, FileUploadBase.InvalidContentTypeException, FileUploadBase.IOFileUploadException, FileUploadBase.SizeException, FileUploadBase.SizeLimitExceededException, FileUploadBase.UnknownSizeException
 
Field Summary
 
Fields inherited from class org.apache.commons.fileupload.FileUploadBase
ATTACHMENT, CONTENT_DISPOSITION, CONTENT_LENGTH, CONTENT_TYPE, FORM_DATA, MAX_HEADER_SIZE, MULTIPART, MULTIPART_FORM_DATA, MULTIPART_MIXED
 
Constructor Summary
RestletFileUpload()
          Constructs an uninitialised instance of this class.
RestletFileUpload(FileItemFactory fileItemFactory)
          Constructs an instance of this class which uses the supplied factory to create FileItem instances.
 
Method Summary
 java.util.List<FileItem> parseRepresentation(Representation multipartForm)
          Processes an RFC 1867 compliant multipart/form-data input representation.
 java.util.List<FileItem> parseRequest(Request request)
          Processes an RFC 1867 compliant multipart/form-data input representation.
 
Methods inherited from class org.apache.commons.fileupload.FileUpload
getFileItemFactory, setFileItemFactory
 
Methods inherited from class org.apache.commons.fileupload.FileUploadBase
createItem, getBoundary, getFieldName, getFieldName, getFileName, getFileName, getFileSizeMax, getHeader, getHeaderEncoding, getItemIterator, getParsedHeaders, getProgressListener, getSizeMax, isMultipartContent, isMultipartContent, newFileItemHeaders, parseHeaders, parseRequest, 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

RestletFileUpload

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

See Also:
RestletFileUpload(FileItemFactory)

RestletFileUpload

public RestletFileUpload(FileItemFactory fileItemFactory)
Constructs an instance of this class which uses the supplied factory to create FileItem instances.

See Also:
RestletFileUpload()
Method Detail

parseRepresentation

public java.util.List<FileItem> parseRepresentation(Representation multipartForm)
                                             throws FileUploadException
Processes an RFC 1867 compliant multipart/form-data input representation.

Parameters:
multipartForm - The multipart representation to be parsed.
Returns:
A list of FileItem instances parsed, in the order that they were transmitted.
Throws:
FileUploadException - if there are problems reading/parsing the request or storing files.

parseRequest

public java.util.List<FileItem> parseRequest(Request request)
                                      throws FileUploadException
Processes an RFC 1867 compliant multipart/form-data input representation.

Parameters:
request - The request containing the entity to be parsed.
Returns:
A list of FileItem instances parsed, in the order that they were transmitted.
Throws:
FileUploadException - if there are problems reading/parsing the request or storing files.


Copyright © 2005-2008 Noelios Technologies.