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 FileUploadBase.parseRequest(org.apache.tomcat.util.http.fileupload.RequestContext) 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.
ATTACHMENT, CONTENT_DISPOSITION, CONTENT_LENGTH, CONTENT_TYPE, FORM_DATA, MULTIPART, MULTIPART_FORM_DATA, MULTIPART_MIXED| Constructor and Description |
|---|
ServletFileUpload()
Constructs an uninitialised instance of this class.
|
ServletFileUpload(FileItemFactory fileItemFactory)
Constructs an instance of this class which uses the supplied factory to
create
FileItem instances. |
| Modifier and Type | Method and Description |
|---|---|
FileItemIterator |
getItemIterator(HttpServletRequest request)
Processes an RFC 1867
compliant
multipart/form-data stream. |
static boolean |
isMultipartContent(HttpServletRequest request)
Utility method that determines whether the request contains multipart
content.
|
Map<String,List<FileItem>> |
parseParameterMap(HttpServletRequest request)
Processes an RFC 1867
compliant
multipart/form-data stream. |
getFileItemFactory, setFileItemFactorygetBoundary, getFieldName, getFileName, getFileSizeMax, getHeaderEncoding, getItemIterator, getParsedHeaders, getProgressListener, getSizeMax, isMultipartContent, newFileItemHeaders, parseParameterMap, parseRequest, setFileSizeMax, setHeaderEncoding, setProgressListener, setSizeMaxpublic ServletFileUpload()
setFileItemFactory(), before attempting
to parse requests.public ServletFileUpload(FileItemFactory fileItemFactory)
FileItem instances.fileItemFactory - The factory to use for creating file items.FileUpload.FileUpload()public static final boolean isMultipartContent(HttpServletRequest request)
request - The servlet request to be evaluated. Must be non-null.true if the request is multipart;
false otherwise.public Map<String,List<FileItem>> parseParameterMap(HttpServletRequest request) throws FileUploadException
multipart/form-data stream.request - The servlet request to be parsed.FileItem instances parsed from the request.FileUploadException - if there are problems reading/parsing
the request or storing files.public FileItemIterator getItemIterator(HttpServletRequest request) throws FileUploadException, IOException
multipart/form-data stream.request - The servlet request to be parsed.FileItemStream
parsed from the request, in the order that they were
transmitted.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.Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.