Class FileUploadBase
- java.lang.Object
-
- org.apache.tomcat.util.http.fileupload.FileUploadBase
-
- Direct Known Subclasses:
FileUpload
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/mixedencoding type, as specified by RFC 1867. UseparseRequest(RequestContext)to acquire a list ofFileItems 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
Fields Modifier and Type Field Description static StringATTACHMENTContent-disposition value for file attachment.static StringCONTENT_DISPOSITIONHTTP content disposition header name.static StringCONTENT_LENGTHHTTP content length header name.static StringCONTENT_TYPEHTTP content type header name.static StringFORM_DATAContent-disposition value for form data.static StringMULTIPARTPart of HTTP content type header.static StringMULTIPART_FORM_DATAHTTP content type header for multipart forms.static StringMULTIPART_MIXEDHTTP content type header for multiple uploads.
-
Constructor Summary
Constructors Constructor Description FileUploadBase()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description byte[]getBoundary(String contentType)Retrieves the boundary from theContent-typeheader.StringgetFieldName(FileItemHeaders headers)Retrieves the field name from theContent-dispositionheader.longgetFileCountMax()Returns the maximum number of files allowed in a single request.abstract FileItemFactorygetFileItemFactory()Returns the factory class used when creating file items.StringgetFileName(FileItemHeaders headers)Retrieves the file name from theContent-dispositionheader.longgetFileSizeMax()Returns the maximum allowed size of a single uploaded file, as opposed togetSizeMax().StringgetHeaderEncoding()Retrieves the character encoding used when reading the headers of an individual part.FileItemIteratorgetItemIterator(RequestContext ctx)Processes an RFC 1867 compliantmultipart/form-datastream.FileItemHeadersgetParsedHeaders(String headerPart)Parses theheader-partand returns as key/value pairs.ProgressListenergetProgressListener()Returns the progress listener.longgetSizeMax()Returns the maximum allowed size of a complete request, as opposed togetFileSizeMax().protected FileItemHeadersImplnewFileItemHeaders()Creates a new instance ofFileItemHeaders.List<FileItem>parseRequest(RequestContext ctx)Processes an RFC 1867 compliantmultipart/form-datastream.voidsetFileCountMax(long fileCountMax)Sets the maximum number of files allowed per request.abstract voidsetFileItemFactory(FileItemFactory 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().voidsetHeaderEncoding(String encoding)Specifies the character encoding to be used when reading the headers of individual part.voidsetProgressListener(ProgressListener pListener)Sets the progress listener.voidsetSizeMax(long sizeMax)Sets the maximum allowed size of a complete request, as opposed tosetFileSizeMax(long).
-
-
-
Field Detail
-
CONTENT_TYPE
public static final String CONTENT_TYPE
HTTP content type header name.- See Also:
- Constant Field Values
-
CONTENT_DISPOSITION
public static final String CONTENT_DISPOSITION
HTTP content disposition header name.- See Also:
- Constant Field Values
-
CONTENT_LENGTH
public static final String CONTENT_LENGTH
HTTP content length header name.- See Also:
- Constant Field Values
-
FORM_DATA
public static final String FORM_DATA
Content-disposition value for form data.- See Also:
- Constant Field Values
-
ATTACHMENT
public static final String ATTACHMENT
Content-disposition value for file attachment.- See Also:
- Constant Field Values
-
MULTIPART
public static final String MULTIPART
Part of HTTP content type header.- See Also:
- Constant Field Values
-
MULTIPART_FORM_DATA
public static final String MULTIPART_FORM_DATA
HTTP content type header for multipart forms.- See Also:
- Constant Field Values
-
MULTIPART_MIXED
public static final String MULTIPART_MIXED
HTTP content type header for multiple uploads.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.-1means no limit.
-
getHeaderEncoding
public 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(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.
-
getItemIterator
public FileItemIterator getItemIterator(RequestContext ctx) throws FileUploadException, IOException
Processes an RFC 1867 compliantmultipart/form-datastream.- Parameters:
ctx- The context for the request to be parsed.- Returns:
- An iterator to instances of
FileItemStreamparsed 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.
-
parseRequest
public List<FileItem> parseRequest(RequestContext ctx) throws FileUploadException
Processes an RFC 1867 compliantmultipart/form-datastream.- Parameters:
ctx- 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.
-
getBoundary
public byte[] getBoundary(String contentType)
Retrieves 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.
-
getFileName
public String getFileName(FileItemHeaders headers)
Retrieves the file name from theContent-dispositionheader.- Parameters:
headers- The HTTP headers object.- Returns:
- The file name for the current
encapsulation.
-
getFieldName
public String getFieldName(FileItemHeaders headers)
Retrieves the field name from theContent-dispositionheader.- Parameters:
headers- AMapcontaining the HTTP request headers.- Returns:
- The field name for the current
encapsulation.
-
getParsedHeaders
public FileItemHeaders getParsedHeaders(String headerPart)
Parses the
header-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.
-
newFileItemHeaders
protected FileItemHeadersImpl newFileItemHeaders()
Creates a new instance ofFileItemHeaders.- Returns:
- The new instance.
-
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.
-
-