io.netty.handler.codec.http.multipart

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.

Constructor Summary

Constructors

Constructor and Description
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request)
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset)
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset, int maxFields, int maxBufferedBytes)
HttpPostMultipartRequestDecoder(HttpRequest request)

Method Summary

Modifier and Type	Method and Description
protected void	addHttpData(InterfaceHttpData data) Utility function to add a new decoded data
void	cleanFiles() Clean all HttpDatas (on Disk) 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 the HttpPostMultipartRequestDecoder and release all it resources.
InterfaceHttpData	getBodyHttpData(String name) This getMethod returns the first InterfaceHttpData with the given name from body.
List<InterfaceHttpData>	getBodyHttpDatas() This getMethod returns a List of all HttpDatas from body.
List<InterfaceHttpData>	getBodyHttpDatas(String name) This getMethod returns a List of all HttpDatas with the given name from body.
int	getDiscardThreshold() 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	isMultipart() True if this request is a Multipart request
InterfaceHttpData	next() Returns the next available InterfaceHttpData or null if, at the time it is called, there is no more available InterfaceHttpData.
HttpPostMultipartRequestDecoder	offer(HttpContent content) Initialized the internals from a new chunk
void	removeHttpDataFromClean(InterfaceHttpData data) Remove the given FileUpload from the list of FileUploads to clean
void	setDiscardThreshold(int discardThreshold) Set the amount of bytes after which read bytes in the buffer should be discarded.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(HttpRequest request)

Parameters:

request - the request to decode

Throws:

NullPointerException - for request

HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(HttpDataFactory factory,
                                       HttpRequest request)

Parameters:

factory - the factory used to create InterfaceHttpData

request - the request to decode

Throws:

NullPointerException - for request or factory

HttpPostRequestDecoder.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 InterfaceHttpData

request - the request to decode

charset - the charset to use as default

Throws:

NullPointerException - for request or charset or factory

HttpPostRequestDecoder.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 InterfaceHttpData

request - the request to decode

charset - the charset to use as default

maxFields - the maximum number of fields the form can have, -1 to disable

maxBufferedBytes - the maximum number of bytes the decoder can buffer when decoding a field, -1 to disable

Throws:

NullPointerException - for request or charset or factory

HttpPostRequestDecoder.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 interface InterfaceHttpPostRequestDecoder

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. Use 0 to disable it.

Specified by:

setDiscardThreshold in interface InterfaceHttpPostRequestDecoder

getDiscardThreshold

public int getDiscardThreshold()

Return the threshold in bytes after which read data in the buffer should be discarded.

Specified by:

getDiscardThreshold in interface InterfaceHttpPostRequestDecoder

getBodyHttpDatas

public 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 interface InterfaceHttpPostRequestDecoder

Returns:

the list of HttpDatas from Body part for POST getMethod

Throws:

HttpPostRequestDecoder.NotEnoughDataDecoderException - Need more chunks

getBodyHttpDatas

public List<InterfaceHttpData> 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. If not, NotEnoughDataDecoderException will be raised.

Specified by:

getBodyHttpDatas in interface InterfaceHttpPostRequestDecoder

Returns:

All Body HttpDatas with the given name (ignore case)

Throws:

HttpPostRequestDecoder.NotEnoughDataDecoderException - need more chunks

getBodyHttpData

public InterfaceHttpData getBodyHttpData(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 interface InterfaceHttpPostRequestDecoder

Returns:

The first Body InterfaceHttpData with the given name (ignore case)

Throws:

HttpPostRequestDecoder.NotEnoughDataDecoderException - need more chunks

offer

public HttpPostMultipartRequestDecoder offer(HttpContent content)

Initialized the internals from a new chunk

Specified by:

offer in interface InterfaceHttpPostRequestDecoder

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 interface InterfaceHttpPostRequestDecoder

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 call ReferenceCounted.release() after you are done with processing to make sure to not leak any resources

Specified by:

next in interface InterfaceHttpPostRequestDecoder

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 interface InterfaceHttpPostRequestDecoder

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

getFileUpload

protected InterfaceHttpData getFileUpload(String delimiter)

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 the HttpPostMultipartRequestDecoder and release all it resources. After this method was called it is not possible to operate on it anymore.

Specified by:

destroy in interface InterfaceHttpPostRequestDecoder

cleanFiles

public void cleanFiles()

Clean all HttpDatas (on Disk) for the current request.

Specified by:

cleanFiles in interface InterfaceHttpPostRequestDecoder

removeHttpDataFromClean

public void removeHttpDataFromClean(InterfaceHttpData data)

Remove the given FileUpload from the list of FileUploads to clean

Specified by:

removeHttpDataFromClean in interface InterfaceHttpPostRequestDecoder