Class HttpPostStandardRequestDecoder
- java.lang.Object
-
- io.netty.handler.codec.http.multipart.HttpPostStandardRequestDecoder
-
- All Implemented Interfaces:
InterfaceHttpPostRequestDecoder
public class HttpPostStandardRequestDecoder extends java.lang.Object implements InterfaceHttpPostRequestDecoder
This decoder will decode Body and can handle POST BODY. You MUST calldestroy()
after completion to release all resources.
-
-
Constructor Summary
Constructors Constructor Description HttpPostStandardRequestDecoder(HttpRequest request)
HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request)
HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request, java.nio.charset.Charset charset)
HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request, java.nio.charset.Charset charset, int maxFields, int maxBufferedBytes)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addHttpData(InterfaceHttpData data)
Utility function to add a new decoded datavoid
cleanFiles()
Clean allHttpData
s for the current request.InterfaceHttpData
currentPartialHttpData()
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).void
destroy()
Destroy theHttpPostStandardRequestDecoder
and release all it resources.InterfaceHttpData
getBodyHttpData(java.lang.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.java.util.List<InterfaceHttpData>
getBodyHttpDatas()
This getMethod returns a List of all HttpDatas from body.
If chunked, all chunks must have been offered using offer() getMethod.java.util.List<InterfaceHttpData>
getBodyHttpDatas(java.lang.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.int
getDiscardThreshold()
Return the threshold in bytes after which read data in the buffer should be discarded.boolean
hasNext()
True if at current getStatus, there is an available decoded InterfaceHttpData from the Body.boolean
isMultipart()
True if this request is a Multipart requestInterfaceHttpData
next()
Returns the next available InterfaceHttpData or null if, at the time it is called, there is no more available InterfaceHttpData.HttpPostStandardRequestDecoder
offer(HttpContent content)
Initialized the internals from a new chunkvoid
removeHttpDataFromClean(InterfaceHttpData data)
Remove the given FileUpload from the list of FileUploads to cleanvoid
setDiscardThreshold(int discardThreshold)
Set the amount of bytes after which read bytes in the buffer should be discarded.
-
-
-
Constructor Detail
-
HttpPostStandardRequestDecoder
public HttpPostStandardRequestDecoder(HttpRequest request)
- Parameters:
request
- the request to decode- Throws:
java.lang.NullPointerException
- for requestHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
HttpPostStandardRequestDecoder
public HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request)
- Parameters:
factory
- the factory used to create InterfaceHttpDatarequest
- the request to decode- Throws:
java.lang.NullPointerException
- for request or factoryHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
HttpPostStandardRequestDecoder
public HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request, java.nio.charset.Charset charset)
- Parameters:
factory
- the factory used to create InterfaceHttpDatarequest
- the request to decodecharset
- the charset to use as default- Throws:
java.lang.NullPointerException
- for request or charset or factoryHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
HttpPostStandardRequestDecoder
public HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request, java.nio.charset.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:
java.lang.NullPointerException
- for request or charset or factoryHttpPostRequestDecoder.ErrorDataDecoderException
- if the default charset was wrong when decoding or other errors
-
-
Method Detail
-
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
public java.util.List<InterfaceHttpData> 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
public java.util.List<InterfaceHttpData> getBodyHttpDatas(java.lang.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. 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
public InterfaceHttpData getBodyHttpData(java.lang.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. 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
public HttpPostStandardRequestDecoder offer(HttpContent content)
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
public InterfaceHttpData 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
public InterfaceHttpData 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.
-
addHttpData
protected void addHttpData(InterfaceHttpData data)
Utility function to add a new decoded data
-
destroy
public void destroy()
Destroy theHttpPostStandardRequestDecoder
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 allHttpData
s for the current request.- Specified by:
cleanFiles
in interfaceInterfaceHttpPostRequestDecoder
-
removeHttpDataFromClean
public void removeHttpDataFromClean(InterfaceHttpData data)
Remove the given FileUpload from the list of FileUploads to clean- Specified by:
removeHttpDataFromClean
in interfaceInterfaceHttpPostRequestDecoder
-
-