jp.littlesoft.file.server
クラス AbstractFileItem

java.lang.Object
  jp.littlesoft.file.server.AbstractFileItem

すべての実装されたインタフェース:

Serializable, org.apache.commons.fileupload.FileItem

直系の既知のサブクラス:

DefaultFileItem

public abstract class AbstractFileItem
extends Object
implements org.apache.commons.fileupload.FileItem, Serializable

ファイルアップロードFileItemクラス。

バージョン:

1.3.0

作成者:

LittleSoft Corporation

関連項目:

直列化された形式

フィールドの概要

protected String	contentType
protected String	fieldName
protected String	fileName
protected boolean	isFormField
protected AbstractFileItem	nextItem
protected SplitUploadParams	params
protected AbstractFileItem	prevItem
protected boolean	temporary

コンストラクタの概要

AbstractFileItem(File file)
指定されたファイルへ読み書きを行うファイルアイテムを生成する.

AbstractFileItem(String fieldName, String contentType, boolean isFormField, String fileName)
FileItemFactoryから呼ばれるコンストラクタ

メソッドの概要

abstract void	delete() 関係する一時ディスク領域も含むストレージ上のファイルアイテムを削除します。
abstract byte[]	get() ファイルアイテムの内容をバイト配列で返します。
String	getContentType() ブラウザによって付加されたコンテントタイプを返します。
String	getFieldName() ファイルアイテムに対応したマルチパートフォームフィールド名を返します。
abstract InputStream	getFullReadInputStream(File file) 分割されたファイルを先頭からすべて読み取る入力ストリームを取得します.
abstract String	getId() ファイルを識別する一意のIDを取得する.
abstract InputStream	getInputStream() ファイルの内容を取得するための InputStream を返します.
String	getName() ブラウザ(または他のクライアントソフトウェア)によって渡された クライアントの ファイルシステム上でのオリジナルのファイル名を返します。
AbstractFileItem	getNextItem() 次のFileItemオブジェクトを取得する。
abstract OutputStream	getOutputStream() ファイルの内容を保持するための OutputStream を返します。
SplitUploadParams	getParams()
AbstractFileItem	getPrevItem() 前のFileItemオブジェクトを取得する。
long	getSize() ファイルアイテムのサイズを返します。
String	getString() デフォルトのキャラクタエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。
String	getString(String encode) 指定されたエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。
long	getTotalSize() 分割時の累積データサイズを取得する。
boolean	isFormField() FileItem インスタンスが単純なフォームフィールドを示すかどうかを判断します。
abstract boolean	isInMemory() ファイルの内容をメモリ上から読み込むことができるかどうかを示します。
boolean	isTemporary() アップロードアイテムが生成された時点ではisTemporary:trueです.
void	setFieldName(String fieldName) このファイルアイテムを参照するためのフィールド名を設定します。
void	setFormField(boolean isFormField) FileItem インスタンスが単純なフォームフィールドを示すかどうかを設定します。
protected void	setNextItem(AbstractFileItem nextItem)
protected void	setParams(SplitUploadParams params)
protected void	setPrevItem(AbstractFileItem prevItem)
void	setTemporary(boolean temporary) アップロードアイテムが生成された時点ではisTemporary:trueです.
String	toString()
abstract void	write(File file) fileで指定された永続化ストレージにデータを書き出します.

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

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

フィールドの詳細

temporary

protected boolean temporary

fieldName

protected String fieldName

contentType

protected String contentType

isFormField

protected boolean isFormField

fileName

protected String fileName

params

protected SplitUploadParams params

prevItem

protected AbstractFileItem prevItem

nextItem

protected AbstractFileItem nextItem

コンストラクタの詳細

AbstractFileItem

public AbstractFileItem(File file)

指定されたファイルへ読み書きを行うファイルアイテムを生成する.

パラメータ:

File -

AbstractFileItem

public AbstractFileItem(String fieldName,
                        String contentType,
                        boolean isFormField,
                        String fileName)

FileItemFactoryから呼ばれるコンストラクタ

パラメータ:

fieldName - フォームフィールド名

contentType - フォームフィールドのコンテントタイプ

isFormField - 単純なフォームフィールドを示す場合はtrue、それ以外の場合はfalse

fileName - ブラウザまたは他のクライアントから渡されるアップロードファイル名

メソッドの詳細

delete

public abstract void delete()

関係する一時ディスク領域も含むストレージ上のファイルアイテムを削除します。
FileItem インスタンスがガベージコレクションにかかった時にこのストレージは削除されますが、
このメソッドは早く確実に削除を実施し、システムリソースを保護します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の delete

パラメータ:

file - アップロードアイテムの出力先となる File

例外:

Exception - エラーが発生した場合

get

public abstract byte[] get()

ファイルアイテムの内容をバイト配列で返します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の get

戻り値:

ファイルアイテムの内容を示すバイト配列

getContentType

public String getContentType()

ブラウザによって付加されたコンテントタイプを返します。 定義されていない場合には null を返します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getContentType

戻り値:

ブラウザによって付加されたコンテントタイプ。定義されていない場合には null

getFieldName

public String getFieldName()

ファイルアイテムに対応したマルチパートフォームフィールド名を返します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getFieldName

戻り値:

フォームフィールド名

getInputStream

public abstract InputStream getInputStream()
                                    throws IOException

ファイルの内容を取得するための InputStream を返します.

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getInputStream

戻り値:

ファイルの内容を取得するための InputStream

例外:

IOException - エラーが発生した場合

getName

public String getName()

ブラウザ(または他のクライアントソフトウェア)によって渡された クライアントの
ファイルシステム上でのオリジナルのファイル名を返します。
大体の場合、これはパス情報を除いた元のファイル名になります。
しかし、Operaブラウザ等のいくつかのクライアントではパス情報が含まれます。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getName

戻り値:

クライアントのファイルシステム上でのオリジナルのファイル名

getOutputStream

public abstract OutputStream getOutputStream()
                                      throws IOException

ファイルの内容を保持するための OutputStream を返します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getOutputStream

戻り値:

ファイルの内容を保持するための OutputStream

例外:

IOException - エラーが発生した場合

getSize

public long getSize()

ファイルアイテムのサイズを返します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getSize

戻り値:

ファイルアイテムのバイト単位のサイズ

getString

public String getString()

デフォルトのキャラクタエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。
このメソッドはアイテムの内容を取得するために get() メソッドを使用します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getString

戻り値:

アイテムの内容の文字列表現

getString

public String getString(String encode)
                 throws UnsupportedEncodingException

指定されたエンコーディングを使用してファイルアイテムの内容の文字列表現を返します。
このメソッドはアイテムの内容を取得するために get() メソッドを使用します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の getString

パラメータ:

encoding - 使用するキャラクタエンコーディング

戻り値:

アイテムの内容の文字列表現

例外:

UnsupportedEncodingException - 指定されたエンコーディングが利用できなかった場合

isFormField

public boolean isFormField()

FileItem インスタンスが単純なフォームフィールドを示すかどうかを判断します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の isFormField

戻り値:

インスタンスが単純なフォームフィールドを示す場合はtrue、インスタンスがアップロードされたファイルを示す場合はfalse

isInMemory

public abstract boolean isInMemory()

ファイルの内容をメモリ上から読み込むことができるかどうかを示します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の isInMemory

戻り値:

ファイルの内容をメモリ上から読み込むことができる場合はtrue、その他の場合はfalse

setFieldName

public void setFieldName(String fieldName)

このファイルアイテムを参照するためのフィールド名を設定します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の setFieldName

パラメータ:

name - フォームフィールド名

setFormField

public void setFormField(boolean isFormField)

FileItem インスタンスが単純なフォームフィールドを示すかどうかを設定します。

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の setFormField

パラメータ:

state - インスタンスが単純なフォームフィールドを示す場合はtrue、インスタンスがアップロードされたファイルを示す場合はfalse

getFullReadInputStream

public abstract InputStream getFullReadInputStream(File file)
                                            throws Exception

分割されたファイルを先頭からすべて読み取る入力ストリームを取得します.

戻り値:

InputStream;

例外:

Exception

write

public abstract void write(File file)
                    throws Exception

fileで指定された永続化ストレージにデータを書き出します.
分割されたファイルの場合、先頭アイテムをwriteすれば残りも同時にwriteされます.
当メソッドによりファイルの状態はisTemporary:falseとなります. また、Temporaryファイル等の後始末も行います.

定義:

インタフェース org.apache.commons.fileupload.FileItem 内の write

パラメータ:

file - アップロードアイテムの出力先となる File

例外:

Exception - エラーが発生した場合

isTemporary

public boolean isTemporary()

アップロードアイテムが生成された時点ではisTemporary:trueです. isTemporary:trueの場合、FileManagerによって当該セッション情報が破棄されると同時にファイルも削除されます

戻り値:

isTemporary

setTemporary

public void setTemporary(boolean temporary)

アップロードアイテムが生成された時点ではisTemporary:trueです. isTemporary:trueの場合、FileManagerによって当該セッション情報が破棄されると同時にファイルも削除されます. isTemporary:falseに設定すると上記削除対象からは除外されますが、永続的なストレージへの移動と一時ファイルの消去は個別に実装する必要があります.

getTotalSize

public long getTotalSize()

分割時の累積データサイズを取得する。

戻り値:

toString

public String toString()

オーバーライド:

クラス Object 内の toString

getId

public abstract String getId()

ファイルを識別する一意のIDを取得する. 通常のDiskFileであればファイルパス、GAEではentityのKeyを文字列化した値

戻り値:

id

getPrevItem

public AbstractFileItem getPrevItem()

前のFileItemオブジェクトを取得する。

戻り値:

前のFileItemオブジェクト

getNextItem

public AbstractFileItem getNextItem()

次のFileItemオブジェクトを取得する。

戻り値:

次のFileItemオブジェクト

getParams

public SplitUploadParams getParams()

setParams

protected void setParams(SplitUploadParams params)

setPrevItem

protected void setPrevItem(AbstractFileItem prevItem)

setNextItem

protected void setNextItem(AbstractFileItem nextItem)