- FIELD_SEPARATOR - Static variable in class org.apache.commons.fileupload.MultipartStream
-
A byte sequence that that follows a delimiter that will be
followed by an encapsulation (CRLF
).
- fieldName - Variable in class org.apache.commons.fileupload.disk.DiskFileItem
-
The name of the form field as provided by the browser.
- FileItem - Interface in org.apache.commons.fileupload
-
This class represents a file or form item that was received within a
multipart/form-data
POST request.
- fileItemFactory - Variable in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
The factory to use to create new form items.
- FileItemFactory - Interface in org.apache.commons.fileupload
-
A factory interface for creating
FileItem
instances.
- fileItemFactory - Variable in class org.apache.commons.fileupload.FileUpload
-
The factory to use to create new form items.
- fileName - Variable in class org.apache.commons.fileupload.disk.DiskFileItem
-
The original filename in the user's filesystem.
- FileUpload - Class in org.apache.commons.fileupload
-
High level API for processing file uploads.
- FileUpload() - Constructor for class org.apache.commons.fileupload.FileUpload
-
Constructs an uninitialised instance of this class.
- FileUpload(FileItemFactory) - Constructor for class org.apache.commons.fileupload.FileUpload
-
Constructs an instance of this class which uses the supplied factory to
create FileItem
instances.
- FileUploadBase - Class in org.apache.commons.fileupload
-
High level API for processing file uploads.
- FileUploadBase() - Constructor for class org.apache.commons.fileupload.FileUploadBase
-
- FileUploadBase.InvalidContentTypeException - Exception in org.apache.commons.fileupload
-
Thrown to indicate that the request is not a multipart request.
- FileUploadBase.InvalidContentTypeException() - Constructor for exception org.apache.commons.fileupload.FileUploadBase.InvalidContentTypeException
-
Constructs a InvalidContentTypeException
with no
detail message.
- FileUploadBase.InvalidContentTypeException(String) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.InvalidContentTypeException
-
Constructs an InvalidContentTypeException
with
the specified detail message.
- FileUploadBase.SizeLimitExceededException - Exception in org.apache.commons.fileupload
-
Thrown to indicate that the request size exceeds the configured maximum.
- FileUploadBase.SizeLimitExceededException() - Constructor for exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
Constructs a SizeExceededException
with no
detail message.
- FileUploadBase.SizeLimitExceededException(String) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
Constructs a SizeExceededException
with
the specified detail message.
- FileUploadBase.SizeLimitExceededException(String, long, long) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
Constructs a SizeExceededException
with
the specified detail message, and actual and permitted sizes.
- FileUploadBase.UnknownSizeException - Exception in org.apache.commons.fileupload
-
Thrown to indicate that the request size is not specified.
- FileUploadBase.UnknownSizeException() - Constructor for exception org.apache.commons.fileupload.FileUploadBase.UnknownSizeException
-
Constructs a UnknownSizeException
with no
detail message.
- FileUploadBase.UnknownSizeException(String) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.UnknownSizeException
-
Constructs an UnknownSizeException
with
the specified detail message.
- FileUploadException - Exception in org.apache.commons.fileupload
-
Exception for errors encountered while processing the request.
- FileUploadException() - Constructor for exception org.apache.commons.fileupload.FileUploadException
-
Constructs a new FileUploadException
without message.
- FileUploadException(String) - Constructor for exception org.apache.commons.fileupload.FileUploadException
-
Constructs a new FileUploadException
with specified detail
message.
- finalize() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Removes the file contents from the temporary storage.
- findByte(byte, int) - Method in class org.apache.commons.fileupload.MultipartStream
-
Searches for a byte of specified value in the buffer
,
starting at the specified position
.
- findSeparator() - Method in class org.apache.commons.fileupload.MultipartStream
-
Searches for the boundary
in the buffer
region delimited by head
and tail
.
- FORM_DATA - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
Content-disposition value for form data.
- get() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the contents of the file as an array of bytes.
- get() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the contents of the file item as an array of bytes.
- getActualSize() - Method in exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
Retrieves the actual size of the request.
- getBoundary(String) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Retrieves the boundary from the Content-type
header.
- getCharacterEncoding() - Method in class org.apache.commons.fileupload.portlet.PortletRequestContext
-
Retrieve the character encoding for the request.
- getCharacterEncoding() - Method in interface org.apache.commons.fileupload.RequestContext
-
Retrieve the character encoding for the request.
- getCharacterEncoding() - Method in class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Retrieve the character encoding for the request.
- getCharSet() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the content charset passed by the agent or null
if
not defined.
- getContentLength() - Method in class org.apache.commons.fileupload.portlet.PortletRequestContext
-
Retrieve the content length of the request.
- getContentLength() - Method in interface org.apache.commons.fileupload.RequestContext
-
Retrieve the content length of the request.
- getContentLength() - Method in class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Retrieve the content length of the request.
- getContentType() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the content type passed by the agent or null
if
not defined.
- getContentType() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the content type passed by the browser or null
if
not defined.
- getContentType() - Method in class org.apache.commons.fileupload.portlet.PortletRequestContext
-
Retrieve the content type of the request.
- getContentType() - Method in interface org.apache.commons.fileupload.RequestContext
-
Retrieve the content type of the request.
- getContentType() - Method in class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Retrieve the content type of the request.
- getFieldName() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the name of the field in the multipart form corresponding to
this file item.
- getFieldName() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the name of the field in the multipart form corresponding to
this file item.
- getFieldName(Map) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Retrieves the field name from the Content-disposition
header.
- getFileItemFactory() - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
Use FileUpload
instead.
- getFileItemFactory() - Method in class org.apache.commons.fileupload.FileUpload
-
Returns the factory class used when creating file items.
- getFileItemFactory() - Method in class org.apache.commons.fileupload.FileUploadBase
-
Returns the factory class used when creating file items.
- getFileName(Map) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Retrieves the file name from the Content-disposition
header.
- getHeader(Map, String) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Returns the header with the specified name from the supplied map.
- getHeaderEncoding() - Method in class org.apache.commons.fileupload.FileUploadBase
-
Retrieves the character encoding used when reading the headers of an
individual part.
- getHeaderEncoding() - Method in class org.apache.commons.fileupload.MultipartStream
-
Retrieves the character encoding used when reading the headers of an
individual part.
- getInputStream() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns an InputStream
that can be
used to retrieve the contents of the file.
- getInputStream() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns an InputStream
that can be
used to retrieve the contents of the file.
- getInputStream() - Method in class org.apache.commons.fileupload.portlet.PortletRequestContext
-
Retrieve the input stream for the request.
- getInputStream() - Method in interface org.apache.commons.fileupload.RequestContext
-
Retrieve the input stream for the request.
- getInputStream() - Method in class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Retrieve the input stream for the request.
- getName() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the original filename in the client's filesystem.
- getName() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the original filename in the client's filesystem, as provided by
the browser (or other client software).
- getOutputStream() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns an OutputStream
that can
be used for storing the contents of the file.
- getOutputStream() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns an OutputStream
that can
be used for storing the contents of the file.
- getPermittedSize() - Method in exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
Retrieves the permitted size of the request.
- getRepository() - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Returns the directory used to temporarily store files that are larger
than the configured size threshold.
- getRepositoryPath() - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
Use DiskFileItemFactory
instead.
- getSize() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the size of the file.
- getSize() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the size of the file item.
- getSizeMax() - Method in class org.apache.commons.fileupload.FileUploadBase
-
Returns the maximum allowed upload size.
- getSizeThreshold() - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Returns the size threshold beyond which files are written directly to
disk.
- getSizeThreshold() - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
Use DiskFileItemFactory
instead.
- getStoreLocation() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the File
object for the FileItem
's
data's temporary location on the disk.
- getString(String) - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the contents of the file as a String, using the specified
encoding.
- getString() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the contents of the file as a String, using the default
character encoding.
- getString(String) - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the contents of the file item as a String, using the specified
encoding.
- getString() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the contents of the file item as a String, using the default
character encoding.
- getTempFile() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Creates and returns a File
representing a uniquely
named temporary file in the configured repository path.
- getToken(boolean) - Method in class org.apache.commons.fileupload.ParameterParser
-
A helper method to process the parsed token.
- getUniqueId() - Static method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns an identifier that is unique within the class loader used to
load this class, but does not have random-like apearance.
- ParameterParser - Class in org.apache.commons.fileupload
-
A simple parser intended to parse sequences of name/value pairs.
- ParameterParser() - Constructor for class org.apache.commons.fileupload.ParameterParser
-
Default ParameterParser constructor.
- parse(String, char) - Method in class org.apache.commons.fileupload.ParameterParser
-
Extracts a map of name/value pairs from the given string.
- parse(char[], char) - Method in class org.apache.commons.fileupload.ParameterParser
-
Extracts a map of name/value pairs from the given array of
characters.
- parse(char[], int, int, char) - Method in class org.apache.commons.fileupload.ParameterParser
-
Extracts a map of name/value pairs from the given array of
characters.
- parseHeaders(String) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Parses the header-part
and returns as key/value
pairs.
- parseQuotedToken(char[]) - Method in class org.apache.commons.fileupload.ParameterParser
-
Parses out a token until any of the given terminators
is encountered outside the quotation marks.
- parseRequest(HttpServletRequest, int, long, String) - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
Use ServletFileUpload
instead.
- parseRequest(HttpServletRequest) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Deprecated.
Use the method in ServletFileUpload
instead.
- parseRequest(RequestContext) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Processes an
RFC 1867
compliant
multipart/form-data
stream.
- parseRequest(ActionRequest) - Method in class org.apache.commons.fileupload.portlet.PortletFileUpload
-
Processes an
RFC 1867
compliant
multipart/form-data
stream.
- parseRequest(HttpServletRequest) - Method in class org.apache.commons.fileupload.servlet.ServletFileUpload
-
Processes an
RFC 1867
compliant
multipart/form-data
stream.
- parseToken(char[]) - Method in class org.apache.commons.fileupload.ParameterParser
-
Parses out a token until any of the given terminators
is encountered.
- permitted - Variable in exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
The maximum permitted size of the request.
- PortletFileUpload - Class in org.apache.commons.fileupload.portlet
-
High level API for processing file uploads.
- PortletFileUpload() - Constructor for class org.apache.commons.fileupload.portlet.PortletFileUpload
-
Constructs an uninitialised instance of this class.
- PortletFileUpload(FileItemFactory) - Constructor for class org.apache.commons.fileupload.portlet.PortletFileUpload
-
Constructs an instance of this class which uses the supplied factory to
create FileItem
instances.
- PortletRequestContext - Class in org.apache.commons.fileupload.portlet
-
Provides access to the request information needed for a request made to
a portlet.
- PortletRequestContext(ActionRequest) - Constructor for class org.apache.commons.fileupload.portlet.PortletRequestContext
-
Construct a context for this request.
- pos - Variable in class org.apache.commons.fileupload.ParameterParser
-
Current position in the string.
- ServletFileUpload - Class in org.apache.commons.fileupload.servlet
-
High level API for processing file uploads.
- ServletFileUpload() - Constructor for class org.apache.commons.fileupload.servlet.ServletFileUpload
-
Constructs an uninitialised instance of this class.
- ServletFileUpload(FileItemFactory) - Constructor for class org.apache.commons.fileupload.servlet.ServletFileUpload
-
Constructs an instance of this class which uses the supplied factory to
create FileItem
instances.
- ServletRequestContext - Class in org.apache.commons.fileupload.servlet
-
Provides access to the request information needed for a request made to
an HTTP servlet.
- ServletRequestContext(HttpServletRequest) - Constructor for class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Construct a context for this request.
- setBoundary(byte[]) - Method in class org.apache.commons.fileupload.MultipartStream
-
Changes the boundary token used for partitioning the stream.
- setFieldName(String) - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Sets the field name used to reference this file item.
- setFieldName(String) - Method in interface org.apache.commons.fileupload.FileItem
-
Sets the field name used to reference this file item.
- setFileItemFactory(FileItemFactory) - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
Use FileUpload
instead.
- setFileItemFactory(FileItemFactory) - Method in class org.apache.commons.fileupload.FileUpload
-
Sets the factory class to use when creating file items.
- setFileItemFactory(FileItemFactory) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Sets the factory class to use when creating file items.
- setFormField(boolean) - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Specifies whether or not a FileItem
instance represents
a simple form field.
- setFormField(boolean) - Method in interface org.apache.commons.fileupload.FileItem
-
Specifies whether or not a FileItem
instance represents
a simple form field.
- setHeaderEncoding(String) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Specifies the character encoding to be used when reading the headers of
individual part.
- setHeaderEncoding(String) - Method in class org.apache.commons.fileupload.MultipartStream
-
Specifies the character encoding to be used when reading the headers of
individual parts.
- setLowerCaseNames(boolean) - Method in class org.apache.commons.fileupload.ParameterParser
-
Sets the flag if parameter names are to be converted to lower case when
name/value pairs are parsed.
- setRepository(File) - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Sets the directory used to temporarily store files that are larger
than the configured size threshold.
- setRepositoryPath(String) - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
Use DiskFileItemFactory
instead.
- setSizeMax(long) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Sets the maximum allowed upload size.
- setSizeThreshold(int) - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Sets the size threshold beyond which files are written directly to disk.
- setSizeThreshold(int) - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.
Use DiskFileItemFactory
instead.
- size - Variable in class org.apache.commons.fileupload.disk.DiskFileItem
-
The size of the item, in bytes.
- sizeMax - Variable in class org.apache.commons.fileupload.FileUploadBase
-
The maximum size permitted for an uploaded file.
- sizeThreshold - Variable in class org.apache.commons.fileupload.disk.DiskFileItem
-
The threshold above which uploads will be stored on disk.
- sizeThreshold - Variable in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
The threshold above which uploads will be stored on disk.
- skipPreamble() - Method in class org.apache.commons.fileupload.MultipartStream
-
Finds the beginning of the first encapsulation
.
- STREAM_TERMINATOR - Static variable in class org.apache.commons.fileupload.MultipartStream
-
A byte sequence that that follows a delimiter of the last
encapsulation in the stream (--
).