HttpPostRequestDecoder (Netty 3.10.5.Final API文档

java.lang.Object
- org.jboss.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 (both multipart and standard).

嵌套类概要

嵌套类
限定符和类型	类和说明
`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 status 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 status 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)`

方法概要

方法
限定符和类型	方法和说明
`void`	`cleanFiles()` Clean all HttpDatas (on Disk) for the current request.
`InterfaceHttpData`	`getBodyHttpData(java.lang.String name)` This method returns the first InterfaceHttpData with the given name from body.
`java.util.List<InterfaceHttpData>`	`getBodyHttpDatas()` This method returns a List of all HttpDatas from body.
`java.util.List<InterfaceHttpData>`	`getBodyHttpDatas(java.lang.String name)` This method returns a List of all HttpDatas with the given name from body.
`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 status, 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.
`void`	`offer(HttpChunk chunk)` Initialized the internals from a new chunk
`void`	`removeHttpDataFromClean(InterfaceHttpData data)` Remove the given FileUpload from the list of FileUploads to clean

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

- 构造器详细资料
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpRequest request)
                       throws HttpPostRequestDecoder.ErrorDataDecoderException
```
    参数:
    request - the request to decode
    
    抛出:
    
    java.lang.NullPointerException - for request
    
    HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors
  - HttpPostRequestDecoder
```
public HttpPostRequestDecoder(HttpDataFactory factory,
                      HttpRequest request)
                       throws HttpPostRequestDecoder.ErrorDataDecoderException
```
    参数:
    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
```
public HttpPostRequestDecoder(HttpDataFactory factory,
                      HttpRequest request,
                      java.nio.charset.Charset charset)
                       throws HttpPostRequestDecoder.ErrorDataDecoderException
```
    参数:
    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
- 方法详细资料
  - isMultipart
```
public static boolean isMultipart(HttpRequest request)
                           throws HttpPostRequestDecoder.ErrorDataDecoderException
```
    Check if the given request is a multipart request
    
    返回:
    True if the request is a Multipart request
    
    抛出:
    
    HttpPostRequestDecoder.ErrorDataDecoderException
  - getMultipartDataBoundary
```
protected static java.lang.String[] getMultipartDataBoundary(java.lang.String contentType)
                                                      throws HttpPostRequestDecoder.ErrorDataDecoderException
```
    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
    
    抛出:
    
    HttpPostRequestDecoder.ErrorDataDecoderException
  - isMultipart
```
public boolean isMultipart()
```
    True if this request is a Multipart request
    
    指定者:
    
    isMultipart 在接口中 InterfaceHttpPostRequestDecoder
    
    返回:
    True if this request is a Multipart request
  - getBodyHttpDatas
```
public java.util.List<InterfaceHttpData> getBodyHttpDatas()
                                                   throws HttpPostRequestDecoder.NotEnoughDataDecoderException
```
    This method returns a List of all HttpDatas from body.
    If chunked, all chunks must have been offered using offer() method. If not, NotEnoughDataDecoderException will be raised.
    
    指定者:
    
    getBodyHttpDatas 在接口中 InterfaceHttpPostRequestDecoder
    
    返回:
    the list of HttpDatas from Body part for POST method
    
    抛出:
    
    HttpPostRequestDecoder.NotEnoughDataDecoderException - Need more chunks
  - getBodyHttpDatas
```
public java.util.List<InterfaceHttpData> getBodyHttpDatas(java.lang.String name)
                                                   throws HttpPostRequestDecoder.NotEnoughDataDecoderException
```
    This method returns a List of all HttpDatas with the given name from body.
    If chunked, all chunks must have been offered using offer() method. 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)
                                  throws HttpPostRequestDecoder.NotEnoughDataDecoderException
```
    This method returns the first InterfaceHttpData with the given name from body.
    If chunked, all chunks must have been offered using offer() method. 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 void offer(HttpChunk chunk)
           throws HttpPostRequestDecoder.ErrorDataDecoderException
```
    Initialized the internals from a new chunk
    
    指定者:
    
    offer 在接口中 InterfaceHttpPostRequestDecoder
    
    参数:
    chunk - the new received chunk
    
    抛出:
    
    HttpPostRequestDecoder.ErrorDataDecoderException - if there is a problem with the charset decoding or other errors
  - hasNext
```
public boolean hasNext()
                throws HttpPostRequestDecoder.EndOfDataDecoderException
```
    True if at current status, there is an available decoded InterfaceHttpData from the Body. This method works for chunked and not chunked request.
    
    指定者:
    
    hasNext 在接口中 InterfaceHttpPostRequestDecoder
    
    返回:
    True if at current status, there is a decoded InterfaceHttpData
    
    抛出:
    
    HttpPostRequestDecoder.EndOfDataDecoderException - No more data will be available
  - next
```
public InterfaceHttpData next()
                       throws HttpPostRequestDecoder.EndOfDataDecoderException
```
    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.
    
    指定者:
    
    next 在接口中 InterfaceHttpPostRequestDecoder
    
    返回:
    the next available InterfaceHttpData or null if none
    
    抛出:
    
    HttpPostRequestDecoder.EndOfDataDecoderException - No more data will be available
  - cleanFiles
```
public void cleanFiles()
```
    Clean all HttpDatas (on Disk) 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

类 HttpPostRequestDecoder

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

HttpPostRequestDecoder

HttpPostRequestDecoder

HttpPostRequestDecoder

方法详细资料

isMultipart

getMultipartDataBoundary

isMultipart

getBodyHttpDatas

getBodyHttpDatas

getBodyHttpData

offer

hasNext

next

cleanFiles

removeHttpDataFromClean