Class DefaultHttpDataFactory

java.lang.Object

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

All Implemented Interfaces:

HttpDataFactory

public class DefaultHttpDataFactory
extends Object
implements HttpDataFactory

Default factory giving Attribute and FileUpload according to constructor Attribute and FileUpload could be :
- MemoryAttribute, DiskAttribute or MixedAttribute
- MemoryFileUpload, DiskFileUpload or MixedFileUpload
according to the constructor.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	checkSize
private long	maxSize
static final long	MAXSIZE	Proposed default MAXSIZE = -1 as UNLIMITED
private long	minSize
static final long	MINSIZE	Proposed default MINSIZE as 16 KB.
private final Map<HttpRequest, List<HttpData>>	requestFileDeleteMap	Keep all HttpDatas until cleanAllHttpDatas() is called.
private final boolean	useDisk

Constructor Summary

Constructors

Constructor	Description
DefaultHttpDataFactory()	HttpData will be in memory if less than default size (16KB).
DefaultHttpDataFactory(boolean useDisk)	HttpData will be always on Disk if useDisk is True, else always in Memory if False.
DefaultHttpDataFactory(long minSize)	HttpData will be on Disk if the size of the file is greater than minSize, else it will be in memory.

Method Summary

Modifier and Type	Method	Description
private void	checkHttpDataSize(HttpData data)	Utility method
void	cleanAllHttpDatas()	Remove all InterfaceHttpData from virtual File storage from clean list for all requests
void	cleanRequestHttpDatas(HttpRequest request)	Remove all InterfaceHttpData from virtual File storage from clean list for the request
Attribute	createAttribute(HttpRequest request, String name)
Attribute	createAttribute(HttpRequest request, String name, String value)
FileUpload	createFileUpload(HttpRequest request, String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size)
private List<HttpData>	getList(HttpRequest request)
void	removeHttpDataFromClean(HttpRequest request, InterfaceHttpData data)	Remove the given InterfaceHttpData from clean list (will not delete the file, except if the file is still a temporary one as setup at construction)
void	setMaxLimit(long max)	To set a max size limitation on fields.

Methods inherited from class Object

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

Field Details

MINSIZE

public static final long MINSIZE

Proposed default MINSIZE as 16 KB.

See Also:

• Constant Field Values

MAXSIZE

public static final long MAXSIZE

Proposed default MAXSIZE = -1 as UNLIMITED

See Also:

• Constant Field Values

useDisk

private final boolean useDisk

checkSize

private final boolean checkSize

minSize

private long minSize

maxSize

private long maxSize

requestFileDeleteMap

private final Map<HttpRequest, List<HttpData>> requestFileDeleteMap

Keep all HttpDatas until cleanAllHttpDatas() is called.

Constructor Details

DefaultHttpDataFactory

public DefaultHttpDataFactory()

HttpData will be in memory if less than default size (16KB). No limit setup. The type will be Mixed.

DefaultHttpDataFactory

public DefaultHttpDataFactory(boolean useDisk)

HttpData will be always on Disk if useDisk is True, else always in Memory if False. No limit setup.

DefaultHttpDataFactory

public DefaultHttpDataFactory(long minSize)

HttpData will be on Disk if the size of the file is greater than minSize, else it will be in memory. The type will be Mixed. No limit setup.

Method Details

setMaxLimit

public void setMaxLimit(long max)

Description copied from interface: HttpDataFactory

To set a max size limitation on fields. Exceeding it will generate an ErrorDataDecoderException. A value of -1 means no limitation (default).

Specified by:

setMaxLimit in interface HttpDataFactory

Parameters:

max -

getList

private List<HttpData> getList(HttpRequest request)

Returns:

the associated list of Files for the request

createAttribute

public Attribute createAttribute(HttpRequest request,
 String name)

Specified by:

createAttribute in interface HttpDataFactory

Parameters:

request - associated request

Returns:

a new Attribute with no value

checkHttpDataSize

private void checkHttpDataSize(HttpData data)

Utility method

Parameters:

data -

createAttribute

public Attribute createAttribute(HttpRequest request,
 String name,
 String value)

Specified by:

createAttribute in interface HttpDataFactory

Parameters:

request - associated request

Returns:

a new Attribute

createFileUpload

public FileUpload createFileUpload(HttpRequest request,
 String name,
 String filename,
 String contentType,
 String contentTransferEncoding,
 Charset charset,
 long size)

Specified by:

createFileUpload in interface HttpDataFactory

Parameters:

request - associated request

size - the size of the Uploaded file

Returns:

a new FileUpload

removeHttpDataFromClean

public void removeHttpDataFromClean(HttpRequest request,
 InterfaceHttpData data)

Description copied from interface: HttpDataFactory

Remove the given InterfaceHttpData from clean list (will not delete the file, except if the file is still a temporary one as setup at construction)

Specified by:

removeHttpDataFromClean in interface HttpDataFactory

Parameters:

request - associated request

cleanRequestHttpDatas

public void cleanRequestHttpDatas(HttpRequest request)

Description copied from interface: HttpDataFactory

Remove all InterfaceHttpData from virtual File storage from clean list for the request

Specified by:

cleanRequestHttpDatas in interface HttpDataFactory

Parameters:

request - associated request

cleanAllHttpDatas

public void cleanAllHttpDatas()

Description copied from interface: HttpDataFactory

Remove all InterfaceHttpData from virtual File storage from clean list for all requests

Specified by:

cleanAllHttpDatas in interface HttpDataFactory