/*
 * $Header: /home/cvs/commons/fileupload-1.0/ja/src/org/apache/commons/fileupload/DefaultFileItemFactory.java,v 1.5 2004/04/07 04:00:48 hioki Exp $
 * $Revision: 1.5 $
 * $Date: 2004/04/07 04:00:48 $
 *
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */


package org.apache.commons.fileupload;

import java.io.File;


/**
 * <p>{@link org.apache.commons.fileupload.FileItemFactory} インターフェイスの標準実装です。
 * この実装は、アイテムが小さければメモリに、大きければディスクに保存する
 * {@link org.apache.commons.fileupload.FileItem} インスタンスを生成します。
 * ファイルをディスクに保存するサイズの閾値と、その一時ファイルを保存する
 * ディレクトリは設定することが可能です。
 * {@primary The default {@link org.apache.commons.fileupload.FileItemFactory}
 * implementation. This implementation creates
 * {@link org.apache.commons.fileupload.FileItem} instances which keep their
 * content either in memory, for smaller items, or in a temporary file on disk,
 * for larger items. The size threshold, above which content will be stored on
 * disk, is configurable, as is the directory in which temporary files will be
 * created.}</p>
 *
 * <p>設定を行わなかった場合、初期設定は以下の通りです:
 * <ul>
 *   <li>サイズ閾値 10KB</li>
 *   <li>リポジトリ <code>System.getProperty("java.io.tmpdir")</code>
 *       の返すシステム標準一時ディレクトリ </li>
 * </ul>
 * {@primary If not otherwise configured, the default configuration values are as
 * follows:
 * <ul>
 *   <li>Size threshold is 10KB.</li>
 *   <li>Repository is the system default temp directory, as returned by
 *       <code>System.getProperty("java.io.tmpdir")</code>.</li>
 * </ul>}
 * </p>
 *
 * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
 * @translator 日置 聡
 * @editor 入江 弘憲
 * @status completion
 * @update 2003/04/07
 *
 * @version $Id: DefaultFileItemFactory.java,v 1.5 2004/04/07 04:00:48 hioki Exp $
 */
public class DefaultFileItemFactory implements FileItemFactory
{

    // ----------------------------------------------------- Manifest constants


    /**
     * アップロード時にこのサイズを超えたらディスクに保存する閾値の初期値。
     * {@primary The default threshold above which uploads will be stored on disk.}
     */
    public static final int DEFAULT_SIZE_THRESHOLD = 10240;


    // ----------------------------------------------------- Instance Variables


    /**
     * ディスク上にアップロードデータを保存する場合のディレクトリ。
     * {@primary The directory in which uploaded files will be stored, if stored on disk.}
     */
    private File repository;


    /**
     * アップロード時にこのサイズを超えたらディスクに保存する閾値。
     * {@primary The threshold above which uploads will be stored on disk.}
     */
    private int sizeThreshold = DEFAULT_SIZE_THRESHOLD;


    // ----------------------------------------------------------- Constructors


    /**
     * 未設定のクラスインスタンスを生成します。
     * ファクトリ(このクラス)を生成の後、適切なセッターメソッドにて設定を行うことができます。
     * {@primary Constructs an unconfigured instance of this class. The resulting factory
     * may be configured by calling the appropriate setter methods.}
     */
    public DefaultFileItemFactory()
    {
    }


    /**
     * 設定済みのクラスインスタンスを生成します。
     * {@primary Constructs a preconfigured instance of this class.}
     *
     * @param sizeThreshold これより小さければメモリ上に、大きければファイルとして
     *                      アイテムを保持するバイト単位の閾値。
     * {@primary The threshold, in bytes, below which items will be
     *           retained in memory and above which they will be
     *           stored as a file.}
     * @param repository    アイテムのサイズが閾値を越えた際に、
     *                      ファイルの保存先となるディレクトリ。
     * {@primary The data repository, which is the directory in
     *           which files will be created, should the item size
     *           exceed the threshold.}
     */
    public DefaultFileItemFactory(int sizeThreshold, File repository)
    {
        this.sizeThreshold = sizeThreshold;
        this.repository = repository;
    }


    // ------------------------------------------------------------- Properties


    /**
     * 設定された閾値のサイズを超えた一時ファイルが保存されるディレクトリを返します。
     * {@primary Returns the directory used to temporarily store files that are larger
     * than the configured size threshold.}
     *
     * @return 一時ファイルが保存されるディレクトリ。
     * {@primary The directory in which temporary files will be located.}
     *
     * @see #setRepository(java.io.File)
     *
     */
    public File getRepository()
    {
        return repository;
    }


    /**
     * 設定された閾値のサイズを超えた一時ファイルが保存されるディレクトリを設定します。
     * {@primary Sets the directory used to temporarily store files that are larger
     * than the configured size threshold.}
     *
     * @param repository 一時ファイルが保存されるディレクトリ。
     * {@primary The directory in which temporary files will be located.}
     *
     * @see #getRepository()
     *
     */
    public void setRepository(File repository)
    {
        this.repository = repository;
    }


    /**
     * これを超えたらディスク上にファイルを保存するサイズ閾値を返します。
     * 初期値は1024バイトです。{@annotation 10240バイトが正しい初期値です。}
     * {@primary Returns the size threshold beyond which files are written directly to
     * disk. The default value is 1024 bytes.}
     *
     * @return バイトのサイズ閾値。
     * {@primary The size threshold, in bytes.}
     *
     * @see #setSizeThreshold(int)
     */
    public int getSizeThreshold()
    {
        return sizeThreshold;
    }


    /**
     * これを超えたらディスク上にファイルを保存するサイズ閾値を設定します。
     * {@primary Sets the size threshold beyond which files are written directly to disk.}
     *
     * @param sizeThreshold バイト単位のサイズ閾値。
     * {@primary sizeThreshold The size threshold, in bytes.}
     *
     * @see #getSizeThreshold()
     *
     */
    public void setSizeThreshold(int sizeThreshold)
    {
        this.sizeThreshold = sizeThreshold;
    }


    // --------------------------------------------------------- Public Methods

    /**
     * 渡されたパラメータと、このファクトリ内の設定から新しい
     * {@link org.apache.commons.fileupload.DefaultFileItem} を生成します。
     * {@primary Create a new {@link org.apache.commons.fileupload.DefaultFileItem}
     * instance from the supplied parameters and the local factory
     * configuration.}
     *
     * @param fieldName   フォームフィールド名。
     * {@primary The name of the form field.}
     * @param contentType フォームフィールドのコンテントタイプ。
     * {@primary The content type of the form field.}
     * @param isFormField <code>true</code> 単純なフォームフィールドを示す場合;
     *                    <code>false</code> それ以外の場合。
     * {@primary <code>true</code> if this is a plain form field;
     *           <code>false</code> otherwise.}
     * @param fileName    ブラウザまたは他のクライアントから渡されたアップロードファイル名。
     * {@primary The name of the uploaded file, if any, as supplied
     *           by the browser or other client.}
     *
     * @return 新規に作成されたファイルアイテム。
     * {@primary The newly created file item.}
     */
    public FileItem createItem(
            String fieldName,
            String contentType,
            boolean isFormField,
            String fileName
            )
    {
        return new DefaultFileItem(fieldName, contentType,
                isFormField, fileName, sizeThreshold, repository);
    }

}