Package org.jboss.netty.handler.codec.http.multipart

Class HttpPostRequestEncoder

java.lang.Object

org.jboss.netty.handler.codec.http.multipart.HttpPostRequestEncoder

All Implemented Interfaces:

ChunkedInput

public class HttpPostRequestEncoder
extends Object
implements ChunkedInput

This encoder will help to encode Request for a FORM as POST.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private final List<InterfaceHttpData>	bodyListDatas	InterfaceHttpData for Body (without encoding)
private final Charset	charset	Default charset to use
private ChannelBuffer	currentBuffer	The ChannelBuffer currently used by the encoder
private InterfaceHttpData	currentData	The current InterfaceHttpData to encode (used if more chunks are available)
private FileUpload	currentFileUpload	The current FileUpload that is currently in encode process
private boolean	duringMixedMode	While adding a FileUpload, is the multipart currently in Mixed Mode
private final HttpPostRequestEncoder.EncoderMode	encoderMode
private final HttpDataFactory	factory	Factory used to create InterfaceHttpData
private long	globalBodySize	Global Body size
private boolean	headerFinalized	To check if the header has been finalized
private boolean	isChunked	Chunked false by default
private boolean	isKey	If not multipart, does the currentBuffer stands for the Key or for the Value
private boolean	isLastChunk	Does the last non empty chunk already encoded so that next chunk will be empty (last chunk)
private boolean	isLastChunkSent	Last chunk already sent
private final boolean	isMultipart	Does this request is a Multipart request
private ListIterator<InterfaceHttpData>	iterator	Iterator to be used when encoding will be called chunk after chunk
(package private) String	multipartDataBoundary	If multipart, this is the boundary for the flobal multipart
(package private) final List<InterfaceHttpData>	multipartHttpDatas	The final Multipart List of InterfaceHttpData including encoding
(package private) String	multipartMixedBoundary	If multipart, there could be internal multiparts (mixed) to the global multipart.
private static final Map<Pattern,String>	percentEncodings
private final HttpRequest	request	Request to encode

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(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	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()	Releases the resources associated with the stream.
private String	encodeAttribute(String s, Charset charset)	Encode one attribute
private HttpChunk	encodeNextChunkMultipart(int sizeleft)	From the current context (currentBuffer and currentData), returns the next HttpChunk (if possible) trying to get sizeleft bytes more into the currentBuffer.
private HttpChunk	encodeNextChunkUrlEncoded(int sizeleft)	From the current context (currentBuffer and currentData), returns the next HttpChunk (if possible) trying to get sizeleft bytes more into the currentBuffer.
private ChannelBuffer	fillChannelBuffer()
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 method returns a List of all InterfaceHttpData from body part.
private static String	getNewMultipartDelimiter()
boolean	hasNextChunk()	Returns true if and only if there is any data left in the stream.
private void	initDataMultipart()	Init the delimiter for Global Part (Data).
private void	initMixedMultipart()	Init the delimiter for Mixed Part (Mixed).
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
HttpChunk	nextChunk()	Returns the next available HttpChunk.
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

Field Details

percentEncodings

private static final Map<Pattern,String> percentEncodings

factory

private final HttpDataFactory factory

Factory used to create InterfaceHttpData

request

private final HttpRequest request

Request to encode

charset

private final Charset charset

Default charset to use

isChunked

private boolean isChunked

Chunked false by default

bodyListDatas

private final List<InterfaceHttpData> bodyListDatas

InterfaceHttpData for Body (without encoding)

multipartHttpDatas

final List<InterfaceHttpData> multipartHttpDatas

The final Multipart List of InterfaceHttpData including encoding

isMultipart

private final boolean isMultipart

Does this request is a Multipart request

multipartDataBoundary

String multipartDataBoundary

If multipart, this is the boundary for the flobal multipart

multipartMixedBoundary

String multipartMixedBoundary

If multipart, there could be internal multiparts (mixed) to the global multipart. Only one level is allowed.

headerFinalized

private boolean headerFinalized

To check if the header has been finalized

encoderMode

private final HttpPostRequestEncoder.EncoderMode encoderMode

isLastChunk

private boolean isLastChunk

Does the last non empty chunk already encoded so that next chunk will be empty (last chunk)

isLastChunkSent

private boolean isLastChunkSent

Last chunk already sent

currentFileUpload

private FileUpload currentFileUpload

The current FileUpload that is currently in encode process

duringMixedMode

private boolean duringMixedMode

While adding a FileUpload, is the multipart currently in Mixed Mode

globalBodySize

private long globalBodySize

Global Body size

iterator

private ListIterator<InterfaceHttpData> iterator

Iterator to be used when encoding will be called chunk after chunk

currentBuffer

private ChannelBuffer currentBuffer

The ChannelBuffer currently used by the encoder

currentData

private InterfaceHttpData currentData

The current InterfaceHttpData to encode (used if more chunks are available)

isKey

private boolean isKey

If not multipart, does the currentBuffer stands for the Key or for the Value

Constructor Details

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 not a POST

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 not a POST

HttpPostRequestEncoder

public HttpPostRequestEncoder(HttpDataFactory factory,
 HttpRequest request,
 boolean multipart,
 Charset charset)
                       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

Throws:

NullPointerException - for request or charset or factory

HttpPostRequestEncoder.ErrorDataEncoderException - if the request is not a POST

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 + @param 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 not a POST

Method Details

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

initDataMultipart

private void initDataMultipart()

Init the delimiter for Global Part (Data).

initMixedMultipart

private void initMixedMultipart()

Init the delimiter for Mixed Part (Mixed).

getNewMultipartDelimiter

private static String getNewMultipartDelimiter()

Returns:

a newly generated Delimiter (either for DATA or MIXED)

getBodyListAttributes

public List<InterfaceHttpData> getBodyListAttributes()

This method 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

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:

NullPointerException - 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

encodeAttribute

private String encodeAttribute(String s,
 Charset charset)
                        throws HttpPostRequestEncoder.ErrorDataEncoderException

Encode one attribute

Returns:

the encoded attribute

Throws:

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error

fillChannelBuffer

private ChannelBuffer fillChannelBuffer()

Returns:

the next ChannelBuffer to send as a HttpChunk and modifying currentBuffer accordingly

encodeNextChunkMultipart

private HttpChunk encodeNextChunkMultipart(int sizeleft)
                                    throws HttpPostRequestEncoder.ErrorDataEncoderException

From the current context (currentBuffer and currentData), returns the next HttpChunk (if possible) trying to get sizeleft bytes more into the currentBuffer. This is the Multipart version.

Parameters:

sizeleft - the number of bytes to try to get from currentData

Returns:

the next HttpChunk or null if not enough bytes were found

Throws:

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error

encodeNextChunkUrlEncoded

private HttpChunk encodeNextChunkUrlEncoded(int sizeleft)
                                     throws HttpPostRequestEncoder.ErrorDataEncoderException

From the current context (currentBuffer and currentData), returns the next HttpChunk (if possible) trying to get sizeleft bytes more into the currentBuffer. This is the UrlEncoded version.

Parameters:

sizeleft - the number of bytes to try to get from currentData

Returns:

the next HttpChunk or null if not enough bytes were found

Throws:

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error

close

public void close()
           throws Exception

Description copied from interface: ChunkedInput

Releases the resources associated with the stream.

Specified by:

close in interface ChunkedInput

Throws:

Exception

nextChunk

public HttpChunk nextChunk()
                    throws HttpPostRequestEncoder.ErrorDataEncoderException

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 method.

Specified by:

nextChunk in interface ChunkedInput

Returns:

the next available HttpChunk

Throws:

HttpPostRequestEncoder.ErrorDataEncoderException - if the encoding is in error

isEndOfInput

public boolean isEndOfInput()
                     throws Exception

Description copied from interface: ChunkedInput

Return true if and only if there is no data left in the stream and the stream has reached at its end.

Specified by:

isEndOfInput in interface ChunkedInput

Throws:

Exception

hasNextChunk

public boolean hasNextChunk()
                     throws Exception

Description copied from interface: ChunkedInput

Returns true if and only if there is any data left in the stream. Please note that false does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.

Specified by:

hasNextChunk in interface ChunkedInput

Throws:

Exception