org.apache.commons.fileupload
クラス DiskFileUpload

java.lang.Object
  org.apache.commons.fileupload.FileUploadBase
      org.apache.commons.fileupload.DiskFileUpload

public class DiskFileUpload

extends FileUploadBase

ファイルアップロードを処理するための高レベルAPIです。

このクラスは RFC 1867 によって規定された multipart/mixed エンコーディングタイプを使用して HTML ウィジェットから送信された複数のファイルを処理します。 FileUploadBase.parseRequest(HttpServletRequest) を使用して、 HTMLウィジェットから送られたデータを示す FileItem のリストを取得します。

個々のパーツはサイズに応じて一時ディスク領域またはメモリ上に保持され、 FileItem から取得することが可能です。

バージョン:

$Id: DiskFileUpload.java,v 1.6 2004/04/20 15:03:31 hioki Exp $

作成者:

Rafal Krzewski, Daniel Rall, Jason van Zyl, John McNally, Martin Cooper, Sean C. Sullivan

翻訳者:

日置 聡

校正者:

入江 弘憲

入れ子クラスの概要

クラス org.apache.commons.fileupload.FileUploadBase から継承した入れ子クラス

FileUploadBase.InvalidContentTypeException, FileUploadBase.SizeLimitExceededException, FileUploadBase.UnknownSizeException

フィールドの概要

private DefaultFileItemFactory

fileItemFactory 新規フォームアイテムを作成するためのファクトリ。

クラス org.apache.commons.fileupload.FileUploadBase から継承したフィールド

ATTACHMENT, CONTENT_DISPOSITION, CONTENT_TYPE, FORM_DATA, MAX_HEADER_SIZE, MULTIPART, MULTIPART_FORM_DATA, MULTIPART_MIXED

コンストラクタの概要

DiskFileUpload()
標準のファクトリを用いて FileItem インスタンスを生成する、 このクラスのインスタンスを作成します。

DiskFileUpload(DefaultFileItemFactory fileItemFactory)
指定されたファクトリを用いて FileItem インスタンスを生成する、 このクラスのインスタンスを作成します。

メソッドの概要

FileItemFactory	getFileItemFactory() ファイルアイテムを生成する際に使用するファクトリクラスを返します。
String	getRepositoryPath() 設定された閾値のサイズを超えた一時ファイルが保存される場所を返します。
int	getSizeThreshold() これを超えたらディスク上にファイルを保存するサイズ閾値を返します。
List	parseRequest(javax.servlet.http.HttpServletRequest req, int sizeThreshold, long sizeMax, String path) RFC 1867 の仕様に従って multipart/form-data のストリームを処理します。
void	setFileItemFactory(FileItemFactory factory) ファイルアイテムを生成する際に使用するファクトリクラスを設定します。
void	setRepositoryPath(String repositoryPath) 設定された閾値のサイズを超えた一時ファイルが保存される場所を設定します。
void	setSizeThreshold(int sizeThreshold) これを超えたらディスク上にファイルを保存するサイズ閾値を設定します。

クラス org.apache.commons.fileupload.FileUploadBase から継承したメソッド

createItem, getFieldName, getFileName, getHeader, getHeaderEncoding, getSizeMax, isMultipartContent, parseHeaders, parseRequest, setHeaderEncoding, setSizeMax

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

fileItemFactory

private DefaultFileItemFactory fileItemFactory

新規フォームアイテムを作成するためのファクトリ。

コンストラクタの詳細

DiskFileUpload

public DiskFileUpload()

標準のファクトリを用いて FileItem インスタンスを生成する、 このクラスのインスタンスを作成します。

関連項目:

DiskFileUpload(DefaultFileItemFactory fileItemFactory)

DiskFileUpload

public DiskFileUpload(DefaultFileItemFactory fileItemFactory)

指定されたファクトリを用いて FileItem インスタンスを生成する、 このクラスのインスタンスを作成します。

関連項目:

DiskFileUpload()

メソッドの詳細

getFileItemFactory

public FileItemFactory getFileItemFactory()

ファイルアイテムを生成する際に使用するファクトリクラスを返します。

定義:

クラス FileUploadBase 内の getFileItemFactory

戻り値:

ファイルアイテムを生成するファクトリクラス。

setFileItemFactory

public void setFileItemFactory(FileItemFactory factory)

ファイルアイテムを生成する際に使用するファクトリクラスを設定します。 ファクトリクラスは DefaultFileItemFactory もしくはこれを継承したクラスである必要があります。 そうでない場合 ClassCastException が投げられます。

定義:

クラス FileUploadBase 内の setFileItemFactory

パラメータ:

factory - ファイルアイテムを生成するファクトリクラス。

getSizeThreshold

public int getSizeThreshold()

これを超えたらディスク上にファイルを保存するサイズ閾値を返します。

戻り値:

バイト単位のサイズ閾値。

関連項目:

setSizeThreshold(int)

setSizeThreshold

public void setSizeThreshold(int sizeThreshold)

これを超えたらディスク上にファイルを保存するサイズ閾値を設定します。

パラメータ:

sizeThreshold - バイト単位のサイズ閾値。

関連項目:

getSizeThreshold()

getRepositoryPath

public String getRepositoryPath()

設定された閾値のサイズを超えた一時ファイルが保存される場所を返します。

戻り値:

一時ファイルが保存されるパス。

関連項目:

setRepositoryPath(String)

setRepositoryPath

public void setRepositoryPath(String repositoryPath)

設定された閾値のサイズを超えた一時ファイルが保存される場所を設定します。

パラメータ:

repositoryPath - 一時ファイルが保存されるパス。

関連項目:

getRepositoryPath()

parseRequest

public List parseRequest(javax.servlet.http.HttpServletRequest req,
                         int sizeThreshold,
                         long sizeMax,
                         String path)
                  throws FileUploadException

RFC 1867 の仕様に従って multipart/form-data のストリームを処理します。 ファイルがディスク上に保持される場合には getRepository() によってそのパスを取得することができます。

パラメータ:

req - 処理対象となるサーブレットリクエスト。 null は受け付けません。

sizeThreshold - メモリに保持する最大サイズ(バイト単位)。

sizeMax - アップロードを許可する最大サイズ(バイト単位)。

path - ファイルにてデータを保持する場合の場所。

戻り値:

このリクエストを処理して生成された FileItem インスタンスのリスト。 送信された順番に並びます。

例外:

FileUploadException - リクエストの読み込み、処理またはファイルの保持にて 問題が発生した場合。