HttpPostRequestDecoder (dorado-core 0.0.36 API)

java.lang.Object
- ai.houyi.dorado.netty.ext.HttpPostRequestDecoder

所有已实现的接口:

io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
```
public class HttpPostRequestDecoder
extends Object
implements io.netty.handler.codec.http.multipart.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
`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(io.netty.handler.codec.http.multipart.HttpDataFactory factory, io.netty.handler.codec.http.HttpRequest request)`
`HttpPostRequestDecoder(io.netty.handler.codec.http.multipart.HttpDataFactory factory, io.netty.handler.codec.http.HttpRequest request, Charset charset)`
`HttpPostRequestDecoder(io.netty.handler.codec.http.HttpRequest request)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`cleanFiles()`
`io.netty.handler.codec.http.multipart.InterfaceHttpData`	`currentPartialHttpData()`
`void`	`destroy()`
`io.netty.handler.codec.http.multipart.InterfaceHttpData`	`getBodyHttpData(String name)`
`List<io.netty.handler.codec.http.multipart.InterfaceHttpData>`	`getBodyHttpDatas()`
`List<io.netty.handler.codec.http.multipart.InterfaceHttpData>`	`getBodyHttpDatas(String name)`
`int`	`getDiscardThreshold()`
`protected static String[]`	`getMultipartDataBoundary(String contentType)` Check from the request ContentType if this request is a Multipart request.
`boolean`	`hasNext()`
`boolean`	`isMultipart()`
`static boolean`	`isMultipart(io.netty.handler.codec.http.HttpRequest request)` Check if the given request is a multipart request
`io.netty.handler.codec.http.multipart.InterfaceHttpData`	`next()`
`io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder`	`offer(io.netty.handler.codec.http.HttpContent content)`
`void`	`removeHttpDataFromClean(io.netty.handler.codec.http.multipart.InterfaceHttpData data)`
`void`	`setDiscardThreshold(int discardThreshold)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(io.netty.handler.codec.http.HttpRequest request)
```
    参数:
    
    request - the request to decode
    
    抛出:
    
    NullPointerException - for request
    
    HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(io.netty.handler.codec.http.multipart.HttpDataFactory factory,
                              io.netty.handler.codec.http.HttpRequest request)
```
    参数:
    
    factory - the factory used to create InterfaceHttpData
    
    request - the request to decode
    
    抛出:
    
    NullPointerException - for request or factory
    
    HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(io.netty.handler.codec.http.multipart.HttpDataFactory factory,
                              io.netty.handler.codec.http.HttpRequest request,
                              Charset charset)
```
    参数:
    
    factory - the factory used to create InterfaceHttpData
    
    request - the request to decode
    
    charset - the charset to use as default
    
    抛出:
    
    NullPointerException - for request or charset or factory
    
    HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors
- 方法详细资料
  - isMultipart
```
public static boolean isMultipart(io.netty.handler.codec.http.HttpRequest request)
```
    Check if the given request is a multipart request
    
    返回:
    
    True if the request is a Multipart request
  - getMultipartDataBoundary
```
protected static String[] getMultipartDataBoundary(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()
```
    指定者:
    
    isMultipart 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - setDiscardThreshold
```
public void setDiscardThreshold(int discardThreshold)
```
    指定者:
    
    setDiscardThreshold 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - getDiscardThreshold
```
public int getDiscardThreshold()
```
    指定者:
    
    getDiscardThreshold 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - getBodyHttpDatas
```
public List<io.netty.handler.codec.http.multipart.InterfaceHttpData> getBodyHttpDatas()
```
    指定者:
    
    getBodyHttpDatas 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - getBodyHttpDatas
```
public List<io.netty.handler.codec.http.multipart.InterfaceHttpData> getBodyHttpDatas(String name)
```
    指定者:
    
    getBodyHttpDatas 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - getBodyHttpData
```
public io.netty.handler.codec.http.multipart.InterfaceHttpData getBodyHttpData(String name)
```
    指定者:
    
    getBodyHttpData 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - offer
```
public io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder offer(io.netty.handler.codec.http.HttpContent content)
```
    指定者:
    
    offer 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - hasNext
```
public boolean hasNext()
```
    指定者:
    
    hasNext 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - next
```
public io.netty.handler.codec.http.multipart.InterfaceHttpData next()
```
    指定者:
    
    next 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - currentPartialHttpData
```
public io.netty.handler.codec.http.multipart.InterfaceHttpData currentPartialHttpData()
```
    指定者:
    
    currentPartialHttpData 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - destroy
```
public void destroy()
```
    指定者:
    
    destroy 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - cleanFiles
```
public void cleanFiles()
```
    指定者:
    
    cleanFiles 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder
  - removeHttpDataFromClean
```
public void removeHttpDataFromClean(io.netty.handler.codec.http.multipart.InterfaceHttpData data)
```
    指定者:
    
    removeHttpDataFromClean 在接口中 io.netty.handler.codec.http.multipart.InterfaceHttpPostRequestDecoder

类 HttpPostRequestDecoder

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

HttpPostRequestDecoder

HttpPostRequestDecoder

HttpPostRequestDecoder

方法详细资料

isMultipart

getMultipartDataBoundary

isMultipart

setDiscardThreshold

getDiscardThreshold

getBodyHttpDatas

getBodyHttpDatas

getBodyHttpData

offer

hasNext

next

currentPartialHttpData

destroy

cleanFiles

removeHttpDataFromClean