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

Class HttpPostMultipartRequestDecoder

java.lang.Object

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

All Implemented Interfaces:

InterfaceHttpPostRequestDecoder

public class HttpPostMultipartRequestDecoder
extends Object
implements InterfaceHttpPostRequestDecoder

This decoder will decode Body and can handle POST BODY in multipart form.

Constructor Summary

Constructors

Constructor	Description
HttpPostMultipartRequestDecoder(HttpRequest request)
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request)
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset)
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request, Charset charset, int maxFields, int maxBufferedBytes)

Method Summary

Modifier and Type	Method	Description
void	cleanFiles()	Clean all HttpDatas (on Disk) for the current request.
InterfaceHttpData	getBodyHttpData(String name)	This method returns the first InterfaceHttpData with the given name from body. If chunked, all chunks must have been offered using offer() method.
List<InterfaceHttpData>	getBodyHttpDatas()	This method returns a List of all HttpDatas from body. If chunked, all chunks must have been offered using offer() method.
List<InterfaceHttpData>	getBodyHttpDatas(String name)	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.
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
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

Methods inherited from class java.lang.Object

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

Constructor Details

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(HttpRequest request)
                                throws HttpPostRequestDecoder.ErrorDataDecoderException

Parameters:

request - the request to decode

Throws:

NullPointerException - for request

HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(HttpDataFactory factory,
 HttpRequest request)
                                throws HttpPostRequestDecoder.ErrorDataDecoderException

Parameters:

factory - the factory used to create InterfaceHttpData

request - the request to decode

Throws:

NullPointerException - for request or factory

HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(HttpDataFactory factory,
 HttpRequest request,
 Charset charset)
                                throws HttpPostRequestDecoder.ErrorDataDecoderException

Parameters:

factory - the factory used to create InterfaceHttpData

request - the request to decode

charset - the charset to use as default

Throws:

NullPointerException - for request or charset or factory

HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(HttpDataFactory factory,
 HttpRequest request,
 Charset charset,
 int maxFields,
 int maxBufferedBytes)
                                throws HttpPostRequestDecoder.ErrorDataDecoderException

Parameters:

factory - the factory used to create InterfaceHttpData

request - the request to decode

charset - the charset to use as default

maxFields - the maximum number of fields the form can have, -1 to disable

maxBufferedBytes - the maximum number of bytes the decoder can buffer when decoding a field, -1 to disable

Throws:

NullPointerException - for request or charset or factory

HttpPostRequestDecoder.ErrorDataDecoderException - if the default charset was wrong when decoding or other errors

Method Details

isMultipart

public boolean isMultipart()

Description copied from interface: InterfaceHttpPostRequestDecoder

True if this request is a Multipart request

Specified by:

isMultipart in interface InterfaceHttpPostRequestDecoder

Returns:

True if this request is a Multipart request

getBodyHttpDatas

public List<InterfaceHttpData> getBodyHttpDatas()
                                         throws HttpPostRequestDecoder.NotEnoughDataDecoderException

Description copied from interface: InterfaceHttpPostRequestDecoder

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.

Specified by:

getBodyHttpDatas in interface InterfaceHttpPostRequestDecoder

Returns:

the list of HttpDatas from Body part for POST method

Throws:

HttpPostRequestDecoder.NotEnoughDataDecoderException - Need more chunks

getBodyHttpDatas

public List<InterfaceHttpData> getBodyHttpDatas(String name)
                                         throws HttpPostRequestDecoder.NotEnoughDataDecoderException

Description copied from interface: InterfaceHttpPostRequestDecoder

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.

Specified by:

getBodyHttpDatas in interface InterfaceHttpPostRequestDecoder

Returns:

All Body HttpDatas with the given name (ignore case)

Throws:

HttpPostRequestDecoder.NotEnoughDataDecoderException - need more chunks

getBodyHttpData

public InterfaceHttpData getBodyHttpData(String name)
                                  throws HttpPostRequestDecoder.NotEnoughDataDecoderException

Description copied from interface: InterfaceHttpPostRequestDecoder

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.

Specified by:

getBodyHttpData in interface InterfaceHttpPostRequestDecoder

Returns:

The first Body InterfaceHttpData with the given name (ignore case)

Throws:

HttpPostRequestDecoder.NotEnoughDataDecoderException - need more chunks

offer

public void offer(HttpChunk chunk)
           throws HttpPostRequestDecoder.ErrorDataDecoderException

Description copied from interface: InterfaceHttpPostRequestDecoder

Initialized the internals from a new chunk

Specified by:

offer in interface InterfaceHttpPostRequestDecoder

Parameters:

chunk - the new received chunk

Throws:

HttpPostRequestDecoder.ErrorDataDecoderException - if there is a problem with the charset decoding or other errors

hasNext

public boolean hasNext()
                throws HttpPostRequestDecoder.EndOfDataDecoderException

Description copied from interface: InterfaceHttpPostRequestDecoder

True if at current status, there is an available decoded InterfaceHttpData from the Body. This method works for chunked and not chunked request.

Specified by:

hasNext in interface InterfaceHttpPostRequestDecoder

Returns:

True if at current status, there is a decoded InterfaceHttpData

Throws:

HttpPostRequestDecoder.EndOfDataDecoderException - No more data will be available

next

public InterfaceHttpData next()
                       throws HttpPostRequestDecoder.EndOfDataDecoderException

Description copied from interface: InterfaceHttpPostRequestDecoder

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.

Specified by:

next in interface InterfaceHttpPostRequestDecoder

Returns:

the next available InterfaceHttpData or null if none

Throws:

HttpPostRequestDecoder.EndOfDataDecoderException - No more data will be available

cleanFiles

public void cleanFiles()

Description copied from interface: InterfaceHttpPostRequestDecoder

Clean all HttpDatas (on Disk) for the current request.

Specified by:

cleanFiles in interface InterfaceHttpPostRequestDecoder

removeHttpDataFromClean

public void removeHttpDataFromClean(InterfaceHttpData data)

Description copied from interface: InterfaceHttpPostRequestDecoder

Remove the given FileUpload from the list of FileUploads to clean

Specified by:

removeHttpDataFromClean in interface InterfaceHttpPostRequestDecoder