    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017package org.apache.commons.fileupload;
    018
    019/**
    020 * <p>A factory interface for creating {@link FileItem} instances. Factories
    021 * can provide their own custom configuration, over and above that provided
    022 * by the default file upload implementation.</p>
    023 */
    024public interface FileItemFactory {
    025
    026    /**
    027     * Create a new {@link FileItem} instance from the supplied parameters and
    028     * any local factory configuration.
    029     *
    030     * @param fieldName   The name of the form field.
    031     * @param contentType The content type of the form field.
    032     * @param isFormField <code>true</code> if this is a plain form field;
    033     *                    <code>false</code> otherwise.
    034     * @param fileName    The name of the uploaded file, if any, as supplied
    035     *                    by the browser or other client.
    036     *
    037     * @return The newly created file item.
    038     */
    039    FileItem createItem(
    040            String fieldName,
    041            String contentType,
    042            boolean isFormField,
    043            String fileName
    044            );
    045
    046}