Alphabetical Index

A B C D F G H I K M O P R S T U W

A

arrayequals(byte[],byte[],int) - static method in class org.apache.commons.fileupload.MultipartStream
Compares count first bytes in the arrays a and b.
ATTACHMENT - static field in class org.apache.commons.fileupload.FileUploadBase
Content-disposition value for file attachment.

B

boundary - field in class org.apache.commons.fileupload.MultipartStream
The byte sequence that partitions the stream.
boundaryLength - field in class org.apache.commons.fileupload.MultipartStream
The length of the boundary token plus the leading CRLF--.
buffer - field in class org.apache.commons.fileupload.MultipartStream
The buffer used for processing the request.
bufSize - field in class org.apache.commons.fileupload.MultipartStream
The length of the buffer used for processing the request.

C

cachedContent - field in class org.apache.commons.fileupload.DefaultFileItem
Cached contents of the file.
checkThreshold(int) - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Checks to see if writing the specified number of bytes would cause the configured threshold to be exceeded.
close() - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Closes this output stream and releases any system resources associated with this stream.
CONTENT_DISPOSITION - static field in class org.apache.commons.fileupload.FileUploadBase
HTTP content disposition header name.
CONTENT_TYPE - static field in class org.apache.commons.fileupload.FileUploadBase
HTTP content type header name.
contentType - field in class org.apache.commons.fileupload.DefaultFileItem
The content type passed by the browser, or null if not defined.
counter - static field in class org.apache.commons.fileupload.DefaultFileItem
Counter used in unique identifier generation.
createItem(Map,boolean) - method in class org.apache.commons.fileupload.FileUploadBase
Creates a new FileItem instance.
createItem(String,String,boolean,String) - method in class org.apache.commons.fileupload.DefaultFileItemFactory
Create a new DefaultFileItem instance from the supplied parameters and the local factory configuration.
createItem(String,String,boolean,String) - method in class org.apache.commons.fileupload.FileItemFactory
Create a new FileItem instance from the supplied parameters and any local factory configuration.
currentOutputStream - field in class org.apache.commons.fileupload.DeferredFileOutputStream
The output stream to which data will be written at any given time.

D

DEFAULT_BUFSIZE - static field in class org.apache.commons.fileupload.MultipartStream
The default length of the buffer used for processing a request.
DEFAULT_SIZE_THRESHOLD - static field in class org.apache.commons.fileupload.DefaultFileItemFactory
The default threshold above which uploads will be stored on disk.
DefaultFileItem - class org.apache.commons.fileupload.DefaultFileItem
The default implementation of the FileItem interface.
DefaultFileItem(String,String,boolean,String,int,File) - constructor for class org.apache.commons.fileupload.DefaultFileItem
Constructs a new DefaultFileItem instance.
DefaultFileItemFactory - class org.apache.commons.fileupload.DefaultFileItemFactory
The default FileItemFactory implementation.
DefaultFileItemFactory() - constructor for class org.apache.commons.fileupload.DefaultFileItemFactory
Constructs an unconfigured instance of this class.
DefaultFileItemFactory(int,File) - constructor for class org.apache.commons.fileupload.DefaultFileItemFactory
Constructs a preconfigured instance of this class.
DeferredFileOutputStream - class org.apache.commons.fileupload.DeferredFileOutputStream
An output stream which will retain data in memory until a specified threshold is reached, and only then commit it to disk.
DeferredFileOutputStream(int,File) - constructor for class org.apache.commons.fileupload.DeferredFileOutputStream
Constructs an instance of this class which will trigger an event at the specified threshold, and save data to a file beyond that point.
delete() - method in class org.apache.commons.fileupload.DefaultFileItem
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
delete() - method in class org.apache.commons.fileupload.FileItem
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
dfos - field in class org.apache.commons.fileupload.DefaultFileItem
Output stream for this item.
discardBodyData() - method in class org.apache.commons.fileupload.MultipartStream
Reads body-data from the current encapsulation and discards it.
DiskFileUpload - class org.apache.commons.fileupload.DiskFileUpload
High level API for processing file uploads.
DiskFileUpload() - constructor for class org.apache.commons.fileupload.DiskFileUpload
Constructs an instance of this class which uses the default factory to create FileItem instances.
DiskFileUpload(org.apache.commons.fileupload.DefaultFileItemFactory) - constructor for class org.apache.commons.fileupload.DiskFileUpload
Constructs an instance of this class which uses the supplied factory to create FileItem instances.
diskOutputStream - field in class org.apache.commons.fileupload.DeferredFileOutputStream
The output stream to which data will be written after the theshold is reached.

F

FIELD_SEPARATOR - static field in class org.apache.commons.fileupload.MultipartStream
A byte sequence that that follows a delimiter that will be followed by an encapsulation (CRLF).
fieldName - field in class org.apache.commons.fileupload.DefaultFileItem
The name of the form field as provided by the browser.
FileItem - interface org.apache.commons.fileupload.FileItem
This class represents a file or form item that was received within a multipart/form-data POST request.
fileItemFactory - field in class org.apache.commons.fileupload.DiskFileUpload
The factory to use to create new form items.
fileItemFactory - field in class org.apache.commons.fileupload.FileUpload
The factory to use to create new form items.
FileItemFactory - interface org.apache.commons.fileupload.FileItemFactory
A factory interface for creating FileItem instances.
fileName - field in class org.apache.commons.fileupload.DefaultFileItem
The original filename in the user's filesystem.
FileUpload - class org.apache.commons.fileupload.FileUpload
High level API for processing file uploads.
FileUpload() - constructor for class org.apache.commons.fileupload.FileUpload
Constructs an instance of this class which uses the default factory to create FileItem instances.
FileUpload(org.apache.commons.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 org.apache.commons.fileupload.FileUploadBase
High level API for processing file uploads.
FileUploadException - class org.apache.commons.fileupload.FileUploadException
Exception for errors encountered while processing the request.
FileUploadException() - constructor for class org.apache.commons.fileupload.FileUploadException
Constructs a new FileUploadException without message.
FileUploadException(String) - constructor for class org.apache.commons.fileupload.FileUploadException
Constructs a new FileUploadException with specified detail message.
finalize() - method in class org.apache.commons.fileupload.DefaultFileItem
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.
flush() - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Flushes this output stream and forces any buffered output bytes to be written out.
FORM_DATA - static field in class org.apache.commons.fileupload.FileUploadBase
Content-disposition value for form data.

G

get() - method in class org.apache.commons.fileupload.DefaultFileItem
Returns the contents of the file as an array of bytes.
get() - method in class org.apache.commons.fileupload.FileItem
Returns the contents of the file item as an array of bytes.
getByteCount() - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Returns the number of bytes that have been written to this output stream.
getContentType() - method in class org.apache.commons.fileupload.DefaultFileItem
Returns the content type passed by the browser or null if not defined.
getContentType() - method in class org.apache.commons.fileupload.FileItem
Returns the content type passed by the browser or null if not defined.
getData() - method in class org.apache.commons.fileupload.DeferredFileOutputStream
Returns the data for this output stream as an array of bytes, assuming that the data has been retained in memory.
getFieldName() - method in class org.apache.commons.fileupload.DefaultFileItem
Returns the name of the field in the multipart form corresponding to this file item.
getFieldName() - method in class 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.
getFile() - method in class org.apache.commons.fileupload.DeferredFileOutputStream
Returns the data for this output stream as a File, assuming that the data was written to disk.
getFileItemFactory() - method in class org.apache.commons.fileupload.DiskFileUpload
Returns the factory class used when creating file items.
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.DefaultFileItem
Returns an InputStream that can be used to retrieve the contents of the file.
getInputStream() - method in class org.apache.commons.fileupload.FileItem
Returns an InputStream that can be used to retrieve the contents of the file.
getName() - method in class org.apache.commons.fileupload.DefaultFileItem
Returns the original filename in the client's filesystem.
getName() - method in class 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.DefaultFileItem
Returns an OutputStream that can be used for storing the contents of the file.
getOutputStream() - method in class org.apache.commons.fileupload.FileItem
Returns an OutputStream that can be used for storing the contents of the file.
getRepository() - method in class org.apache.commons.fileupload.DefaultFileItemFactory
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
Returns the location used to temporarily store files that are larger than the configured size threshold.
getSize() - method in class org.apache.commons.fileupload.DefaultFileItem
Returns the size of the file.
getSize() - method in class 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.DefaultFileItemFactory
Returns the size threshold beyond which files are written directly to disk.
getSizeThreshold() - method in class org.apache.commons.fileupload.DiskFileUpload
Returns the size threshold beyond which files are written directly to disk.
getStoreLocation() - method in class org.apache.commons.fileupload.DefaultFileItem
Returns the java.io.File object for the FileItem's data's temporary location on the disk.
getStream() - method in class org.apache.commons.fileupload.DeferredFileOutputStream
Returns the current output stream.
getStream() - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Returns the underlying output stream, to which the corresponding OutputStream methods in this class will ultimately delegate.
getString() - method in class org.apache.commons.fileupload.DefaultFileItem
Returns the contents of the file as a String, using the default character encoding.
getString() - method in class 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.DefaultFileItem
Returns the contents of the file as a String, using the specified encoding.
getString(String) - method in class 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.DefaultFileItem
Creates and returns a File representing a uniquely named temporary file in the configured repository path.
getThreshold() - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Returns the threshold, in bytes, at which an event will be triggered.
getUniqueId() - static method in class org.apache.commons.fileupload.DefaultFileItem
Returns an identifier that is unique within the class loader used to load this class, but does not have random-like apearance.

H

head - field in class org.apache.commons.fileupload.MultipartStream
The index of first valid character in the buffer.
HEADER_PART_SIZE_MAX - static field in class org.apache.commons.fileupload.MultipartStream
The maximum length of header-part that will be processed (10 kilobytes = 10240 bytes.).
HEADER_SEPARATOR - static field in class org.apache.commons.fileupload.MultipartStream
A byte sequence that marks the end of header-part (CRLFCRLF).
headerEncoding - field in class org.apache.commons.fileupload.FileUploadBase
The content encoding to use when reading part headers.
headerEncoding - field in class org.apache.commons.fileupload.MultipartStream
The content encoding to use when reading headers.

I

Thrown upon attempt of setting an invalid boundary token.
IllegalBoundaryException() - constructor for class org.apache.commons.fileupload.MultipartStream.IllegalBoundaryException
Constructs an IllegalBoundaryException with no detail message.
IllegalBoundaryException(String) - constructor for class org.apache.commons.fileupload.MultipartStream.IllegalBoundaryException
Constructs an IllegalBoundaryException with the specified detail message.
input - field in class org.apache.commons.fileupload.MultipartStream
The input stream from which data is read.
Thrown to indicate that the request is not a multipart request.
InvalidContentTypeException() - constructor for class org.apache.commons.fileupload.FileUploadBase.InvalidContentTypeException
Constructs a InvalidContentTypeException with no detail message.
InvalidContentTypeException(String) - constructor for class org.apache.commons.fileupload.FileUploadBase.InvalidContentTypeException
Constructs an InvalidContentTypeException with the specified detail message.
isFormField - field in class org.apache.commons.fileupload.DefaultFileItem
Whether or not this item is a simple form field.
isFormField() - method in class org.apache.commons.fileupload.DefaultFileItem
Determines whether or not a FileItem instance represents a simple form field.
isFormField() - method in class org.apache.commons.fileupload.FileItem
Determines whether or not a FileItem instance represents a simple form field.
isInMemory() - method in class org.apache.commons.fileupload.DefaultFileItem
Provides a hint as to whether or not the file contents will be read from memory.
isInMemory() - method in class org.apache.commons.fileupload.DeferredFileOutputStream
Determines whether or not the data for this output stream has been retained in memory.
isInMemory() - method in class org.apache.commons.fileupload.FileItem
Provides a hint as to whether or not the file contents will be read from memory.
isMultipartContent(HttpServletRequest) - static method in class org.apache.commons.fileupload.FileUploadBase
Utility method that determines whether the request contains multipart content.
isThresholdExceeded() - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Determines whether or not the configured threshold has been exceeded for this output stream.

K

keepRegion - field in class org.apache.commons.fileupload.MultipartStream
The amount of data, in bytes, that must be kept in the buffer in order to detect delimiters reliably.

M

Thrown to indicate that the input stream fails to follow the required syntax.
MalformedStreamException() - constructor for class org.apache.commons.fileupload.MultipartStream.MalformedStreamException
Constructs a MalformedStreamException with no detail message.
MalformedStreamException(String) - constructor for class org.apache.commons.fileupload.MultipartStream.MalformedStreamException
Constructs an MalformedStreamException with the specified detail message.
MAX_HEADER_SIZE - static field in class org.apache.commons.fileupload.FileUploadBase
The maximum length of a single header line that will be parsed (1024 bytes).
memoryOutputStream - field in class org.apache.commons.fileupload.DeferredFileOutputStream
The output stream to which data will be written prior to the theshold being reached.
MULTIPART - static field in class org.apache.commons.fileupload.FileUploadBase
Part of HTTP content type header.
MULTIPART_FORM_DATA - static field in class org.apache.commons.fileupload.FileUploadBase
HTTP content type header for multipart forms.
MULTIPART_MIXED - static field in class org.apache.commons.fileupload.FileUploadBase
HTTP content type header for multiple uploads.
MultipartStream - class org.apache.commons.fileupload.MultipartStream
Low level API for processing file uploads.
MultipartStream() - constructor for class org.apache.commons.fileupload.MultipartStream
Default constructor.
MultipartStream(InputStream,byte[]) - constructor for class org.apache.commons.fileupload.MultipartStream
Constructs a MultipartStream with a default size buffer.
MultipartStream(InputStream,byte[],int) - constructor for class org.apache.commons.fileupload.MultipartStream
Constructs a MultipartStream with a custom size buffer.

O

Component for handling html file uploads as given by rfc 1867 RFC 1867.
outputFile - field in class org.apache.commons.fileupload.DeferredFileOutputStream
The file to which output will be directed if the threshold is exceeded.

P

parseHeaders(String) - method in class org.apache.commons.fileupload.FileUploadBase
Parses the header-part and returns as key/value pairs.
parseRequest(HttpServletRequest) - method in class org.apache.commons.fileupload.FileUploadBase
Processes an RFC 1867 compliant multipart/form-data stream.
parseRequest(HttpServletRequest,int,long,String) - method in class org.apache.commons.fileupload.DiskFileUpload
Processes an RFC 1867 compliant multipart/form-data stream.

R

readBodyData(OutputStream) - method in class org.apache.commons.fileupload.MultipartStream
Reads body-data from the current encapsulation and writes its contents into the output Stream.
readBoundary() - method in class org.apache.commons.fileupload.MultipartStream
Skips a boundary token, and checks whether more encapsulations 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 current encapsulation.
repository - field in class org.apache.commons.fileupload.DefaultFileItem
The directory in which uploaded files will be stored, if stored on disk.
repository - field in class org.apache.commons.fileupload.DefaultFileItemFactory
The directory in which uploaded files will be stored, if stored on disk.

S

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.DefaultFileItem
Sets the field name used to reference this file item.
setFieldName(String) - method in class org.apache.commons.fileupload.FileItem
Sets the field name used to reference this file item.
Sets the factory class to use when creating file items.
Sets the factory class to use when creating file items.
Sets the factory class to use when creating file items.
setFormField(boolean) - method in class org.apache.commons.fileupload.DefaultFileItem
Specifies whether or not a FileItem instance represents a simple form field.
setFormField(boolean) - method in class 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 parts.
setHeaderEncoding(String) - method in class org.apache.commons.fileupload.MultipartStream
Specifies the character encoding to be used when reading the headers of individual parts.
setRepository(File) - method in class org.apache.commons.fileupload.DefaultFileItemFactory
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
Sets the location used to temporarily store files that are larger than the configured size threshold.
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.DefaultFileItemFactory
Sets the size threshold beyond which files are written directly to disk.
setSizeThreshold(int) - method in class org.apache.commons.fileupload.DiskFileUpload
Sets the size threshold beyond which files are written directly to disk.
Thrown to indicate that the request size exceeds the configured maximum.
SizeLimitExceededException() - constructor for class org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
Constructs a SizeExceededException with no detail message.
SizeLimitExceededException(String) - constructor for class org.apache.commons.fileupload.FileUploadBase.SizeLimitExceededException
Constructs an SizeExceededException with the specified detail message.
sizeMax - field in class org.apache.commons.fileupload.FileUploadBase
The maximum size permitted for an uploaded file.
sizeThreshold - field in class org.apache.commons.fileupload.DefaultFileItem
The threshold above which uploads will be stored on disk.
sizeThreshold - field in class org.apache.commons.fileupload.DefaultFileItemFactory
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 field in class org.apache.commons.fileupload.MultipartStream
A byte sequence that that follows a delimiter of the last encapsulation in the stream (--).

T

tail - field in class org.apache.commons.fileupload.MultipartStream
The index of last valid characer in the buffer + 1.
threshold - field in class org.apache.commons.fileupload.ThresholdingOutputStream
The threshold at which the event will be triggered.
thresholdExceeded - field in class org.apache.commons.fileupload.ThresholdingOutputStream
Whether or not the configured threshold has been exceeded.
ThresholdingOutputStream - class org.apache.commons.fileupload.ThresholdingOutputStream
An output stream which triggers an event when a specified number of bytes of data have been written to it.
ThresholdingOutputStream(int) - constructor for class org.apache.commons.fileupload.ThresholdingOutputStream
Constructs an instance of this class which will trigger an event at the specified threshold.
thresholdReached() - method in class org.apache.commons.fileupload.DeferredFileOutputStream
Switches the underlying output stream from a memory based stream to one that is backed by disk.
thresholdReached() - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Indicates that the configured threshold has been reached, and that a subclass should take whatever action necessary on this event.
toString() - method in class org.apache.commons.fileupload.MultipartStream
Returns a string representation of this object.

U

Thrown to indicate that the request size is not specified.
UnknownSizeException() - constructor for class org.apache.commons.fileupload.FileUploadBase.UnknownSizeException
Constructs a UnknownSizeException with no detail message.
UnknownSizeException(String) - constructor for class org.apache.commons.fileupload.FileUploadBase.UnknownSizeException
Constructs an UnknownSizeException with the specified detail message.

W

write(b[]) - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Writes b.length bytes from the specified byte array to this output stream.
write(b[],int,int) - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Writes len bytes from the specified byte array starting at offset off to this output stream.
write(File) - method in class org.apache.commons.fileupload.DefaultFileItem
A convenience method to write an uploaded item to disk.
write(File) - method in class org.apache.commons.fileupload.FileItem
A convenience method to write an uploaded item to disk.
write(int) - method in class org.apache.commons.fileupload.ThresholdingOutputStream
Writes the specified byte to this output stream.
written - field in class org.apache.commons.fileupload.ThresholdingOutputStream
The number of bytes written to the output stream.

Copyright © 2002-2003 Apache Software Foundation. All Rights Reserved.