io.netty.handler.codec.http.multipart

类 HttpPostStandardRequestDecoder

java.lang.Object

io.netty.handler.codec.http.multipart.HttpPostStandardRequestDecoder

所有已实现的接口:

InterfaceHttpPostRequestDecoder

public class HttpPostStandardRequestDecoder
extends java.lang.Object
implements InterfaceHttpPostRequestDecoder

This decoder will decode Body and can handle POST BODY. You MUST call destroy() after completion to release all resources.

构造器概要

构造器

构造器和说明
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)
HttpPostStandardRequestDecoder(HttpRequest request)

方法概要

限定符和类型	方法和说明
protected void	addHttpData(InterfaceHttpData data) Utility function to add a new decoded data
void	cleanFiles() Clean all HttpDatas 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 HttpPostStandardRequestDecoder and release all it resources.
InterfaceHttpData	getBodyHttpData(java.lang.String name) This getMethod returns the first InterfaceHttpData with the given name from body.
java.util.List<InterfaceHttpData>	getBodyHttpDatas() This getMethod returns a List of all HttpDatas from body.
java.util.List<InterfaceHttpData>	getBodyHttpDatas(java.lang.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.
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.
HttpPostStandardRequestDecoder	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.

从类继承的方法 java.lang.Object

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

构造器详细资料

HttpPostStandardRequestDecoder

public HttpPostStandardRequestDecoder(HttpRequest request)

参数:

request - the request to decode

抛出:

java.lang.NullPointerException - for request

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

HttpPostStandardRequestDecoder

public HttpPostStandardRequestDecoder(HttpDataFactory factory,
                                      HttpRequest request)

参数:

factory - the factory used to create InterfaceHttpData

request - the request to decode

抛出:

java.lang.NullPointerException - for request or factory

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

HttpPostStandardRequestDecoder

public HttpPostStandardRequestDecoder(HttpDataFactory factory,
                                      HttpRequest request,
                                      java.nio.charset.Charset charset)

参数:

factory - the factory used to create InterfaceHttpData

request - the request to decode

charset - the charset to use as default

抛出:

java.lang.NullPointerException - for request or charset or factory

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

参数:

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

抛出:

java.lang.NullPointerException - for request or charset or factory

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

方法详细资料

isMultipart

public boolean isMultipart()

True if this request is a Multipart request

指定者:

isMultipart 在接口中 InterfaceHttpPostRequestDecoder

返回:

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.

指定者:

setDiscardThreshold 在接口中 InterfaceHttpPostRequestDecoder

getDiscardThreshold

public int getDiscardThreshold()

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

指定者:

getDiscardThreshold 在接口中 InterfaceHttpPostRequestDecoder

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.

指定者:

getBodyHttpDatas 在接口中 InterfaceHttpPostRequestDecoder

返回:

the list of HttpDatas from Body part for POST getMethod

抛出:

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.

指定者:

getBodyHttpDatas 在接口中 InterfaceHttpPostRequestDecoder

返回:

All Body HttpDatas with the given name (ignore case)

抛出:

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.

指定者:

getBodyHttpData 在接口中 InterfaceHttpPostRequestDecoder

返回:

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

抛出:

HttpPostRequestDecoder.NotEnoughDataDecoderException - need more chunks

offer

public HttpPostStandardRequestDecoder offer(HttpContent content)

Initialized the internals from a new chunk

指定者:

offer 在接口中 InterfaceHttpPostRequestDecoder

参数:

content - the new received chunk

抛出:

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.

指定者:

hasNext 在接口中 InterfaceHttpPostRequestDecoder

返回:

True if at current getStatus, there is a decoded InterfaceHttpData

抛出:

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

指定者:

next 在接口中 InterfaceHttpPostRequestDecoder

返回:

the next available InterfaceHttpData or null if none

抛出:

HttpPostRequestDecoder.EndOfDataDecoderException - No more data will be available

currentPartialHttpData

public InterfaceHttpData currentPartialHttpData()

从接口复制的说明: 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.

指定者:

currentPartialHttpData 在接口中 InterfaceHttpPostRequestDecoder

返回:

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

指定者:

destroy 在接口中 InterfaceHttpPostRequestDecoder

cleanFiles

public void cleanFiles()

Clean all HttpDatas for the current request.

指定者:

cleanFiles 在接口中 InterfaceHttpPostRequestDecoder

removeHttpDataFromClean

public void removeHttpDataFromClean(InterfaceHttpData data)

Remove the given FileUpload from the list of FileUploads to clean

指定者:

removeHttpDataFromClean 在接口中 InterfaceHttpPostRequestDecoder