A B C D F G H I L M N O P R S T U W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- addHeader(String, String) - Method in class org.apache.commons.fileupload.util.FileItemHeadersImpl
-
Method to add header values to this instance.
- arrayequals(byte[], byte[], int) - Static method in class org.apache.commons.fileupload.MultipartStream
-
Compares
count
first bytes in the arraysa
andb
. - asString(InputStream) - Static method in class org.apache.commons.fileupload.util.Streams
-
This convenience method allows to read a
FileItemStream
's content into a string. - asString(InputStream, String) - Static method in class org.apache.commons.fileupload.util.Streams
-
This convenience method allows to read a
FileItemStream
's content into a string, using the given character encoding. - ATTACHMENT - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
Content-disposition value for file attachment.
- available() - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Returns the number of bytes, which are currently available, without blocking.
B
- BOUNDARY_PREFIX - Static variable in class org.apache.commons.fileupload.MultipartStream
-
A byte sequence that precedes a boundary (
CRLF--
).
C
- checkFileName(String) - Static method in class org.apache.commons.fileupload.util.Streams
-
Checks, whether the given file name is valid in the sense, that it doesn't contain any NUL characters.
- close() - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Closes the input stream.
- close() - Method in interface org.apache.commons.fileupload.util.Closeable
-
Closes the object.
- close() - Method in class org.apache.commons.fileupload.util.LimitedInputStream
-
Closes this input stream and releases any system resources associated with the stream.
- close(boolean) - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Closes the input stream.
- Closeable - Interface in org.apache.commons.fileupload.util
-
Interface of an object, which may be closed.
- CONTENT_DISPOSITION - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
HTTP content disposition header name.
- CONTENT_LENGTH - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
HTTP content length header name.
- CONTENT_TYPE - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
HTTP content type header name.
- contentLength() - Method in class org.apache.commons.fileupload.portlet.PortletRequestContext
-
Retrieve the content length of the request.
- contentLength() - Method in class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Retrieve the content length of the request.
- contentLength() - Method in interface org.apache.commons.fileupload.UploadContext
-
Retrieve the content length of the request.
- contextDestroyed(ServletContextEvent) - Method in class org.apache.commons.fileupload.servlet.FileCleanerCleanup
-
Called when the web application is being destroyed.
- contextInitialized(ServletContextEvent) - Method in class org.apache.commons.fileupload.servlet.FileCleanerCleanup
-
Called when the web application is initialized.
- copy(InputStream, OutputStream, boolean) - Static method in class org.apache.commons.fileupload.util.Streams
-
Copies the contents of the given
InputStream
to the givenOutputStream
. - copy(InputStream, OutputStream, boolean, byte[]) - Static method in class org.apache.commons.fileupload.util.Streams
-
Copies the contents of the given
InputStream
to the givenOutputStream
. - CR - Static variable in class org.apache.commons.fileupload.MultipartStream
-
The Carriage Return ASCII character value.
- createItem(String, String, boolean, String) - Method in class org.apache.commons.fileupload.DefaultFileItemFactory
-
Deprecated.1.1 Use
DiskFileItemFactory
instead. - createItem(String, String, boolean, String) - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Create a new
DiskFileItem
instance from the supplied parameters and the local factory configuration. - createItem(String, String, boolean, String) - Method in interface org.apache.commons.fileupload.FileItemFactory
-
Create a new
FileItem
instance from the supplied parameters and any local factory configuration. - createItem(Map<String, String>, boolean) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Deprecated.1.2 This method is no longer used in favour of internally created instances of
FileItem
.
D
- DASH - Static variable in class org.apache.commons.fileupload.MultipartStream
-
The dash (-) ASCII character value.
- decodeText(String) - Static method in class org.apache.commons.fileupload.util.mime.MimeUtility
-
Decode a string of text obtained from a mail header into its proper form.
- DEFAULT_BUFFER_SIZE - Static variable in class org.apache.commons.fileupload.util.Streams
-
Default buffer size for use in
Streams.copy(InputStream, OutputStream, boolean)
. - DEFAULT_BUFSIZE - Static variable in class org.apache.commons.fileupload.MultipartStream
-
The default length of the buffer used for processing a request.
- DEFAULT_CHARSET - Static variable in class org.apache.commons.fileupload.disk.DiskFileItem
-
Default content charset to be used when no explicit charset parameter is provided by the sender.
- DEFAULT_SIZE_THRESHOLD - Static variable in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
The default threshold above which uploads will be stored on disk.
- DefaultFileItem - Class in org.apache.commons.fileupload
-
Deprecated.1.1 Use
DiskFileItem
instead. - DefaultFileItem(String, String, boolean, String, int, File) - Constructor for class org.apache.commons.fileupload.DefaultFileItem
-
Deprecated.1.1 Use
DiskFileItem
instead. - DefaultFileItemFactory - Class in org.apache.commons.fileupload
-
Deprecated.1.1 Use
DiskFileItemFactory
instead. - DefaultFileItemFactory() - Constructor for class org.apache.commons.fileupload.DefaultFileItemFactory
-
Deprecated.1.1 Use
DiskFileItemFactory
instead. - DefaultFileItemFactory(int, File) - Constructor for class org.apache.commons.fileupload.DefaultFileItemFactory
-
Deprecated.1.1 Use
DiskFileItemFactory
instead. - delete() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
- delete() - Method in interface org.apache.commons.fileupload.FileItem
-
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
- discardBodyData() - Method in class org.apache.commons.fileupload.MultipartStream
-
Reads
body-data
from the currentencapsulation
and discards it. - DiskFileItem - Class in org.apache.commons.fileupload.disk
-
The default implementation of the
FileItem
interface. - DiskFileItem(String, String, boolean, String, int, File) - Constructor for class org.apache.commons.fileupload.disk.DiskFileItem
-
Constructs a new
DiskFileItem
instance. - DiskFileItemFactory - Class in org.apache.commons.fileupload.disk
-
The default
FileItemFactory
implementation. - DiskFileItemFactory() - Constructor for class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Constructs an unconfigured instance of this class.
- DiskFileItemFactory(int, File) - Constructor for class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Constructs a preconfigured instance of this class.
- DiskFileUpload - Class in org.apache.commons.fileupload
-
Deprecated.1.1 Use
ServletFileUpload
together withDiskFileItemFactory
instead. - DiskFileUpload() - Constructor for class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.1.1 Use
FileUpload
instead. - DiskFileUpload(DefaultFileItemFactory) - Constructor for class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.1.1 Use
FileUpload
instead.
F
- 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
). - FILE_CLEANING_TRACKER_ATTRIBUTE - Static variable in class org.apache.commons.fileupload.servlet.FileCleanerCleanup
-
Attribute name, which is used for storing an instance of
FileCleaningTracker
in the web application. - FileCleanerCleanup - Class in org.apache.commons.fileupload.servlet
-
A servlet context listener, which ensures that the
FileCleaningTracker
's reaper thread is terminated, when the web application is destroyed. - FileCleanerCleanup() - Constructor for class org.apache.commons.fileupload.servlet.FileCleanerCleanup
- FileCountLimitExceededException - Exception in org.apache.commons.fileupload
-
This exception is thrown if a request contains more files than the specified limit.
- FileCountLimitExceededException(String, long) - Constructor for exception org.apache.commons.fileupload.FileCountLimitExceededException
-
Creates a new instance.
- 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 - Interface in org.apache.commons.fileupload
-
A factory interface for creating
FileItem
instances. - FileItemHeaders - Interface in org.apache.commons.fileupload
-
This class provides support for accessing the headers for a file or form item that was received within a
multipart/form-data
POST request. - FileItemHeadersImpl - Class in org.apache.commons.fileupload.util
-
Default implementation of the
FileItemHeaders
interface. - FileItemHeadersImpl() - Constructor for class org.apache.commons.fileupload.util.FileItemHeadersImpl
- FileItemHeadersSupport - Interface in org.apache.commons.fileupload
-
Interface that will indicate that
FileItem
orFileItemStream
implementations will accept the headers read for the item. - FileItemIterator - Interface in org.apache.commons.fileupload
-
An iterator, as returned by
FileUploadBase.getItemIterator(RequestContext)
. - FileItemStream - Interface in org.apache.commons.fileupload
-
This interface provides access to a file or form item that was received within a
multipart/form-data
POST request. - FileItemStream.ItemSkippedException - Exception in org.apache.commons.fileupload
-
This exception is thrown, if an attempt is made to read data from the
InputStream
, which has been returned byFileItemStream.openStream()
, afterIterator.hasNext()
has been invoked on the iterator, which created theFileItemStream
. - FileSizeLimitExceededException(String, long, long) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.FileSizeLimitExceededException
-
Constructs a
SizeExceededException
with the specified detail message, and actual and permitted sizes. - 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.FileSizeLimitExceededException - Exception in org.apache.commons.fileupload
-
Thrown to indicate that A files size exceeds the configured maximum.
- FileUploadBase.FileUploadIOException - Exception in org.apache.commons.fileupload
-
This exception is thrown for hiding an inner
FileUploadException
in anIOException
. - FileUploadBase.InvalidContentTypeException - Exception in org.apache.commons.fileupload
-
Thrown to indicate that the request is not a multipart request.
- FileUploadBase.IOFileUploadException - Exception in org.apache.commons.fileupload
-
Thrown to indicate an IOException.
- FileUploadBase.SizeException - Exception in org.apache.commons.fileupload
-
This exception is thrown, if a requests permitted size is exceeded.
- FileUploadBase.SizeLimitExceededException - Exception in org.apache.commons.fileupload
-
Thrown to indicate that the request size exceeds the configured maximum.
- FileUploadBase.UnknownSizeException - Exception in org.apache.commons.fileupload
-
Deprecated.1.2 As of commons-fileupload 1.2, the presence of a content-length header is no longer required.
- 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. - FileUploadException(String, Throwable) - Constructor for exception org.apache.commons.fileupload.FileUploadException
-
Creates a new
FileUploadException
with the given detail message and cause. - FileUploadIOException(FileUploadException) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.FileUploadIOException
-
Creates a
FileUploadIOException
with the given cause. - 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 specifiedposition
. - findSeparator() - Method in class org.apache.commons.fileupload.MultipartStream
-
Searches for the
boundary
in thebuffer
region delimited byhead
andtail
. - FORM_DATA - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
Content-disposition value for form data.
G
- 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.SizeException
-
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. - getBytesRead() - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Returns the number of bytes, which have been read by the stream.
- getCause() - Method in exception org.apache.commons.fileupload.FileUploadBase.FileUploadIOException
-
Returns the exceptions cause.
- getCause() - Method in exception org.apache.commons.fileupload.FileUploadBase.IOFileUploadException
-
Returns the exceptions cause.
- getCause() - Method in exception org.apache.commons.fileupload.FileUploadException
- 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
-
Deprecated.1.3 Use
PortletRequestContext.contentLength()
instead - getContentLength() - Method in interface org.apache.commons.fileupload.RequestContext
-
Deprecated.1.3 Use
UploadContext.contentLength()
instead - getContentLength() - Method in class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Deprecated.1.3 Use
ServletRequestContext.contentLength()
instead - 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 interface org.apache.commons.fileupload.FileItemStream
-
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.
- getDefaultCharset() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the default charset for use when no explicit charset parameter is provided by the sender.
- getDefaultCharset() - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Returns the default charset for use when no explicit charset parameter is provided by the sender.
- 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() - Method in interface org.apache.commons.fileupload.FileItemStream
-
Returns the name of the field in the multipart form corresponding to this file item.
- getFieldName() - Method in exception org.apache.commons.fileupload.FileUploadBase.FileSizeLimitExceededException
-
Returns the field name of the item, which caused the exception.
- getFieldName(Map<String, String>) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Deprecated.1.2.1 Use
FileUploadBase.getFieldName(FileItemHeaders)
. - getFieldName(FileItemHeaders) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Retrieves the field name from the
Content-disposition
header. - getFileCleaningTracker() - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Returns the tracker, which is responsible for deleting temporary files.
- getFileCleaningTracker(ServletContext) - Static method in class org.apache.commons.fileupload.servlet.FileCleanerCleanup
-
Returns the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - getFileCountMax() - Method in class org.apache.commons.fileupload.FileUploadBase
-
Returns the maximum number of files allowed in a single request.
- getFileItemFactory() - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.1.1 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() - Method in exception org.apache.commons.fileupload.FileUploadBase.FileSizeLimitExceededException
-
Returns the file name of the item, which caused the exception.
- getFileName(Map<String, String>) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Deprecated.1.2.1 Use
FileUploadBase.getFileName(FileItemHeaders)
. - getFileName(FileItemHeaders) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Retrieves the file name from the
Content-disposition
header. - getFileSizeMax() - Method in class org.apache.commons.fileupload.FileUploadBase
-
Returns the maximum allowed size of a single uploaded file, as opposed to
FileUploadBase.getSizeMax()
. - getHeader(String) - Method in interface org.apache.commons.fileupload.FileItemHeaders
-
Returns the value of the specified part header as a
String
. - getHeader(String) - Method in class org.apache.commons.fileupload.util.FileItemHeadersImpl
-
Returns the value of the specified part header as a
String
. - getHeader(Map<String, String>, String) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Deprecated.1.2.1 Use
FileItemHeaders.getHeader(String)
. - 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.
- getHeaderNames() - Method in interface org.apache.commons.fileupload.FileItemHeaders
-
Returns an
Iterator
of all the header names. - getHeaderNames() - Method in class org.apache.commons.fileupload.util.FileItemHeadersImpl
-
Returns an
Iterator
of all the header names. - getHeaders() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the file item headers.
- getHeaders() - Method in interface org.apache.commons.fileupload.FileItemHeadersSupport
-
Returns the collection of headers defined locally within this item.
- getHeaders(String) - Method in interface org.apache.commons.fileupload.FileItemHeaders
-
Returns all the values of the specified item header as an
Iterator
ofString
objects. - getHeaders(String) - Method in class org.apache.commons.fileupload.util.FileItemHeadersImpl
-
Returns all the values of the specified item header as an
Iterator
ofString
objects. - 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.
- getItemIterator(ActionRequest) - Method in class org.apache.commons.fileupload.portlet.PortletFileUpload
-
Processes an RFC 1867 compliant
multipart/form-data
stream. - getItemIterator(HttpServletRequest) - Method in class org.apache.commons.fileupload.servlet.ServletFileUpload
-
Processes an RFC 1867 compliant
multipart/form-data
stream. - getItemIterator(RequestContext) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Processes an RFC 1867 compliant
multipart/form-data
stream. - getLimit() - Method in exception org.apache.commons.fileupload.FileCountLimitExceededException
-
Retrieves the limit that was exceeded.
- 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).
- getName() - Method in interface org.apache.commons.fileupload.FileItemStream
-
Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
- getName() - Method in exception org.apache.commons.fileupload.InvalidFileNameException
-
Returns the invalid file name.
- 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. - getParsedHeaders(String) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Parses the
header-part
and returns as key/value pairs. - getPermittedSize() - Method in exception org.apache.commons.fileupload.FileUploadBase.SizeException
-
Retrieves the permitted size of the request.
- getProgressListener() - Method in class org.apache.commons.fileupload.FileUploadBase
-
Returns the progress listener.
- 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.1.1 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 size of a complete request, as opposed to
FileUploadBase.getFileSizeMax()
. - 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.1.1 Use
DiskFileItemFactory
instead. - getStoreLocation() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns the
File
object for theFileItem
's data's temporary location on the disk. - 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() - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the contents of the file item as a String, using the default character encoding.
- 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(String) - Method in interface org.apache.commons.fileupload.FileItem
-
Returns the contents of the file item as a String, using the specified 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.
H
- hasNext() - Method in interface org.apache.commons.fileupload.FileItemIterator
-
Returns, whether another instance of
FileItemStream
is available. - HEADER_PART_SIZE_MAX - Static variable in class org.apache.commons.fileupload.MultipartStream
-
The maximum length of
header-part
that will be processed (10 kilobytes = 10240 bytes.). - HEADER_SEPARATOR - Static variable in class org.apache.commons.fileupload.MultipartStream
-
A byte sequence that marks the end of
header-part
(CRLFCRLF
).
I
- IllegalBoundaryException() - Constructor for exception org.apache.commons.fileupload.MultipartStream.IllegalBoundaryException
-
Constructs an
IllegalBoundaryException
with no detail message. - IllegalBoundaryException(String) - Constructor for exception org.apache.commons.fileupload.MultipartStream.IllegalBoundaryException
-
Constructs an
IllegalBoundaryException
with the specified detail message. - InvalidContentTypeException() - Constructor for exception org.apache.commons.fileupload.FileUploadBase.InvalidContentTypeException
-
Constructs a
InvalidContentTypeException
with no detail message. - InvalidContentTypeException(String) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.InvalidContentTypeException
-
Constructs an
InvalidContentTypeException
with the specified detail message. - InvalidContentTypeException(String, Throwable) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.InvalidContentTypeException
-
Constructs an
InvalidContentTypeException
with the specified detail message and cause. - InvalidFileNameException - Exception in org.apache.commons.fileupload
-
This exception is thrown in case of an invalid file name.
- InvalidFileNameException(String, String) - Constructor for exception org.apache.commons.fileupload.InvalidFileNameException
-
Creates a new instance.
- IOFileUploadException(String, IOException) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.IOFileUploadException
-
Creates a new instance with the given cause.
- isClosed() - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Returns, whether the stream is closed.
- isClosed() - Method in interface org.apache.commons.fileupload.util.Closeable
-
Returns, whether the object is already closed.
- isClosed() - Method in class org.apache.commons.fileupload.util.LimitedInputStream
-
Returns, whether this stream is already closed.
- isFormField() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Determines whether or not a
FileItem
instance represents a simple form field. - isFormField() - Method in interface org.apache.commons.fileupload.FileItem
-
Determines whether or not a
FileItem
instance represents a simple form field. - isFormField() - Method in interface org.apache.commons.fileupload.FileItemStream
-
Determines whether or not a
FileItem
instance represents a simple form field. - isInMemory() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Provides a hint as to whether or not the file contents will be read from memory.
- isInMemory() - Method in interface org.apache.commons.fileupload.FileItem
-
Provides a hint as to whether or not the file contents will be read from memory.
- isLowerCaseNames() - Method in class org.apache.commons.fileupload.ParameterParser
-
Returns
true
if parameter names are to be converted to lower case when name/value pairs are parsed. - isMultipartContent(ActionRequest) - Static method in class org.apache.commons.fileupload.portlet.PortletFileUpload
-
Utility method that determines whether the request contains multipart content.
- isMultipartContent(HttpServletRequest) - Static method in class org.apache.commons.fileupload.FileUploadBase
-
Deprecated.1.1 Use the method on
ServletFileUpload
instead. - isMultipartContent(HttpServletRequest) - Static method in class org.apache.commons.fileupload.servlet.ServletFileUpload
-
Utility method that determines whether the request contains multipart content.
- isMultipartContent(RequestContext) - Static method in class org.apache.commons.fileupload.FileUploadBase
-
Utility method that determines whether the request contains multipart content.
- ItemSkippedException() - Constructor for exception org.apache.commons.fileupload.FileItemStream.ItemSkippedException
L
- LF - Static variable in class org.apache.commons.fileupload.MultipartStream
-
The Line Feed ASCII character value.
- LimitedInputStream - Class in org.apache.commons.fileupload.util
-
An input stream, which limits its data size.
- LimitedInputStream(InputStream, long) - Constructor for class org.apache.commons.fileupload.util.LimitedInputStream
-
Creates a new instance.
M
- MalformedStreamException() - Constructor for exception org.apache.commons.fileupload.MultipartStream.MalformedStreamException
-
Constructs a
MalformedStreamException
with no detail message. - MalformedStreamException(String) - Constructor for exception org.apache.commons.fileupload.MultipartStream.MalformedStreamException
-
Constructs an
MalformedStreamException
with the specified detail message. - MAX_HEADER_SIZE - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
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
. - MimeUtility - Class in org.apache.commons.fileupload.util.mime
-
Utility class to decode MIME texts.
- MULTIPART - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
Part of HTTP content type header.
- MULTIPART_FORM_DATA - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
HTTP content type header for multipart forms.
- MULTIPART_MIXED - Static variable in class org.apache.commons.fileupload.FileUploadBase
-
HTTP content type header for multiple uploads.
- MultipartStream - Class in org.apache.commons.fileupload
-
Low level API for processing file uploads.
- MultipartStream() - Constructor for class org.apache.commons.fileupload.MultipartStream
-
Deprecated.
- MultipartStream(InputStream, byte[]) - Constructor for class org.apache.commons.fileupload.MultipartStream
-
Deprecated.
- MultipartStream(InputStream, byte[], int) - Constructor for class org.apache.commons.fileupload.MultipartStream
-
Deprecated.
- MultipartStream(InputStream, byte[], int, MultipartStream.ProgressNotifier) - Constructor for class org.apache.commons.fileupload.MultipartStream
-
Constructs a
MultipartStream
with a custom size buffer. - MultipartStream.IllegalBoundaryException - Exception in org.apache.commons.fileupload
-
Thrown upon attempt of setting an invalid boundary token.
- MultipartStream.ItemInputStream - Class in org.apache.commons.fileupload
-
An
InputStream
for reading an items contents. - MultipartStream.MalformedStreamException - Exception in org.apache.commons.fileupload
-
Thrown to indicate that the input stream fails to follow the required syntax.
- MultipartStream.ProgressNotifier - Class in org.apache.commons.fileupload
-
Internal class, which is used to invoke the
ProgressListener
.
N
- newFileItemHeaders() - Method in class org.apache.commons.fileupload.FileUploadBase
-
Creates a new instance of
FileItemHeaders
. - next() - Method in interface org.apache.commons.fileupload.FileItemIterator
-
Returns the next available
FileItemStream
.
O
- openStream() - Method in interface org.apache.commons.fileupload.FileItemStream
-
Creates an
InputStream
, which allows to read the items contents. - org.apache.commons.fileupload - package org.apache.commons.fileupload
-
A component for handling HTML file uploads as specified by RFC 1867.
- org.apache.commons.fileupload.disk - package org.apache.commons.fileupload.disk
-
A disk-based implementation of the
FileItem
interface. - org.apache.commons.fileupload.portlet - package org.apache.commons.fileupload.portlet
-
An implementation of
FileUpload
for use in portlets conforming to JSR 168. - org.apache.commons.fileupload.servlet - package org.apache.commons.fileupload.servlet
-
An implementation of
FileUpload
for use in servlets conforming to JSR 53. - org.apache.commons.fileupload.util - package org.apache.commons.fileupload.util
-
This package contains various IO related utility classes or methods, which are basically reusable and not necessarily restricted to the scope of a file upload.
- org.apache.commons.fileupload.util.mime - package org.apache.commons.fileupload.util.mime
-
MIME decoder implementation, imported and retailed from Apache Geronimo.
P
- 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(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.
- parse(String, char) - Method in class org.apache.commons.fileupload.ParameterParser
-
Extracts a map of name/value pairs from the given string.
- parse(String, char[]) - Method in class org.apache.commons.fileupload.ParameterParser
-
Extracts a map of name/value pairs from the given string.
- parseHeaders(String) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Deprecated.1.2.1 Use
FileUploadBase.getParsedHeaders(String)
- parseParameterMap(ActionRequest) - Method in class org.apache.commons.fileupload.portlet.PortletFileUpload
-
Processes an RFC 1867 compliant
multipart/form-data
stream. - parseParameterMap(HttpServletRequest) - Method in class org.apache.commons.fileupload.servlet.ServletFileUpload
-
Processes an RFC 1867 compliant
multipart/form-data
stream. - parseParameterMap(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.FileUploadBase
-
Deprecated.1.1 Use
ServletFileUpload.parseRequest(HttpServletRequest)
instead. - parseRequest(HttpServletRequest) - Method in class org.apache.commons.fileupload.servlet.ServletFileUpload
-
Processes an RFC 1867 compliant
multipart/form-data
stream. - parseRequest(HttpServletRequest, int, long, String) - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.1.1 Use
ServletFileUpload
instead. - parseRequest(RequestContext) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Processes an RFC 1867 compliant
multipart/form-data
stream. - 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.
- printStackTrace(PrintStream) - Method in exception org.apache.commons.fileupload.FileUploadException
-
Prints this throwable and its backtrace to the specified print stream.
- printStackTrace(PrintWriter) - Method in exception org.apache.commons.fileupload.FileUploadException
-
Prints this throwable and its backtrace to the specified print writer.
- ProgressListener - Interface in org.apache.commons.fileupload
-
The
ProgressListener
may be used to display a progress bar or do stuff like that.
R
- raiseError(long, long) - Method in class org.apache.commons.fileupload.util.LimitedInputStream
-
Called to indicate, that the input streams limit has been exceeded.
- read() - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Returns the next byte in the stream.
- read() - Method in class org.apache.commons.fileupload.util.LimitedInputStream
-
Reads the next byte of data from this input stream.
- read(byte[], int, int) - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Reads bytes into the given buffer.
- read(byte[], int, int) - Method in class org.apache.commons.fileupload.util.LimitedInputStream
-
Reads up to
len
bytes of data from this input stream into an array of bytes. - readBodyData(OutputStream) - Method in class org.apache.commons.fileupload.MultipartStream
-
Reads
body-data
from the currentencapsulation
and writes its contents into the outputStream
. - readBoundary() - Method in class org.apache.commons.fileupload.MultipartStream
-
Skips a
boundary
token, and checks whether moreencapsulations
are contained in the stream. - readByte() - Method in class org.apache.commons.fileupload.MultipartStream
-
Reads a byte from the
buffer
, and refills it as necessary. - readHeaders() - Method in class org.apache.commons.fileupload.MultipartStream
-
Reads the
header-part
of the currentencapsulation
. - RequestContext - Interface in org.apache.commons.fileupload
-
Abstracts access to the request information needed for file uploads.
S
- 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.
- setDefaultCharset(String) - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Sets the default charset for use when no explicit charset parameter is provided by the sender.
- setDefaultCharset(String) - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Sets the default charset for use when no explicit charset parameter is provided by the sender.
- 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.
- setFieldName(String) - Method in exception org.apache.commons.fileupload.FileUploadBase.FileSizeLimitExceededException
-
Sets the field name of the item, which caused the exception.
- setFileCleaningTracker(ServletContext, FileCleaningTracker) - Static method in class org.apache.commons.fileupload.servlet.FileCleanerCleanup
-
Sets the instance of
FileCleaningTracker
, which is associated with the givenServletContext
. - setFileCleaningTracker(FileCleaningTracker) - Method in class org.apache.commons.fileupload.disk.DiskFileItemFactory
-
Sets the tracker, which is responsible for deleting temporary files.
- setFileCountMax(long) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Sets the maximum number of files allowed per request.
- setFileItemFactory(FileItemFactory) - Method in class org.apache.commons.fileupload.DiskFileUpload
-
Deprecated.1.1 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.
- setFileName(String) - Method in exception org.apache.commons.fileupload.FileUploadBase.FileSizeLimitExceededException
-
Sets the file name of the item, which caused the exception.
- setFileSizeMax(long) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Sets the maximum allowed size of a single uploaded file, as opposed to
FileUploadBase.getSizeMax()
. - 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.
- setHeaders(FileItemHeaders) - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Sets the file item headers.
- setHeaders(FileItemHeaders) - Method in interface org.apache.commons.fileupload.FileItemHeadersSupport
-
Sets the headers read from within an item.
- 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.
- setProgressListener(ProgressListener) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Sets the progress listener.
- 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.1.1 Use
DiskFileItemFactory
instead. - setSizeMax(long) - Method in class org.apache.commons.fileupload.FileUploadBase
-
Sets the maximum allowed size of a complete request, as opposed to
FileUploadBase.setFileSizeMax(long)
. - 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.1.1 Use
DiskFileItemFactory
instead. - SizeException(String, long, long) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.SizeException
-
Creates a new instance.
- SizeLimitExceededException() - Constructor for exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
Deprecated.1.2 Replaced by
SizeLimitExceededException(String, long, long)
- SizeLimitExceededException(String) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
-
Deprecated.1.2 Replaced by
SizeLimitExceededException(String, long, long)
- 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. - skip(long) - Method in class org.apache.commons.fileupload.MultipartStream.ItemInputStream
-
Skips the given number of bytes.
- 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 (
--
). - Streams - Class in org.apache.commons.fileupload.util
-
Utility class for working with streams.
T
- toString() - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
Returns a string representation of this object.
- toString() - Method in class org.apache.commons.fileupload.portlet.PortletRequestContext
-
Returns a string representation of this object.
- toString() - Method in class org.apache.commons.fileupload.servlet.ServletRequestContext
-
Returns a string representation of this object.
U
- UnknownSizeException() - Constructor for exception org.apache.commons.fileupload.FileUploadBase.UnknownSizeException
-
Deprecated.Constructs a
UnknownSizeException
with no detail message. - UnknownSizeException(String) - Constructor for exception org.apache.commons.fileupload.FileUploadBase.UnknownSizeException
-
Deprecated.Constructs an
UnknownSizeException
with the specified detail message. - update(long, long, int) - Method in interface org.apache.commons.fileupload.ProgressListener
-
Updates the listeners status information.
- UploadContext - Interface in org.apache.commons.fileupload
-
Enhanced access to the request information needed for file uploads, which fixes the Content Length data access in
RequestContext
.
W
- write(File) - Method in class org.apache.commons.fileupload.disk.DiskFileItem
-
A convenience method to write an uploaded item to disk.
- write(File) - Method in interface org.apache.commons.fileupload.FileItem
-
A convenience method to write an uploaded item to disk.
All Classes All Packages