Class FileUploadBase
java.lang.Object
org.apache.tomcat.util.http.fileupload.FileUploadBase
- Direct Known Subclasses:
- FileUpload
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 SummaryFieldsModifier 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 intDefault per part header size limit in bytes.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 SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbyte[]getBoundary(String contentType) Gets the boundary from theContent-typeheader.getFieldName(FileItemHeaders headers) Gets the field name from theContent-dispositionheader.longReturns the maximum number of files allowed in a single request.abstract FileItemFactoryReturns the factory class used when creating file items.getFileName(FileItemHeaders headers) Gets the file name from theContent-dispositionheader.longReturns 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.Processes an RFC 1867 compliantmultipart/form-datastream.getParsedHeaders(String headerPart) Parses theheader-partand returns as key/value pairs.intObtain the per part size limit for headers.Returns the progress listener.longReturns the maximum allowed size of a complete request, as opposed togetFileSizeMax().protected FileItemHeadersImplCreates a new instance ofFileItemHeaders.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.voidsetPartHeaderSizeMax(int partHeaderSizeMax) Sets the per part size limit for headers.voidsetProgressListener(ProgressListener listener) Sets the progress listener.voidsetSizeMax(long sizeMax) Sets the maximum allowed size of a complete request, as opposed tosetFileSizeMax(long).
- 
Field Details- 
CONTENT_TYPE
- 
CONTENT_DISPOSITION
- 
CONTENT_LENGTH
- 
FORM_DATA
- 
ATTACHMENT
- 
MULTIPART
- 
MULTIPART_FORM_DATAHTTP content type header for multipart forms.- See Also:
 
- 
MULTIPART_MIXED
- 
DEFAULT_PART_HEADER_SIZE_MAXpublic static final int DEFAULT_PART_HEADER_SIZE_MAXDefault per part header size limit in bytes.- Since:
- FileUpload 1.6.0
- See Also:
 
 
- 
- 
Constructor Details- 
FileUploadBasepublic FileUploadBase()Constructs a new instance.
 
- 
- 
Method Details- 
getBoundaryGets 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.
 
- 
getFieldNameGets the field name from theContent-dispositionheader.- Parameters:
- headers- A- Mapcontaining the HTTP request headers.
- Returns:
- The field name for the current encapsulation.
 
- 
getFileCountMaxpublic long getFileCountMax()Returns the maximum number of files allowed in a single request.- Returns:
- The maximum number of files allowed in a single request.
 
- 
getFileItemFactoryReturns the factory class used when creating file items.- Returns:
- The factory class for new file items.
 
- 
getFileNameGets the file name from theContent-dispositionheader.- Parameters:
- headers- The HTTP headers object.
- Returns:
- The file name for the current encapsulation.
 
- 
getFileSizeMaxpublic 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:
 
- 
getHeaderEncodingGets 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.
 
- 
getItemIteratorProcesses 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.
 
- 
getParsedHeadersParses 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- The- header-partof the current- encapsulation.
- Returns:
- A Mapcontaining the parsed HTTP request headers.
 
- 
getPartHeaderSizeMaxpublic int getPartHeaderSizeMax()Obtain the per part size limit for headers.- Returns:
- The maximum size of the headers for a single part in bytes.
- Since:
- FileUpload 1.6.0
 
- 
getProgressListenerReturns the progress listener.- Returns:
- The progress listener, if any, or null.
 
- 
getSizeMaxpublic 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:
 
- 
newFileItemHeadersCreates a new instance ofFileItemHeaders.- Returns:
- The new instance.
 
- 
parseRequestProcesses 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.
 
- 
setFileCountMaxpublic void setFileCountMax(long fileCountMax) Sets the maximum number of files allowed per request.- Parameters:
- fileCountMax- The new limit.- -1means no limit.
 
- 
setFileItemFactorySets the factory class to use when creating file items.- Parameters:
- factory- The factory class for new file items.
 
- 
setFileSizeMaxpublic 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:
 
- 
setHeaderEncodingSpecifies 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.
 
- 
setPartHeaderSizeMaxpublic void setPartHeaderSizeMax(int partHeaderSizeMax) Sets the per part size limit for headers.- Parameters:
- partHeaderSizeMax- The maximum size of the headers in bytes.
- Since:
- FileUpload 1.6.0
 
- 
setProgressListenerSets the progress listener.- Parameters:
- listener- The progress listener, if any. Defaults to null.
 
- 
setSizeMaxpublic 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:
 
 
-