Interface MultipartFormDataParser

All Known Implementing Classes:
CommonsMultipartFormDataParser, InMemoryMultipartFormDataParser

public interface MultipartFormDataParser
Multi-part form data parser.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the directory path used for temporary files.
    void
    parse(RequestAdapter requestAdapter)
    Parse the given servlet request, resolving its multipart elements.
    void
    setAllowedFileExtensions(String allowedFileExtensions)
    Sets the allowed file extensions.
    void
    setDeniedFileExtensions(String deniedFileExtensions)
    Sets the denied file extensions.
    void
    setMaxFileSize(long maxFileSize)
    Set the maximum allowed size (in bytes) for each individual file before an upload gets rejected.
    void
    setMaxInMemorySize(int maxInMemorySize)
    Set the maximum allowed size (in bytes) before uploads are written to disk.
    void
    setMaxRequestSize(long maxRequestSize)
    Sets the maximum length of HTTP GET Request -1 indicates no limit (the default).
    void
    setTempDirectoryPath(String tempDirectoryPath)
    Sets the directory path used to temporarily files.
  • Method Details

    • getTempDirectoryPath

      String getTempDirectoryPath()
      Returns the directory path used for temporary files.
      Returns:
      the directory path used for temporary files
    • setTempDirectoryPath

      void setTempDirectoryPath(String tempDirectoryPath)
      Sets the directory path used to temporarily files.
      Parameters:
      tempDirectoryPath - the directory path used for temporary files
    • setMaxRequestSize

      void setMaxRequestSize(long maxRequestSize)
      Sets the maximum length of HTTP GET Request -1 indicates no limit (the default).
      Parameters:
      maxRequestSize - the maximum length of HTTP GET Request
      See Also:
      • FileUploadBase.setSizeMax(long)
    • setMaxFileSize

      void setMaxFileSize(long maxFileSize)
      Set the maximum allowed size (in bytes) for each individual file before an upload gets rejected. -1 indicates no limit (the default).
      Parameters:
      maxFileSize - the maximum upload size per file
      Since:
      3.0.0
      See Also:
      • FileUploadBase.setFileSizeMax(long)
    • setMaxInMemorySize

      void setMaxInMemorySize(int maxInMemorySize)
      Set the maximum allowed size (in bytes) before uploads are written to disk. Uploaded files will still be received past this amount, but they will not be stored in memory. Default is 10240, according to Commons FileUpload.
      Parameters:
      maxInMemorySize - the maximum in memory size allowed
      See Also:
      • DiskFileItemFactory.setSizeThreshold(int)
    • setAllowedFileExtensions

      void setAllowedFileExtensions(String allowedFileExtensions)
      Sets the allowed file extensions.
      Parameters:
      allowedFileExtensions - the allowed file extensions
    • setDeniedFileExtensions

      void setDeniedFileExtensions(String deniedFileExtensions)
      Sets the denied file extensions.
      Parameters:
      deniedFileExtensions - the denied file extensions
    • parse

      void parse(RequestAdapter requestAdapter) throws MultipartRequestParseException
      Parse the given servlet request, resolving its multipart elements.
      Parameters:
      requestAdapter - the request adapter
      Throws:
      MultipartRequestParseException - if multipart resolution failed