public abstract class FileUploadBase extends Object
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(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.
| Modifier and Type | Field and Description | 
|---|---|
| static String | ATTACHMENTContent-disposition value for file attachment. | 
| static String | CONTENT_DISPOSITIONHTTP content disposition header name. | 
| static String | CONTENT_LENGTHHTTP content length header name. | 
| static String | CONTENT_TYPEHTTP content type header name. | 
| static String | FORM_DATAContent-disposition value for form data. | 
| static String | MULTIPARTPart of HTTP content type header. | 
| static String | MULTIPART_FORM_DATAHTTP content type header for multipart forms. | 
| static String | MULTIPART_MIXEDHTTP content type header for multiple uploads. | 
| Constructor and Description | 
|---|
| FileUploadBase() | 
| Modifier and Type | Method and Description | 
|---|---|
| byte[] | getBoundary(String contentType)Retrieves the boundary from the  Content-typeheader. | 
| String | getFieldName(FileItemHeaders headers)Retrieves the field name from the  Content-dispositionheader. | 
| abstract FileItemFactory | getFileItemFactory()Returns the factory class used when creating file items. | 
| String | getFileName(FileItemHeaders headers)Retrieves the file name from the  Content-dispositionheader. | 
| long | getFileSizeMax()Returns the maximum allowed size of a single uploaded file,
 as opposed to  getSizeMax(). | 
| String | getHeaderEncoding()Retrieves the character encoding used when reading the headers of an
 individual part. | 
| FileItemIterator | getItemIterator(RequestContext ctx)Processes an RFC 1867
 compliant  multipart/form-datastream. | 
| FileItemHeaders | getParsedHeaders(String headerPart) Parses the  header-partand returns as key/value
 pairs. | 
| ProgressListener | getProgressListener()Returns the progress listener. | 
| long | getSizeMax()Returns the maximum allowed size of a complete request, as opposed
 to  getFileSizeMax(). | 
| static boolean | isMultipartContent(RequestContext ctx)Utility method that determines whether the request contains multipart
 content. | 
| protected FileItemHeadersImpl | newFileItemHeaders()Creates a new instance of  FileItemHeaders. | 
| Map<String,List<FileItem>> | parseParameterMap(RequestContext ctx)Processes an RFC 1867
 compliant  multipart/form-datastream. | 
| List<FileItem> | parseRequest(RequestContext ctx)Processes an RFC 1867
 compliant  multipart/form-datastream. | 
| abstract void | setFileItemFactory(FileItemFactory factory)Sets the factory class to use when creating file items. | 
| void | setFileSizeMax(long fileSizeMax)Sets the maximum allowed size of a single uploaded file,
 as opposed to  getSizeMax(). | 
| void | setHeaderEncoding(String encoding)Specifies the character encoding to be used when reading the headers of
 individual part. | 
| void | setProgressListener(ProgressListener pListener)Sets the progress listener. | 
| void | setSizeMax(long sizeMax)Sets the maximum allowed size of a complete request, as opposed
 to  setFileSizeMax(long). | 
public static final String CONTENT_TYPE
public static final String CONTENT_DISPOSITION
public static final String CONTENT_LENGTH
public static final String FORM_DATA
public static final String ATTACHMENT
public static final String MULTIPART
public static final String MULTIPART_FORM_DATA
public static final String MULTIPART_MIXED
public static final boolean isMultipartContent(RequestContext ctx)
Utility method that determines whether the request contains multipart content.
NOTE:This method will be moved to the
 ServletFileUpload class after the FileUpload 1.1 release.
 Unfortunately, since this method is static, it is not possible to
 provide its replacement until this method is removed.
ctx - The request context to be evaluated. Must be non-null.true if the request is multipart;
         false otherwise.public abstract FileItemFactory getFileItemFactory()
public abstract void setFileItemFactory(FileItemFactory factory)
factory - The factory class for new file items.public long getSizeMax()
getFileSizeMax().setSizeMax(long)public void setSizeMax(long sizeMax)
setFileSizeMax(long).sizeMax - The maximum allowed size, in bytes. The default value of
   -1 indicates, that there is no limit.getSizeMax()public long getFileSizeMax()
getSizeMax().setFileSizeMax(long)public void setFileSizeMax(long fileSizeMax)
getSizeMax().fileSizeMax - Maximum size of a single uploaded file.getFileSizeMax()public String getHeaderEncoding()
null, the request
 encoding is used. If that is also not specified, or null,
 the platform default encoding is used.public void setHeaderEncoding(String encoding)
null, the request
 encoding is used. If that is also not specified, or null,
 the platform default encoding is used.encoding - The encoding used to read part headers.public FileItemIterator getItemIterator(RequestContext ctx) throws FileUploadException, IOException
multipart/form-data stream.ctx - The context for the 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.public List<FileItem> parseRequest(RequestContext ctx) throws FileUploadException
multipart/form-data stream.ctx - The context for the 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(RequestContext ctx) throws FileUploadException
multipart/form-data stream.ctx - The context for the request to be parsed.FileItem instances parsed from the request.FileUploadException - if there are problems reading/parsing
                             the request or storing files.public byte[] getBoundary(String contentType)
Content-type header.contentType - The value of the content type header from which to
                    extract the boundary value.public String getFileName(FileItemHeaders headers)
Content-disposition
 header.headers - The HTTP headers object.encapsulation.public String getFieldName(FileItemHeaders headers)
Content-disposition
 header.headers - A Map containing the HTTP request headers.encapsulation.public FileItemHeaders getParsedHeaders(String headerPart)
 Parses the header-part and returns as key/value
 pairs.
 
If there are multiple headers of the same names, the name will map to a comma-separated list containing the values.
headerPart - The header-part of the current
                   encapsulation.Map containing the parsed HTTP request headers.protected FileItemHeadersImpl newFileItemHeaders()
FileItemHeaders.public ProgressListener getProgressListener()
public void setProgressListener(ProgressListener pListener)
pListener - The progress listener, if any. Defaults to null.Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.