Class DefaultHttpDataFactory

java.lang.Object
io.netty.handler.codec.http.multipart.DefaultHttpDataFactory
All Implemented Interfaces:
HttpDataFactory
public class DefaultHttpDataFactory extends java.lang.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 Details

    • MINSIZE

      public static final long MINSIZE
      Proposed default MINSIZE as 16 KB.
      See Also:

    • MAXSIZE

      public static final long MAXSIZE
      Proposed default MAXSIZE = -1 as UNLIMITED
      See Also:

    • useDisk

      private final boolean useDisk

    • checkSize

      private final boolean checkSize

    • minSize

      private long minSize

    • maxSize

      private long maxSize

    • charset

      private java.nio.charset.Charset charset

    • baseDir

      private java.lang.String baseDir

    • deleteOnExit

      private boolean deleteOnExit

    • requestFileDeleteMap

      private final java.util.Map<HttpRequest, java.util.List<HttpData>> requestFileDeleteMap
      Keep all HttpDatas until cleaning methods are called. We need to use IdentityHashMap because different requests may be equal. See DefaultHttpRequest.hashCode() and DefaultHttpRequest.equals(Object). Similarly, when removing data items, we need to check their identities because different data items may be equal.

  • Constructor Details

    • DefaultHttpDataFactory

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

    • DefaultHttpDataFactory

      public DefaultHttpDataFactory(java.nio.charset.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, java.nio.charset.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, java.nio.charset.Charset charset)

  • Method Details

    • setBaseDir

      public void setBaseDir(java.lang.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

    • getList

      private java.util.List<HttpData> getList(HttpRequest request)
      Returns:
      the associated list of HttpData for the request

    • createAttribute

      public Attribute createAttribute(HttpRequest request, java.lang.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, java.lang.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

    • checkHttpDataSize

      private static void checkHttpDataSize(HttpData data)
      Utility method

    • createAttribute

      public Attribute createAttribute(HttpRequest request, java.lang.String name, java.lang.String value)
      Specified by:
      createAttribute in interface HttpDataFactory
      Parameters:
      request - associated request
      Returns:
      a new Attribute

    • createFileUpload

      public FileUpload createFileUpload(HttpRequest request, java.lang.String name, java.lang.String filename, java.lang.String contentType, java.lang.String contentTransferEncoding, java.nio.charset.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