Class FileUploadBase
- Direct Known Subclasses:
DiskFileUpload
,FileUpload
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
FileItem
s 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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Thrown to indicate that A files size exceeds the configured maximum.static class
Signals that a FileUpload I/O exception of some sort has occurred.static class
Thrown to indicate that the request is not a multipart request.static class
Thrown to indicate an IOException.protected static class
This exception is thrown, if a requests permitted size is exceeded.static class
Thrown to indicate that the request size exceeds the configured maximum.static class
Deprecated.1.2 As of commons-fileupload 1.2, the presence of a content-length header is no longer required. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Content-disposition value for file attachment.static final String
HTTP content disposition header name.static final String
HTTP content length header name.static final String
HTTP content type header name.static final int
Default per part header size limit in bytes.static final String
Content-disposition value for form data.static final int
Deprecated.This constant is no longer used.static final String
Part of HTTP content type header.static final String
HTTP content type header for multipart forms.static final String
HTTP content type header for multiple uploads.static final String
HTTP content type header for multiple related data. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected FileItem
createItem
(Map<String, String> headers, boolean isFormField) Deprecated.1.2 This method is no longer used in favor of internally created instances ofFileItem
.protected byte[]
getBoundary
(String contentType) Gets the boundary from theContent-type
header.protected String
getFieldName
(Map<String, String> headers) Deprecated.1.2.1 UsegetFieldName(FileItemHeaders)
.protected String
getFieldName
(FileItemHeaders headers) Gets the field name from theContent-disposition
header.long
Returns the maximum number of files allowed in a single request.abstract FileItemFactory
Returns the factory class used when creating file items.protected String
getFileName
(Map<String, String> headers) Deprecated.1.2.1 UsegetFileName(FileItemHeaders)
.protected String
getFileName
(FileItemHeaders headers) Gets the file name from theContent-disposition
header.long
Returns the maximum allowed size of a single uploaded file, as opposed togetSizeMax()
.protected final String
Deprecated.1.2.1 UseFileItemHeaders.getHeader(String)
.Gets the character encoding used when reading the headers of an individual part.Processes an RFC 1867 compliantmultipart/form-data
stream.protected FileItemHeaders
getParsedHeaders
(String headerPart) Parses theheader-part
and returns as key/value pairs.int
Obtain the per part size limit for headers.Returns the progress listener.long
Returns the maximum allowed size of a complete request, as opposed togetFileSizeMax()
.static boolean
Deprecated.1.1 Use the method onServletFileUpload
instead.static final boolean
Utility method that determines whether the request contains multipart content.protected FileItemHeadersImpl
Creates a new instance ofFileItemHeaders
.parseHeaders
(String headerPart) Deprecated.1.2.1 UsegetParsedHeaders(String)
Processes an RFC 1867 compliantmultipart/form-data
stream.Deprecated.1.1 UseServletFileUpload.parseRequest(HttpServletRequest)
instead.Processes an RFC 1867 compliantmultipart/form-data
stream.void
setFileCountMax
(long fileCountMax) Sets the maximum number of files allowed per request.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 togetSizeMax()
.void
setHeaderEncoding
(String encoding) Specifies the character encoding to be used when reading the headers of individual part.void
setPartHeaderSizeMax
(int partHeaderSizeMax) Sets the per part size limit for headers.void
setProgressListener
(ProgressListener listener) Sets the progress listener.void
setSizeMax
(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:
-
MULTIPART_RELATED
HTTP content type header for multiple related data.- Since:
- 1.6.0
- See Also:
-
MAX_HEADER_SIZE
Deprecated.This constant is no longer used. As of commons-fileupload 1.6, the applicable limit is the total size of a single part's headers,getPartHeaderSizeMax()
in bytes.The maximum length of a single header line that will be parsed (1024 bytes).- See Also:
-
DEFAULT_PART_HEADER_SIZE_MAX
Default per part header size limit in bytes.- Since:
- 1.6.0
- See Also:
-
-
Constructor Details
-
FileUploadBase
public FileUploadBase()Constructs a new instance.
-
-
Method Details
-
isMultipartContent
Deprecated.1.1 Use the method onServletFileUpload
instead.Utility method that determines whether the request contains multipart content.- Parameters:
req
- The servlet request to be evaluated. Must be non-null.- Returns:
true
if the request is multipart;false
otherwise.
-
isMultipartContent
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.- Parameters:
ctx
- The request context to be evaluated. Must be non-null.- Returns:
true
if the request is multipart;false
otherwise.
-
createItem
Deprecated.1.2 This method is no longer used in favor of internally created instances ofFileItem
.Creates a newFileItem
instance.- Parameters:
headers
- AMap
containing the HTTP request headers.isFormField
- Whether or not this item is a form field, as opposed to a file.- Returns:
- A newly created
FileItem
instance.
-
getBoundary
Gets the boundary from theContent-type
header.- 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-disposition
header.- Parameters:
headers
- AMap
containing the HTTP request headers.- Returns:
- The field name for the current
encapsulation
.
-
getFieldName
Deprecated.1.2.1 UsegetFieldName(FileItemHeaders)
.Gets the field name from theContent-disposition
header.- Parameters:
headers
- AMap
containing the HTTP request headers.- Returns:
- The field name for the current
encapsulation
.
-
getFileCountMax
Returns the maximum number of files allowed in a single request.- Returns:
- The maximum number of files allowed in a single request.
-
getFileItemFactory
Returns the factory class used when creating file items.- Returns:
- The factory class for new file items.
-
getFileName
Gets the file name from theContent-disposition
header.- Parameters:
headers
- The HTTP headers object.- Returns:
- The file name for the current
encapsulation
.
-
getFileName
Deprecated.1.2.1 UsegetFileName(FileItemHeaders)
.Gets the file name from theContent-disposition
header.- Parameters:
headers
- AMap
containing the HTTP request headers.- Returns:
- The file name for the current
encapsulation
.
-
getFileSizeMax
Returns the maximum allowed size of a single uploaded file, as opposed togetSizeMax()
.- Returns:
- Maximum size of a single uploaded file.
- See Also:
-
getHeader
Deprecated.1.2.1 UseFileItemHeaders.getHeader(String)
.Returns the header with the specified name from the supplied map. The header lookup is case-insensitive.- Parameters:
headers
- AMap
containing the HTTP request headers.name
- The name of the header to return.- Returns:
- The value of specified header, or a comma-separated list if there were multiple headers of that name.
-
getHeaderEncoding
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
Processes an RFC 1867 compliantmultipart/form-data
stream.- Parameters:
ctx
- The context for the request to be parsed.- Returns:
- An iterator to instances of
FileItemStream
parsed 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 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.
- Parameters:
headerPart
- Theheader-part
of the currentencapsulation
.- Returns:
- A
Map
containing the parsed HTTP request headers.
-
getPartHeaderSizeMax
Obtain the per part size limit for headers.- Returns:
- The maximum size of the headers for a single part in bytes.
- Since:
- 1.6.0
-
getProgressListener
Returns the progress listener.- Returns:
- The progress listener, if any, or null.
-
getSizeMax
Returns 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.
-
parseHeaders
Deprecated.1.2.1 UsegetParsedHeaders(String)
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.
- Parameters:
headerPart
- Theheader-part
of the currentencapsulation
.- Returns:
- A
Map
containing the parsed HTTP request headers.
-
parseParameterMap
Processes an RFC 1867 compliantmultipart/form-data
stream.- Parameters:
ctx
- The context for the request to be parsed.- Returns:
- A map of
FileItem
instances parsed from the request. - Throws:
FileUploadException
- if there are problems reading/parsing the request or storing files.- Since:
- 1.3
-
parseRequest
Deprecated.1.1 UseServletFileUpload.parseRequest(HttpServletRequest)
instead.Processes an RFC 1867 compliantmultipart/form-data
stream.- Parameters:
req
- The servlet request to be parsed.- Returns:
- A list of
FileItem
instances 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
Processes an RFC 1867 compliantmultipart/form-data
stream.- Parameters:
ctx
- The context for the request to be parsed.- Returns:
- A list of
FileItem
instances 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.-1
means 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:
-
setHeaderEncoding
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:
encoding
- The encoding used to read part headers.
-
setPartHeaderSizeMax
Sets the per part size limit for headers.- Parameters:
partHeaderSizeMax
- The maximum size of the headers in bytes.- Since:
- 1.6.0
-
setProgressListener
Sets the progress listener.- Parameters:
listener
- 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:
-