Package io.netty.handler.codec.http.multipart

Class HttpPostRequestEncoder

java.lang.Object

io.netty.handler.codec.http.multipart.HttpPostRequestEncoder

All Implemented Interfaces:

io.netty.handler.stream.ChunkedInput<HttpContent>

public class HttpPostRequestEncoder
extends Object
implements io.netty.handler.stream.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."

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpPostRequestEncoder.EncoderMode	Different modes to use to encode form data.
static class	HttpPostRequestEncoder.ErrorDataEncoderException	Exception when an error occurs while encoding

Constructor Summary

Constructors

Constructor	Description
HttpPostRequestEncoder(HttpRequest request, boolean multipart)
HttpPostRequestEncoder(HttpDataFactory factory, HttpRequest request, boolean multipart)
HttpPostRequestEncoder(HttpDataFactory factory, HttpRequest request, boolean multipart, Charset charset, HttpPostRequestEncoder.EncoderMode encoderMode)

Method Summary

Modifier and Type	Method	Description
void	addBodyAttribute(String name, String value)	Add a simple attribute in the body as Name=Value
void	addBodyFileUpload(String name, File file, String contentType, boolean isText)	Add a file as a FileUpload
void	addBodyFileUpload(String name, String filename, File file, String contentType, boolean isText)	Add a file as a FileUpload
void	addBodyFileUploads(String name, File[] file, 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()
HttpRequest	finalizeRequest()	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.
List<InterfaceHttpData>	getBodyListAttributes()	This getMethod returns a List of all InterfaceHttpData from body part.
boolean	isChunked()
boolean	isEndOfInput()
boolean	isMultipart()	True if this request is a Multipart request
long	length()
long	progress()
HttpContent	readChunk(io.netty.buffer.ByteBufAllocator allocator)	Returns the next available HttpChunk.
HttpContent	readChunk(io.netty.channel.ChannelHandlerContext ctx)	Deprecated.
void	setBodyHttpDatas(List<InterfaceHttpData> datas)	Set the Body HttpDatas list

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpPostRequestEncoder

public HttpPostRequestEncoder(HttpRequest request,
                              boolean multipart)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException

Parameters:

request - the request to encode

multipart - True if the FORM is a ENCTYPE="multipart/form-data"

Throws:

NullPointerException - for request

HttpPostRequestEncoder.ErrorDataEncoderException - if the request is a TRACE

HttpPostRequestEncoder

public HttpPostRequestEncoder(HttpDataFactory factory,
                              HttpRequest request,
                              boolean multipart)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException

Parameters:

factory - the factory used to create InterfaceHttpData

request - the request to encode

multipart - True if the FORM is a ENCTYPE="multipart/form-data"

Throws:

NullPointerException - for request and factory

HttpPostRequestEncoder.ErrorDataEncoderException - if the request is a TRACE

HttpPostRequestEncoder

public HttpPostRequestEncoder(HttpDataFactory factory,
                              HttpRequest request,
                              boolean multipart,
                              Charset charset,
                              HttpPostRequestEncoder.EncoderMode encoderMode)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException

Parameters:

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.

Throws:

NullPointerException - for request or charset or factory

HttpPostRequestEncoder.ErrorDataEncoderException - if the request is a TRACE

Method Detail

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

Returns:

True if this request is a Multipart request

getBodyListAttributes

public List<InterfaceHttpData> getBodyListAttributes()

This getMethod returns a List of all InterfaceHttpData from body part.

Returns:

the list of InterfaceHttpData from Body part

setBodyHttpDatas

public void setBodyHttpDatas(List<InterfaceHttpData> datas)
                      throws HttpPostRequestEncoder.ErrorDataEncoderException

Set the Body HttpDatas list

Throws:

NullPointerException - for datas

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done

addBodyAttribute

public void addBodyAttribute(String name,
                             String value)
                      throws HttpPostRequestEncoder.ErrorDataEncoderException

Add a simple attribute in the body as Name=Value

Parameters:

name - name of the parameter

value - the value of the parameter

Throws:

NullPointerException - for name

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done

addBodyFileUpload

public void addBodyFileUpload(String name,
                              File file,
                              String contentType,
                              boolean isText)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException

Add a file as a FileUpload

Parameters:

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)

Throws:

NullPointerException - for name and file

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done

addBodyFileUpload

public void addBodyFileUpload(String name,
                              String filename,
                              File file,
                              String contentType,
                              boolean isText)
                       throws HttpPostRequestEncoder.ErrorDataEncoderException

Add a file as a FileUpload

Parameters:

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)

Throws:

NullPointerException - for name and file

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done

addBodyFileUploads

public void addBodyFileUploads(String name,
                               File[] file,
                               String[] contentType,
                               boolean[] isText)
                        throws HttpPostRequestEncoder.ErrorDataEncoderException

Add a series of Files associated with one File parameter

Parameters:

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

Throws:

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

Throws:

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.

Returns:

the request object (chunked or not according to size of body)

Throws:

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error or if the finalize were already done

isChunked

public boolean isChunked()

Returns:

True if the request is by Chunk

close

public void close()
           throws Exception

Specified by:

close in interface io.netty.handler.stream.ChunkedInput<HttpContent>

Throws:

Exception

readChunk

@Deprecated
public HttpContent readChunk(io.netty.channel.ChannelHandlerContext ctx)
                      throws Exception

Deprecated.

Specified by:

readChunk in interface io.netty.handler.stream.ChunkedInput<HttpContent>

Throws:

Exception

readChunk

public HttpContent readChunk(io.netty.buffer.ByteBufAllocator allocator)
                      throws 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.

Specified by:

readChunk in interface io.netty.handler.stream.ChunkedInput<HttpContent>

Returns:

the next available HttpChunk

Throws:

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error

Exception

isEndOfInput

public boolean isEndOfInput()
                     throws Exception

Specified by:

isEndOfInput in interface io.netty.handler.stream.ChunkedInput<HttpContent>

Throws:

Exception

length

public long length()

Specified by:

length in interface io.netty.handler.stream.ChunkedInput<HttpContent>

progress

public long progress()

Specified by:

progress in interface io.netty.handler.stream.ChunkedInput<HttpContent>