HttpPostRequestDecoder (Netty 4.0.56.Final API文档

java.lang.Object
- io.netty.handler.codec.http.multipart.HttpPostRequestDecoder

所有已实现的接口:

InterfaceHttpPostRequestDecoder
```
public class HttpPostRequestDecoder
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.

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`HttpPostRequestDecoder.EndOfDataDecoderException` Exception when the body is fully decoded, even if there is still data
`static class`	`HttpPostRequestDecoder.ErrorDataDecoderException` Exception when an error occurs while decoding
`static class`	`HttpPostRequestDecoder.IncompatibleDataDecoderException` Exception when an unappropriated getMethod was called on a request
`protected static class`	`HttpPostRequestDecoder.MultiPartStatus` states follow NOTSTARTED PREAMBLE ( (HEADERDELIMITER DISPOSITION (FIELD \| FILEUPLOAD))* (HEADERDELIMITER DISPOSITION MIXEDPREAMBLE (MIXEDDELIMITER MIXEDDISPOSITION MIXEDFILEUPLOAD)+ MIXEDCLOSEDELIMITER)* CLOSEDELIMITER)+ EPILOGUE First getStatus is: NOSTARTED Content-type: multipart/form-data, boundary=AaB03x => PREAMBLE in Header --AaB03x => HEADERDELIMITER content-disposition: form-data; name="field1" => DISPOSITION Joe Blow => FIELD --AaB03x => HEADERDELIMITER content-disposition: form-data; name="pics" => DISPOSITION Content-type: multipart/mixed, boundary=BbC04y --BbC04y => MIXEDDELIMITER Content-disposition: attachment; filename="file1.txt" => MIXEDDISPOSITION Content-Type: text/plain ... contents of file1.txt ... => MIXEDFILEUPLOAD --BbC04y => MIXEDDELIMITER Content-disposition: file; filename="file2.gif" => MIXEDDISPOSITION Content-type: image/gif Content-Transfer-Encoding: binary ...contents of file2.gif... => MIXEDFILEUPLOAD --BbC04y-- => MIXEDCLOSEDELIMITER --AaB03x-- => CLOSEDELIMITER Once CLOSEDELIMITER is found, last getStatus is EPILOGUE
`static class`	`HttpPostRequestDecoder.NotEnoughDataDecoderException` Exception when try reading data from request in chunked format, and not enough data are available (need more chunks)

构造器概要

构造器
构造器和说明
`HttpPostRequestDecoder(HttpDataFactory factory, HttpRequest request)`
`HttpPostRequestDecoder(HttpDataFactory factory, HttpRequest request, java.nio.charset.Charset charset)`
`HttpPostRequestDecoder(HttpRequest request)`

方法概要

方法
限定符和类型	方法和说明
`protected void`	`addHttpData(InterfaceHttpData data)` Utility function to add a new decoded data
`void`	`cleanFiles()` Clean all HttpDatas (on Disk) for the current request.
`void`	`destroy()` Destroy the `InterfaceHttpPostRequestDecoder` 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.
`protected InterfaceHttpData`	`getFileUpload(java.lang.String delimiter)` Get the FileUpload (new one or current one)
`protected static java.lang.String[]`	`getMultipartDataBoundary(java.lang.String contentType)` Check from the request ContentType if this request is a Multipart request.
`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
`static boolean`	`isMultipart(HttpRequest request)` Check if the given 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.
`InterfaceHttpPostRequestDecoder`	`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

- 构造器详细资料
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpRequest request)
                       throws HttpPostRequestDecoder.ErrorDataDecoderException,
                              HttpPostRequestDecoder.IncompatibleDataDecoderException
```
    参数:
    request - the request to decode
    
    抛出:
    
    java.lang.NullPointerException - for request
    
    HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors
    
    HttpPostRequestDecoder.IncompatibleDataDecoderException - This exception is deprecated
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpDataFactory factory,
                      HttpRequest request)
                       throws HttpPostRequestDecoder.ErrorDataDecoderException,
                              HttpPostRequestDecoder.IncompatibleDataDecoderException
```
    参数:
    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
    
    HttpPostRequestDecoder.IncompatibleDataDecoderException - This exception is deprecated
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpDataFactory factory,
                      HttpRequest request,
                      java.nio.charset.Charset charset)
                       throws HttpPostRequestDecoder.ErrorDataDecoderException,
                              HttpPostRequestDecoder.IncompatibleDataDecoderException
```
    参数:
    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
    
    HttpPostRequestDecoder.IncompatibleDataDecoderException - This exception is deprecated
- 方法详细资料
  - isMultipart
```
public static boolean isMultipart(HttpRequest request)
```
    Check if the given request is a multipart request
    
    返回:
    True if the request is a Multipart request
  - getMultipartDataBoundary
```
protected static java.lang.String[] getMultipartDataBoundary(java.lang.String contentType)
```
    Check from the request ContentType if this request is a Multipart request.
    
    返回:
    an array of String if multipartDataBoundary exists with the multipartDataBoundary as first element, charset if any as second (missing if not set), else null
  - isMultipart
```
public boolean isMultipart()
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    True if this request is a Multipart request
    
    指定者:
    
    isMultipart 在接口中 InterfaceHttpPostRequestDecoder
    
    返回:
    True if this request is a Multipart request
  - setDiscardThreshold
```
public void setDiscardThreshold(int discardThreshold)
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    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()
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    Return the threshold in bytes after which read data in the buffer should be discarded.
    
    指定者:
    
    getDiscardThreshold 在接口中 InterfaceHttpPostRequestDecoder
  - getBodyHttpDatas
```
public java.util.List<InterfaceHttpData> getBodyHttpDatas()
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    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
  - getBodyHttpDatas
```
public java.util.List<InterfaceHttpData> getBodyHttpDatas(java.lang.String name)
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    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)
  - getBodyHttpData
```
public InterfaceHttpData getBodyHttpData(java.lang.String name)
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    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)
  - offer
```
public InterfaceHttpPostRequestDecoder offer(HttpContent content)
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    Initialized the internals from a new chunk
    
    指定者:
    
    offer 在接口中 InterfaceHttpPostRequestDecoder
    
    参数:
    content - the new received chunk
  - hasNext
```
public boolean hasNext()
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    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
  - next
```
public InterfaceHttpData next()
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    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
  - destroy
```
public void destroy()
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    Destroy the InterfaceHttpPostRequestDecoder 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()
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    Clean all HttpDatas (on Disk) for the current request.
    
    指定者:
    
    cleanFiles 在接口中 InterfaceHttpPostRequestDecoder
  - removeHttpDataFromClean
```
public void removeHttpDataFromClean(InterfaceHttpData data)
```
    从接口复制的说明: InterfaceHttpPostRequestDecoder
    
    Remove the given FileUpload from the list of FileUploads to clean
    
    指定者:
    
    removeHttpDataFromClean 在接口中 InterfaceHttpPostRequestDecoder
  - addHttpData
```
protected void addHttpData(InterfaceHttpData data)
```
    Utility function to add a new decoded data
  - getFileUpload
```
protected InterfaceHttpData getFileUpload(java.lang.String delimiter)
```
    Get the FileUpload (new one or current one)
    
    参数:
    delimiter - the delimiter to use
    
    返回:
    the InterfaceHttpData if any
    
    抛出:
    
    HttpPostRequestDecoder.ErrorDataDecoderException

类 HttpPostRequestDecoder

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

HttpPostRequestDecoder

HttpPostRequestDecoder

HttpPostRequestDecoder

方法详细资料

isMultipart

getMultipartDataBoundary

isMultipart

setDiscardThreshold

getDiscardThreshold

getBodyHttpDatas

getBodyHttpDatas

getBodyHttpData

offer

hasNext

next

destroy

cleanFiles

removeHttpDataFromClean

addHttpData

getFileUpload