org.restlet.ext.fileupload
Class RestletFileUpload
java.lang.Object
org.apache.commons.fileupload.FileUploadBase
org.apache.commons.fileupload.FileUpload
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 the "multipart/mixed" encoding type, as
specified by RFC 1867. Use parseRequest(Request)
method 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.
In addition, it is possible to use FileUploadBase.getItemIterator(org.apache.commons.fileupload.RequestContext)
method.
- Author:
- Jerome Louvel
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 |
RestletFileUpload
public RestletFileUpload()
- Constructs an uninitialized 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()
getItemIterator
public FileItemIterator getItemIterator(Representation multipartForm)
throws FileUploadException,
IOException
- Processes an RFC 1867
compliant
multipart/form-data
input representation. Note
that this will not result in the writing of the parts on the disk but
will instead allow you to use stream access.
- Parameters:
multipartForm
- The input representation.
- Returns:
- An iterator to instances of FileItemStream parsed from the
request.
- Throws:
FileUploadException
IOException
- See Also:
- FileUpload
Streaming API
parseRepresentation
public List<FileItem> parseRepresentation(Representation multipartForm)
throws FileUploadException
- Processes an RFC 1867
compliant
multipart/form-data
input representation. Note
that this will result in the writing of the parts on the disk.
- 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 List<FileItem> parseRequest(Request request)
throws FileUploadException
- Processes an RFC 1867
compliant
multipart/form-data
input representation. Note
that this will result in the writing of the parts on the disk.
- 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-2013 Restlet.