Index (nio-multipart-parser 1.1.0 API)

A B C D E F G H I L M N O P R S T U V W

A

AbstractIterator<T> - Class in org.synchronoss.cloud.nio.multipart.util.collect: Class taken from the google guava project guava.
AbstractIterator() - Constructor for class org.synchronoss.cloud.nio.multipart.util.collect.AbstractIterator: Constructor for use by subclasses.
AbstractNioMultipartListener - Class in org.synchronoss.cloud.nio.multipart: NioMultipartParserListener providing empty implementation of all the callbacks.
AbstractNioMultipartListener() - Constructor for class org.synchronoss.cloud.nio.multipart.AbstractNioMultipartListener
ATTACHMENT - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Content disposition attachment parameter

B

BlockingIOAdapter - Class in org.synchronoss.cloud.nio.multipart: Adapts the NioMultipartParser to work with blocking IO.
BlockingIOAdapter() - Constructor for class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter
BlockingIOAdapter.NestedEnd - Class in org.synchronoss.cloud.nio.multipart: Marker PartItem signalling the end of a nested multipart.
BlockingIOAdapter.NestedStart - Class in org.synchronoss.cloud.nio.multipart: Marker PartItem signalling the start of a nested multipart.
BlockingIOAdapter.ParserToken - Interface in org.synchronoss.cloud.nio.multipart: Interface representing a parser token.
BlockingIOAdapter.ParserToken.Type - Enum in org.synchronoss.cloud.nio.multipart: Type of a token: part, nested (start) and nested (end)
BlockingIOAdapter.Part - Class in org.synchronoss.cloud.nio.multipart: A PartItem representing an attachment part.

C

CircularBuffer - Class in org.synchronoss.cloud.nio.multipart.io.buffer: A reusable circular buffer
CircularBuffer(int) - Constructor for class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Constructor.
close() - Method in class org.synchronoss.cloud.nio.multipart.NioMultipartParser
CloseableIterator<T> - Interface in org.synchronoss.cloud.nio.multipart.util.collect: Marker interface that defines an Iterator that is Closeable
closeQuietly(InputStream) - Static method in class org.synchronoss.cloud.nio.multipart.util.IOUtils: Closes an InputStream silently
computeNext() - Method in class org.synchronoss.cloud.nio.multipart.util.collect.AbstractIterator: Returns the next element.
CONTENT_DISPOSITION - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Content disposition header name
CONTENT_LENGTH - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Content length header name
CONTENT_TRANSFER_ENCODING - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Content transfer encoding header name
CONTENT_TYPE - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Content type header name
CR - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: The (\r) character in bytes

D

DASH - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: The dash (-) character in bytes
decodeText(String) - Static method in class org.synchronoss.cloud.nio.multipart.util.MimeUtility: Decode a string of text obtained from a mail header into its proper form.
DEFAULT_BUFFER_SIZE - Static variable in class org.synchronoss.cloud.nio.multipart.NioMultipartParser: The default buffer size: 16Kb The buffer size needs to be bigger than the separator.
DEFAULT_HEADERS_SECTION_SIZE - Static variable in class org.synchronoss.cloud.nio.multipart.NioMultipartParser: The default limit in bytes of the headers section.
DEFAULT_MAX_LEVEL_OF_NESTED_MULTIPART - Static variable in class org.synchronoss.cloud.nio.multipart.NioMultipartParser: Default number of nested multiparts body.
DEFAULT_MAX_THRESHOLD - Static variable in class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory: Default max threshold.
DefaultPartBodyStreamStorageFactory - Class in org.synchronoss.cloud.nio.multipart: Default implementation of the PartBodyStreamStorageFactory.
DefaultPartBodyStreamStorageFactory(String, int) - Constructor for class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory: Constructor.
DefaultPartBodyStreamStorageFactory(String) - Constructor for class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory: Constructor tha uses a default threshold of 10kb.
DefaultPartBodyStreamStorageFactory(int) - Constructor for class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory: Constructor tha uses a default default folder ${java.io.tmpdir}/nio-file-upload
DefaultPartBodyStreamStorageFactory() - Constructor for class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory: Constructor that uses a default threshold of 10kb and a default folder ${java.io.tmpdir}/nio-file-upload
dispose() - Method in class org.synchronoss.cloud.nio.multipart.NioMultipartParser

E

EMPTY_STRING - Static variable in class org.synchronoss.cloud.nio.multipart.util.HeadersParser
endOfData() - Method in class org.synchronoss.cloud.nio.multipart.util.collect.AbstractIterator: Implementations of AbstractIterator.computeNext() must invoke this method when there are no elements left in the iteration.
EndOfLineBuffer - Class in org.synchronoss.cloud.nio.multipart.io.buffer: A reusable buffer that is watching for end of line sequences.
EndOfLineBuffer(int, byte[], OutputStream) - Constructor for class org.synchronoss.cloud.nio.multipart.io.buffer.EndOfLineBuffer: Constructor

F

FixedSizeByteArrayOutputStream - Class in org.synchronoss.cloud.nio.multipart.io: A ByteArrayOutputStream with a limited capacity.
FixedSizeByteArrayOutputStream(int) - Constructor for class org.synchronoss.cloud.nio.multipart.io.FixedSizeByteArrayOutputStream: Constructor.
flush() - Method in class org.synchronoss.cloud.nio.multipart.NioMultipartParser
forBlockingIO(InputStream) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Creates the CloseableIterator.
FORM_DATA - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Content disposition form-data parameter
forNIO(NioMultipartParserListener) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Builds a NioMultipartParser.

G

geFsmTransitions() - Method in class org.synchronoss.cloud.nio.multipart.NioMultipartParser
getAvailableDataLength() - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Returns the number of slots with valid data
getBoundary(String) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Extracts the boundary parameter value defined in the Content-Type header of a multipart request.
getBufferSize() - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Returns the buffer capacity
getCharEncoding() - Method in class org.synchronoss.cloud.nio.multipart.MultipartContext: Returns the character encoding
getCharEncoding(Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Extracts the charset parameter value from the content type header.
getContentLength() - Method in class org.synchronoss.cloud.nio.multipart.MultipartContext: Returns the content length
getContentLength(Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Returns the value of the content length header if present.
getContentType() - Method in class org.synchronoss.cloud.nio.multipart.MultipartContext: Returns the content type
getContentType(Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Returns the value of the content type header if present.
getFieldName(Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Returns the 'name' parameter of the Content-disposition header.
getFileName(Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Returns the 'filename' parameter of the Content-disposition header.
getHeader(String, Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Returns the first value of a particular header
getHeaders() - Method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.NestedStart: Returns the parent part headers.
getHeaders() - Method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.Part: Returns the part headers.
getHeaders(String, Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Returns the list of values fo a particular header.
getPartBody() - Method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.Part: Returns the InputStream from where the part body can be read.
getTempFile(int) - Method in class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory
getThreshold(Map<String, List<String>>) - Method in class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory
getType() - Method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.NestedEnd: Returns the type of the part
getType() - Method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.NestedStart: Returns the type of the part
getType() - Method in interface org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.ParserToken: Returns the type of the part
getType() - Method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.Part: Returns the type of the part

H

hasMultipartContentType(Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Checks if the headers contains a Content-Type header that defines a multipart request.
hasNext() - Method in class org.synchronoss.cloud.nio.multipart.util.collect.AbstractIterator
HEADER_DELIMITER - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Sequence of bytes that represents the end of a headers section
HeadersParser - Class in org.synchronoss.cloud.nio.multipart.util: Class partially taken from the apache commons httpclient project commons-httpclient The code has been adapted for the specific use case of the nio multipart project.

I

inputStreamAsString(InputStream, String) - Static method in class org.synchronoss.cloud.nio.multipart.util.IOUtils: Reads an InputStream into a String with the specified char encoding
IOUtils - Class in org.synchronoss.cloud.nio.multipart.util: Bunch of IO utilities
IOUtils() - Constructor for class org.synchronoss.cloud.nio.multipart.util.IOUtils
isContentTransferEncodingBase64Encoded(Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Returns true if the headers contain the Content-transfer-encoding with value 'base64'.
isEmpty() - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Returns if the buffer is empty
isEndOfLine() - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.EndOfLineBuffer: Returns if an end of line has been encountered.
isFormField(Map<String, List<String>>, MultipartContext) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Checks if the part is a form field.
isFull() - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Returns if the buffer is full
isLowerCaseNames() - Method in class org.synchronoss.cloud.nio.multipart.util.ParameterParser: Returns true if parameter names are to be converted to lower case when name/value pairs are parsed.
isMultipart(String) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Checks if the Content-Type header defines a multipart request.

L

LF - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: The (\n) character in bytes
limitNestingPartsTo(int) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Specifies how many nested parts are allowed.

M

MimeUtility - Class in org.synchronoss.cloud.nio.multipart.util: Class taken from the apache commons file upload project commons-fileupload
Multipart - Class in org.synchronoss.cloud.nio.multipart: Easy to use fluent api to build an NioMultipartParser (for Nio parsing) or to obtain a CloseableIterator (for Blocking IO parsing)
multipart(MultipartContext) - Static method in class org.synchronoss.cloud.nio.multipart.Multipart: Starting point for parsing a multipart stream in NIO mode or Blocking IO Mode
MULTIPART - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Multipart content type prefix
Multipart.Builder - Class in org.synchronoss.cloud.nio.multipart: Builder that created an NioMultipartParser or a CloseableIterator based on the configuration selected via the fluent API.
MULTIPART_FORM_DATA - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Specific multipart/form-data content type
MULTIPART_MIXED - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Specific multipart/mixed content type
MultipartContext - Class in org.synchronoss.cloud.nio.multipart: Multipart context containing: Content Type Content Length Character Encoding
MultipartContext(String, int, String) - Constructor for class org.synchronoss.cloud.nio.multipart.MultipartContext: Constructor
MultipartUtils - Class in org.synchronoss.cloud.nio.multipart: Utilities to parse a multipart stream.

N

newStreamStorageForPartBody(Map<String, List<String>>, int) - Method in class org.synchronoss.cloud.nio.multipart.DefaultPartBodyStreamStorageFactory: Creates the StreamStorage for a specific part.
newStreamStorageForPartBody(Map<String, List<String>>, int) - Method in interface org.synchronoss.cloud.nio.multipart.PartBodyStreamStorageFactory: Creates the StreamStorage for a specific part.
next() - Method in class org.synchronoss.cloud.nio.multipart.util.collect.AbstractIterator
NioMultipartParser - Class in org.synchronoss.cloud.nio.multipart: The main class for parsing a multipart stream in an NIO mode.
NioMultipartParser(MultipartContext, NioMultipartParserListener) - Constructor for class org.synchronoss.cloud.nio.multipart.NioMultipartParser: Constructs a NioMultipartParser.
NioMultipartParser(MultipartContext, NioMultipartParserListener, PartBodyStreamStorageFactory) - Constructor for class org.synchronoss.cloud.nio.multipart.NioMultipartParser: Constructs a NioMultipartParser with default values for the buffer size, headers section size and nested multipart limit, but a custom implementation of PartBodyStreamStorageFactory.
NioMultipartParser(MultipartContext, NioMultipartParserListener, int) - Constructor for class org.synchronoss.cloud.nio.multipart.NioMultipartParser: Constructs a NioMultipartParser with default values for the headers section size and nested multipart limit and PartBodyStreamStorageFactory.
NioMultipartParser(MultipartContext, NioMultipartParserListener, PartBodyStreamStorageFactory, int, int, int) - Constructor for class org.synchronoss.cloud.nio.multipart.NioMultipartParser: Constructs a NioMultipartParser.
NioMultipartParserListener - Interface in org.synchronoss.cloud.nio.multipart: Listener that will be notified with the progress of the multipart parsing.

O

onAllPartsFinished() - Method in class org.synchronoss.cloud.nio.multipart.AbstractNioMultipartListener
onAllPartsFinished() - Method in interface org.synchronoss.cloud.nio.multipart.NioMultipartParserListener: Called when all the parts have been read.
onError(String, Throwable) - Method in class org.synchronoss.cloud.nio.multipart.AbstractNioMultipartListener
onError(String, Throwable) - Method in interface org.synchronoss.cloud.nio.multipart.NioMultipartParserListener: Called if an error occurs during the multipart parsing.
onNestedPartFinished() - Method in class org.synchronoss.cloud.nio.multipart.AbstractNioMultipartListener
onNestedPartFinished() - Method in interface org.synchronoss.cloud.nio.multipart.NioMultipartParserListener: Called when a nested part has completed.
onNestedPartStarted(Map<String, List<String>>) - Method in class org.synchronoss.cloud.nio.multipart.AbstractNioMultipartListener
onNestedPartStarted(Map<String, List<String>>) - Method in interface org.synchronoss.cloud.nio.multipart.NioMultipartParserListener: Called when the parser is about to start a nested multipart.
onPartFinished(StreamStorage, Map<String, List<String>>) - Method in class org.synchronoss.cloud.nio.multipart.AbstractNioMultipartListener
onPartFinished(StreamStorage, Map<String, List<String>>) - Method in interface org.synchronoss.cloud.nio.multipart.NioMultipartParserListener: Called when a part has been parsed.
org.synchronoss.cloud.nio.multipart - package org.synchronoss.cloud.nio.multipart
org.synchronoss.cloud.nio.multipart.io - package org.synchronoss.cloud.nio.multipart.io
org.synchronoss.cloud.nio.multipart.io.buffer - package org.synchronoss.cloud.nio.multipart.io.buffer
org.synchronoss.cloud.nio.multipart.util - package org.synchronoss.cloud.nio.multipart.util
org.synchronoss.cloud.nio.multipart.util.collect - package org.synchronoss.cloud.nio.multipart.util.collect

P

ParameterParser - Class in org.synchronoss.cloud.nio.multipart.util: Class taken from the apache commons file upload project commons-fileupload
ParameterParser() - Constructor for class org.synchronoss.cloud.nio.multipart.util.ParameterParser: Default ParameterParser constructor.
parse(InputStream, MultipartContext) - Static method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter: Parses the multipart stream and it returns the parts in form of CloseableIterator.
parse(InputStream, MultipartContext, PartBodyStreamStorageFactory) - Static method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter: Parses the multipart stream and it return the parts in form of CloseableIterator.
parse(InputStream, MultipartContext, int) - Static method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter: Parses the multipart stream and it return the parts in form of CloseableIterator.
parse(InputStream, MultipartContext, PartBodyStreamStorageFactory, int, int, int) - Static method in class org.synchronoss.cloud.nio.multipart.BlockingIOAdapter: Parses the multipart stream and it return the parts in form of Iterable.
parse(String, char[]) - Method in class org.synchronoss.cloud.nio.multipart.util.ParameterParser: Extracts a map of name/value pairs from the given string.
parse(String, char) - Method in class org.synchronoss.cloud.nio.multipart.util.ParameterParser: Extracts a map of name/value pairs from the given string.
parse(char[], char) - Method in class org.synchronoss.cloud.nio.multipart.util.ParameterParser: Extracts a map of name/value pairs from the given array of characters.
parse(char[], int, int, char) - Method in class org.synchronoss.cloud.nio.multipart.util.ParameterParser: Extracts a map of name/value pairs from the given array of characters.
parseHeaders(InputStream, String) - Static method in class org.synchronoss.cloud.nio.multipart.util.HeadersParser: Parse the headers section into a Map
PartBodyStreamStorageFactory - Interface in org.synchronoss.cloud.nio.multipart: Factory for a StreamStorage.
peek() - Method in class org.synchronoss.cloud.nio.multipart.util.collect.AbstractIterator: Returns the next element in the iteration without advancing the iteration.

R

readAll(OutputStream) - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Reads all the available valid data into an OutputStream
readChunk(OutputStream, int) - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Reads a chunk of available data into an OutputStream
readFormParameterValue(StreamStorage, Map<String, List<String>>) - Static method in class org.synchronoss.cloud.nio.multipart.MultipartUtils: Reads the form fields into a string.
recycle(byte[], OutputStream) - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.EndOfLineBuffer: Recycles the buffer
remove() - Method in class org.synchronoss.cloud.nio.multipart.util.collect.UnmodifiableIterator: Deprecated.
Unsupported operation.
reset() - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Resets the buffer.
reset() - Method in class org.synchronoss.cloud.nio.multipart.io.FixedSizeByteArrayOutputStream

S

saveTemporaryFilesTo(String) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Configures the folder where temporary files are stored during the processing.
setLowerCaseNames(boolean) - Method in class org.synchronoss.cloud.nio.multipart.util.ParameterParser: Sets the flag if parameter names are to be converted to lower case when name/value pairs are parsed.
SYSTEM_CHAR_SET - Static variable in class org.synchronoss.cloud.nio.multipart.util.IOUtils

T

TEXT_PLAIN - Static variable in class org.synchronoss.cloud.nio.multipart.MultipartUtils: text/plain mime-type
toString() - Method in class org.synchronoss.cloud.nio.multipart.MultipartContext

U

UnmodifiableIterator<E> - Class in org.synchronoss.cloud.nio.multipart.util.collect: Class taken from the google guava project guava.
UnmodifiableIterator() - Constructor for class org.synchronoss.cloud.nio.multipart.util.collect.UnmodifiableIterator: Constructor for use by subclasses.
usePartBodyStreamStorageFactory(PartBodyStreamStorageFactory) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Configures a specific PartBodyStreamStorageFactory to use.

V

valueOf(String) - Static method in enum org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.ParserToken.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.synchronoss.cloud.nio.multipart.BlockingIOAdapter.ParserToken.Type: Returns an array containing the constants of this enum type, in the order they are declared.

W

withBufferSize(int) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Configures a specific buffer size to use during the parsing.
withHeadersSizeLimit(int) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Configures a specific headers section limit.
withMaxMemoryUsagePerBodyPart(int) - Method in class org.synchronoss.cloud.nio.multipart.Multipart.Builder: Configures the threshold defining how many bytes of a part's body will be kept in memory before flushing them to disk.
write(byte) - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.CircularBuffer: Writes a byte in the first available slot in the buffer.
write(byte) - Method in class org.synchronoss.cloud.nio.multipart.io.buffer.EndOfLineBuffer: Writes a byte of data in the buffer.
write(int) - Method in class org.synchronoss.cloud.nio.multipart.io.FixedSizeByteArrayOutputStream
write(byte[], int, int) - Method in class org.synchronoss.cloud.nio.multipart.io.FixedSizeByteArrayOutputStream
write(int) - Method in class org.synchronoss.cloud.nio.multipart.NioMultipartParser
write(byte[]) - Method in class org.synchronoss.cloud.nio.multipart.NioMultipartParser
write(byte[], int, int) - Method in class org.synchronoss.cloud.nio.multipart.NioMultipartParser

A B C D E F G H I L M N O P R S T U V W