Package org.apache.commons.fileupload

Class FileUploadBase

java.lang.Object
org.apache.commons.fileupload.FileUploadBase
Direct Known Subclasses:
DiskFileUpload, FileUpload
public abstract class FileUploadBase extends Object
High level API for processing file uploads.

This class handles multiple files per single HTML widget, sent using multipart/mixed encoding type, as specified by RFC 1867. Use parseRequest(RequestContext) to acquire a list of FileItems associated with a given HTML widget.

How the data for individual parts is stored is determined by the factory used to create them; a given part may be in memory, on disk, or somewhere else.

  • Field Details

    • LF

      private static final char LF
      Line feed.
      See Also:

    • CR

      private static final char CR
      Carriage return.
      See Also:

    • CONTENT_TYPE

      public static final String CONTENT_TYPE
      HTTP content type header name.
      See Also:

    • CONTENT_DISPOSITION

      public static final String CONTENT_DISPOSITION
      HTTP content disposition header name.
      See Also:

    • CONTENT_LENGTH

      public static final String CONTENT_LENGTH
      HTTP content length header name.
      See Also:

    • FORM_DATA

      public static final String FORM_DATA
      Content-disposition value for form data.
      See Also:

    • ATTACHMENT

      public static final String ATTACHMENT
      Content-disposition value for file attachment.
      See Also:

    • MULTIPART

      public static final String MULTIPART
      Part of HTTP content type header.
      See Also:

    • MULTIPART_FORM_DATA

      public static final String MULTIPART_FORM_DATA
      HTTP content type header for multipart forms.
      See Also:

    • MULTIPART_MIXED

      public static final String MULTIPART_MIXED
      HTTP content type header for multiple uploads.
      See Also:

    • MAX_HEADER_SIZE

      @Deprecated public static final int MAX_HEADER_SIZE
      Deprecated.
      This constant is no longer used. As of commons-fileupload 1.6, the applicable limit is the total size of a single part's headers, getPartHeaderSizeMax() in bytes.
      The maximum length of a single header line that will be parsed (1024 bytes).
      See Also:

    • DEFAULT_PART_HEADER_SIZE_MAX

      public static final int DEFAULT_PART_HEADER_SIZE_MAX
      Default per part header size limit in bytes.
      Since:
      1.6.0
      See Also:

    • sizeMax

      private long sizeMax
      The maximum size permitted for the complete request, as opposed to fileSizeMax. A value of -1 indicates no maximum.

    • fileSizeMax

      private long fileSizeMax
      The maximum size permitted for a single uploaded file, as opposed to sizeMax. A value of -1 indicates no maximum.

    • fileCountMax

      private long fileCountMax
      The maximum permitted number of files that may be uploaded in a single request. A value of -1 indicates no maximum.

    • partHeaderSizeMax

      private int partHeaderSizeMax
      The maximum permitted size of the headers provided with a single part in bytes.

    • headerEncoding

      private String headerEncoding
      The content encoding to use when reading part headers.

    • listener

      private ProgressListener listener
      The progress listener.

  • Constructor Details

    • FileUploadBase

      public FileUploadBase()
      Constructs a new instance.

  • Method Details

    • isMultipartContent

      @Deprecated public static boolean isMultipartContent(javax.servlet.http.HttpServletRequest req)
      Deprecated.
      1.1 Use the method on ServletFileUpload instead.
      Utility method that determines whether the request contains multipart content.
      Parameters:
      req - The servlet request to be evaluated. Must be non-null.
      Returns:
      true if the request is multipart; false otherwise.

    • isMultipartContent

      public static final boolean isMultipartContent(RequestContext ctx)

      Utility method that determines whether the request contains multipart content.

      NOTE:This method will be moved to the ServletFileUpload class after the FileUpload 1.1 release. Unfortunately, since this method is static, it is not possible to provide its replacement until this method is removed.

      Parameters:
      ctx - The request context to be evaluated. Must be non-null.
      Returns:
      true if the request is multipart; false otherwise.

    • createItem

      @Deprecated protected FileItem createItem(Map<String,String> headers, boolean isFormField)
      Deprecated.
      1.2 This method is no longer used in favor of internally created instances of FileItem.
      Creates a new FileItem instance.
      Parameters:
      headers - A Map containing the HTTP request headers.
      isFormField - Whether or not this item is a form field, as opposed to a file.
      Returns:
      A newly created FileItem instance.

    • getBoundary

      protected byte[] getBoundary(String contentType)
      Gets the boundary from the Content-type header.
      Parameters:
      contentType - The value of the content type header from which to extract the boundary value.
      Returns:
      The boundary, as a byte array.

    • getFieldName

      protected String getFieldName(FileItemHeaders headers)
      Gets the field name from the Content-disposition header.
      Parameters:
      headers - A Map containing the HTTP request headers.
      Returns:
      The field name for the current encapsulation.

    • getFieldName

      @Deprecated protected String getFieldName(Map<String,String> headers)
      Deprecated.
      1.2.1 Use getFieldName(FileItemHeaders).
      Gets the field name from the Content-disposition header.
      Parameters:
      headers - A Map containing the HTTP request headers.
      Returns:
      The field name for the current encapsulation.

    • getFieldName

      private String getFieldName(String contentDisposition)
      Returns the field name, which is given by the content-disposition header.
      Parameters:
      contentDisposition - The content-dispositions header value.
      Returns:
      The field name.

    • getFileCountMax

      public long getFileCountMax()
      Returns the maximum number of files allowed in a single request.
      Returns:
      The maximum number of files allowed in a single request.

    • getFileItemFactory

      public abstract FileItemFactory getFileItemFactory()
      Returns the factory class used when creating file items.
      Returns:
      The factory class for new file items.

    • getFileName

      protected String getFileName(FileItemHeaders headers)
      Gets the file name from the Content-disposition header.
      Parameters:
      headers - The HTTP headers object.
      Returns:
      The file name for the current encapsulation.

    • getFileName

      @Deprecated protected String getFileName(Map<String,String> headers)
      Deprecated.
      1.2.1 Use getFileName(FileItemHeaders).
      Gets the file name from the Content-disposition header.
      Parameters:
      headers - A Map containing the HTTP request headers.
      Returns:
      The file name for the current encapsulation.

    • getFileName

      private String getFileName(String contentDisposition)
      Returns the given content-disposition headers file name.
      Parameters:
      contentDisposition - The content-disposition headers value.
      Returns:
      The file name

    • getFileSizeMax

      public long getFileSizeMax()
      Returns the maximum allowed size of a single uploaded file, as opposed to getSizeMax().
      Returns:
      Maximum size of a single uploaded file.
      See Also:

    • getHeader

      @Deprecated protected final String getHeader(Map<String,String> headers, String name)
      Deprecated.
      1.2.1 Use FileItemHeaders.getHeader(String).
      Returns the header with the specified name from the supplied map. The header lookup is case-insensitive.
      Parameters:
      headers - A Map containing the HTTP request headers.
      name - The name of the header to return.
      Returns:
      The value of specified header, or a comma-separated list if there were multiple headers of that name.

    • getHeaderEncoding

      public String getHeaderEncoding()
      Gets the character encoding used when reading the headers of an individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
      Returns:
      The encoding used to read part headers.

    • getItemIterator

      public FileItemIterator getItemIterator(RequestContext ctx) throws FileUploadException, IOException
      Processes an RFC 1867 compliant multipart/form-data stream.
      Parameters:
      ctx - The context for the request to be parsed.
      Returns:
      An iterator to instances of FileItemStream parsed from the request, in the order that they were transmitted.
      Throws:
      FileUploadException - if there are problems reading/parsing the request or storing files.
      IOException - An I/O error occurred. This may be a network error while communicating with the client or a problem while storing the uploaded content.

    • getParsedHeaders

      protected FileItemHeaders getParsedHeaders(String headerPart)

      Parses the header-part and returns as key/value pairs.

      If there are multiple headers of the same names, the name will map to a comma-separated list containing the values.

      Parameters:
      headerPart - The header-part of the current encapsulation.
      Returns:
      A Map containing the parsed HTTP request headers.

    • getPartHeaderSizeMax

      public int getPartHeaderSizeMax()
      Obtain the per part size limit for headers.
      Returns:
      The maximum size of the headers for a single part in bytes.
      Since:
      1.6.0

    • getProgressListener

      public ProgressListener getProgressListener()
      Returns the progress listener.
      Returns:
      The progress listener, if any, or null.

    • getSizeMax

      public long getSizeMax()
      Returns the maximum allowed size of a complete request, as opposed to getFileSizeMax().
      Returns:
      The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.
      See Also:

    • newFileItemHeaders

      protected FileItemHeadersImpl newFileItemHeaders()
      Creates a new instance of FileItemHeaders.
      Returns:
      The new instance.

    • parseEndOfLine

      private int parseEndOfLine(String headerPart, int end)
      Skips bytes until the end of the current line.
      Parameters:
      headerPart - The headers, which are being parsed.
      end - Index of the last byte, which has yet been processed.
      Returns:
      Index of the \r\n sequence, which indicates end of line.

    • parseHeaderLine

      private void parseHeaderLine(FileItemHeadersImpl headers, String header)
      Reads the next header line.
      Parameters:
      headers - String with all headers.
      header - Map where to store the current header.

    • parseHeaders

      @Deprecated protected Map<String,String> parseHeaders(String headerPart)
      Deprecated.
      1.2.1 Use getParsedHeaders(String)

      Parses the header-part and returns as key/value pairs.

      If there are multiple headers of the same names, the name will map to a comma-separated list containing the values.

      Parameters:
      headerPart - The header-part of the current encapsulation.
      Returns:
      A Map containing the parsed HTTP request headers.

    • parseParameterMap

      public Map<String,List<FileItem>> parseParameterMap(RequestContext ctx) throws FileUploadException
      Processes an RFC 1867 compliant multipart/form-data stream.
      Parameters:
      ctx - The context for the request to be parsed.
      Returns:
      A map of FileItem instances parsed from the request.
      Throws:
      FileUploadException - if there are problems reading/parsing the request or storing files.
      Since:
      1.3

    • parseRequest

      @Deprecated public List<FileItem> parseRequest(javax.servlet.http.HttpServletRequest req) throws FileUploadException
      Deprecated.
      1.1 Use ServletFileUpload.parseRequest(HttpServletRequest) instead.
      Processes an RFC 1867 compliant multipart/form-data stream.
      Parameters:
      req - The servlet request to be parsed.
      Returns:
      A list of FileItem instances parsed from the request, in the order that they were transmitted.
      Throws:
      FileUploadException - if there are problems reading/parsing the request or storing files.

    • parseRequest

      public List<FileItem> parseRequest(RequestContext ctx) throws FileUploadException
      Processes an RFC 1867 compliant multipart/form-data stream.
      Parameters:
      ctx - The context for the request to be parsed.
      Returns:
      A list of FileItem instances parsed from the request, in the order that they were transmitted.
      Throws:
      FileUploadException - if there are problems reading/parsing the request or storing files.

    • setFileCountMax

      public void setFileCountMax(long fileCountMax)
      Sets the maximum number of files allowed per request.
      Parameters:
      fileCountMax - The new limit. -1 means no limit.

    • setFileItemFactory

      public abstract void setFileItemFactory(FileItemFactory factory)
      Sets the factory class to use when creating file items.
      Parameters:
      factory - The factory class for new file items.

    • setFileSizeMax

      public void setFileSizeMax(long fileSizeMax)
      Sets the maximum allowed size of a single uploaded file, as opposed to getSizeMax().
      Parameters:
      fileSizeMax - Maximum size of a single uploaded file.
      See Also:

    • setHeaderEncoding

      public void setHeaderEncoding(String encoding)
      Specifies the character encoding to be used when reading the headers of individual part. When not specified, or null, the request encoding is used. If that is also not specified, or null, the platform default encoding is used.
      Parameters:
      encoding - The encoding used to read part headers.

    • setPartHeaderSizeMax

      public void setPartHeaderSizeMax(int partHeaderSizeMax)
      Sets the per part size limit for headers.
      Parameters:
      partHeaderSizeMax - The maximum size of the headers in bytes.
      Since:
      1.6.0

    • setProgressListener

      public void setProgressListener(ProgressListener listener)
      Sets the progress listener.
      Parameters:
      listener - The progress listener, if any. Defaults to null.

    • setSizeMax

      public void setSizeMax(long sizeMax)
      Sets the maximum allowed size of a complete request, as opposed to setFileSizeMax(long).
      Parameters:
      sizeMax - The maximum allowed size, in bytes. The default value of -1 indicates, that there is no limit.
      See Also: