{@link org.apache.commons.fileupload.FileItem FileItem} * インターフェイスの標準実装です。 * {@primary The default implementation of the * {@link org.apache.commons.fileupload.FileItem FileItem} interface.} * *
{@link org.apache.commons.fileupload.DiskFileUpload DiskFileUpload}
* からこのクラスインスタンスを取得した後
* ({@link org.apache.commons.fileupload.DiskFileUpload #parseRequest(javax.servlet.http.HttpServletRequest)}) を参照)、
* {@link #get()} メソッドを使ってすべてのファイルの内容を(メモリ上に)取得するか、
* {@link #getInputStream()} メソッドを使って {@link java.io.InputStream InputStream}
* を取得し、メモリ上に展開することなく
* ファイルを処理する(大きなファイルを扱う場合に有用)かを選択することができます。
*
* {@primary After retrieving an instance of this class from a {@link
* org.apache.commons.fileupload.DiskFileUpload DiskFileUpload} instance (see
* {@link org.apache.commons.fileupload.DiskFileUpload
* #parseRequest(javax.servlet.http.HttpServletRequest)}), you may
* either request all contents of file at once using {@link #get()} or
* request an {@link java.io.InputStream InputStream} with
* {@link #getInputStream()} and process the file without attempting to load
* it into memory, which may come handy with large files.}
*
* @author Rafal Krzewski
* @author Sean Legassick
* @author Jason van Zyl
* @author John McNally
* @author Martin Cooper
* @author Sean C. Sullivan
* @translator 日置 聡
* @editor 入江 弘憲
* @status completion
* @update 2003/04/07
*
* @version $Id: DefaultFileItem.java,v 1.5 2004/04/07 04:00:48 hioki Exp $
*/
public class DefaultFileItem
implements FileItem
{
// ----------------------------------------------------------- Data members
/**
* 固有の識別子を生成するために使用されるカウンタ。
* {@primary Counter used in unique identifier generation.}
*/
private static int counter = 0;
/**
* ブラウザによって付加されたフォームフィールド名。
* {@primary The name of the form field as provided by the browser.}
*/
private String fieldName;
/**
* ブラウザによって付加されたコンテントタイプ。
* 定義されていない場合には null 。
* {@primary The content type passed by the browser, or null if
* not defined.}
*/
private String contentType;
/**
* このアイテムが単純なフォームフィールドかどうか。
* {@primary Whether or not this item is a simple form field.}
*/
private boolean isFormField;
/**
* ユーザのファイルシステム上でのオリジナルのファイル名。
* {@primary The original filename in the user's filesystem.}
*/
private String fileName;
/**
* アップロードファイルをディスク上に保持するかどうかの閾値。
* {@primary The threshold above which uploads will be stored on disk.}
*/
private int sizeThreshold;
/**
* ディスク上に保持する場合にアップロードファイルが保存されるディレクトリ。
* {@primary The directory in which uploaded files will be stored, if stored on disk.}
*/
private File repository;
/**
* キャッシュされたファイルの内容。
* {@primary Cached contents of the file.}
*/
private byte[] cachedContent;
/**
* このアイテムの出力ストリーム。
* {@primary Output stream for this item.}
*/
private DeferredFileOutputStream dfos;
// ----------------------------------------------------------- Constructors
/**
* 新規 DefaultFileItem インスタンスを生成します。
* {@primary Constructs a new DefaultFileItem instance.}
*
* @param fieldName フォームフィールド名。
* {@primary The name of the form field.}
* @param contentType ブラウザによって付加されたコンテントタイプ。
* 定義されていない場合には null 。
* {@primary The content type passed by the browser or
* null if not specified.}
* @param isFormField このアイテムがアップロードファイルではなく
* 単純なフォームフィールドかどうか。
* {@primary Whether or not this item is a plain form field, as
* opposed to a file upload.}
* @param fileName ユーザのファイルシステム上でのオリジナルのファイル名。
* 定義されていない場合には null 。
* {@primary The original filename in the user's filesystem, or
* null if not specified.}
* @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.}
*/
DefaultFileItem(String fieldName, String contentType, boolean isFormField,
String fileName, int sizeThreshold, File repository)
{
this.fieldName = fieldName;
this.contentType = contentType;
this.isFormField = isFormField;
this.fileName = fileName;
this.sizeThreshold = sizeThreshold;
this.repository = repository;
}
// ------------------------------- Methods from javax.activation.DataSource
/**
* ファイルの内容を取得するための {@link java.io.InputStream InputStream} を返します。
* {@primary Returns an {@link java.io.InputStream InputStream} that can be
* used to retrieve the contents of the file.}
*
* @return ファイルの内容を取得するための {@link java.io.InputStream InputStream} 。
* {@primary {@link java.io.InputStream InputStream} that can be
* used to retrieve the contents of the file.}
*
* @exception IOException エラーが発生した場合。
* {@primary if an error occurs.}
*/
public InputStream getInputStream()
throws IOException
{
if (!dfos.isInMemory())
{
return new FileInputStream(dfos.getFile());
}
if (cachedContent == null)
{
cachedContent = dfos.getData();
}
return new ByteArrayInputStream(cachedContent);
}
/**
* ブラウザによって付加されたコンテントタイプを返します。
* 定義されていない場合には null を返します。
* {@primary Returns the content type passed by the browser or null if
* not defined.}
*
* @return ブラウザによって付加されたコンテントタイプ。
* 定義されていない場合には null。
* {@primary The content type passed by the browser or null if
* not defined.}
*/
public String getContentType()
{
return contentType;
}
/**
* クライアントのファイルシステム上でのオリジナルのファイル名を返します。
* {@primary Returns the original filename in the client's filesystem.}
*
* @return クライアントのファイルシステム上でのオリジナルのファイル名。
* {@primary The original filename in the client's filesystem.}
*/
public String getName()
{
return fileName;
}
// ------------------------------------------------------- FileItem methods
/**
* ファイルの内容をメモリ上から読み込むことができるかどうかを示します。
* {@primary Provides a hint as to whether or not the file contents will be read
* from memory.}
*
* @return true ファイルの内容をメモリ上から読み込むことができる場合;
* false その他の場合。
* {@primary true if the file contents will be read
* from memory; false otherwise.}
*/
public boolean isInMemory()
{
return (dfos.isInMemory());
}
/**
* ファイルアイテムのサイズを返します。
* {@primary Returns the size of the file.}
*
* @return ファイルアイテムのバイト単位のサイズ。
* {@primary The size of the file, in bytes.}
*/
public long getSize()
{
if (cachedContent != null)
{
return cachedContent.length;
}
else if (dfos.isInMemory())
{
return dfos.getData().length;
}
else
{
return dfos.getFile().length();
}
}
/**
* ファイルの内容をバイト配列で返します。
* ファイルの内容がまだメモリ上にキャッシュされていない場合、
* ディスクストレージからロードし、キャッシュします。
* {@primary Returns the contents of the file as an array of bytes. If the
* contents of the file were not yet cached in memory, they will be
* loaded from the disk storage and cached.}
*
* @return ファイルの内容を示すバイト配列。
* {@primary The contents of the file as an array of bytes.}
*/
public byte[] get()
{
if (dfos.isInMemory())
{
if (cachedContent == null)
{
cachedContent = dfos.getData();
}
return cachedContent;
}
byte[] fileData = new byte[(int) getSize()];
FileInputStream fis = null;
try
{
fis = new FileInputStream(dfos.getFile());
fis.read(fileData);
}
catch (IOException e)
{
fileData = null;
}
finally
{
if (fis != null)
{
try
{
fis.close();
}
catch (IOException e)
{
// ignore
}
}
}
return fileData;
}
/**
* 指定されたエンコーディングを使用してファイルの内容の文字列表現を返します。
* このメソッドはファイルの内容を取得するために {@link #get()} メソッドを使用します。
* {@primary Returns the contents of the file as a String, using the specified
* encoding. This method uses {@link #get()} to retrieve the
* contents of the file.}
*
* @param encoding 使用するキャラクタエンコーディング。
* {@primary The character encoding to use.}
*
* @return ファイルの内容の文字列表現。
* {@primary The contents of the file, as a string.}
*
* @exception UnsupportedEncodingException 指定されたエンコーディングが利用できなかった場合。
* {@primary if the requested character encoding is not available.}
*/
public String getString(String encoding)
throws UnsupportedEncodingException
{
return new String(get(), encoding);
}
/**
* デフォルトのキャラクタエンコーディングを使用してファイルの内容の文字列表現を返します。
* このメソッドはファイルの内容を取得するために {@link #get()} メソッドを使用します。
* {@primary Returns the contents of the file as a String, using the default
* character encoding. This method uses {@link #get()} to retrieve the
* contents of the file.}
*
* @return ファイルの内容の文字列表現。
* {@primary @return The contents of the file, as a string.}
*/
public String getString()
{
return new String(get());
}
/**
* アップロードアイテムをディスクに書き出すための簡易メソッドです。
* クライアントコードはアイテムがメモリに保持されているか、ディスクの一時領域に保持されているかを考慮しません。
* アップロードアイテムをファイルに書き出すことだけを考えます。
* {@primary A convenience method to write an uploaded item to disk. The client code
* is not concerned with whether or not the item is stored in memory, or on
* disk in a temporary location. They just want to write the uploaded item
* to a file.}
*
* この実装はもしアイテムがディスク上に展開されている場合、 * 最初にアップロードアイテムを指定された名称のファイルに変更する事を試みます。 * それ以外の場合にはデータを指定されたファイルにコピーします。 * {@primary This implementation first attempts to rename the uploaded item to the * specified destination file, if the item was originally written to disk. * Otherwise, the data will be copied to the specified file.} *
* このメソッドは、1つのアイテムについて最初に実行された1度だけ、動作することが保証されます。
* (1度処理を行った後には)このメソッドは一時ファイルの名称を変更してしまうので、
* 次にコピーまたは名称の変更をしようとしても、そのファイルはもう既に利用できません。
* {@primary This method is only guaranteed to work once, the first time it
* is invoked for a particular item. This is because, in the event that the
* method renames a temporary file, that file will no longer be available
* to copy or rename again at a later time.}
*
* @param file アップロードアイテムの出力先となる File 。
* {@primary The File into which the uploaded item should
* be stored.}
*
* @exception Exception エラーが発生した場合。
* {@primary if an error occurs.}
*/
public void write(File file) throws Exception
{
if (isInMemory())
{
FileOutputStream fout = null;
try
{
fout = new FileOutputStream(file);
fout.write(get());
}
finally
{
if (fout != null)
{
fout.close();
}
}
}
else
{
File outputFile = getStoreLocation();
if (outputFile != null)
{
/*
* The uploaded file is being stored on disk
* in a temporary location so move it to the
* desired file.
*/
if (!outputFile.renameTo(file))
{
BufferedInputStream in = null;
BufferedOutputStream out = null;
try
{
in = new BufferedInputStream(
new FileInputStream(outputFile));
out = new BufferedOutputStream(
new FileOutputStream(file));
byte[] bytes = new byte[2048];
int s = 0;
while ((s = in.read(bytes)) != -1)
{
out.write(bytes, 0, s);
}
}
finally
{
try
{
in.close();
}
catch (IOException e)
{
// ignore
}
try
{
out.close();
}
catch (IOException e)
{
// ignore
}
}
}
}
else
{
/*
* For whatever reason we cannot write the
* file to disk.
*/
throw new FileUploadException(
"Cannot write uploaded file to disk!");
}
}
}
/**
* 関係する一時ディスク領域も含むストレージ上のファイルアイテムを削除します。
* FileItem インスタンスがガベージコレクションにかかった時にこのストレージは削除されますが、
* このメソッドは早く確実に削除を実施し、システムリソースを保護します。
* {@primary Deletes the underlying storage for a file item, including deleting any
* associated temporary disk file. Although this storage will be deleted
* automatically when the FileItem instance is garbage
* collected, this method can be used to ensure that this is done at an
* earlier time, thus preserving system resources.}
*/
public void delete()
{
cachedContent = null;
File outputFile = getStoreLocation();
if (outputFile != null && outputFile.exists())
{
outputFile.delete();
}
}
/**
* ファイルアイテムに対応したマルチパートフォームフィールド名を返します。
* {@primary Returns the name of the field in the multipart form corresponding to
* this file item.}
*
* @return フォームフィールド名。
* {@primary The name of the form field.}
*
* @see #setFieldName(java.lang.String)
*
*/
public String getFieldName()
{
return fieldName;
}
/**
* このファイルアイテムを参照するためのフィールド名を設定します。
* {@primary Sets the field name used to reference this file item.}
*
* @param fieldName フォームフィールド名。
* {@primary The name of the form field.}
*
* @see #getFieldName()
*
*/
public void setFieldName(String fieldName)
{
this.fieldName = fieldName;
}
/**
* FileItem インスタンスが単純なフォームフィールドを示すかどうかを判断します。
* {@primary Determines whether or not a FileItem instance represents
* a simple form field.}
*
* @return true インスタンスが単純なフォームフィールドを示す場合;
* false インスタンスがアップロードされたファイルを示す場合。
* {@primary true if the instance represents a simple form
* field; false if it represents an uploaded file.}
*
* @see #setFormField(boolean)
*
*/
public boolean isFormField()
{
return isFormField;
}
/**
* FileItem インスタンスが単純なフォームフィールドを示すかどうかを設定します。
* {@primary Specifies whether or not a FileItem instance represents
* a simple form field.}
*
* @param state true インスタンスが単純なフォームフィールドを示す場合;
* false インスタンスがアップロードされたファイルを示す場合。
* {@primary true if the instance represents a simple form
* field; false if it represents an uploaded file.}
*
* @see #isFormField()
*
*/
public void setFormField(boolean state)
{
isFormField = state;
}
/**
* ファイルの内容を保持するための {@link java.io.OutputStream OutputStream} を返します。
* {@primary Returns an {@link java.io.OutputStream OutputStream} that can
* be used for storing the contents of the file.}
*
* @return ファイルの内容を保持するための {@link java.io.OutputStream OutputStream} 。
* {@primary An {@link java.io.OutputStream OutputStream} that can be used
* for storing the contensts of the file.}
*
* @exception IOException エラーが発生した場合。
* {@primary if an error occurs.}
*/
public OutputStream getOutputStream()
throws IOException
{
if (dfos == null)
{
File outputFile = getTempFile();
dfos = new DeferredFileOutputStream(sizeThreshold, outputFile);
}
return dfos;
}
// --------------------------------------------------------- Public methods
/**
* 一時領域に保持されている FileItem のデータを示す {@link java.io.File}
* オブジェクトを返します。
* FileItem がデータをメモリ上に保持している場合には、
* このメソッドは null を返します。
* 大きなファイルを扱う際には、もし一時領域と移動先の論理ボリュームが同じなら
* {@link java.io.File#renameTo(java.io.File)}
* を使ってデータのコピーを行うことなく新しい位置に移動することができます。
* {@primary Returns the {@link java.io.File} object for the FileItem's
* data's temporary location on the disk. Note that for
* FileItems that have their data stored in memory,
* this method will return null. When handling large
* files, you can use {@link java.io.File#renameTo(java.io.File)} to
* move the file to new location without copying the data, if the
* source and destination locations reside within the same logical
* volume.}
*
* @return データファイル。データがメモリ上に保持されている場合には null 。
* {@primary The data file, or null if the data is stored in
* memory.}
*/
public File getStoreLocation()
{
return dfos.getFile();
}
// ------------------------------------------------------ Protected methods
/**
* 一時領域からファイルの内容を削除します。
* {@primary Removes the file contents from the temporary storage.}
*/
protected void finalize()
{
File outputFile = dfos.getFile();
if (outputFile != null && outputFile.exists())
{
outputFile.delete();
}
}
/**
* 設定されたリポジトリパス内の固有名称の一時ファイルを表す
* {@link java.io.File File} を作成して返します。
* {@primary Creates and returns a {@link java.io.File File} representing a uniquely
* named temporary file in the configured repository path.}
*
* @return 一時領域内の {@link java.io.File File} 。
* {@primary The {@link java.io.File File} to be used for temporary storage.}
*/
protected File getTempFile()
{
File tempDir = repository;
if (tempDir == null)
{
tempDir = new File(System.getProperty("java.io.tmpdir"));
}
String fileName = "upload_" + getUniqueId() + ".tmp";
File f = new File(tempDir, fileName);
f.deleteOnExit();
return f;
}
// -------------------------------------------------------- Private methods
/**
* このクラスをロードするクラスローダ内で固有の(しかしランダムに見えない)識別子を返します。
* {@primary Returns an identifier that is unique within the class loader used to
* load this class, but does not have random-like apearance.}
*
* @return (ランダムに見えない)インスタンス識別子の文字列。
* {@primary A String with the non-random looking instance identifier.}
*/
private static String getUniqueId()
{
int current;
synchronized (DefaultFileItem.class)
{
current = counter++;
}
String id = Integer.toString(current);
// If you manage to get more than 100 million of ids, you'll
// start getting ids longer than 8 characters.
if (current < 100000000)
{
id = ("00000000" + id).substring(id.length());
}
return id;
}
}