io.netty.handler.codec.http.multipart

Class DefaultHttpDataFactory

java.lang.Object

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

According to the constructor, Attribute and FileUpload can be:

• MemoryAttribute, DiskAttribute or MixedAttribute
• MemoryFileUpload, DiskFileUpload or MixedFileUpload

A good example of releasing HttpData once all work is done is as follow:

   for (InterfaceHttpData httpData: decoder.getBodyHttpDatas()) {
     httpData.release();
     factory.removeHttpDataFromClean(request, httpData);
   }
   factory.cleanAllHttpData();
   decoder.destroy();
  

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAXSIZE Proposed default MAXSIZE = -1 as UNLIMITED
static long	MINSIZE Proposed default MINSIZE as 16 KB.

Constructor Summary

Constructors

Constructor and 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(boolean useDisk, Charset charset)
DefaultHttpDataFactory(Charset charset)
DefaultHttpDataFactory(long minSize) HttpData will be on Disk if the size of the file is greater than minSize, else it will be in memory.
DefaultHttpDataFactory(long minSize, Charset charset)

Method Summary

Modifier and Type	Method and Description
void	cleanAllHttpData() Remove all InterfaceHttpData from virtual File storage from clean list for all requests
void	cleanAllHttpDatas()
void	cleanRequestHttpData(HttpRequest request) Remove all InterfaceHttpData from virtual File storage from clean list for the request
void	cleanRequestHttpDatas(HttpRequest request)
Attribute	createAttribute(HttpRequest request, String name)
Attribute	createAttribute(HttpRequest request, String name, long definedSize)
Attribute	createAttribute(HttpRequest request, String name, String value)
FileUpload	createFileUpload(HttpRequest request, String name, String filename, String contentType, String contentTransferEncoding, Charset charset, long size)
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	setBaseDir(String baseDir) Override global DiskAttribute.baseDirectory and DiskFileUpload.baseDirectory values.
void	setDeleteOnExit(boolean deleteOnExit) Override global DiskAttribute.deleteOnExitTemporaryFile and DiskFileUpload.deleteOnExitTemporaryFile values.
void	setMaxLimit(long maxSize) To set a max size limitation on fields.

Methods inherited from class java.lang.Object

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

Field Detail

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

Constructor Detail

DefaultHttpDataFactory

public DefaultHttpDataFactory()

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

DefaultHttpDataFactory

public DefaultHttpDataFactory(Charset charset)

DefaultHttpDataFactory

public DefaultHttpDataFactory(boolean useDisk)

HttpData will be always on Disk if useDisk is True, else always in Memory if False

DefaultHttpDataFactory

public DefaultHttpDataFactory(boolean useDisk,
                              Charset charset)

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.

DefaultHttpDataFactory

public DefaultHttpDataFactory(long minSize,
                              Charset charset)

Method Detail

setBaseDir

public void setBaseDir(String baseDir)

Override global DiskAttribute.baseDirectory and DiskFileUpload.baseDirectory values.

Parameters:

baseDir - directory path where to store disk attributes and file uploads.

setDeleteOnExit

public void setDeleteOnExit(boolean deleteOnExit)

Override global DiskAttribute.deleteOnExitTemporaryFile and DiskFileUpload.deleteOnExitTemporaryFile values.

Parameters:

deleteOnExit - true if temporary files should be deleted with the JVM, false otherwise.

setMaxLimit

public void setMaxLimit(long maxSize)

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

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

createAttribute

public Attribute createAttribute(HttpRequest request,
                                 String name,
                                 long definedSize)

Specified by:

createAttribute in interface HttpDataFactory

Parameters:

request - associated request

name - name of the attribute

definedSize - defined size from request for this attribute

Returns:

a new Attribute with no value

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

cleanRequestHttpData

public void cleanRequestHttpData(HttpRequest request)

Description copied from interface: HttpDataFactory

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

Specified by:

cleanRequestHttpData in interface HttpDataFactory

Parameters:

request - associated request

cleanAllHttpData

public void cleanAllHttpData()

Description copied from interface: HttpDataFactory

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

Specified by:

cleanAllHttpData in interface HttpDataFactory

cleanRequestHttpDatas

public void cleanRequestHttpDatas(HttpRequest request)

Specified by:

cleanRequestHttpDatas in interface HttpDataFactory

cleanAllHttpDatas

public void cleanAllHttpDatas()

Specified by:

cleanAllHttpDatas in interface HttpDataFactory