com.helger.web.fileupload.servlet.ServletFileUpload Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-web Show documentation
Java library with basic web functionality
There is a newer version: 10.1.9
/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.web.fileupload.servlet;

import java.io.IOException;

import javax.annotation.Nonnull;

import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.collection.impl.ICommonsList;
import com.helger.web.fileupload.IFileItem;
import com.helger.web.fileupload.IFileItemFactory;
import com.helger.web.fileupload.IFileItemIterator;
import com.helger.web.fileupload.exception.FileUploadException;
import com.helger.web.fileupload.parse.FileUpload;

import jakarta.servlet.http.HttpServletRequest;

/**
 * 
 * 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
 * {@link #parseRequest(HttpServletRequest)} to acquire a list of
 * {@link com.helger.web.fileupload.IFileItem}s 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.
 * 
 *
 * @author Rafal Krzewski
 * @author Daniel Rall
 * @author Jason van Zyl
 * @author John McNally
 * @author Martin Cooper
 * @author Sean C. Sullivan
 * @version $Id: ServletFileUpload.java 479484 2006-11-27 01:06:53Z jochen $
 */
public class ServletFileUpload extends FileUpload
{
  /**
   * Constructs an instance of this class which uses the supplied factory to
   * create FileItem instances.
   *
   * @param aFileItemFactory
   *        The factory to use for creating file items.
   */
  public ServletFileUpload (@Nonnull final IFileItemFactory aFileItemFactory)
  {
    super (aFileItemFactory);
  }

  /**
   * Processes an RFC 1867
   * compliant multipart/form-data stream.
   *
   * @param aHttpRequest
   *        The servlet request to be parsed.
   * @return 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.
   */
  @Nonnull
  @ReturnsMutableCopy
  public ICommonsList  parseRequest (@Nonnull final HttpServletRequest aHttpRequest) throws FileUploadException
  {
    return super.parseRequest (new ServletRequestContext (aHttpRequest));
  }

  /**
   * Processes an RFC 1867
   * compliant multipart/form-data stream.
   *
   * @param aHttpRequest
   *        The servlet request to be parsed.
   * @return 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.
   * @throws 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.
   */
  @Nonnull
  public IFileItemIterator getItemIterator (@Nonnull final HttpServletRequest aHttpRequest) throws FileUploadException, IOException
  {
    return super.getItemIterator (new ServletRequestContext (aHttpRequest));
  }
}