Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractFileItemBuilder() - Constructor for class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Constructs a new instance.
- AbstractFileUpload<R,
I extends FileItem<I>, F extends FileItemFactory<I>> - Class in org.apache.commons.fileupload2.core -
High level API for processing file uploads.
- AbstractFileUpload() - Constructor for class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Constructs a new instance for subclasses.
- AbstractRequestContext<T> - Class in org.apache.commons.fileupload2.core
-
Abstracts a RequestContext for implementations.
- AbstractRequestContext(Function<String, String>, LongSupplier, T) - Constructor for class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Constructs a new instance.
- addHeader(String, String) - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Adds a header.
- ATTACHMENT - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Content-disposition value for file attachment.
- available() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Returns the number of bytes, which are currently available, without blocking.
B
- builder() - Static method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Constructs a new
DiskFileItem.Builder. - builder() - Static method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Constructs a new
DiskFileItemFactory.Builder. - builder() - Static method in class org.apache.commons.fileupload2.core.MultipartInput
-
Constructs a new
MultipartInput.Builder. - Builder() - Constructor for class org.apache.commons.fileupload2.core.DiskFileItem.Builder
-
Constructs a new instance.
- Builder() - Constructor for class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Constructs a new instance.
- Builder() - Constructor for class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Constructs a new instance.
C
- checkFileName(String) - Static method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Tests if the file name is valid.
- checkThreshold(int) - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Called to check, whether the threshold will be exceeded, if the given number of bytes are written to the stream.
- close() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
- close() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Closes the input stream.
- close(boolean) - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Closes the input stream.
- closed - Enum constant in enum org.apache.commons.fileupload2.core.DeferrableOutputStream.State
-
The stream has been closed, and data can no longer be written.
- CONTENT_DISPOSITION - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content disposition header name.
- CONTENT_LENGTH - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content length header name.
- CONTENT_TYPE - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content type header name.
- CR - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
The Carriage Return ASCII character value.
D
- DASH - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
The dash (-) ASCII character value.
- DEFAULT_CHARSET - Static variable in class org.apache.commons.fileupload2.core.DiskFileItem
-
Default content charset to be used when no explicit charset parameter is provided by the sender.
- DEFAULT_PART_HEADER_SIZE_MAX - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
Default per part header size limit in bytes.
- DEFAULT_THRESHOLD - Static variable in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
The default threshold in bytes above which uploads will be stored on disk.
- DeferrableOutputStream - Class in org.apache.commons.fileupload2.core
-
An
OutputStream, which keeps its data in memory, until a configured threshold is reached. - DeferrableOutputStream(int, Supplier<Path>, DeferrableOutputStream.Listener) - Constructor for class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Creates a new instance with the given threshold, and the given supplier for a temporary files path.
- DeferrableOutputStream.Listener - Interface in org.apache.commons.fileupload2.core
-
Interface of a listener object, that wishes to be notified about state changes.
- DeferrableOutputStream.State - Enum in org.apache.commons.fileupload2.core
-
This enumeration represents the possible states of the
DeferrableOutputStream. - delete() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
- delete() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
- discardBodyData() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads
body-datafrom the currentencapsulationand discards it. - DiskFileItem - Class in org.apache.commons.fileupload2.core
-
The default implementation of the
FileIteminterface. - DiskFileItem.Builder - Class in org.apache.commons.fileupload2.core
-
Builds a new
DiskFileIteminstance. - DiskFileItemFactory - Class in org.apache.commons.fileupload2.core
-
The default
FileItemFactoryimplementation. - DiskFileItemFactory.Builder - Class in org.apache.commons.fileupload2.core
-
Builds a new
DiskFileItemFactoryinstance.
F
- FileItem<F extends FileItem<F>> - Interface in org.apache.commons.fileupload2.core
-
This class represents a file or form item that was received within a
multipart/form-dataPOST request. - fileItemBuilder() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
- fileItemBuilder() - Method in interface org.apache.commons.fileupload2.core.FileItemFactory
-
Creates a new AbstractFileItemBuilder.
- FileItemFactory<I extends FileItem<I>> - Interface in org.apache.commons.fileupload2.core
-
Creates
FileIteminstances. - FileItemFactory.AbstractFileItemBuilder<I extends FileItem<I>,
B extends FileItemFactory.AbstractFileItemBuilder<I, B>> - Class in org.apache.commons.fileupload2.core -
Abstracts building for subclasses.
- FileItemHeaders - Interface in org.apache.commons.fileupload2.core
-
This class provides support for accessing the headers for a file or form item that was received within a
multipart/form-dataPOST request. - FileItemHeadersProvider<T extends FileItemHeadersProvider<T>> - Interface in org.apache.commons.fileupload2.core
-
Provides access to headers.
- FileItemInput - Interface in org.apache.commons.fileupload2.core
-
Provides access to a file or form item that was received within a
multipart/form-dataPOST request. - FileItemInput.ItemSkippedException - Exception in org.apache.commons.fileupload2.core
-
This exception is thrown, if an attempt is made to read data from the
InputStream, which has been returned byFileItemInput.getInputStream(), afterIterator.hasNext()has been invoked on the iterator, which created theFileItemInput. - FileItemInputIterator - Interface in org.apache.commons.fileupload2.core
-
An iterator, as returned by
AbstractFileUpload.getItemIterator(RequestContext). - FileUploadBoundaryException(String) - Constructor for exception org.apache.commons.fileupload2.core.MultipartInput.FileUploadBoundaryException
-
Constructs an instance with the specified detail message.
- FileUploadByteCountLimitException - Exception in org.apache.commons.fileupload2.core
-
Signals that a file size exceeds the configured maximum.
- FileUploadByteCountLimitException(String, long, long, String, String) - Constructor for exception org.apache.commons.fileupload2.core.FileUploadByteCountLimitException
-
Constructs an instance with the specified detail message, and actual and permitted sizes.
- FileUploadContentTypeException - Exception in org.apache.commons.fileupload2.core
-
Signals that a request is not a multipart request.
- FileUploadContentTypeException(String, String) - Constructor for exception org.apache.commons.fileupload2.core.FileUploadContentTypeException
-
Constructs an instance with the specified detail message.
- FileUploadContentTypeException(String, Throwable) - Constructor for exception org.apache.commons.fileupload2.core.FileUploadContentTypeException
-
Constructs an instance with the specified detail message and cause.
- FileUploadException - Exception in org.apache.commons.fileupload2.core
-
Signals errors encountered while processing the request.
- FileUploadException(String) - Constructor for exception org.apache.commons.fileupload2.core.FileUploadException
-
Constructs an instance with a given detail message.
- FileUploadException(String, Throwable) - Constructor for exception org.apache.commons.fileupload2.core.FileUploadException
-
Constructs an instance with the given detail message and cause.
- FileUploadFileCountLimitException - Exception in org.apache.commons.fileupload2.core
-
Signals that a request contains more files than the specified limit.
- FileUploadFileCountLimitException(String, long, long) - Constructor for exception org.apache.commons.fileupload2.core.FileUploadFileCountLimitException
-
Constructs an instance.
- FileUploadSizeException - Exception in org.apache.commons.fileupload2.core
-
Signals that a requests permitted size is exceeded.
- FileUploadSizeException(String, long, long) - Constructor for exception org.apache.commons.fileupload2.core.FileUploadSizeException
-
Constructs an instance.
- findByte(byte, int) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Searches for a byte of specified value in the
buffer, starting at the specifiedposition. - findSeparator() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Searches for the
boundaryin thebufferregion delimited byheadandtail. - FORM_DATA - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Content-disposition value for form data.
G
- get() - Method in class org.apache.commons.fileupload2.core.DiskFileItem.Builder
-
Constructs a new instance.
- get() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Deprecated.
- get() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Constructs a new instance.
- get() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the contents of the file item as a byte array.
- get() - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Constructs a new instance.
- getActualSize() - Method in exception org.apache.commons.fileupload2.core.FileUploadSizeException
-
Gets the actual size of the request.
- getBoundary(String) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the boundary from the
Content-typeheader. - getBufferSize() - Method in class org.apache.commons.fileupload2.core.DiskFileItem.Builder
-
Deprecated.Since 2.0.0, use
DiskFileItem.Builder.getThreshold()instead. - getBufferSize() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Deprecated.Since 2.0.0, use
DiskFileItemFactory.Builder.getThreshold()instead. - getBytes() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Returns the data, that has been written, if the stream has been closed, and the stream is still in memory (
DeferrableOutputStream.isInMemory()returns true). - getBytesRead() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Gets the number of bytes, which have been read by the stream.
- getCharacterEncoding() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the character encoding for the request.
- getCharset() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the content charset passed by the agent or
nullif not defined. - getCharset() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the character encoding for the request or null if unspecified.
- getCharsetDefault() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the default charset for use when no explicit charset parameter is provided by the sender.
- getCharsetDefault() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the default charset for use when no explicit charset parameter is provided by the sender.
- getContentLength() - Method in class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Gets the content length of the request.
- getContentLength() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the content length of the request.
- getContentType() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the content type passed by the agent or
nullif not defined. - getContentType() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the content type passed by the browser or
nullif not defined. - getContentType() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Gets the content type.
- getContentType() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Gets the content type passed by the browser or
nullif not defined. - getContentType() - Method in exception org.apache.commons.fileupload2.core.FileUploadContentTypeException
-
Gets the content type.
- getContentType() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the content type of the request.
- getFieldName() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the name of the field in the multipart form corresponding to this file item.
- getFieldName() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the name of the field in the multipart form corresponding to this file item.
- getFieldName() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Gets the field name.
- getFieldName() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Gets the name of the field in the multipart form corresponding to this file item.
- getFieldName() - Method in exception org.apache.commons.fileupload2.core.FileUploadByteCountLimitException
-
Gets the field name of the item, which caused the exception.
- getFieldName(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the field name from the
Content-dispositionheader. - getFileCleaningTracker() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Returns the
FileCleaningTracker, which is being used to remove temporary files. - getFileCleaningTracker() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the tracker, which is responsible for deleting temporary files.
- getFileCleaningTracker() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Gets the file cleaning tracker.
- getFileItemFactory() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the factory class used when creating file items.
- getFileItemHeaders() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Gets the field item headers.
- getFileName() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Gets the file name.
- getFileName() - Method in exception org.apache.commons.fileupload2.core.FileUploadByteCountLimitException
-
Gets the file name of the item, which caused the exception.
- getFileName(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the file name from the
Content-dispositionheader. - getFileSizeMax() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Gets the maximum size of a single file.
- getHeader(String) - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Gets the value of the specified part header as a
String. - getHeaderCharset() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the character encoding used when reading the headers of an individual part.
- getHeaderCharset() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Gets the character encoding used when reading the headers of an individual part.
- getHeaderNames() - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Gets an
Iteratorof all the header names. - getHeaders() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the file item headers.
- getHeaders() - Method in interface org.apache.commons.fileupload2.core.FileItemHeadersProvider
-
Gets the collection of headers defined locally within this item.
- getHeaders(String) - Method in interface org.apache.commons.fileupload2.core.FileItemHeaders
-
Gets all the values of the specified item header as an
IteratorofStringobjects. - getInputStream() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
If the stream is closed: Returns an
InputStreamon the data, that has been written to this stream. - getInputStream() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets an
InputStreamthat can be used to retrieve the contents of the file. - getInputStream() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets an
InputStreamthat can be used to retrieve the contents of the file. - getInputStream() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Opens an
InputStream, which allows to read the items contents. - getInputStream() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Gets the input stream for the request.
- getItemIterator(RequestContext) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets an RFC 1867 compliant
multipart/form-datastream. - getItemIterator(R) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets a file item iterator.
- getMaxFileCount() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the maximum number of files allowed in a single request.
- getMaxFileSize() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the maximum allowed size of a single uploaded file, as opposed to
AbstractFileUpload.getMaxSize(). - getMaxPartHeaderSize() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the per part size limit for headers.
- getMaxPartHeaderSize() - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Gets the per part size limit for headers.
- getMaxPartHeaderSize() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Returns the per part size limit for headers.
- getMaxSize() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the maximum allowed size of a complete request, as opposed to
AbstractFileUpload.getMaxFileSize(). - getName() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the original file name in the client's file system.
- getName() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the original file name in the client's file system, as provided by the browser (or other client software).
- getName() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Gets the original file name in the client's file system, as provided by the browser (or other client software).
- getOutputStream() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets an
OutputStreamthat can be used for storing the contents of the file. - getOutputStream() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets an
OutputStreamthat can be used for storing the contents of the file. - getParsedHeaders(String) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses the
header-partand returns as key/value pairs. - getPath() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Returns the output file, that has been created, if any, or null.
- getPath() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the
Pathfor theFileItem's data's temporary location on the disk. - getPermitted() - Method in exception org.apache.commons.fileupload2.core.FileUploadSizeException
-
Gets the limit size of the request.
- getProgressListener() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Gets the progress listener.
- getReader() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Returns the contents of the file as a
Reader, using the specifiedDiskFileItem.getCharset(). - getRepository() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the directory used to temporarily store files that are larger than the configured size threshold.
- getRequest() - Method in class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Gets the request.
- getSize() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Returns the number of bytes, that have been written to this stream.
- getSize() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the size of the file.
- getSize() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the size of the file item.
- getSizeMax() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Gets the maximum size of the complete HTTP request.
- getState() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Returns the streams current state.
- getString() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Deprecated.Since 2.0.0, use
DiskFileItem.getReader()instead. - getString() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the contents of the file item as a String, using the default character encoding.
- getString(Charset) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Gets the contents of the file as a String, using the specified encoding.
- getString(Charset) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Gets the contents of the file item as a String, using the specified encoding.
- getThreshold() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Returns the streams configured threshold.
- getThreshold() - Method in class org.apache.commons.fileupload2.core.DiskFileItem.Builder
-
Returns the threshold.
- getThreshold() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Returns the file items threshold.
- getThreshold() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Returns the threshold.
- getThreshold() - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory
-
Gets the size threshold beyond which files are written directly to disk.
H
- hasNext() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Tests whether another instance of
FileItemInputis available.
I
- initialized - Enum constant in enum org.apache.commons.fileupload2.core.DeferrableOutputStream.State
-
The stream object has been created with a non-negative threshold, but so far no data has been written.
- isClosed() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Tests whether this instance is closed.
- isFormField() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Tests whether or not a
FileIteminstance represents a simple form field. - isFormField() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Tests whether or not a
FileIteminstance represents a simple form field. - isFormField() - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Tests whether this is a form field.
- isFormField() - Method in interface org.apache.commons.fileupload2.core.FileItemInput
-
Tests whether or not a
FileIteminstance represents a simple form field. - isInMemory() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Returns true, if this stream was never persisted, and no output file has been created.
- isInMemory() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Provides a hint as to whether or not the file contents will be read from memory.
- isInMemory() - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Tests a hint as to whether or not the file contents will be read from memory.
- isLowerCaseNames() - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Tests
trueif parameter names are to be converted to lower case when name/value pairs are parsed. - isMultipartContent(RequestContext) - Static method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Utility method that determines whether the request contains multipart content.
- isMultipartRelated() - Method in class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Tests whether the Request of type
multipart/related? - isMultipartRelated() - Method in interface org.apache.commons.fileupload2.core.RequestContext
-
Is the Request of type
multipart/related? - isMultipartRequestMethod(String) - Static method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Checks if a given request method is a valid multipart request method.
L
- LF - Static variable in class org.apache.commons.fileupload2.core.MultipartInput
-
The Line Feed ASCII character value.
M
- MalformedStreamException(String) - Constructor for exception org.apache.commons.fileupload2.core.MultipartInput.MalformedStreamException
-
Constructs an
MalformedStreamExceptionwith the specified detail message. - MalformedStreamException(String, Throwable) - Constructor for exception org.apache.commons.fileupload2.core.MultipartInput.MalformedStreamException
-
Constructs an
MalformedStreamExceptionwith the specified detail message. - MULTIPART - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Part of HTTP content type header.
- MULTIPART_FORM_DATA - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content type header for multipart forms.
- MULTIPART_MIXED - Static variable in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
HTTP content type header for multiple uploads.
- MultipartInput - Class in org.apache.commons.fileupload2.core
-
Low-level API for processing file uploads.
- MultipartInput.Builder - Class in org.apache.commons.fileupload2.core
-
Builds a new
MultipartInputinstance. - MultipartInput.FileUploadBoundaryException - Exception in org.apache.commons.fileupload2.core
-
Signals an attempt to set an invalid boundary token.
- MultipartInput.ItemInputStream - Class in org.apache.commons.fileupload2.core
-
An
InputStreamfor reading an items contents. - MultipartInput.MalformedStreamException - Exception in org.apache.commons.fileupload2.core
-
Signals that the input stream fails to follow the required syntax.
- MultipartInput.ProgressNotifier - Class in org.apache.commons.fileupload2.core
-
Internal class, which is used to invoke the
ProgressListener.
N
- newFileItemHeaders() - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Creates a new instance of
FileItemHeaders. - newFileItemHeaders() - Static method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Create a new FileItemHeaders implementation.
- newInputStream() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Creates a new
MultipartInput.ItemInputStream. - next() - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Returns the next available
FileItemInput. - NOP - Static variable in interface org.apache.commons.fileupload2.core.ProgressListener
-
Nop implementation.
- noteItem() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ProgressNotifier
-
Called to indicate, that a new file item has been detected.
O
- opened - Enum constant in enum org.apache.commons.fileupload2.core.DeferrableOutputStream.State
-
The stream object has been created with a non-negative threshold, and some data has been written, but the threshold is not yet exceeded, and the data is still kept in memory.
- org.apache.commons.fileupload2.core - package org.apache.commons.fileupload2.core
-
A component for handling HTML file uploads as specified by RFC 1867.
P
- ParameterParser - Class in org.apache.commons.fileupload2.core
-
A simple parser intended to parse sequences of name/value pairs.
- ParameterParser() - Constructor for class org.apache.commons.fileupload2.core.ParameterParser
-
Default ParameterParser constructor.
- parse(char[], char) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given array of characters.
- parse(char[], int, int, char) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given array of characters.
- parse(String, char) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given string.
- parse(String, char[]) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Parses a map of name/value pairs from the given string.
- parseParameterMap(RequestContext) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-datastream. - parseParameterMap(R) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-datastream. - parseRequest(RequestContext) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-datastream. - parseRequest(R) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Parses an RFC 1867 compliant
multipart/form-datastream. - persist() - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
-
Create the output file, change the state to
persisted, and return anOutputStream, which is writing to that file. - persisted - Enum constant in enum org.apache.commons.fileupload2.core.DeferrableOutputStream.State
-
Either of the following conditions is given: The stream object has been created with a threshold of -1, or the stream object has been created with a non-negative threshold, and some data has been written.
- persisted(Path) - Method in interface org.apache.commons.fileupload2.core.DeferrableOutputStream.Listener
-
Called, after
DeferrableOutputStream.persist()has been invoked, and the temporary file has been created. - ProgressListener - Interface in org.apache.commons.fileupload2.core
-
Receives progress information.
- ProgressNotifier(ProgressListener, long) - Constructor for class org.apache.commons.fileupload2.core.MultipartInput.ProgressNotifier
-
Creates a new instance with the given listener and content length.
R
- read() - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Reads the next byte in the stream.
- read(byte[], int, int) - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Reads bytes into the given buffer.
- readBodyData(OutputStream) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads
body-datafrom the currentencapsulationand writes its contents into the outputStream. - readBoundary() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Skips a
boundarytoken, and checks whether moreencapsulationsare contained in the stream. - readByte() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads a byte from the
buffer, and refills it as necessary. - readHeaders() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Reads the
header-partof the currentencapsulation. - RequestContext - Interface in org.apache.commons.fileupload2.core
-
Abstracts access to the request information needed for file uploads.
S
- setBoundary(byte[]) - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Sets the boundary.
- setBoundary(byte[]) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Changes the boundary token used for partitioning the stream.
- setBufferSize(int) - Method in class org.apache.commons.fileupload2.core.DiskFileItem.Builder
-
Deprecated.Since 2.0.0, use
DiskFileItem.Builder.setThreshold(int)instead. - setBufferSize(int) - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Deprecated.Since 2.0.0, use
DiskFileItemFactory.Builder.setThreshold(int)instead. - setCharsetDefault(Charset) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Sets the default charset for use when no explicit charset parameter is provided by the sender.
- setContentType(String) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Sets the content type.
- setFieldName(String) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Sets the field name used to reference this file item.
- setFieldName(String) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Sets the field name used to reference this file item.
- setFieldName(String) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Sets the field name.
- setFileCleaningTracker(FileCleaningTracker) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Sets the
FileCleaningTracker, which is being used to remove temporary files. - setFileCleaningTracker(FileCleaningTracker) - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Sets the tracker, which is responsible for deleting temporary files.
- setFileCleaningTracker(FileCleaningTracker) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Sets the file cleaning tracker.
- setFileItemFactory(F) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the factory class to use when creating file items.
- setFileItemHeaders(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Sets the file item headers.
- setFileName(String) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Sets the file name.
- setFileSizeMax(long) - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Sets the maximum size of a single file.
- setFormField(boolean) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Specifies whether or not a
FileIteminstance represents a simple form field. - setFormField(boolean) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Sets whether or not a
FileIteminstance represents a simple form field. - setFormField(boolean) - Method in class org.apache.commons.fileupload2.core.FileItemFactory.AbstractFileItemBuilder
-
Sets whether this is a form field.
- setHeaderCharset(Charset) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Specifies the character encoding to be used when reading the headers of individual part.
- setHeaderCharset(Charset) - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Sets the character encoding to be used when reading the headers of individual parts.
- setHeaders(FileItemHeaders) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Sets the file item headers.
- setHeaders(FileItemHeaders) - Method in interface org.apache.commons.fileupload2.core.FileItemHeadersProvider
-
Sets the headers read from within an item.
- setLowerCaseNames(boolean) - Method in class org.apache.commons.fileupload2.core.ParameterParser
-
Sets the flag if parameter names are to be converted to lower case when name/value pairs are parsed.
- setMaxFileCount(long) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the maximum number of files allowed per request.
- setMaxFileSize(long) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the maximum allowed size of a single uploaded file, as opposed to
AbstractFileUpload.getMaxSize(). - setMaxPartHeaderSize(int) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the per part size limit for headers.
- setMaxPartHeaderSize(int) - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Sets the per part size limit for headers.
- setMaxSize(long) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the maximum allowed size of a complete request, as opposed to
AbstractFileUpload.setMaxFileSize(long). - setProgressListener(ProgressListener) - Method in class org.apache.commons.fileupload2.core.AbstractFileUpload
-
Sets the progress listener.
- setProgressNotifier(MultipartInput.ProgressNotifier) - Method in class org.apache.commons.fileupload2.core.MultipartInput.Builder
-
Sets the progress notifier.
- setSizeMax(long) - Method in interface org.apache.commons.fileupload2.core.FileItemInputIterator
-
Sets the maximum size of the complete HTTP request.
- setThreshold(int) - Method in class org.apache.commons.fileupload2.core.DiskFileItem.Builder
-
Sets the threshold.
- setThreshold(int) - Method in class org.apache.commons.fileupload2.core.DiskFileItemFactory.Builder
-
Sets the threshold.
- skip(long) - Method in class org.apache.commons.fileupload2.core.MultipartInput.ItemInputStream
-
Skips the given number of bytes.
- skipPreamble() - Method in class org.apache.commons.fileupload2.core.MultipartInput
-
Finds the beginning of the first
encapsulation.
T
- toString() - Method in class org.apache.commons.fileupload2.core.AbstractRequestContext
-
Returns a string representation of this object.
- toString() - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Returns a string representation of this object.
U
- update(long, long, int) - Method in interface org.apache.commons.fileupload2.core.ProgressListener
-
Updates the listeners status information.
V
- valueOf(String) - Static method in enum org.apache.commons.fileupload2.core.DeferrableOutputStream.State
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.commons.fileupload2.core.DeferrableOutputStream.State
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- write(byte[]) - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
- write(byte[], int, int) - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
- write(int) - Method in class org.apache.commons.fileupload2.core.DeferrableOutputStream
- write(Path) - Method in class org.apache.commons.fileupload2.core.DiskFileItem
-
Writes an uploaded item to disk.
- write(Path) - Method in interface org.apache.commons.fileupload2.core.FileItem
-
Writes an uploaded item to disk.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
DiskFileItem.getInputStream(), orDiskFileItem.getReader(), instead.