HttpPostRequestEncoder (Netty 4.1.109.Final API文档

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

所有已实现的接口:

ChunkedInput<HttpContent>
```
public class HttpPostRequestEncoder
extends java.lang.Object
implements ChunkedInput<HttpContent>
```
This encoder will help to encode Request for a FORM as POST.
According to RFC 7231, POST, PUT and OPTIONS allow to have a body. This encoder will support widely all methods except TRACE since the RFC notes for GET, DELETE, HEAD and CONNECT: (replaces XXX by one of these methods)

"A payload within a XXX request message has no defined semantics; sending a payload body on a XXX request might cause some existing implementations to reject the request."

On the contrary, for TRACE method, RFC says:

"A client MUST NOT send a message body in a TRACE request."

嵌套类概要

嵌套类
限定符和类型	类和说明
`static class`	`HttpPostRequestEncoder.EncoderMode` Different modes to use to encode form data.
`static class`	`HttpPostRequestEncoder.ErrorDataEncoderException` Exception when an error occurs while encoding

构造器概要

构造器
构造器和说明
`HttpPostRequestEncoder(HttpDataFactory factory, HttpRequest request, boolean multipart)`
`HttpPostRequestEncoder(HttpDataFactory factory, HttpRequest request, boolean multipart, java.nio.charset.Charset charset, HttpPostRequestEncoder.EncoderMode encoderMode)`
`HttpPostRequestEncoder(HttpRequest request, boolean multipart)`

方法概要

All Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`void`	`addBodyAttribute(java.lang.String name, java.lang.String value)` Add a simple attribute in the body as Name=Value
`void`	`addBodyFileUpload(java.lang.String name, java.io.File file, java.lang.String contentType, boolean isText)` Add a file as a FileUpload
`void`	`addBodyFileUpload(java.lang.String name, java.lang.String filename, java.io.File file, java.lang.String contentType, boolean isText)` Add a file as a FileUpload
`void`	`addBodyFileUploads(java.lang.String name, java.io.File[] file, java.lang.String[] contentType, boolean[] isText)` Add a series of Files associated with one File parameter
`void`	`addBodyHttpData(InterfaceHttpData data)` Add the InterfaceHttpData to the Body list
`void`	`cleanFiles()` Clean all HttpDatas (on Disk) for the current request.
`void`	`close()` Releases the resources associated with the input.
`HttpRequest`	`finalizeRequest()` Finalize the request by preparing the Header in the request and returns the request ready to be sent.
`java.util.List<InterfaceHttpData>`	`getBodyListAttributes()` This getMethod returns a List of all InterfaceHttpData from body part.
`boolean`	`isChunked()`
`boolean`	`isEndOfInput()` Return `true` if and only if there is no data left in the stream and the stream has reached at its end.
`boolean`	`isMultipart()` True if this request is a Multipart request
`long`	`length()` Returns the length of the input.
`long`	`progress()` Returns current transfer progress.
`HttpContent`	`readChunk(ByteBufAllocator allocator)` Returns the next available HttpChunk.
`HttpContent`	`readChunk(ChannelHandlerContext ctx)` 已过时。
`void`	`setBodyHttpDatas(java.util.List<InterfaceHttpData> datas)` Set the Body HttpDatas list

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

- 构造器详细资料
  - HttpPostRequestEncoder
```
public HttpPostRequestEncoder(HttpRequest request,
                              boolean multipart)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    参数:
    
    request - the request to encode
    
    multipart - True if the FORM is a ENCTYPE="multipart/form-data"
    
    抛出:
    
    java.lang.NullPointerException - for request
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the request is a TRACE
  - HttpPostRequestEncoder
```
public HttpPostRequestEncoder(HttpDataFactory factory,
                              HttpRequest request,
                              boolean multipart)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    参数:
    
    factory - the factory used to create InterfaceHttpData
    
    request - the request to encode
    
    multipart - True if the FORM is a ENCTYPE="multipart/form-data"
    
    抛出:
    
    java.lang.NullPointerException - for request and factory
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the request is a TRACE
  - HttpPostRequestEncoder
```
public HttpPostRequestEncoder(HttpDataFactory factory,
                              HttpRequest request,
                              boolean multipart,
                              java.nio.charset.Charset charset,
                              HttpPostRequestEncoder.EncoderMode encoderMode)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    参数:
    
    factory - the factory used to create InterfaceHttpData
    
    request - the request to encode
    
    multipart - True if the FORM is a ENCTYPE="multipart/form-data"
    
    charset - the charset to use as default
    
    encoderMode - the mode for the encoder to use. See HttpPostRequestEncoder.EncoderMode for the details.
    
    抛出:
    
    java.lang.NullPointerException - for request or charset or factory
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the request is a TRACE
- 方法详细资料
  - cleanFiles
```
public void cleanFiles()
```
    Clean all HttpDatas (on Disk) for the current request.
  - isMultipart
```
public boolean isMultipart()
```
    True if this request is a Multipart request
    
    返回:
    
    True if this request is a Multipart request
  - getBodyListAttributes
```
public java.util.List<InterfaceHttpData> getBodyListAttributes()
```
    This getMethod returns a List of all InterfaceHttpData from body part.
    
    返回:
    
    the list of InterfaceHttpData from Body part
  - setBodyHttpDatas
```
public void setBodyHttpDatas(java.util.List<InterfaceHttpData> datas)
                      throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    Set the Body HttpDatas list
    
    抛出:
    
    java.lang.NullPointerException - for datas
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done
  - addBodyAttribute
```
public void addBodyAttribute(java.lang.String name,
                             java.lang.String value)
                      throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    Add a simple attribute in the body as Name=Value
    
    参数:
    
    name - name of the parameter
    
    value - the value of the parameter
    
    抛出:
    
    java.lang.NullPointerException - for name
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done
  - addBodyFileUpload
```
public void addBodyFileUpload(java.lang.String name,
                              java.io.File file,
                              java.lang.String contentType,
                              boolean isText)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    Add a file as a FileUpload
    
    参数:
    
    name - the name of the parameter
    
    file - the file to be uploaded (if not Multipart mode, only the filename will be included)
    
    contentType - the associated contentType for the File
    
    isText - True if this file should be transmitted in Text format (else binary)
    
    抛出:
    
    java.lang.NullPointerException - for name and file
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done
  - addBodyFileUpload
```
public void addBodyFileUpload(java.lang.String name,
                              java.lang.String filename,
                              java.io.File file,
                              java.lang.String contentType,
                              boolean isText)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    Add a file as a FileUpload
    
    参数:
    
    name - the name of the parameter
    
    file - the file to be uploaded (if not Multipart mode, only the filename will be included)
    
    filename - the filename to use for this File part, empty String will be ignored by the encoder
    
    contentType - the associated contentType for the File
    
    isText - True if this file should be transmitted in Text format (else binary)
    
    抛出:
    
    java.lang.NullPointerException - for name and file
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done
  - addBodyFileUploads
```
public void addBodyFileUploads(java.lang.String name,
                               java.io.File[] file,
                               java.lang.String[] contentType,
                               boolean[] isText)
                        throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    Add a series of Files associated with one File parameter
    
    参数:
    
    name - the name of the parameter
    
    file - the array of files
    
    contentType - the array of content Types associated with each file
    
    isText - the array of isText attribute (False meaning binary mode) for each file
    
    抛出:
    
    java.lang.IllegalArgumentException - also throws if array have different sizes
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done
  - addBodyHttpData
```
public void addBodyHttpData(InterfaceHttpData data)
                     throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    Add the InterfaceHttpData to the Body list
    
    抛出:
    
    java.lang.NullPointerException - for data
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done
  - finalizeRequest
```
public HttpRequest finalizeRequest()
                            throws HttpPostRequestEncoder.ErrorDataEncoderException
```
    Finalize the request by preparing the Header in the request and returns the request ready to be sent.
    Once finalized, no data must be added.
    If the request does not need chunk (isChunked() == false), this request is the only object to send to the remote server.
    
    返回:
    
    the request object (chunked or not according to size of body)
    
    抛出:
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done
  - isChunked
```
public boolean isChunked()
```
    返回:
    
    True if the request is by Chunk
  - close
```
public void close()
           throws java.lang.Exception
```
    从接口复制的说明: ChunkedInput
    
    Releases the resources associated with the input.
    
    指定者:
    
    close 在接口中 ChunkedInput<HttpContent>
    
    抛出:
    
    java.lang.Exception
  - readChunk
```
@Deprecated
public HttpContent readChunk(ChannelHandlerContext ctx)
                                   throws java.lang.Exception
```
    已过时。
    
    指定者:
    
    readChunk 在接口中 ChunkedInput<HttpContent>
    
    参数:
    
    ctx - The context which provides a ByteBufAllocator if buffer allocation is necessary.
    
    返回:
    
    the fetched chunk. null if there is no data left in the stream. Please note that null does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.
    
    抛出:
    
    java.lang.Exception
  - readChunk
```
public HttpContent readChunk(ByteBufAllocator allocator)
                      throws java.lang.Exception
```
    Returns the next available HttpChunk. The caller is responsible to test if this chunk is the last one (isLast()), in order to stop calling this getMethod.
    
    指定者:
    
    readChunk 在接口中 ChunkedInput<HttpContent>
    
    参数:
    
    allocator - ByteBufAllocator if buffer allocation is necessary.
    
    返回:
    
    the next available HttpChunk
    
    抛出:
    
    HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error
    
    java.lang.Exception
  - isEndOfInput
```
public boolean isEndOfInput()
                     throws java.lang.Exception
```
    从接口复制的说明: ChunkedInput
    
    Return true if and only if there is no data left in the stream and the stream has reached at its end.
    
    指定者:
    
    isEndOfInput 在接口中 ChunkedInput<HttpContent>
    
    抛出:
    
    java.lang.Exception
  - length
```
public long length()
```
    从接口复制的说明: ChunkedInput
    
    Returns the length of the input.
    
    指定者:
    
    length 在接口中 ChunkedInput<HttpContent>
    
    返回:
    
    the length of the input if the length of the input is known. a negative value if the length of the input is unknown.
  - progress
```
public long progress()
```
    从接口复制的说明: ChunkedInput
    
    Returns current transfer progress.
    
    指定者:
    
    progress 在接口中 ChunkedInput<HttpContent>

类 HttpPostRequestEncoder

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

HttpPostRequestEncoder

HttpPostRequestEncoder

HttpPostRequestEncoder

方法详细资料

cleanFiles

isMultipart

getBodyListAttributes

setBodyHttpDatas

addBodyAttribute

addBodyFileUpload

addBodyFileUpload

addBodyFileUploads

addBodyHttpData

finalizeRequest

isChunked

close

readChunk

readChunk

isEndOfInput

length

progress