Modifier and Type	Class and Description
private static class	HttpPostStandardRequestDecoder.UrlDecoder
private static class	HttpPostStandardRequestDecoder.UrlEncodedDetector

Modifier and Type	Field and Description
private final List<InterfaceHttpData>	bodyListHttpData HttpDatas from Body
private int	bodyListHttpDataRank Body HttpDatas current position
private final Map<String, List<InterfaceHttpData>>	bodyMapHttpData HttpDatas as Map from Body
private final Charset	charset Default charset to use
private Attribute	currentAttribute The current Attribute that is currently in decode process
private HttpPostRequestDecoder.MultiPartStatus	currentStatus Current getStatus
private boolean	destroyed
private int	discardThreshold
private final HttpDataFactory	factory Factory used to create InterfaceHttpData
private boolean	isLastChunk Does the last chunk already received
private final HttpRequest	request Request to decode
private ByteBuf	undecodedChunk The current channelBuffer

Access	Constructor and Description
public	HttpPostStandardRequestDecoder(HttpRequest the request to decode request)
public	HttpPostStandardRequestDecoder(HttpDataFactory the factory used to create InterfaceHttpData factory, HttpRequest the request to decode request)
public	HttpPostStandardRequestDecoder(HttpDataFactory the factory used to create InterfaceHttpData factory, HttpRequest the request to decode request, Charset the charset to use as default charset)

Method Summary

Modifier and Type	Method and Description
protected void	addHttpData(InterfaceHttpData data) Utility function to add a new decoded data
private void	checkDestroyed()
public void	cleanFiles() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.cleanFiles. Clean all `HttpData`s for the current request.
public InterfaceHttpData	currentPartialHttpData() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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).
private static String	Returns: the decoded component decodeAttribute(String s, Charset charset) Decode component
private static ByteBuf	decodeAttribute(ByteBuf b, Charset charset)
public void	destroy() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.destroy. Destroy the `HttpPostStandardRequestDecoder` and release all it resources.
public InterfaceHttpData	Returns: The first Body InterfaceHttpData with the given name (ignore case) getBodyHttpData(String name) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.getBodyHttpData. This getMethod returns the first InterfaceHttpData with the given name from body.
public List<InterfaceHttpData>	Returns: the list of HttpDatas from Body part for POST getMethod getBodyHttpDatas() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.getBodyHttpDatas. This getMethod returns a List of all HttpDatas from body.
public List<InterfaceHttpData>	Returns: All Body HttpDatas with the given name (ignore case) getBodyHttpDatas(String name) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.getBodyHttpDatas. This getMethod returns a List of all HttpDatas with the given name from body.
public int	getDiscardThreshold() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.getDiscardThreshold. Return the threshold in bytes after which read data in the buffer should be discarded.
public boolean	Returns: True if at current getStatus, there is a decoded InterfaceHttpData hasNext() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.hasNext. True if at current getStatus, there is an available decoded InterfaceHttpData from the Body.
public boolean	Returns: True if this request is a Multipart request isMultipart() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.isMultipart. True if this request is a Multipart request
public InterfaceHttpData	Returns: the next available InterfaceHttpData or null if none next() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.next. Returns the next available InterfaceHttpData or null if, at the time it is called, there is no more available InterfaceHttpData.
public HttpPostStandardRequestDecoder	offer(HttpContent the new received chunk content) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.offer. Initialized the internals from a new chunk
private void	parseBody() This getMethod will parse as much as possible data and fill the list and map
private void	parseBodyAttributes() This getMethod fill the map and list with as much Attribute as possible from Body in not Multipart mode.
private void	parseBodyAttributesStandard() This getMethod fill the map and list with as much Attribute as possible from Body in not Multipart mode.
public void	removeHttpDataFromClean(InterfaceHttpData data) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.removeHttpDataFromClean. Remove the given FileUpload from the list of FileUploads to clean
public void	setDiscardThreshold(int discardThreshold) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.setDiscardThreshold. Set the amount of bytes after which read bytes in the buffer should be discarded.
private void	setFinalBuffer(ByteBuf buffer)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bodyListHttpData	back to summary
private final List<InterfaceHttpData> bodyListHttpData HttpDatas from Body

bodyListHttpDataRank	back to summary
private int bodyListHttpDataRank Body HttpDatas current position

bodyMapHttpData	back to summary
private final Map<String, List<InterfaceHttpData>> bodyMapHttpData HttpDatas as Map from Body

charset	back to summary
private final Charset charset Default charset to use

currentAttribute	back to summary
private Attribute currentAttribute The current Attribute that is currently in decode process

currentStatus	back to summary
private HttpPostRequestDecoder.MultiPartStatus currentStatus Current getStatus

destroyed	back to summary
private boolean destroyed

discardThreshold	back to summary
private int discardThreshold

factory	back to summary
private final HttpDataFactory factory Factory used to create InterfaceHttpData

isLastChunk	back to summary
private boolean isLastChunk Does the last chunk already received

request	back to summary
private final HttpRequest request Request to decode

undecodedChunk	back to summary
private ByteBuf undecodedChunk The current channelBuffer

Constructor Detail

HttpPostStandardRequestDecoder	back to summary
public HttpPostStandardRequestDecoder(HttpRequest request) Parameters request:HttpRequest the request to decode Exceptions NullPointerException: for request ErrorDataDecoderException: if the default charset was wrong when decoding or other errors

HttpPostStandardRequestDecoder	back to summary
public HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request) Parameters factory:HttpDataFactory the factory used to create InterfaceHttpData request:HttpRequest the request to decode Exceptions NullPointerException: for request or factory ErrorDataDecoderException: if the default charset was wrong when decoding or other errors

HttpPostStandardRequestDecoder	back to summary
public HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset) Parameters factory:HttpDataFactory the factory used to create InterfaceHttpData request:HttpRequest the request to decode charset:Charset the charset to use as default Exceptions NullPointerException: for request or charset or factory ErrorDataDecoderException: if the default charset was wrong when decoding or other errors

HttpPostStandardRequestDecoder

back to summary

public HttpPostStandardRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset)

Parameters

factory:HttpDataFactory: the factory used to create InterfaceHttpData
request:HttpRequest: the request to decode
charset:Charset: the charset to use as default

Exceptions

NullPointerException:: for request or charset or factory
ErrorDataDecoderException:: if the default charset was wrong when decoding or other errors

Method Detail

addHttpData	back to summary
protected void addHttpData(InterfaceHttpData data) Utility function to add a new decoded data

checkDestroyed	back to summary
private void checkDestroyed()

cleanFiles back to summary

cleanFiles	back to summary
public void cleanFiles() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.cleanFiles. Clean all `HttpData`s for the current request. Annotations @Override

public void cleanFiles()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.cleanFiles.

Clean all HttpDatas for the current request.

Annotations

@Override

currentPartialHttpData	back to summary
public InterfaceHttpData currentPartialHttpData() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.currentPartialHttpData. Doc from io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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). Full decoded ones are accessible through hasNext() and next() methods. Returns:InterfaceHttpData the current InterfaceHttpData if currently in decoding status or null if none. Annotations @Override

currentPartialHttpData

back to summary

public InterfaceHttpData currentPartialHttpData()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.currentPartialHttpData.

Doc from io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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). Full decoded ones are accessible through hasNext() and next() methods.

Returns:InterfaceHttpData

the current InterfaceHttpData if currently in decoding status or null if none.

Annotations

@Override

decodeAttribute	back to summary
private static String decodeAttribute(String s, Charset charset) Decode component Returns:String the decoded component

decodeAttribute

back to summary

private static String decodeAttribute(String s, Charset charset)

Decode component

Returns:String: the decoded component

decodeAttribute	back to summary
private static ByteBuf decodeAttribute(ByteBuf b, Charset charset)

destroy back to summary

destroy	back to summary
public void destroy() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.destroy. Destroy the `HttpPostStandardRequestDecoder` and release all it resources. After this method was called it is not possible to operate on it anymore. Annotations @Override

public void destroy()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.destroy.

Destroy the HttpPostStandardRequestDecoder and release all it resources. After this method was called it is not possible to operate on it anymore.

Annotations

@Override

getBodyHttpData	back to summary
public InterfaceHttpData getBodyHttpData(String name) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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. Returns:InterfaceHttpData The first Body InterfaceHttpData with the given name (ignore case) Annotations @Override Exceptions NotEnoughDataDecoderException: need more chunks

getBodyHttpData

back to summary

public InterfaceHttpData getBodyHttpData(String name)

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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.

Returns:InterfaceHttpData

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

Annotations

@Override

Exceptions

NotEnoughDataDecoderException:: need more chunks

getBodyHttpDatas	back to summary
public List<InterfaceHttpData> getBodyHttpDatas() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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. Returns:List<InterfaceHttpData> the list of HttpDatas from Body part for POST getMethod Annotations @Override Exceptions NotEnoughDataDecoderException: Need more chunks

getBodyHttpDatas

back to summary

public List<InterfaceHttpData> getBodyHttpDatas()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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.

Returns:List<InterfaceHttpData>

the list of HttpDatas from Body part for POST getMethod

Annotations

@Override

Exceptions

NotEnoughDataDecoderException:: Need more chunks

getBodyHttpDatas	back to summary
public List<InterfaceHttpData> getBodyHttpDatas(String name) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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. Returns:List<InterfaceHttpData> All Body HttpDatas with the given name (ignore case) Annotations @Override Exceptions NotEnoughDataDecoderException: need more chunks

getBodyHttpDatas

back to summary

public List<InterfaceHttpData> getBodyHttpDatas(String name)

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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.

Returns:List<InterfaceHttpData>

All Body HttpDatas with the given name (ignore case)

Annotations

@Override

Exceptions

NotEnoughDataDecoderException:: need more chunks

getDiscardThreshold	back to summary
public int getDiscardThreshold() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.getDiscardThreshold. Return the threshold in bytes after which read data in the buffer should be discarded. Annotations @Override

getDiscardThreshold

back to summary

public int getDiscardThreshold()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.getDiscardThreshold.

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

Annotations

@Override

hasNext	back to summary
public boolean hasNext() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.hasNext. True if at current getStatus, there is an available decoded InterfaceHttpData from the Body. This getMethod works for chunked and not chunked request. Returns:boolean True if at current getStatus, there is a decoded InterfaceHttpData Annotations @Override Exceptions EndOfDataDecoderException: No more data will be available

hasNext

back to summary

public boolean hasNext()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.hasNext.

True if at current getStatus, there is an available decoded InterfaceHttpData from the Body. This getMethod works for chunked and not chunked request.

Returns:boolean

True if at current getStatus, there is a decoded InterfaceHttpData

Annotations

@Override

Exceptions

EndOfDataDecoderException:: No more data will be available

isMultipart	back to summary
public boolean isMultipart() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.isMultipart. True if this request is a Multipart request Returns:boolean True if this request is a Multipart request Annotations @Override

isMultipart

back to summary

public boolean isMultipart()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.isMultipart.

True if this request is a Multipart request

Returns:boolean

True if this request is a Multipart request

Annotations

@Override

next back to summary

next	back to summary
public InterfaceHttpData next() Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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 `InterfaceHttpData#release()` after you are done with processing to make sure to not leak any resources Returns:InterfaceHttpData the next available InterfaceHttpData or null if none Annotations @Override Exceptions EndOfDataDecoderException: No more data will be available

public InterfaceHttpData next()

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.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 InterfaceHttpData#release() after you are done with processing to make sure to not leak any resources

Returns:InterfaceHttpData

the next available InterfaceHttpData or null if none

Annotations

@Override

Exceptions

EndOfDataDecoderException:: No more data will be available

offer	back to summary
public HttpPostStandardRequestDecoder offer(HttpContent content) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.offer. Initialized the internals from a new chunk Parameters content:HttpContent the new received chunk Annotations @Override Exceptions ErrorDataDecoderException: if there is a problem with the charset decoding or other errors

offer

back to summary

public HttpPostStandardRequestDecoder offer(HttpContent content)

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.offer.

Initialized the internals from a new chunk

Parameters

content:HttpContent: the new received chunk

Annotations

@Override

Exceptions

ErrorDataDecoderException:: if there is a problem with the charset decoding or other errors

parseBody	back to summary
private void parseBody() This getMethod will parse as much as possible data and fill the list and map Exceptions ErrorDataDecoderException: if there is a problem with the charset decoding or other errors

parseBody

back to summary

private void parseBody()

This getMethod will parse as much as possible data and fill the list and map

Exceptions

ErrorDataDecoderException:: if there is a problem with the charset decoding or other errors

parseBodyAttributes	back to summary
private void parseBodyAttributes() This getMethod fill the map and list with as much Attribute as possible from Body in not Multipart mode. Exceptions ErrorDataDecoderException: if there is a problem with the charset decoding or other errors

parseBodyAttributes

back to summary

private void parseBodyAttributes()

This getMethod fill the map and list with as much Attribute as possible from Body in not Multipart mode.

Exceptions

ErrorDataDecoderException:: if there is a problem with the charset decoding or other errors

parseBodyAttributesStandard	back to summary
private void parseBodyAttributesStandard() This getMethod fill the map and list with as much Attribute as possible from Body in not Multipart mode. Exceptions ErrorDataDecoderException: if there is a problem with the charset decoding or other errors

parseBodyAttributesStandard

back to summary

private void parseBodyAttributesStandard()

This getMethod fill the map and list with as much Attribute as possible from Body in not Multipart mode.

Exceptions

ErrorDataDecoderException:: if there is a problem with the charset decoding or other errors

removeHttpDataFromClean	back to summary
public void removeHttpDataFromClean(InterfaceHttpData data) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.removeHttpDataFromClean. Remove the given FileUpload from the list of FileUploads to clean Annotations @Override

removeHttpDataFromClean

back to summary

public void removeHttpDataFromClean(InterfaceHttpData data)

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.removeHttpDataFromClean.

Remove the given FileUpload from the list of FileUploads to clean

Annotations

@Override

setDiscardThreshold back to summary

setDiscardThreshold	back to summary
public void setDiscardThreshold(int discardThreshold) Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.setDiscardThreshold. 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. Annotations @Override

public void setDiscardThreshold(int discardThreshold)

Implements io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder.setDiscardThreshold.

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.

Annotations

@Override

setFinalBuffer	back to summary
private void setFinalBuffer(ByteBuf buffer) throws IOException

io.netty.handler.codec.http.multipart back to summary

private final Class HttpPostStandardRequestDecoder.UrlDecoder

Class Inheritance

extends Object
implements ByteProcessor

java.lang.Object
io.netty.handler.codec.http.multipart.HttpPostStandardRequestDecoder.UrlDecoder

All Implemented Interfaces

io.netty.util.ByteProcessor

Field Summary

Modifier and Type	Field and Description
private byte	hiByte
private int	nextEscapedIdx
private final ByteBuf	output

Constructor Summary

Access	Constructor and Description
pack-priv	UrlDecoder(ByteBuf output)

Method Summary

Modifier and Type	Method and Description
public boolean	process(byte value) Implements io.netty.util.ByteProcessor.process.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

hiByte	back to summary
private byte hiByte

nextEscapedIdx	back to summary
private int nextEscapedIdx

output	back to summary
private final ByteBuf output

Constructor Detail

UrlDecoder	back to summary
pack-priv UrlDecoder(ByteBuf output)

Method Detail

process back to summary

process	back to summary
public boolean process(byte value) Implements io.netty.util.ByteProcessor.process. Returns:boolean Doc from io.netty.util.ByteProcessor.process. `true` if the processor wants to continue the loop and handle the next byte in the buffer. `false` if the processor wants to stop handling bytes and abort the loop. Annotations @Override

public boolean process(byte value)

Implements io.netty.util.ByteProcessor.process.

Returns:boolean

Doc from io.netty.util.ByteProcessor.process.

true if the processor wants to continue the loop and handle the next byte in the buffer. false if the processor wants to stop handling bytes and abort the loop.

Annotations

@Override

public Class HttpPostStandardRequestDecoder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpPostStandardRequestDecoder.UrlDecoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpPostStandardRequestDecoder.UrlEncodedDetector

Constructor Summary

Method Summary

Constructor Detail

Method Detail