Class FileUploadBase
- java.lang.Object
-
- org.apache.commons.fileupload.FileUploadBase
-
- Direct Known Subclasses:
DiskFileUpload
,FileUpload
public abstract class FileUploadBase extends java.lang.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. UseparseRequest(RequestContext)
to acquire a list ofFileItem
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 Classes Modifier and Type Class Description private class
FileUploadBase.FileItemIteratorImpl
The iterator, which is returned bygetItemIterator(RequestContext)
.static class
FileUploadBase.FileSizeLimitExceededException
Thrown to indicate that A files size exceeds the configured maximum.static class
FileUploadBase.FileUploadIOException
This exception is thrown for hiding an innerFileUploadException
in anIOException
.static class
FileUploadBase.InvalidContentTypeException
Thrown to indicate that the request is not a multipart request.static class
FileUploadBase.IOFileUploadException
Thrown to indicate an IOException.protected static class
FileUploadBase.SizeException
This exception is thrown, if a requests permitted size is exceeded.static class
FileUploadBase.SizeLimitExceededException
Thrown to indicate that the request size exceeds the configured maximum.static class
FileUploadBase.UnknownSizeException
Deprecated.1.2 As of commons-fileupload 1.2, the presence of a content-length header is no longer required.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTACHMENT
Content-disposition value for file attachment.static java.lang.String
CONTENT_DISPOSITION
HTTP content disposition header name.static java.lang.String
CONTENT_LENGTH
HTTP content length header name.static java.lang.String
CONTENT_TYPE
HTTP content type header name.private long
fileCountMax
The maximum permitted number of files that may be uploaded in a single request.private long
fileSizeMax
The maximum size permitted for a single uploaded file, as opposed tosizeMax
.static java.lang.String
FORM_DATA
Content-disposition value for form data.private java.lang.String
headerEncoding
The content encoding to use when reading part headers.private ProgressListener
listener
The progress listener.static int
MAX_HEADER_SIZE
Deprecated.This constant is no longer used.static java.lang.String
MULTIPART
Part of HTTP content type header.static java.lang.String
MULTIPART_FORM_DATA
HTTP content type header for multipart forms.static java.lang.String
MULTIPART_MIXED
HTTP content type header for multiple uploads.private long
sizeMax
The maximum size permitted for the complete request, as opposed tofileSizeMax
.
-
Constructor Summary
Constructors Constructor Description FileUploadBase()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected FileItem
createItem(java.util.Map<java.lang.String,java.lang.String> headers, boolean isFormField)
Deprecated.1.2 This method is no longer used in favour of internally created instances ofFileItem
.protected byte[]
getBoundary(java.lang.String contentType)
Retrieves the boundary from theContent-type
header.private java.lang.String
getFieldName(java.lang.String pContentDisposition)
Returns the field name, which is given by the content-disposition header.protected java.lang.String
getFieldName(java.util.Map<java.lang.String,java.lang.String> headers)
Deprecated.1.2.1 UsegetFieldName(FileItemHeaders)
.protected java.lang.String
getFieldName(FileItemHeaders headers)
Retrieves the field name from theContent-disposition
header.long
getFileCountMax()
Returns the maximum number of files allowed in a single request.abstract FileItemFactory
getFileItemFactory()
Returns the factory class used when creating file items.private java.lang.String
getFileName(java.lang.String pContentDisposition)
Returns the given content-disposition headers file name.protected java.lang.String
getFileName(java.util.Map<java.lang.String,java.lang.String> headers)
Deprecated.1.2.1 UsegetFileName(FileItemHeaders)
.protected java.lang.String
getFileName(FileItemHeaders headers)
Retrieves the file name from theContent-disposition
header.long
getFileSizeMax()
Returns the maximum allowed size of a single uploaded file, as opposed togetSizeMax()
.protected java.lang.String
getHeader(java.util.Map<java.lang.String,java.lang.String> headers, java.lang.String name)
Deprecated.1.2.1 UseFileItemHeaders.getHeader(String)
.java.lang.String
getHeaderEncoding()
Retrieves the character encoding used when reading the headers of an individual part.FileItemIterator
getItemIterator(RequestContext ctx)
Processes an RFC 1867 compliantmultipart/form-data
stream.protected FileItemHeaders
getParsedHeaders(java.lang.String headerPart)
Parses theheader-part
and returns as key/value pairs.ProgressListener
getProgressListener()
Returns the progress listener.long
getSizeMax()
Returns the maximum allowed size of a complete request, as opposed togetFileSizeMax()
.static boolean
isMultipartContent(javax.servlet.http.HttpServletRequest req)
Deprecated.1.1 Use the method onServletFileUpload
instead.static boolean
isMultipartContent(RequestContext ctx)
Utility method that determines whether the request contains multipart content.protected FileItemHeadersImpl
newFileItemHeaders()
Creates a new instance ofFileItemHeaders
.private int
parseEndOfLine(java.lang.String headerPart, int end)
Skips bytes until the end of the current line.private void
parseHeaderLine(FileItemHeadersImpl headers, java.lang.String header)
Reads the next header line.protected java.util.Map<java.lang.String,java.lang.String>
parseHeaders(java.lang.String headerPart)
Deprecated.1.2.1 UsegetParsedHeaders(String)
java.util.Map<java.lang.String,java.util.List<FileItem>>
parseParameterMap(RequestContext ctx)
Processes an RFC 1867 compliantmultipart/form-data
stream.java.util.List<FileItem>
parseRequest(javax.servlet.http.HttpServletRequest req)
Deprecated.1.1 UseServletFileUpload.parseRequest(HttpServletRequest)
instead.java.util.List<FileItem>
parseRequest(RequestContext ctx)
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(java.lang.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 tosetFileSizeMax(long)
.
-
-
-
Field Detail
-
CONTENT_TYPE
public static final java.lang.String CONTENT_TYPE
HTTP content type header name.- See Also:
- Constant Field Values
-
CONTENT_DISPOSITION
public static final java.lang.String CONTENT_DISPOSITION
HTTP content disposition header name.- See Also:
- Constant Field Values
-
CONTENT_LENGTH
public static final java.lang.String CONTENT_LENGTH
HTTP content length header name.- See Also:
- Constant Field Values
-
FORM_DATA
public static final java.lang.String FORM_DATA
Content-disposition value for form data.- See Also:
- Constant Field Values
-
ATTACHMENT
public static final java.lang.String ATTACHMENT
Content-disposition value for file attachment.- See Also:
- Constant Field Values
-
MULTIPART
public static final java.lang.String MULTIPART
Part of HTTP content type header.- See Also:
- Constant Field Values
-
MULTIPART_FORM_DATA
public static final java.lang.String MULTIPART_FORM_DATA
HTTP content type header for multipart forms.- See Also:
- Constant Field Values
-
MULTIPART_MIXED
public static final java.lang.String MULTIPART_MIXED
HTTP content type header for multiple uploads.- See Also:
- Constant Field Values
-
MAX_HEADER_SIZE
@Deprecated public static final int MAX_HEADER_SIZE
Deprecated.This constant is no longer used. As of commons-fileupload 1.2, the only applicable limit is the total size of a parts headers,MultipartStream.HEADER_PART_SIZE_MAX
.The maximum length of a single header line that will be parsed (1024 bytes).- See Also:
- Constant Field Values
-
sizeMax
private long sizeMax
The maximum size permitted for the complete request, as opposed tofileSizeMax
. A value of -1 indicates no maximum.
-
fileSizeMax
private long fileSizeMax
The maximum size permitted for a single uploaded file, as opposed tosizeMax
. A value of -1 indicates no maximum.
-
fileCountMax
private long fileCountMax
The maximum permitted number of files that may be uploaded in a single request. A value of -1 indicates no maximum.
-
headerEncoding
private java.lang.String headerEncoding
The content encoding to use when reading part headers.
-
listener
private ProgressListener listener
The progress listener.
-
-
Method Detail
-
isMultipartContent
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.- Parameters:
ctx
- The request context to be evaluated. Must be non-null.- Returns:
true
if the request is multipart;false
otherwise.
-
isMultipartContent
@Deprecated public static boolean isMultipartContent(javax.servlet.http.HttpServletRequest req)
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.
-
getFileItemFactory
public abstract FileItemFactory getFileItemFactory()
Returns the factory class used when creating file items.- Returns:
- The factory class for new file items.
-
setFileItemFactory
public abstract void setFileItemFactory(FileItemFactory factory)
Sets the factory class to use when creating file items.- Parameters:
factory
- The factory class for new file items.
-
getSizeMax
public long 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:
setSizeMax(long)
-
setSizeMax
public void setSizeMax(long sizeMax)
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:
getSizeMax()
-
getFileSizeMax
public long getFileSizeMax()
Returns the maximum allowed size of a single uploaded file, as opposed togetSizeMax()
.- Returns:
- Maximum size of a single uploaded file.
- See Also:
setFileSizeMax(long)
-
setFileSizeMax
public void setFileSizeMax(long fileSizeMax)
Sets the maximum allowed size of a single uploaded file, as opposed togetSizeMax()
.- Parameters:
fileSizeMax
- Maximum size of a single uploaded file.- See Also:
getFileSizeMax()
-
getFileCountMax
public long getFileCountMax()
Returns the maximum number of files allowed in a single request.- Returns:
- The maximum number of files allowed in a single request.
-
setFileCountMax
public void setFileCountMax(long fileCountMax)
Sets the maximum number of files allowed per request.- Parameters:
fileCountMax
- The new limit.-1
means no limit.
-
getHeaderEncoding
public java.lang.String getHeaderEncoding()
Retrieves 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.
-
setHeaderEncoding
public void setHeaderEncoding(java.lang.String encoding)
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.
-
parseRequest
@Deprecated public java.util.List<FileItem> parseRequest(javax.servlet.http.HttpServletRequest req) throws FileUploadException
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.
-
getItemIterator
public FileItemIterator getItemIterator(RequestContext ctx) throws FileUploadException, java.io.IOException
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.java.io.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.
-
parseRequest
public java.util.List<FileItem> parseRequest(RequestContext ctx) throws FileUploadException
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.
-
parseParameterMap
public java.util.Map<java.lang.String,java.util.List<FileItem>> parseParameterMap(RequestContext ctx) throws FileUploadException
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
-
getBoundary
protected byte[] getBoundary(java.lang.String contentType)
Retrieves 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.
-
getFileName
@Deprecated protected java.lang.String getFileName(java.util.Map<java.lang.String,java.lang.String> headers)
Deprecated.1.2.1 UsegetFileName(FileItemHeaders)
.Retrieves the file name from theContent-disposition
header.- Parameters:
headers
- AMap
containing the HTTP request headers.- Returns:
- The file name for the current
encapsulation
.
-
getFileName
protected java.lang.String getFileName(FileItemHeaders headers)
Retrieves the file name from theContent-disposition
header.- Parameters:
headers
- The HTTP headers object.- Returns:
- The file name for the current
encapsulation
.
-
getFileName
private java.lang.String getFileName(java.lang.String pContentDisposition)
Returns the given content-disposition headers file name.- Parameters:
pContentDisposition
- The content-disposition headers value.- Returns:
- The file name
-
getFieldName
protected java.lang.String getFieldName(FileItemHeaders headers)
Retrieves the field name from theContent-disposition
header.- Parameters:
headers
- AMap
containing the HTTP request headers.- Returns:
- The field name for the current
encapsulation
.
-
getFieldName
private java.lang.String getFieldName(java.lang.String pContentDisposition)
Returns the field name, which is given by the content-disposition header.- Parameters:
pContentDisposition
- The content-dispositions header value.- Returns:
- The field jake
-
getFieldName
@Deprecated protected java.lang.String getFieldName(java.util.Map<java.lang.String,java.lang.String> headers)
Deprecated.1.2.1 UsegetFieldName(FileItemHeaders)
.Retrieves the field name from theContent-disposition
header.- Parameters:
headers
- AMap
containing the HTTP request headers.- Returns:
- The field name for the current
encapsulation
.
-
createItem
@Deprecated protected FileItem createItem(java.util.Map<java.lang.String,java.lang.String> headers, boolean isFormField) throws FileUploadException
Deprecated.1.2 This method is no longer used in favour 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. - Throws:
FileUploadException
- if an error occurs.
-
getParsedHeaders
protected FileItemHeaders getParsedHeaders(java.lang.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.
- Parameters:
headerPart
- Theheader-part
of the currentencapsulation
.- Returns:
- A
Map
containing the parsed HTTP request headers.
-
newFileItemHeaders
protected FileItemHeadersImpl newFileItemHeaders()
Creates a new instance ofFileItemHeaders
.- Returns:
- The new instance.
-
parseHeaders
@Deprecated protected java.util.Map<java.lang.String,java.lang.String> parseHeaders(java.lang.String headerPart)
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.
-
parseEndOfLine
private int parseEndOfLine(java.lang.String headerPart, int end)
Skips bytes until the end of the current line.- Parameters:
headerPart
- The headers, which are being parsed.end
- Index of the last byte, which has yet been processed.- Returns:
- Index of the \r\n sequence, which indicates end of line.
-
parseHeaderLine
private void parseHeaderLine(FileItemHeadersImpl headers, java.lang.String header)
Reads the next header line.- Parameters:
headers
- String with all headers.header
- Map where to store the current header.
-
getHeader
@Deprecated protected final java.lang.String getHeader(java.util.Map<java.lang.String,java.lang.String> headers, java.lang.String name)
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.
-
getProgressListener
public ProgressListener getProgressListener()
Returns the progress listener.- Returns:
- The progress listener, if any, or null.
-
setProgressListener
public void setProgressListener(ProgressListener pListener)
Sets the progress listener.- Parameters:
pListener
- The progress listener, if any. Defaults to null.
-
-