Class AbstractFileUpload<R,I extends FileItem<I>,F extends FileItemFactory<I>>
java.lang.Object
org.apache.commons.fileupload2.core.AbstractFileUpload<R,I,F>
- Type Parameters:
R- The request context type.I- The FileItem type.F- the FileItemFactory type.
public abstract class AbstractFileUpload<R,I extends FileItem<I>,F extends FileItemFactory<I>>
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringContent-disposition value for file attachment.static final StringHTTP content disposition header name.static final StringHTTP content length header name.static final StringHTTP content type header name.static final StringContent-disposition value for form data.static final StringPart of HTTP content type header.static final StringHTTP content type header for multipart forms.static final StringHTTP content type header for multiple uploads. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbyte[]getBoundary(String contentType) Gets the boundary from theContent-typeheader.getFieldName(FileItemHeaders headers) Gets the field name from theContent-dispositionheader.longGets the maximum number of files allowed in a single request.Gets the factory class used when creating file items.getFileName(FileItemHeaders headers) Gets the file name from theContent-dispositionheader.longGets the maximum allowed size of a single uploaded file, as opposed togetSizeMax().Gets the character encoding used when reading the headers of an individual part.getItemIterator(RequestContext requestContext) Gets an RFC 1867 compliantmultipart/form-datastream.abstract FileItemInputIteratorgetItemIterator(R request) Gets a file item iterator.getParsedHeaders(String headerPart) Parses theheader-partand returns as key/value pairs.Gets the progress listener.longGets the maximum allowed size of a complete request, as opposed togetFileSizeMax().static final booleanUtility method that determines whether the request contains multipart content.protected FileItemHeadersCreates a new instance ofFileItemHeaders.Parses an RFC 1867 compliantmultipart/form-datastream.parseParameterMap(R request) Parses an RFC 1867 compliantmultipart/form-datastream.parseRequest(RequestContext requestContext) Parses an RFC 1867 compliantmultipart/form-datastream.parseRequest(R request) Parses an RFC 1867 compliantmultipart/form-datastream.voidsetFileCountMax(long fileCountMax) Sets the maximum number of files allowed per request.voidsetFileItemFactory(F factory) Sets the factory class to use when creating file items.voidsetFileSizeMax(long fileSizeMax) Sets the maximum allowed size of a single uploaded file, as opposed togetSizeMax().voidsetHeaderCharset(Charset headerCharset) Specifies the character encoding to be used when reading the headers of individual part.voidsetProgressListener(ProgressListener progressListener) Sets the progress listener.voidsetSizeMax(long sizeMax) Sets the maximum allowed size of a complete request, as opposed tosetFileSizeMax(long).
-
Field Details
-
CONTENT_TYPE
HTTP content type header name.- See Also:
-
CONTENT_DISPOSITION
HTTP content disposition header name.- See Also:
-
CONTENT_LENGTH
HTTP content length header name.- See Also:
-
FORM_DATA
Content-disposition value for form data.- See Also:
-
ATTACHMENT
Content-disposition value for file attachment.- See Also:
-
MULTIPART
Part of HTTP content type header.- See Also:
-
MULTIPART_FORM_DATA
HTTP content type header for multipart forms.- See Also:
-
MULTIPART_MIXED
HTTP content type header for multiple uploads.- See Also:
-
-
Constructor Details
-
AbstractFileUpload
public AbstractFileUpload()
-
-
Method Details
-
isMultipartContent
Utility method that determines whether the request contains multipart content.NOTE: This method will be moved to the
ServletFileUploadclass 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.- Parameters:
ctx- The request context to be evaluated. Must be non-null.- Returns:
trueif the request is multipart;falseotherwise.
-
getBoundary
Gets the boundary from theContent-typeheader.- Parameters:
contentType- The value of the content type header from which to extract the boundary value.- Returns:
- The boundary, as a byte array.
-
getFieldName
Gets the field name from theContent-dispositionheader.- Parameters:
headers- AMapcontaining the HTTP request headers.- Returns:
- The field name for the current
encapsulation.
-
getFileCountMax
Gets the maximum number of files allowed in a single request.- Returns:
- The maximum number of files allowed in a single request.
-
getFileItemFactory
Gets the factory class used when creating file items.- Returns:
- The factory class for new file items.
-
getFileName
Gets the file name from theContent-dispositionheader.- Parameters:
headers- The HTTP headers object.- Returns:
- The file name for the current
encapsulation.
-
getFileSizeMax
Gets the maximum allowed size of a single uploaded file, as opposed togetSizeMax().- Returns:
- Maximum size of a single uploaded file.
- See Also:
-
getHeaderCharset
Gets the character encoding used when reading the headers of an individual part. When not specified, ornull, the request encoding is used. If that is also not specified, ornull, the platform default encoding is used.- Returns:
- The encoding used to read part headers.
-
getItemIterator
public abstract FileItemInputIterator getItemIterator(R request) throws FileUploadException, IOException Gets a file item iterator.- Parameters:
request- The servlet request to be parsed.- Returns:
- An iterator to instances of
FileItemInputparsed from the request, in the order that they were transmitted. - Throws:
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.
-
getItemIterator
public FileItemInputIterator getItemIterator(RequestContext requestContext) throws FileUploadException, IOException Gets an RFC 1867 compliantmultipart/form-datastream.- Parameters:
requestContext- The context for the request to be parsed.- Returns:
- An iterator to instances of
FileItemInputparsed from the request, in the order that they were transmitted. - Throws:
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.
-
getParsedHeaders
Parses theheader-partand 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.
- Parameters:
headerPart- Theheader-partof the currentencapsulation.- Returns:
- A
Mapcontaining the parsed HTTP request headers.
-
getProgressListener
Gets the progress listener.- Returns:
- The progress listener, if any, or null.
-
getSizeMax
Gets the maximum allowed size of a complete request, as opposed togetFileSizeMax().- Returns:
- The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.
- See Also:
-
newFileItemHeaders
Creates a new instance ofFileItemHeaders.- Returns:
- The new instance.
-
parseParameterMap
Parses an RFC 1867 compliantmultipart/form-datastream.- Parameters:
request- The servlet request to be parsed.- Returns:
- A map of
FileIteminstances parsed from the request. - Throws:
FileUploadException- if there are problems reading/parsing the request or storing files.
-
parseParameterMap
Parses an RFC 1867 compliantmultipart/form-datastream.- Parameters:
ctx- The context for the request to be parsed.- Returns:
- A map of
FileIteminstances parsed from the request. - Throws:
FileUploadException- if there are problems reading/parsing the request or storing files.
-
parseRequest
Parses an RFC 1867 compliantmultipart/form-datastream.- Parameters:
request- The servlet request to be parsed.- Returns:
- A list of
FileIteminstances parsed from the request, in the order that they were transmitted. - Throws:
FileUploadException- if there are problems reading/parsing the request or storing files.
-
parseRequest
Parses an RFC 1867 compliantmultipart/form-datastream.- Parameters:
requestContext- The context for the request to be parsed.- Returns:
- A list of
FileIteminstances parsed from the request, in the order that they were transmitted. - Throws:
FileUploadException- if there are problems reading/parsing the request or storing files.
-
setFileCountMax
Sets the maximum number of files allowed per request.- Parameters:
fileCountMax- The new limit.-1means no limit.
-
setFileItemFactory
Sets the factory class to use when creating file items.- Parameters:
factory- The factory class for new file items.
-
setFileSizeMax
Sets the maximum allowed size of a single uploaded file, as opposed togetSizeMax().- Parameters:
fileSizeMax- Maximum size of a single uploaded file.- See Also:
-
setHeaderCharset
Specifies the character encoding to be used when reading the headers of individual part. When not specified, ornull, the request encoding is used. If that is also not specified, ornull, the platform default encoding is used.- Parameters:
headerCharset- The encoding used to read part headers.
-
setProgressListener
Sets the progress listener.- Parameters:
progressListener- The progress listener, if any. Defaults to null.
-
setSizeMax
Sets the maximum allowed size of a complete request, as opposed tosetFileSizeMax(long).- Parameters:
sizeMax- The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.- See Also:
-