Class HttpPostMultipartRequestDecoder
java.lang.Object
io.netty.handler.codec.http.multipart.HttpPostMultipartRequestDecoder
- All Implemented Interfaces:
InterfaceHttpPostRequestDecoder
public class HttpPostMultipartRequestDecoder
extends Object
implements InterfaceHttpPostRequestDecoder
This decoder will decode Body and can handle POST BODY.
You MUST call
destroy()
after completion to release all resources.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List
<InterfaceHttpData> HttpDatas from Bodyprivate int
Body HttpDatas current positionprivate final Map
<String, List<InterfaceHttpData>> HttpDatas as Map from Bodyprivate Charset
Default charset to useprivate Attribute
The current Attribute that is currently in decode processprivate Map
<CharSequence, Attribute> Used in Multipartprivate FileUpload
The current FileUpload that is currently in decode processCurrent getStatusprivate boolean
private int
private final HttpDataFactory
Factory used to create InterfaceHttpDataprivate static final String
private boolean
Does the last chunk already receivedprivate final int
The maximum number of accumulated bytes when decoding a fieldprivate final int
The maximum number of fields allows by the formprivate final String
If multipart, this is the boundary for the global multipartprivate String
If multipart, there could be internal multiparts (mixed) to the global multipart.private final HttpRequest
Request to decodeprivate ByteBuf
The current channelBuffer -
Constructor Summary
ConstructorsConstructorDescriptionHttpPostMultipartRequestDecoder
(HttpDataFactory factory, HttpRequest request) HttpPostMultipartRequestDecoder
(HttpDataFactory factory, HttpRequest request, Charset charset) HttpPostMultipartRequestDecoder
(HttpDataFactory factory, HttpRequest request, Charset charset, int maxFields, int maxBufferedBytes) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addHttpData
(InterfaceHttpData data) Utility function to add a new decoded dataprivate void
void
Clean all HttpDatas (on Disk) for the current request.private void
Remove all Attributes that should be cleaned between two FileUpload in Mixed modeprivate static String
cleanString
(String field) Clean the String from any unallowed characterReturns the current InterfaceHttpData if currently in decoding status, meaning all data are not yet within, or null if there is no InterfaceHttpData currently in decoding status (either because none yet decoded or none currently partially decoded).private InterfaceHttpData
Decode a multipart request by pieces
NOTSTARTED PREAMBLE (
(HEADERDELIMITER DISPOSITION (FIELD | FILEUPLOAD))*
(HEADERDELIMITER DISPOSITION MIXEDPREAMBLE
(MIXEDDELIMITER MIXEDDISPOSITION MIXEDFILEUPLOAD)+
MIXEDCLOSEDELIMITER)*
CLOSEDELIMITER)+ EPILOGUE
Inspired from HttpMessageDecodervoid
destroy()
Destroy theHttpPostMultipartRequestDecoder
and release all it resources.private InterfaceHttpData
findMultipartDelimiter
(String delimiter, HttpPostRequestDecoder.MultiPartStatus dispositionStatus, HttpPostRequestDecoder.MultiPartStatus closeDelimiterStatus) Find the next Multipart Delimiterprivate InterfaceHttpData
Find the next DispositiongetBodyHttpData
(String name) This getMethod returns the first InterfaceHttpData with the given name from body.
If chunked, all chunks must have been offered using offer() getMethod.This getMethod returns a List of all HttpDatas from body.
If chunked, all chunks must have been offered using offer() getMethod.getBodyHttpDatas
(String name) This getMethod returns a List of all HttpDatas with the given name from body.
If chunked, all chunks must have been offered using offer() getMethod.private Attribute
getContentDispositionAttribute
(String... values) (package private) int
This method is package private intentionally in order to allow during tests to access to the amount of memory allocated (capacity) within the private ByteBuf undecodedChunkint
Return the threshold in bytes after which read data in the buffer should be discarded.protected InterfaceHttpData
getFileUpload
(String delimiter) Get the FileUpload (new one or current one)boolean
hasNext()
True if at current getStatus, there is an available decoded InterfaceHttpData from the Body.boolean
True if this request is a Multipart requestprivate static boolean
loadDataMultipartOptimized
(ByteBuf undecodedChunk, String delimiter, HttpData httpData) Load the field value or file data from a Multipart requestnext()
Returns the next available InterfaceHttpData or null if, at the time it is called, there is no more available InterfaceHttpData.offer
(HttpContent content) Initialized the internals from a new chunkprivate void
This getMethod will parse as much as possible data and fill the list and mapprivate void
Parse the Body for multipartprivate static String
readDelimiterOptimized
(ByteBuf undecodedChunk, String delimiter, Charset charset) Read one line up to --delimiter or --delimiter-- and if existing the CRLF or LF Read one line up to --delimiter or --delimiter-- and if existing the CRLF or LF.private static String
readLineOptimized
(ByteBuf undecodedChunk, Charset charset) Read one line up to the CRLF or LFvoid
Remove the given FileUpload from the list of FileUploads to cleanprivate static void
rewriteCurrentBuffer
(ByteBuf buffer, int lengthToSkip) Rewrite buffer in order to skip lengthToSkip bytes from current readerIndex, such that any readable bytes available after readerIndex + lengthToSkip (so before writerIndex) are moved at readerIndex position, therefore decreasing writerIndex of lengthToSkip at the end of the process.void
setDiscardThreshold
(int discardThreshold) Set the amount of bytes after which read bytes in the buffer should be discarded.private static void
skipControlCharacters
(ByteBuf undecodedChunk) Skip control Charactersprivate static void
skipControlCharactersStandard
(ByteBuf undecodedChunk) private boolean
Skip one empty lineprivate static String[]
Split one header in Multipartprivate static String[]
splitMultipartHeaderValues
(String svalue) Split one header value in Multipart
-
Field Details
-
factory
Factory used to create InterfaceHttpData -
request
Request to decode -
maxFields
private final int maxFieldsThe maximum number of fields allows by the form -
maxBufferedBytes
private final int maxBufferedBytesThe maximum number of accumulated bytes when decoding a field -
charset
Default charset to use -
isLastChunk
private boolean isLastChunkDoes the last chunk already received -
bodyListHttpData
HttpDatas from Body -
bodyMapHttpData
HttpDatas as Map from Body -
undecodedChunk
The current channelBuffer -
bodyListHttpDataRank
private int bodyListHttpDataRankBody HttpDatas current position -
multipartDataBoundary
If multipart, this is the boundary for the global multipart -
multipartMixedBoundary
If multipart, there could be internal multiparts (mixed) to the global multipart. Only one level is allowed. -
currentStatus
Current getStatus -
currentFieldAttributes
Used in Multipart -
currentFileUpload
The current FileUpload that is currently in decode process -
currentAttribute
The current Attribute that is currently in decode process -
destroyed
private boolean destroyed -
discardThreshold
private int discardThreshold -
FILENAME_ENCODED
-
-
Constructor Details
-
HttpPostMultipartRequestDecoder
- Parameters:
request
- the request to decode- Throws:
NullPointerException
- for requestHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
HttpPostMultipartRequestDecoder
- Parameters:
factory
- the factory used to create InterfaceHttpDatarequest
- the request to decode- Throws:
NullPointerException
- for request or factoryHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
HttpPostMultipartRequestDecoder
public HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset) - Parameters:
factory
- the factory used to create InterfaceHttpDatarequest
- the request to decodecharset
- the charset to use as default- Throws:
NullPointerException
- for request or charset or factoryHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
HttpPostMultipartRequestDecoder
public HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset, int maxFields, int maxBufferedBytes) - Parameters:
factory
- the factory used to create InterfaceHttpDatarequest
- the request to decodecharset
- the charset to use as defaultmaxFields
- the maximum number of fields the form can have,-1
to disablemaxBufferedBytes
- the maximum number of bytes the decoder can buffer when decoding a field,-1
to disable- Throws:
NullPointerException
- for request or charset or factoryHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
-
Method Details
-
checkDestroyed
private void checkDestroyed() -
isMultipart
public boolean isMultipart()True if this request is a Multipart request- Specified by:
isMultipart
in interfaceInterfaceHttpPostRequestDecoder
- Returns:
- True if this request is a Multipart request
-
setDiscardThreshold
public void setDiscardThreshold(int discardThreshold) Set the amount of bytes after which read bytes in the buffer should be discarded. Setting this lower gives lower memory usage but with the overhead of more memory copies. Use0
to disable it.- Specified by:
setDiscardThreshold
in interfaceInterfaceHttpPostRequestDecoder
-
getDiscardThreshold
public int getDiscardThreshold()Return the threshold in bytes after which read data in the buffer should be discarded.- Specified by:
getDiscardThreshold
in interfaceInterfaceHttpPostRequestDecoder
-
getBodyHttpDatas
This getMethod returns a List of all HttpDatas from body.
If chunked, all chunks must have been offered using offer() getMethod. If not, NotEnoughDataDecoderException will be raised.- Specified by:
getBodyHttpDatas
in interfaceInterfaceHttpPostRequestDecoder
- Returns:
- the list of HttpDatas from Body part for POST getMethod
- Throws:
HttpPostRequestDecoder.NotEnoughDataDecoderException
- Need more chunks
-
getBodyHttpDatas
This getMethod returns a List of all HttpDatas with the given name from body.
If chunked, all chunks must have been offered using offer() getMethod. If not, NotEnoughDataDecoderException will be raised.- Specified by:
getBodyHttpDatas
in interfaceInterfaceHttpPostRequestDecoder
- Returns:
- All Body HttpDatas with the given name (ignore case)
- Throws:
HttpPostRequestDecoder.NotEnoughDataDecoderException
- need more chunks
-
getBodyHttpData
This getMethod returns the first InterfaceHttpData with the given name from body.
If chunked, all chunks must have been offered using offer() getMethod. If not, NotEnoughDataDecoderException will be raised.- Specified by:
getBodyHttpData
in interfaceInterfaceHttpPostRequestDecoder
- Returns:
- The first Body InterfaceHttpData with the given name (ignore case)
- Throws:
HttpPostRequestDecoder.NotEnoughDataDecoderException
- need more chunks
-
offer
Initialized the internals from a new chunk- Specified by:
offer
in interfaceInterfaceHttpPostRequestDecoder
- Parameters:
content
- the new received chunk- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
- if there is a problem with the charset decoding or other errors
-
hasNext
public boolean hasNext()True if at current getStatus, there is an available decoded InterfaceHttpData from the Body. This getMethod works for chunked and not chunked request.- Specified by:
hasNext
in interfaceInterfaceHttpPostRequestDecoder
- Returns:
- True if at current getStatus, there is a decoded InterfaceHttpData
- Throws:
HttpPostRequestDecoder.EndOfDataDecoderException
- No more data will be available
-
next
Returns the next available InterfaceHttpData or null if, at the time it is called, there is no more available InterfaceHttpData. A subsequent call to offer(httpChunk) could enable more data. Be sure to callReferenceCounted.release()
after you are done with processing to make sure to not leak any resources- Specified by:
next
in interfaceInterfaceHttpPostRequestDecoder
- Returns:
- the next available InterfaceHttpData or null if none
- Throws:
HttpPostRequestDecoder.EndOfDataDecoderException
- No more data will be available
-
currentPartialHttpData
Description copied from interface:InterfaceHttpPostRequestDecoder
Returns the current InterfaceHttpData if currently in decoding status, meaning all data are not yet within, or null if there is no InterfaceHttpData currently in decoding status (either because none yet decoded or none currently partially decoded). Full decoded ones are accessible through hasNext() and next() methods.- Specified by:
currentPartialHttpData
in interfaceInterfaceHttpPostRequestDecoder
- Returns:
- the current InterfaceHttpData if currently in decoding status or null if none.
-
parseBody
private void parseBody()This getMethod will parse as much as possible data and fill the list and map- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
- if there is a problem with the charset decoding or other errors
-
addHttpData
Utility function to add a new decoded data -
parseBodyMultipart
private void parseBodyMultipart()Parse the Body for multipart- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
- if there is a problem with the charset decoding or other errors
-
decodeMultipart
Decode a multipart request by pieces
NOTSTARTED PREAMBLE (
(HEADERDELIMITER DISPOSITION (FIELD | FILEUPLOAD))*
(HEADERDELIMITER DISPOSITION MIXEDPREAMBLE
(MIXEDDELIMITER MIXEDDISPOSITION MIXEDFILEUPLOAD)+
MIXEDCLOSEDELIMITER)*
CLOSEDELIMITER)+ EPILOGUE
Inspired from HttpMessageDecoder- Returns:
- the next decoded InterfaceHttpData or null if none until now.
- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
- if an error occurs
-
skipControlCharacters
Skip control Characters -
skipControlCharactersStandard
-
findMultipartDelimiter
private InterfaceHttpData findMultipartDelimiter(String delimiter, HttpPostRequestDecoder.MultiPartStatus dispositionStatus, HttpPostRequestDecoder.MultiPartStatus closeDelimiterStatus) Find the next Multipart Delimiter- Parameters:
delimiter
- delimiter to finddispositionStatus
- the next getStatus if the delimiter is a startcloseDelimiterStatus
- the next getStatus if the delimiter is a close delimiter- Returns:
- the next InterfaceHttpData if any
- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
-
findMultipartDisposition
Find the next Disposition- Returns:
- the next InterfaceHttpData if any
- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
-
getContentDispositionAttribute
-
getFileUpload
Get the FileUpload (new one or current one)- Parameters:
delimiter
- the delimiter to use- Returns:
- the InterfaceHttpData if any
- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
-
destroy
public void destroy()Destroy theHttpPostMultipartRequestDecoder
and release all it resources. After this method was called it is not possible to operate on it anymore.- Specified by:
destroy
in interfaceInterfaceHttpPostRequestDecoder
-
cleanFiles
public void cleanFiles()Clean all HttpDatas (on Disk) for the current request.- Specified by:
cleanFiles
in interfaceInterfaceHttpPostRequestDecoder
-
removeHttpDataFromClean
Remove the given FileUpload from the list of FileUploads to clean- Specified by:
removeHttpDataFromClean
in interfaceInterfaceHttpPostRequestDecoder
-
cleanMixedAttributes
private void cleanMixedAttributes()Remove all Attributes that should be cleaned between two FileUpload in Mixed mode -
readLineOptimized
Read one line up to the CRLF or LF- Returns:
- the String from one line
- Throws:
HttpPostRequestDecoder.NotEnoughDataDecoderException
- Need more chunks and reset thereaderIndex
to the previous value
-
readDelimiterOptimized
private static String readDelimiterOptimized(ByteBuf undecodedChunk, String delimiter, Charset charset) Read one line up to --delimiter or --delimiter-- and if existing the CRLF or LF Read one line up to --delimiter or --delimiter-- and if existing the CRLF or LF. Note that CRLF or LF are mandatory for opening delimiter (--delimiter) but not for closing delimiter (--delimiter--) since some clients does not include CRLF in this case.- Parameters:
delimiter
- of the form --string, such that '--' is already included- Returns:
- the String from one line as the delimiter searched (opening or closing)
- Throws:
HttpPostRequestDecoder.NotEnoughDataDecoderException
- Need more chunks and reset thereaderIndex
to the previous value
-
rewriteCurrentBuffer
Rewrite buffer in order to skip lengthToSkip bytes from current readerIndex, such that any readable bytes available after readerIndex + lengthToSkip (so before writerIndex) are moved at readerIndex position, therefore decreasing writerIndex of lengthToSkip at the end of the process.- Parameters:
buffer
- the buffer to rewrite from current readerIndexlengthToSkip
- the size to skip from readerIndex
-
loadDataMultipartOptimized
private static boolean loadDataMultipartOptimized(ByteBuf undecodedChunk, String delimiter, HttpData httpData) Load the field value or file data from a Multipart request- Returns:
true
if the last chunk is loaded (boundary delimiter found),false
if need more chunks- Throws:
HttpPostRequestDecoder.ErrorDataDecoderException
-
cleanString
Clean the String from any unallowed character- Returns:
- the cleaned String
-
skipOneLine
private boolean skipOneLine()Skip one empty line- Returns:
- True if one empty line was skipped
-
splitMultipartHeader
Split one header in Multipart- Returns:
- an array of String where rank 0 is the name of the header, follows by several values that were separated by ';' or ','
-
splitMultipartHeaderValues
Split one header value in Multipart- Returns:
- an array of String where values that were separated by ';' or ','
-
getCurrentAllocatedCapacity
int getCurrentAllocatedCapacity()This method is package private intentionally in order to allow during tests to access to the amount of memory allocated (capacity) within the private ByteBuf undecodedChunk- Returns:
- the number of bytes the internal buffer can contain
-