ファイルアップロードを処理するための高レベルAPIです。 * {@primary High level API for processing file uploads.}
* *このクラスは RFC 1867
* によって規定された multipart/mixed エンコーディングタイプを使用して
* HTML ウィジェットから送信された複数のファイルを処理します。
* {@link #parseRequest(HttpServletRequest)} を使用して、
* HTMLウィジェットから送られたデータを示す {@link org.apache.commons.fileupload.FileItem}
* のリストを取得します。
* {@primary 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
* org.apache.commons.fileupload.FileItem}s associated with a given HTML
* widget.}
個々のパーツはサイズに応じて一時ディスク領域またはメモリ上に保持され、 * {@link org.apache.commons.fileupload.FileItem} から取得することが可能です。 * {@primary Individual parts will be stored in temporary disk storage or in memory, * depending on their size, and will be available as {@link * org.apache.commons.fileupload.FileItem}s.}
* * @author Rafal Krzewski * @author Daniel Rall * @author Jason van Zyl * @author John McNally * @author Martin Cooper * @author Sean C. Sullivan * @translator 日置 聡 * @editor 入江 弘憲 * @status completion * @update 2003/04/21 * * @version $Id: DiskFileUpload.java,v 1.6 2004/04/20 15:03:31 hioki Exp $ */ public class DiskFileUpload extends FileUploadBase { // ----------------------------------------------------------- Data members /** * 新規フォームアイテムを作成するためのファクトリ。 * {@primary The factory to use to create new form items.} */ private DefaultFileItemFactory fileItemFactory; // ----------------------------------------------------------- Constructors /** * 標準のファクトリを用いてFileItem インスタンスを生成する、
* このクラスのインスタンスを作成します。
* {@primary Constructs an instance of this class which uses the default factory to
* create FileItem instances.}
*
* @see #DiskFileUpload(DefaultFileItemFactory fileItemFactory)
*/
public DiskFileUpload()
{
super();
this.fileItemFactory = new DefaultFileItemFactory();
}
/**
* 指定されたファクトリを用いて FileItem インスタンスを生成する、
* このクラスのインスタンスを作成します。
* {@primary Constructs an instance of this class which uses the supplied factory to
* create FileItem instances.}
*
* @see #DiskFileUpload()
*/
public DiskFileUpload(DefaultFileItemFactory fileItemFactory)
{
super();
this.fileItemFactory = fileItemFactory;
}
// ----------------------------------------------------- Property accessors
/**
* ファイルアイテムを生成する際に使用するファクトリクラスを返します。
* {@primary Returns the factory class used when creating file items.}
*
* @return ファイルアイテムを生成するファクトリクラス。
* {@primary The factory class for new file items.}
*/
public FileItemFactory getFileItemFactory()
{
return fileItemFactory;
}
/**
* ファイルアイテムを生成する際に使用するファクトリクラスを設定します。
* ファクトリクラスは DefaultFileItemFactory もしくはこれを継承したクラスである必要があります。
* そうでない場合 ClassCastException が投げられます。
* {@primary Sets the factory class to use when creating file items. The factory must
* be an instance of DefaultFileItemFactory or a subclass
* thereof, or else a ClassCastException will be thrown.}
*
* @param factory ファイルアイテムを生成するファクトリクラス。
* {@primary The factory class for new file items.}
*/
public void setFileItemFactory(FileItemFactory factory)
{
this.fileItemFactory = (DefaultFileItemFactory) factory;
}
/**
* これを超えたらディスク上にファイルを保存するサイズ閾値を返します。
* {@primary Returns the size threshold beyond which files are written directly to
* disk.}
*
* @return バイト単位のサイズ閾値。
* {@primary The size threshold, in bytes.}
*
* @see #setSizeThreshold(int)
*/
public int getSizeThreshold()
{
return fileItemFactory.getSizeThreshold();
}
/**
* これを超えたらディスク上にファイルを保存するサイズ閾値を設定します。
* {@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)
{
fileItemFactory.setSizeThreshold(sizeThreshold);
}
/**
* 設定された閾値のサイズを超えた一時ファイルが保存される場所を返します。
* {@primary Returns the location used to temporarily store files that are larger
* than the configured size threshold.}
*
* @return 一時ファイルが保存されるパス。
* {@primary The path to the temporary file location.}
*
* @see #setRepositoryPath(String)
*/
public String getRepositoryPath()
{
return fileItemFactory.getRepository().getPath();
}
/**
* 設定された閾値のサイズを超えた一時ファイルが保存される場所を設定します。
* {@primary Sets the location used to temporarily store files that are larger
* than the configured size threshold.}
*
* @param repositoryPath 一時ファイルが保存されるパス。
* {@primary repositoryPath The path to the temporary file location.}
*
* @see #getRepositoryPath()
*/
public void setRepositoryPath(String repositoryPath)
{
fileItemFactory.setRepository(new File(repositoryPath));
}
// --------------------------------------------------------- Public methods
/**
* RFC 1867 の仕様に従って
* multipart/form-data のストリームを処理します。
* ファイルがディスク上に保持される場合には getRepository()
* によってそのパスを取得することができます。
* {@primary Processes an RFC 1867
* compliant multipart/form-data stream. If files are stored
* on disk, the path is given by getRepository().}
*
* @param req 処理対象となるサーブレットリクエスト。 null は受け付けません。
* {@primary The servlet request to be parsed. Must be non-null.}
* @param sizeThreshold メモリに保持する最大サイズ(バイト単位)。
* {@primary The max size in bytes to be stored in memory.}
* @param sizeMax アップロードを許可する最大サイズ(バイト単位)。
* {@primary The maximum allowed upload size, in bytes.}
* @param path ファイルにてデータを保持する場合の場所。
* {@primary The location where the files should be stored.}
*
* @return このリクエストを処理して生成された FileItem インスタンスのリスト。
* 送信された順番に並びます。
* {@primary A list of FileItem instances parsed from the
* request, in the order that they were transmitted.}
*
* @exception FileUploadException リクエストの読み込み、処理またはファイルの保持にて
* 問題が発生した場合。
* {@primary if there are problems reading/parsing the request or storing files.}
*/
public List /* FileItem */ parseRequest(HttpServletRequest req,
int sizeThreshold,
long sizeMax, String path)
throws FileUploadException
{
setSizeThreshold(sizeThreshold);
setSizeMax(sizeMax);
setRepositoryPath(path);
return parseRequest(req);
}
}