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
#parseRequest(javax.servlet.http.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.
FileUploadBase.FileSizeLimitExceededException, FileUploadBase.FileUploadIOException, FileUploadBase.InvalidContentTypeException, FileUploadBase.IOFileUploadException, FileUploadBase.SizeException, FileUploadBase.SizeLimitExceededException, FileUploadBase.UnknownSizeException
ATTACHMENT, CONTENT_DISPOSITION, CONTENT_LENGTH, CONTENT_TYPE, DEFAULT_PART_HEADER_SIZE_MAX, FORM_DATA, MAX_HEADER_SIZE, MULTIPART, MULTIPART_FORM_DATA, MULTIPART_MIXED
Constructor and 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. |
Modifier and Type | Method and Description |
---|---|
FileItemIterator |
getItemIterator(javax.portlet.ActionRequest request)
Processes an RFC 1867
compliant
multipart/form-data stream. |
static boolean |
isMultipartContent(javax.portlet.ActionRequest request)
Utility method that determines whether the request contains multipart
content.
|
Map<String,List<FileItem>> |
parseParameterMap(javax.portlet.ActionRequest request)
Processes an RFC 1867
compliant
multipart/form-data stream. |
List<FileItem> |
parseRequest(javax.portlet.ActionRequest request)
Processes an RFC 1867
compliant
multipart/form-data stream. |
getFileItemFactory, setFileItemFactory
createItem, getBoundary, getFieldName, getFieldName, getFileCountMax, getFileName, getFileName, getFileSizeMax, getHeader, getHeaderEncoding, getItemIterator, getParsedHeaders, getPartHeaderSizeMax, getProgressListener, getSizeMax, isMultipartContent, isMultipartContent, newFileItemHeaders, parseHeaders, parseParameterMap, parseRequest, parseRequest, setFileCountMax, setFileSizeMax, setHeaderEncoding, setPartHeaderSizeMax, setProgressListener, setSizeMax
public PortletFileUpload()
setFileItemFactory()
, before attempting
to parse requests.FileUpload(FileItemFactory)
public PortletFileUpload(FileItemFactory fileItemFactory)
FileItem
instances.fileItemFactory
- The factory to use for creating file items.FileUpload()
public static final boolean isMultipartContent(javax.portlet.ActionRequest request)
request
- The portlet request to be evaluated. Must be non-null.true
if the request is multipart;
false
otherwise.public List<FileItem> parseRequest(javax.portlet.ActionRequest request) throws FileUploadException
multipart/form-data
stream.request
- The portlet request to be parsed.FileItem
instances parsed from the
request, in the order that they were transmitted.FileUploadException
- if there are problems reading/parsing
the request or storing files.public Map<String,List<FileItem>> parseParameterMap(javax.portlet.ActionRequest request) throws FileUploadException
multipart/form-data
stream.request
- The portlet 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(javax.portlet.ActionRequest request) throws FileUploadException, IOException
multipart/form-data
stream.request
- The portlet 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 © 2002–2025 The Apache Software Foundation. All rights reserved.