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

类 HttpPostMultipartRequestDecoder

java.lang.Object

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

所有已实现的接口:

InterfaceHttpPostRequestDecoder

public class HttpPostMultipartRequestDecoder
extends java.lang.Object
implements InterfaceHttpPostRequestDecoder

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

构造器概要

构造器

构造器和说明
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request)
HttpPostMultipartRequestDecoder(HttpDataFactory factory, HttpRequest request, java.nio.charset.Charset charset)
HttpPostMultipartRequestDecoder(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.
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

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

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

构造器详细资料

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(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

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(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

HttpPostMultipartRequestDecoder

public HttpPostMultipartRequestDecoder(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 boolean isMultipart()

从接口复制的说明: InterfaceHttpPostRequestDecoder

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

从接口复制的说明: 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.

指定者:

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

从接口复制的说明: 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.

指定者:

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

从接口复制的说明: 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.

指定者:

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

从接口复制的说明: InterfaceHttpPostRequestDecoder

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

从接口复制的说明: InterfaceHttpPostRequestDecoder

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

从接口复制的说明: 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.

指定者:

next 在接口中 InterfaceHttpPostRequestDecoder

返回:

the next available InterfaceHttpData or null if none

抛出:

HttpPostRequestDecoder.EndOfDataDecoderException - No more data will be available

cleanFiles

public void cleanFiles()

从接口复制的说明: InterfaceHttpPostRequestDecoder

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

指定者:

cleanFiles 在接口中 InterfaceHttpPostRequestDecoder

removeHttpDataFromClean

public void removeHttpDataFromClean(InterfaceHttpData data)

从接口复制的说明: InterfaceHttpPostRequestDecoder

Remove the given FileUpload from the list of FileUploads to clean

指定者:

removeHttpDataFromClean 在接口中 InterfaceHttpPostRequestDecoder