Index (Upload Parser API Documentation)

A B C D E F G H I M N O P R S U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractUploadParser - Class in com.github.elopteryx.upload.internal: Base class for the parser implementations.
AbstractUploadParser() - Constructor for class com.github.elopteryx.upload.internal.AbstractUploadParser
AsyncUploadParser - Class in com.github.elopteryx.upload.internal: The asynchronous implementation of the parser.
AsyncUploadParser(HttpServletRequest) - Constructor for class com.github.elopteryx.upload.internal.AsyncUploadParser
available() - Method in class com.github.elopteryx.upload.util.ByteBufferBackedInputStream

B

beginParse(MultipartParser.PartHandler, byte[], int, Charset) - Static method in class com.github.elopteryx.upload.internal.MultipartParser: Begins parsing the multipart input, sets up the necessary objects.
beginPart(Headers) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
BlockingUploadParser - Class in com.github.elopteryx.upload.internal: The blocking implementation of the parser.
BlockingUploadParser(HttpServletRequest) - Constructor for class com.github.elopteryx.upload.internal.BlockingUploadParser
ByteBufferBackedInputStream - Class in com.github.elopteryx.upload.util: An input stream implementation which reads from the given byte buffer.
ByteBufferBackedInputStream(ByteBuffer) - Constructor for class com.github.elopteryx.upload.util.ByteBufferBackedInputStream: Public constructor.

C

checkBuffer - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The buffer that stores the first bytes of the current part.
close() - Method in class com.github.elopteryx.upload.util.ByteBufferBackedInputStream
close() - Method in class com.github.elopteryx.upload.util.NullChannel
close() - Method in class com.github.elopteryx.upload.util.OutputStreamBackedChannel
com.github.elopteryx.upload - module com.github.elopteryx.upload: Async file upload module for servlets.
com.github.elopteryx.upload - package com.github.elopteryx.upload: The top level of the package hierarchy which contains the public API of this library.
com.github.elopteryx.upload.errors - package com.github.elopteryx.upload.errors: This package contains the exception classes used in this library.
com.github.elopteryx.upload.internal - package com.github.elopteryx.upload.internal: The package for the actual implementation.
com.github.elopteryx.upload.util - package com.github.elopteryx.upload.util: This package contains utility classes for channels and streams used by this library.
CONTENT_DISPOSITION - Static variable in class com.github.elopteryx.upload.internal.Headers
CONTENT_ENCODING - Static variable in class com.github.elopteryx.upload.internal.Headers
CONTENT_LENGTH - Static variable in class com.github.elopteryx.upload.internal.Headers
CONTENT_TYPE - Static variable in class com.github.elopteryx.upload.internal.Headers
context - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The context instance.

D

data(ByteBuffer) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
dataBuffer - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The buffer that stores the bytes which were read from the servlet input stream or from a different source.
doBlockingParse() - Method in class com.github.elopteryx.upload.internal.BlockingUploadParser: Performs a full parsing and returns the used context object.
doBlockingParse(HttpServletRequest) - Method in class com.github.elopteryx.upload.UploadParser: The parser begins parsing the request stream.

E

endPart() - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
extractBoundaryFromHeader(String) - Static method in class com.github.elopteryx.upload.internal.Headers: Extracts a token from a header that has a given key.
extractQuotedValueFromHeader(String, String) - Static method in class com.github.elopteryx.upload.internal.Headers: Extracts a quoted value from a header that has a given key.

F

from(OutputStream) - Static method in class com.github.elopteryx.upload.PartOutput: Creates a new instance from the given stream object.
from(WritableByteChannel) - Static method in class com.github.elopteryx.upload.PartOutput: Creates a new instance from the given channel object.
from(Path) - Static method in class com.github.elopteryx.upload.PartOutput: Creates a new instance from the given path object.

G

getActualSize() - Method in exception com.github.elopteryx.upload.errors.UploadSizeException: Returns the actual size.
getContentType() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getContentType() - Method in interface com.github.elopteryx.upload.PartStream: Returns the content type of this part, as it was submitted by the client.
getCurrentOutput() - Method in class com.github.elopteryx.upload.internal.UploadContextImpl
getCurrentOutput() - Method in interface com.github.elopteryx.upload.UploadContext: Returns the currently active output, which was returned in the latest UploadParser#onPartBegin method.
getCurrentPart() - Method in class com.github.elopteryx.upload.internal.UploadContextImpl
getCurrentPart() - Method in interface com.github.elopteryx.upload.UploadContext: Returns the currently processed part stream, allowing the caller to get available information.
getHeader(String) - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getHeader(String) - Method in interface com.github.elopteryx.upload.PartStream: Returns the value of the specified mime header as a String.
getHeaderNames() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getHeaderNames() - Method in interface com.github.elopteryx.upload.PartStream: Returns the header names of this part.
getHeaders(String) - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getHeaders(String) - Method in interface com.github.elopteryx.upload.PartStream: Returns the values of the part header with the given name.
getKnownSize() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getKnownSize() - Method in interface com.github.elopteryx.upload.PartStream: Returns the known size of this part.
getName() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getName() - Method in interface com.github.elopteryx.upload.PartStream: Returns the name of this part, which equals the name of the form field the part was selected for.
getOutput() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getPartStreams() - Method in class com.github.elopteryx.upload.internal.UploadContextImpl
getPartStreams() - Method in interface com.github.elopteryx.upload.UploadContext: Returns the parts which have already been processed.
getPermittedSize() - Method in exception com.github.elopteryx.upload.errors.UploadSizeException: Returns the permitted size.
getRequest() - Method in class com.github.elopteryx.upload.internal.UploadContextImpl
getRequest() - Method in interface com.github.elopteryx.upload.UploadContext: Returns the given request object for this parser, allowing customization during the stages of the asynchronous processing.
getSubmittedFileName() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
getSubmittedFileName() - Method in interface com.github.elopteryx.upload.PartStream: Returns the file name specified by the client or null if the part is a normal form field.
getUserObject(Class<T>) - Method in class com.github.elopteryx.upload.internal.UploadContextImpl
getUserObject(Class<T>) - Method in interface com.github.elopteryx.upload.UploadContext: Returns the given user object for this parser, allowing customization during the stages of the asynchronous processing.

H

Headers - Class in com.github.elopteryx.upload.internal: This class is used to extract, store and retrieve header keys and values.
Headers() - Constructor for class com.github.elopteryx.upload.internal.Headers

I

isFile() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
isFile() - Method in interface com.github.elopteryx.upload.PartStream: Determines whether or not this PartStream instance represents a file item.
isFinished() - Method in class com.github.elopteryx.upload.internal.PartStreamImpl
isFinished() - Method in interface com.github.elopteryx.upload.PartStream: Returns whether the part has been completely uploaded.
isMultipart(HttpServletRequest) - Static method in class com.github.elopteryx.upload.UploadParser: Utility method which can be used to check whether the request should be processed by this parser or not.
isOpen() - Method in class com.github.elopteryx.upload.util.NullChannel
isOpen() - Method in class com.github.elopteryx.upload.util.OutputStreamBackedChannel

M

maxBytesUsed - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The number of bytes to be allocated for the buffers.
maxBytesUsed(int) - Method in class com.github.elopteryx.upload.UploadParser: Sets the amount of bytes to allocate for the parsing.
maxPartSize(long) - Method in class com.github.elopteryx.upload.UploadParser: Sets the maximum allowed size for each part.
maxRequestSize - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The maximum size permitted for the complete request.
maxRequestSize(long) - Method in class com.github.elopteryx.upload.UploadParser: Sets the maximum allowed size for the request.
MULTIPART_FORM_DATA - Static variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The valid mime type.
MultipartException - Exception in com.github.elopteryx.upload.errors: Exception thrown by the multipart parser.
MultipartException(String) - Constructor for exception com.github.elopteryx.upload.errors.MultipartException: Public constructor.
MultipartParser - Class in com.github.elopteryx.upload.internal: Copied from Undertow.

N

newParser() - Static method in class com.github.elopteryx.upload.UploadParser: Returns a new parser, allowing the caller to set configuration.
NullChannel - Class in com.github.elopteryx.upload.util: A channel implementation which provides no data and discards the data supplied.
NullChannel() - Constructor for class com.github.elopteryx.upload.util.NullChannel

O

onAllDataRead() - Method in class com.github.elopteryx.upload.internal.AsyncUploadParser: Invoked when all data for the current request has been read.
onDataAvailable() - Method in class com.github.elopteryx.upload.internal.AsyncUploadParser: When an instance of the ReadListener is registered with a ServletInputStream, this method will be invoked by the container the first time when it is possible to read data.
onError(OnError) - Method in class com.github.elopteryx.upload.UploadParser: Sets a callback for the errors, called if any error occurs.
onError(UploadContext, Throwable) - Method in interface com.github.elopteryx.upload.OnError: The consumer function to implement.
onError(Throwable) - Method in class com.github.elopteryx.upload.internal.AsyncUploadParser: Invoked when an error occurs processing the request.
OnError - Interface in com.github.elopteryx.upload: A functional interface.
onPartBegin(OnPartBegin) - Method in class com.github.elopteryx.upload.UploadParser: Sets a callback for each part, called at the beginning.
onPartBegin(UploadContext, ByteBuffer) - Method in interface com.github.elopteryx.upload.OnPartBegin: The function to implement.
OnPartBegin - Interface in com.github.elopteryx.upload: A functional interface.
onPartEnd(OnPartEnd) - Method in class com.github.elopteryx.upload.UploadParser: Sets a callback for each part, called at the end.
onPartEnd(UploadContext) - Method in interface com.github.elopteryx.upload.OnPartEnd: The consumer function to implement.
OnPartEnd - Interface in com.github.elopteryx.upload: A functional interface.
onRequestComplete(OnRequestComplete) - Method in class com.github.elopteryx.upload.UploadParser: Sets a callback for the request, called after each part is processed.
onRequestComplete(UploadContext) - Method in interface com.github.elopteryx.upload.OnRequestComplete: The consumer function to implement.
OnRequestComplete - Interface in com.github.elopteryx.upload: A functional interface.
OutputStreamBackedChannel - Class in com.github.elopteryx.upload.util: A channel implementation which writes the ByteBuffer data to the given OutputStream instance.
OutputStreamBackedChannel(OutputStream) - Constructor for class com.github.elopteryx.upload.util.OutputStreamBackedChannel: Public constructor.

P

parseState - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The reference to the multipart parser.
PartOutput - Class in com.github.elopteryx.upload: A value holder class, allowing the caller to provide various output objects, like a byte channel or an output stream.
PartOutput(Object) - Constructor for class com.github.elopteryx.upload.PartOutput: Protected constructor, no need for public access.
PartSizeException - Exception in com.github.elopteryx.upload.errors: Exception thrown when there is a maximum size limit set for the individual parts and it is exceeded for the first time.
PartSizeException(String, long, long) - Constructor for exception com.github.elopteryx.upload.errors.PartSizeException: Public constructor.
PartStream - Interface in com.github.elopteryx.upload: This interface represents a part item, which is being streamed from the client.
PartStreamImpl - Class in com.github.elopteryx.upload.internal: Default implementation of PartStream.
PartStreamImpl(String, String, Headers) - Constructor for class com.github.elopteryx.upload.internal.PartStreamImpl: Creates a new instance.

R

read() - Method in class com.github.elopteryx.upload.util.ByteBufferBackedInputStream
read(byte[], int, int) - Method in class com.github.elopteryx.upload.util.ByteBufferBackedInputStream
read(ByteBuffer) - Method in class com.github.elopteryx.upload.util.NullChannel
requestSize - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The known size of the request.
RequestSizeException - Exception in com.github.elopteryx.upload.errors: Exception thrown when there is a maximum size limit set for the whole request and it is exceeded for the first time.
RequestSizeException(String, long, long) - Constructor for exception com.github.elopteryx.upload.errors.RequestSizeException: Public constructor.

S

safeToCast(Class<T>) - Method in class com.github.elopteryx.upload.PartOutput: Returns whether it is safe to retrieve the value object with the class parameter.
setErrorCallback(OnError) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
setMaxBytesUsed(int) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser: Sets the amount of bytes to allocate.
setMaxPartSize(long) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
setMaxRequestSize(long) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
setPartBeginCallback(OnPartBegin) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
setPartEndCallback(OnPartEnd) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
setRequestCallback(OnRequestComplete) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
setSizeThreshold(int) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
setupAsyncParse() - Method in class com.github.elopteryx.upload.internal.AsyncUploadParser: Setups the async parsing by registering the instance to the servlet stream as a read listener.
setupAsyncParse(HttpServletRequest) - Method in class com.github.elopteryx.upload.UploadParser: Performs the necessary operations to setup the async parsing.
setUserObject(Object) - Method in class com.github.elopteryx.upload.internal.AbstractUploadParser
sizeThreshold - Variable in class com.github.elopteryx.upload.internal.AbstractUploadParser: The number of bytes that should be buffered before calling the part begin callback.
sizeThreshold(int) - Method in class com.github.elopteryx.upload.UploadParser: Sets the amount of bytes to buffer in the memory, before calling the part end callback.

U

unwrap(Class<T>) - Method in class com.github.elopteryx.upload.PartOutput: Retrieves the value object, casting it to the given type.
UploadContext - Interface in com.github.elopteryx.upload: The context object which is passed to the user-supplied functions, allowing the user to get the necessary objects during the various stages of the parsing.
UploadContextImpl - Class in com.github.elopteryx.upload.internal: Default implementation of UploadContext.
UploadContextImpl(HttpServletRequest, Object) - Constructor for class com.github.elopteryx.upload.internal.UploadContextImpl
UploadParser - Class in com.github.elopteryx.upload: The main class for the library.
UploadSizeException - Exception in com.github.elopteryx.upload.errors: Base class for the size related exceptions.
userObject(Object) - Method in class com.github.elopteryx.upload.UploadParser: Sets the user object, which can be anything.

W

write(ByteBuffer) - Method in class com.github.elopteryx.upload.util.NullChannel
write(ByteBuffer) - Method in class com.github.elopteryx.upload.util.OutputStreamBackedChannel

A B C D E F G H I M N O P R S U W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form