Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractFileItemBuilder() - Constructor for class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- AbstractFileUpload<R,
I, - Class in org.apache.commons.fileupload2.coreF> -
High level API for processing file uploads.
- AbstractFileUpload() - Constructor for class org.apache.commons.fileupload2.core.AbstractFileUpload
- AbstractRequestContext<T> - Class in org.apache.commons.fileupload2.core
- AbstractRequestContext(Function<String, String>, LongSupplier, T) - Constructor for class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Constructs a new instance.
- addHeader(String, String) - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Adds a header.
- ATTACHMENT - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Content-disposition value for file attachment.
- available() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Returns the number of bytes, which are currently available, without blocking.
B
- builder() - Static method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Constructs a new
DiskFileItem.Builder
. - builder() - Static method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Constructs a new
DiskFileItemFactory.Builder
. - builder() - Static method in class org.apache.commons.fileupload2.core.MultipartInput
-
Constructs a new
MultipartInput.Builder
. - Builder() - Constructor for class org.apache.commons.fileupload2.core.DiskFileItem.Builder
- Builder() - Constructor for class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
- Builder() - Constructor for class org.apache.commons.fileupload2.core.MultipartInput.Builder
C
- checkFileName(String) - Static method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Tests if the file name is valid.
- close() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Closes the input stream.
- close(boolean) - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Closes the input stream.
- CONTENT_DISPOSITION - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content disposition header name.
- CONTENT_LENGTH - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content length header name.
- CONTENT_TYPE - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content type header name.
- contextDestroyed(ServletContextEvent) - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaFileCleaner
-
Called when the web application is being destroyed.
- contextDestroyed(ServletContextEvent) - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaFileCleaner
-
Called when the web application is being destroyed.
- contextDestroyed(ServletContextEvent) - Method in class org.apache.commons.fileupload2.javax.JavaxFileCleaner
-
Called when the web application is being destroyed.
- contextInitialized(ServletContextEvent) - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaFileCleaner
-
Called when the web application is initialized.
- contextInitialized(ServletContextEvent) - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaFileCleaner
-
Called when the web application is initialized.
- contextInitialized(ServletContextEvent) - Method in class org.apache.commons.fileupload2.javax.JavaxFileCleaner
-
Called when the web application is initialized.
- CR - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
The Carriage Return ASCII character value.
D
- DASH - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
The dash (-) ASCII character value.
- DEFAULT_CHARSET - Static variable in class org.apache.commons.fileupload2.core.DiskFileItem
-
Default content charset to be used when no explicit charset parameter is provided by the sender.
- DEFAULT_THRESHOLD - Static variable in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
The default threshold in bytes above which uploads will be stored on disk.
- delete() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
- delete() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
- discardBodyData() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads
body-data
from the currentencapsulation
and discards it. - DiskFileItem - Class in org.apache.commons.fileupload2.core
-
The default implementation of the
FileItem
interface. - DiskFileItem.Builder - Class in org.apache.commons.fileupload2.core
-
Builds a new
DiskFileItem
instance. - DiskFileItemFactory - Class in org.apache.commons.fileupload2.core
-
The default
FileItemFactory
implementation. - DiskFileItemFactory.Builder - Class in org.apache.commons.fileupload2.core
-
Builds a new
DiskFileItemFactory
instance.
F
- FILE_CLEANING_TRACKER_ATTRIBUTE - Static variable in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaFileCleaner
-
Attribute name, which is used for storing an instance of
FileCleaningTracker
in the web application. - FILE_CLEANING_TRACKER_ATTRIBUTE - Static variable in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaFileCleaner
-
Attribute name, which is used for storing an instance of
FileCleaningTracker
in the web application. - FILE_CLEANING_TRACKER_ATTRIBUTE - Static variable in class org.apache.commons.fileupload2.javax.JavaxFileCleaner
-
Attribute name, which is used for storing an instance of
FileCleaningTracker
in the web application. - FileItem<F> - Interface in org.apache.commons.fileupload2.core
-
This class represents a file or form item that was received within a
multipart/form-data
POST request. - fileItemBuilder() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
- fileItemBuilder() - Method in interface org.apache.commons.fileupload2.core.FileItemFactory
-
Creates a new AbstractFileItemBuilder.
- FileItemFactory<I> - Interface in org.apache.commons.fileupload2.core
-
Creates
FileItem
instances. - FileItemFactory.AbstractFileItemBuilder<I,
B> - Class in org.apache.commons.fileupload2.core -
Abstracts building for subclasses.
- FileItemHeaders - Interface in org.apache.commons.fileupload2.core
-
This class provides support for accessing the headers for a file or form item that was received within a
multipart/form-data
POST request. - FileItemHeadersProvider<T> - Interface in org.apache.commons.fileupload2.core
-
Provides access to headers.
- FileItemInput - Interface in org.apache.commons.fileupload2.core
-
Provides access to a file or form item that was received within a
multipart/form-data
POST request. - FileItemInput.ItemSkippedException - Exception Class in org.apache.commons.fileupload2.core
-
This exception is thrown, if an attempt is made to read data from the
InputStream
, which has been returned byFileItemInput.getInputStream()
, afterIterator.hasNext()
has been invoked on the iterator, which created theFileItemInput
. - FileItemInputIterator - Interface in org.apache.commons.fileupload2.core
-
An iterator, as returned by
AbstractFileUpload.getItemIterator(RequestContext)
. - FileUploadBoundaryException(String) - Constructor for exception class org.apache.commons.fileupload2.core.MultipartInput.FileUploadBoundaryException
-
Constructs an instance with the specified detail message.
- FileUploadByteCountLimitException - Exception Class in org.apache.commons.fileupload2.core
-
Signals that a file size exceeds the configured maximum.
- FileUploadByteCountLimitException(String, long, long, String, String) - Constructor for exception class org.apache.commons.fileupload2.core.FileUploadByteCountLimitException
-
Constructs an instance with the specified detail message, and actual and permitted sizes.
- FileUploadContentTypeException - Exception Class in org.apache.commons.fileupload2.core
-
Signals that a request is not a multipart request.
- FileUploadContentTypeException(String, String) - Constructor for exception class org.apache.commons.fileupload2.core.FileUploadContentTypeException
-
Constructs an instance with the specified detail message.
- FileUploadContentTypeException(String, Throwable) - Constructor for exception class org.apache.commons.fileupload2.core.FileUploadContentTypeException
-
Constructs an instance with the specified detail message and cause.
- FileUploadException - Exception Class in org.apache.commons.fileupload2.core
-
Signals errors encountered while processing the request.
- FileUploadException(String) - Constructor for exception class org.apache.commons.fileupload2.core.FileUploadException
-
Constructs an instance with a given detail message.
- FileUploadException(String, Throwable) - Constructor for exception class org.apache.commons.fileupload2.core.FileUploadException
-
Constructs an instance with the given detail message and cause.
- FileUploadFileCountLimitException - Exception Class in org.apache.commons.fileupload2.core
-
Signals that a request contains more files than the specified limit.
- FileUploadFileCountLimitException(String, long, long) - Constructor for exception class org.apache.commons.fileupload2.core.FileUploadFileCountLimitException
-
Constructs an instance.
- FileUploadSizeException - Exception Class in org.apache.commons.fileupload2.core
-
Signals that a requests permitted size is exceeded.
- FileUploadSizeException(String, long, long) - Constructor for exception class org.apache.commons.fileupload2.core.FileUploadSizeException
-
Constructs an instance.
- findByte(byte, int) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Searches for a byte of specified value in the
buffer
, starting at the specifiedposition
. - findSeparator() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Searches for the
boundary
in thebuffer
region delimited byhead
andtail
. - FORM_DATA - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Content-disposition value for form data.
G
- get() - Method in class org.apache.commons.fileupload2.core.DiskFileItem.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the contents of the file as an array of bytes.
- get() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Constructs a new instance.
- get() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the contents of the file item as a byte array.
- get() - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Constructs a new instance.
- getActualSize() - Method in exception class org.apache.commons.fileupload2.core.FileUploadSizeException
-
Gets the actual size of the request.
- getBoundary(String) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the boundary from the
Content-type
header. - getBytesRead() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Gets the number of bytes, which have been read by the stream.
- getCharacterEncoding() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the character encoding for the request.
- getCharacterEncoding() - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletRequestContext
-
Gets the character encoding for the request.
- getCharacterEncoding() - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletRequestContext
-
Gets the character encoding for the request.
- getCharacterEncoding() - Method in class org.apache.commons.fileupload2.javax.JavaxServletRequestContext
-
Gets the character encoding for the request.
- getCharacterEncoding() - Method in class org.apache.commons.fileupload2.portlet.JavaxPortletRequestContext
-
Gets the character encoding for the request.
- getCharset() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the content charset passed by the agent or
null
if not defined. - getCharset() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the character encoding for the request or null if unspecified.
- getCharsetDefault() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the default charset for use when no explicit charset parameter is provided by the sender.
- getCharsetDefault() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the default charset for use when no explicit charset parameter is provided by the sender.
- getContentLength() - Method in class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Gets the content length of the request.
- getContentLength() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the content length of the request.
- getContentType() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the content type passed by the agent or
null
if not defined. - getContentType() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the content type passed by the browser or
null
if not defined. - getContentType() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- getContentType() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Gets the content type passed by the browser or
null
if not defined. - getContentType() - Method in exception class org.apache.commons.fileupload2.core.FileUploadContentTypeException
- getContentType() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the content type of the request.
- getContentType() - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletRequestContext
-
Gets the content type of the request.
- getContentType() - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletRequestContext
-
Gets the content type of the request.
- getContentType() - Method in class org.apache.commons.fileupload2.javax.JavaxServletRequestContext
-
Gets the content type of the request.
- getContentType() - Method in class org.apache.commons.fileupload2.portlet.JavaxPortletRequestContext
-
Gets the content type of the request.
- getFieldName() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the name of the field in the multipart form corresponding to this file item.
- getFieldName() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the name of the field in the multipart form corresponding to this file item.
- getFieldName() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- getFieldName() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Gets the name of the field in the multipart form corresponding to this file item.
- getFieldName() - Method in exception class org.apache.commons.fileupload2.core.FileUploadByteCountLimitException
-
Gets the field name of the item, which caused the exception.
- getFieldName(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the field name from the
Content-disposition
header. - getFileCleaningTracker() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the tracker, which is responsible for deleting temporary files.
- getFileCleaningTracker() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- getFileCleaningTracker(ServletContext) - Static method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaFileCleaner
-
Gets the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - getFileCleaningTracker(ServletContext) - Static method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaFileCleaner
-
Gets the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - getFileCleaningTracker(ServletContext) - Static method in class org.apache.commons.fileupload2.javax.JavaxFileCleaner
-
Gets the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - getFileCountMax() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the maximum number of files allowed in a single request.
- getFileItemFactory() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the factory class used when creating file items.
- getFileItemHeaders() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- getFileName() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- getFileName() - Method in exception class org.apache.commons.fileupload2.core.FileUploadByteCountLimitException
-
Gets the file name of the item, which caused the exception.
- getFileName(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the file name from the
Content-disposition
header. - getFileSizeMax() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the maximum allowed size of a single uploaded file, as opposed to
AbstractFileUpload.getSizeMax()
. - getFileSizeMax() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Gets the maximum size of a single file.
- getHeader(String) - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Gets the value of the specified part header as a
String
. - getHeaderCharset() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the character encoding used when reading the headers of an individual part.
- getHeaderCharset() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Gets the character encoding used when reading the headers of an individual part.
- getHeaderNames() - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Gets an
Iterator
of all the header names. - getHeaders() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the file item headers.
- getHeaders() - Method in interface org.apache.commons.fileupload2.core.FileItemHeadersProvider
-
Gets the collection of headers defined locally within this item.
- getHeaders(String) - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Gets all the values of the specified item header as an
Iterator
ofString
objects. - getInputStream() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets an
InputStream
that can be used to retrieve the contents of the file. - getInputStream() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets an
InputStream
that can be used to retrieve the contents of the file. - getInputStream() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Opens an
InputStream
, which allows to read the items contents. - getInputStream() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the input stream for the request.
- getInputStream() - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletRequestContext
-
Gets the input stream for the request.
- getInputStream() - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletRequestContext
-
Gets the input stream for the request.
- getInputStream() - Method in class org.apache.commons.fileupload2.javax.JavaxServletRequestContext
-
Gets the input stream for the request.
- getInputStream() - Method in class org.apache.commons.fileupload2.portlet.JavaxPortletRequestContext
-
Gets the input stream for the request.
- getItemIterator(HttpServletRequest) - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletFileUpload
-
Gets an RFC 1867 compliant
multipart/form-data
file item iterator. - getItemIterator(HttpServletRequest) - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletFileUpload
-
Gets an RFC 1867 compliant
multipart/form-data
file item iterator. - getItemIterator(ActionRequest) - Method in class org.apache.commons.fileupload2.portlet.JavaxPortletFileUpload
-
Gets an RFC 1867 compliant
multipart/form-data
file item iterator. - getItemIterator(HttpServletRequest) - Method in class org.apache.commons.fileupload2.javax.JavaxServletFileUpload
-
Gets an RFC 1867 compliant
multipart/form-data
file item iterator. - getItemIterator(RequestContext) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets an RFC 1867 compliant
multipart/form-data
stream. - getItemIterator(R) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets a file item iterator.
- getName() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the original file name in the client's file system.
- getName() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the original file name in the client's file system, as provided by the browser (or other client software).
- getName() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Gets the original file name in the client's file system, as provided by the browser (or other client software).
- getOutputStream() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets an
OutputStream
that can be used for storing the contents of the file. - getOutputStream() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets an
OutputStream
that can be used for storing the contents of the file. - getParsedHeaders(String) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses the
header-part
and returns as key/value pairs. - getPath() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the
Path
for theFileItem
's data's temporary location on the disk. - getPermitted() - Method in exception class org.apache.commons.fileupload2.core.FileUploadSizeException
-
Gets the limit size of the request.
- getProgressListener() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the progress listener.
- getRepository() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the directory used to temporarily store files that are larger than the configured size threshold.
- getRequest() - Method in class org.apache.commons.fileupload2.core.AbstractRequestContext
- getSize() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the size of the file.
- getSize() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the size of the file item.
- getSizeMax() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the maximum allowed size of a complete request, as opposed to
AbstractFileUpload.getFileSizeMax()
. - getSizeMax() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Gets the maximum size of the complete HTTP request.
- getString() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the contents of the file as a String, using the default character encoding.
- getString() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the contents of the file item as a String, using the default character encoding.
- getString(Charset) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the contents of the file as a String, using the specified encoding.
- getString(Charset) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the contents of the file item as a String, using the specified encoding.
- getTempFile() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Creates and returns a
File
representing a uniquely named temporary file in the configured repository path. - getThreshold() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the size threshold beyond which files are written directly to disk.
H
- hasNext() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Tests whether another instance of
FileItemInput
is available. - HEADER_PART_SIZE_MAX - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
The maximum length of
header-part
that will be processed (10 kilobytes = 10240 bytes.).
I
- isClosed() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
- isFormField() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Tests whether or not a
FileItem
instance represents a simple form field. - isFormField() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Tests whether or not a
FileItem
instance represents a simple form field. - isFormField() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- isFormField() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Tests whether or not a
FileItem
instance represents a simple form field. - isInMemory() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Provides a hint as to whether or not the file contents will be read from memory.
- isInMemory() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Tests a hint as to whether or not the file contents will be read from memory.
- isLowerCaseNames() - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Tests
true
if parameter names are to be converted to lower case when name/value pairs are parsed. - isMultipartContent(HttpServletRequest) - Static method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletFileUpload
-
Tests whether the request contains multipart content.
- isMultipartContent(HttpServletRequest) - Static method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletFileUpload
-
Tests whether the request contains multipart content.
- isMultipartContent(ActionRequest) - Static method in class org.apache.commons.fileupload2.portlet.JavaxPortletFileUpload
-
Tests whether the request contains multipart content.
- isMultipartContent(HttpServletRequest) - Static method in class org.apache.commons.fileupload2.javax.JavaxServletFileUpload
-
Tests whether the request contains multipart content.
- isMultipartContent(RequestContext) - Static method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Utility method that determines whether the request contains multipart content.
J
- JakartaFileCleaner - Class in org.apache.commons.fileupload2.jakarta.servlet5
-
A servlet context listener, which ensures that the
FileCleaningTracker
's reaper thread is terminated, when the web application is destroyed. - JakartaFileCleaner - Class in org.apache.commons.fileupload2.jakarta.servlet6
-
A servlet context listener, which ensures that the
FileCleaningTracker
's reaper thread is terminated, when the web application is destroyed. - JakartaFileCleaner() - Constructor for class org.apache.commons.fileupload2.jakarta.servlet5.JakartaFileCleaner
- JakartaFileCleaner() - Constructor for class org.apache.commons.fileupload2.jakarta.servlet6.JakartaFileCleaner
- JakartaServletDiskFileUpload - Class in org.apache.commons.fileupload2.jakarta.servlet5
-
A JakartaServletFileUpload for
DiskFileItem
andDiskFileItemFactory
. - JakartaServletDiskFileUpload - Class in org.apache.commons.fileupload2.jakarta.servlet6
-
A JakartaServletFileUpload for
DiskFileItem
andDiskFileItemFactory
. - JakartaServletDiskFileUpload() - Constructor for class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletDiskFileUpload
- JakartaServletDiskFileUpload() - Constructor for class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletDiskFileUpload
- JakartaServletDiskFileUpload(DiskFileItemFactory) - Constructor for class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletDiskFileUpload
- JakartaServletDiskFileUpload(DiskFileItemFactory) - Constructor for class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletDiskFileUpload
- JakartaServletFileUpload<I,
F> - Class in org.apache.commons.fileupload2.jakarta.servlet5 -
High level API for processing file uploads.
- JakartaServletFileUpload<I,
F> - Class in org.apache.commons.fileupload2.jakarta.servlet6 -
High level API for processing file uploads.
- JakartaServletFileUpload() - Constructor for class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletFileUpload
-
Constructs an uninitialized instance of this class.
- JakartaServletFileUpload() - Constructor for class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletFileUpload
-
Constructs an uninitialized instance of this class.
- JakartaServletFileUpload(F) - Constructor for class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletFileUpload
-
Constructs an instance of this class which uses the supplied factory to create
FileItem
instances. - JakartaServletFileUpload(F) - Constructor for class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletFileUpload
-
Constructs an instance of this class which uses the supplied factory to create
FileItem
instances. - JakartaServletRequestContext - Class in org.apache.commons.fileupload2.jakarta.servlet5
-
Provides access to the request information needed for a request made to an HTTP servlet.
- JakartaServletRequestContext - Class in org.apache.commons.fileupload2.jakarta.servlet6
-
Provides access to the request information needed for a request made to an HTTP servlet.
- JakartaServletRequestContext(HttpServletRequest) - Constructor for class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletRequestContext
-
Constructs a context for this request.
- JakartaServletRequestContext(HttpServletRequest) - Constructor for class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletRequestContext
-
Constructs a context for this request.
- JavaxFileCleaner - Class in org.apache.commons.fileupload2.javax
-
A servlet context listener, which ensures that the
FileCleaningTracker
's reaper thread is terminated, when the web application is destroyed. - JavaxFileCleaner() - Constructor for class org.apache.commons.fileupload2.javax.JavaxFileCleaner
- JavaxPortletFileUpload<I,
F> - Class in org.apache.commons.fileupload2.portlet -
High level API for processing file uploads.
- JavaxPortletFileUpload() - Constructor for class org.apache.commons.fileupload2.portlet.JavaxPortletFileUpload
-
Constructs an uninitialized instance of this class.
- JavaxPortletFileUpload(F) - Constructor for class org.apache.commons.fileupload2.portlet.JavaxPortletFileUpload
-
Constructs an instance of this class which uses the supplied factory to create
FileItem
instances. - JavaxPortletRequestContext - Class in org.apache.commons.fileupload2.portlet
-
Provides access to the request information needed for a request made to a portlet.
- JavaxPortletRequestContext(ActionRequest) - Constructor for class org.apache.commons.fileupload2.portlet.JavaxPortletRequestContext
-
Constructs a context for this request.
- JavaxServletDiskFileUpload - Class in org.apache.commons.fileupload2.javax
-
A JavaxServletFileUpload for
DiskFileItem
andDiskFileItemFactory
. - JavaxServletDiskFileUpload() - Constructor for class org.apache.commons.fileupload2.javax.JavaxServletDiskFileUpload
- JavaxServletDiskFileUpload(DiskFileItemFactory) - Constructor for class org.apache.commons.fileupload2.javax.JavaxServletDiskFileUpload
- JavaxServletFileUpload<I,
F> - Class in org.apache.commons.fileupload2.javax -
High level API for processing file uploads.
- JavaxServletFileUpload() - Constructor for class org.apache.commons.fileupload2.javax.JavaxServletFileUpload
-
Constructs an uninitialized instance of this class.
- JavaxServletFileUpload(F) - Constructor for class org.apache.commons.fileupload2.javax.JavaxServletFileUpload
-
Constructs an instance of this class which uses the supplied factory to create
FileItem
instances. - JavaxServletRequestContext - Class in org.apache.commons.fileupload2.javax
-
Provides access to the request information needed for a request made to an HTTP servlet.
- JavaxServletRequestContext(HttpServletRequest) - Constructor for class org.apache.commons.fileupload2.javax.JavaxServletRequestContext
-
Constructs a context for this request.
L
- LF - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
The Line Feed ASCII character value.
M
- MalformedStreamException(String) - Constructor for exception class org.apache.commons.fileupload2.core.MultipartInput.MalformedStreamException
-
Constructs an
MalformedStreamException
with the specified detail message. - MalformedStreamException(String, Throwable) - Constructor for exception class org.apache.commons.fileupload2.core.MultipartInput.MalformedStreamException
-
Constructs an
MalformedStreamException
with the specified detail message. - MULTIPART - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Part of HTTP content type header.
- MULTIPART_FORM_DATA - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content type header for multipart forms.
- MULTIPART_MIXED - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content type header for multiple uploads.
- MultipartInput - Class in org.apache.commons.fileupload2.core
-
Low-level API for processing file uploads.
- MultipartInput.Builder - Class in org.apache.commons.fileupload2.core
-
Builds a new
MultipartInput
instance. - MultipartInput.FileUploadBoundaryException - Exception Class in org.apache.commons.fileupload2.core
-
Signals an attempt to set an invalid boundary token.
- MultipartInput.ItemInputStream - Class in org.apache.commons.fileupload2.core
-
An
InputStream
for reading an items contents. - MultipartInput.MalformedStreamException - Exception Class in org.apache.commons.fileupload2.core
-
Signals that the input stream fails to follow the required syntax.
- MultipartInput.ProgressNotifier - Class in org.apache.commons.fileupload2.core
-
Internal class, which is used to invoke the
ProgressListener
.
N
- newFileItemHeaders() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Creates a new instance of
FileItemHeaders
. - newFileItemHeaders() - Static method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- newInputStream() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Creates a new
MultipartInput.ItemInputStream
. - next() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Returns the next available
FileItemInput
. - NOP - Static variable in interface org.apache.commons.fileupload2.core.ProgressListener
-
Nop implementation.
- noteItem() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ProgressNotifier
-
Called to indicate, that a new file item has been detected.
O
- org.apache.commons.fileupload2.core - package org.apache.commons.fileupload2.core
-
A component for handling HTML file uploads as specified by RFC 1867.
- org.apache.commons.fileupload2.jakarta.servlet5 - package org.apache.commons.fileupload2.jakarta.servlet5
-
An implementation of
AbstractFileUpload
for use in servlets conforming to the namespacejakarta.servlet
. - org.apache.commons.fileupload2.jakarta.servlet6 - package org.apache.commons.fileupload2.jakarta.servlet6
-
An implementation of
AbstractFileUpload
for use in servlets conforming to the namespacejakarta.servlet
. - org.apache.commons.fileupload2.javax - package org.apache.commons.fileupload2.javax
-
An implementation of
AbstractFileUpload
for use in servlets conforming to JSR 53. - org.apache.commons.fileupload2.portlet - package org.apache.commons.fileupload2.portlet
-
An implementation of
AbstractFileUpload
for use in portlets conforming to JSR 168.
P
- ParameterParser - Class in org.apache.commons.fileupload2.core
-
A simple parser intended to parse sequences of name/value pairs.
- ParameterParser() - Constructor for class org.apache.commons.fileupload2.core.ParameterParser
-
Default ParameterParser constructor.
- parse(char[], char) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given array of characters.
- parse(char[], int, int, char) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given array of characters.
- parse(String, char) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given string.
- parse(String, char[]) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given string.
- parseParameterMap(HttpServletRequest) - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseParameterMap(HttpServletRequest) - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseParameterMap(ActionRequest) - Method in class org.apache.commons.fileupload2.portlet.JavaxPortletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseParameterMap(HttpServletRequest) - Method in class org.apache.commons.fileupload2.javax.JavaxServletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseParameterMap(RequestContext) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseParameterMap(R) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseRequest(HttpServletRequest) - Method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaServletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseRequest(HttpServletRequest) - Method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaServletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseRequest(ActionRequest) - Method in class org.apache.commons.fileupload2.portlet.JavaxPortletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseRequest(HttpServletRequest) - Method in class org.apache.commons.fileupload2.javax.JavaxServletFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseRequest(RequestContext) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - parseRequest(R) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-data
stream. - ProgressListener - Interface in org.apache.commons.fileupload2.core
-
Receives progress information.
- ProgressNotifier(ProgressListener, long) - Constructor for class org.apache.commons.fileupload2.core.MultipartInput.ProgressNotifier
-
Creates a new instance with the given listener and content length.
R
- read() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Reads the next byte in the stream.
- read(byte[], int, int) - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Reads bytes into the given buffer.
- readBodyData(OutputStream) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads
body-data
from the currentencapsulation
and writes its contents into the outputStream
. - readBoundary() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Skips a
boundary
token, and checks whether moreencapsulations
are contained in the stream. - readByte() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads a byte from the
buffer
, and refills it as necessary. - readHeaders() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads the
header-part
of the currentencapsulation
. - RequestContext - Interface in org.apache.commons.fileupload2.core
-
Abstracts access to the request information needed for file uploads.
S
- setBoundary(byte[]) - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Sets the boundary.
- setBoundary(byte[]) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Changes the boundary token used for partitioning the stream.
- setCharsetDefault(Charset) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Sets the default charset for use when no explicit charset parameter is provided by the sender.
- setContentType(String) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- setFieldName(String) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Sets the field name used to reference this file item.
- setFieldName(String) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Sets the field name used to reference this file item.
- setFieldName(String) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- setFileCleaningTracker(ServletContext, FileCleaningTracker) - Static method in class org.apache.commons.fileupload2.jakarta.servlet5.JakartaFileCleaner
-
Sets the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - setFileCleaningTracker(ServletContext, FileCleaningTracker) - Static method in class org.apache.commons.fileupload2.jakarta.servlet6.JakartaFileCleaner
-
Sets the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - setFileCleaningTracker(ServletContext, FileCleaningTracker) - Static method in class org.apache.commons.fileupload2.javax.JavaxFileCleaner
-
Sets the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - setFileCleaningTracker(FileCleaningTracker) - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Sets the tracker, which is responsible for deleting temporary files.
- setFileCleaningTracker(FileCleaningTracker) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- setFileCountMax(long) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the maximum number of files allowed per request.
- setFileItemFactory(F) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the factory class to use when creating file items.
- setFileItemHeaders(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- setFileName(String) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- setFileSizeMax(long) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the maximum allowed size of a single uploaded file, as opposed to
AbstractFileUpload.getSizeMax()
. - setFileSizeMax(long) - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Sets the maximum size of a single file.
- setFormField(boolean) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Specifies whether or not a
FileItem
instance represents a simple form field. - setFormField(boolean) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Sets whether or not a
FileItem
instance represents a simple form field. - setFormField(boolean) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
- setHeaderCharset(Charset) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Specifies the character encoding to be used when reading the headers of individual part.
- setHeaderCharset(Charset) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Sets the character encoding to be used when reading the headers of individual parts.
- setHeaders(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Sets the file item headers.
- setHeaders(FileItemHeaders) - Method in interface org.apache.commons.fileupload2.core.FileItemHeadersProvider
-
Sets the headers read from within an item.
- setLowerCaseNames(boolean) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Sets the flag if parameter names are to be converted to lower case when name/value pairs are parsed.
- setProgressListener(ProgressListener) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the progress listener.
- setProgressNotifier(MultipartInput.ProgressNotifier) - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Sets the progress notifier.
- setSizeMax(long) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the maximum allowed size of a complete request, as opposed to
AbstractFileUpload.setFileSizeMax(long)
. - setSizeMax(long) - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Sets the maximum size of the complete HTTP request.
- skip(long) - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Skips the given number of bytes.
- skipPreamble() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Finds the beginning of the first
encapsulation
.
T
- toString() - Method in class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Returns a string representation of this object.
- toString() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Returns a string representation of this object.
U
- update(long, long, int) - Method in interface org.apache.commons.fileupload2.core.ProgressListener
-
Updates the listeners status information.
W
- write(Path) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Writes an uploaded item to disk.
- write(Path) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Writes an uploaded item to disk.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form