/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      https://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.
 */

/**
 * <p>
 * A component for handling HTML file uploads as specified by <a href="https://www.ietf.org/rfc/rfc1867.txt" target="_top">RFC&nbsp;1867</a>. This component
 * provides support for uploads within both servlets (JSR 53) and portlets (JSR 168).
 * </p>
 * <p>
 * While this package provides the generic functionality for file uploads, these classes are not typically used directly. Instead, normal usage involves one of
 * the provided extensions of {@link org.apache.commons.fileupload2.core.AbstractFileUpload} such as
 * {@code org.apache.commons.fileupload2.core.servlet.ServletFileUpload ServletFileUpload} or
 * {@code org.apache.commons.fileupload2.core.portlet.PortletFileUpload PortletFileUpload}, together with a factory for
 * {@link org.apache.commons.fileupload2.core.FileItem} instances, such as {@link org.apache.commons.fileupload2.core.DiskFileItemFactory}.
 * </p>
 * <p>
 * The following is a brief example of typical usage in a servlet, storing the uploaded files on disk.
 * </p>
 *
 * <pre>{@code
 * public void doPost(HttpServletRequest req, HttpServletResponse res) {
 *   DiskFileItemFactory factory = new DiskFileItemFactory.builder()
 *     // maximum size that will be stored in memory
 *     .setSizeThreshold(4096);
 *     // the location for saving data that is larger than getSizeThreshold()
 *     .setPath(Paths.get("/tmp"))
 *     // build it
 *     .get();
 *
 *   ServletFileUpload upload = new ServletFileUpload(factory);
 *   // maximum size before a FileUploadException will be thrown
 *   upload.setSizeMax(1000000);
 *
 *   List fileItems = upload.parseRequest(req);
 *   // assume we know there are two files. The first file is a small
 *   // text file, the second is unknown and is written to a file on
 *   // the server
 *   Iterator i = fileItems.iterator();
 *   String comment = ((FileItem)i.next()).getString();
 *   FileItem fi = (FileItem)i.next();
 *   // file name on the client
 *   String fileName = fi.getName();
 *   // save comment and file name to database
 *   ...
 *   // write the file
 *   fi.write(new File("/www/uploads/", fileName));
 * }
 * }</pre>
 * <p>
 * In the example above, the first file is loaded into memory as a {@code String}. Before calling the {@code getString} method, the data may have been in memory
 * or on disk depending on its size. The second file we assume it will be large and therefore never explicitly load it into memory, though if it is less than
 * 4096 bytes it will be in memory before it is written to its final location. When writing to the final location, if the data is larger than the threshold, an
 * attempt is made to rename the temporary file to the given location. If it cannot be renamed, it is streamed to the new location.
 * </p>
 * <p>
 * Please see the FileUpload <a href="https://commons.apache.org/fileupload/using.html" target="_top">User Guide</a> for further details and examples of how to
 * use this package.
 * </p>
 */
package org.apache.commons.fileupload2.core;
