devpia.dextupload
Class FileUpload

java.lang.Object
  devpia.dextupload.ErrorManager
      devpia.dextupload.FileUpload

public class FileUpload

extends devpia.dextupload.ErrorManager

実際にファイルをアップロードしてサーバーに保存する機能を担当する、コンポーネントの最も核心となるオブジェクトです。

Constructor Summary

FileUpload(javax.servlet.http.HttpServletRequest Request, javax.servlet.http.HttpServletResponse Response)

FileUpload(javax.servlet.http.HttpServletRequest Request, javax.servlet.http.HttpServletResponse Response, java.lang.String strCharSet)

Method Summary

void	DeleteSavedFiles() アップロードを通じてサーバーに保存した全てのファイルを削除します。
void	dispose() 割り当てられた全てのリソースを解除します。
void	Flush() サーバーにファイル(一時ファイルを含む)を保存せず、ウェブブラウザから送られて来るあらゆるデータを無視して破棄します。
boolean	getAutoMakeFolder() [AutoMakeFolder]機能の設定を求めます。
java.lang.String	getCharacterEncoding() 現在設定されたCharacter Encodingの値を求めます。
FileItem	getFileItem(java.lang.String _Name) ユーザーが転送した_Nameに該当するファイルアイテムを取得します。
java.util.Map	getFileItemMap() ユーザーが転送した全てのファイルアイテムをMap形式で取得します。
java.util.Enumeration	getFileItemNames() ユーザーが転送した全てのファイルアイテムの名前を取得します。
FileItem[]	getFileItemValues(java.lang.String _Name) ユーザーが転送した_Nameに該当する全てのファイルアイテムを配列形式で取得します。
int	getMaxFileLength() アップロード可能な最大ファイルサイズを求めます。
int	getMaxTotalLength() アップロード可能なファイルの総サイズを求めます。
java.lang.String	getParameter(java.lang.String _Name) ユーザーが転送したフォームデータを取得します。
java.util.Map	getParameterMap() ユーザーが転送した全てのフォームアイテムをMap形式で取得します。
java.util.Enumeration	getParameterNames() ユーザーが転送した全てのフォーム名を取得します。
java.lang.String[]	getParameterValues(java.lang.String _Name) ユーザーが転送した_Nameに該当する全てのフォームデータを配列形式で取得します。
int	getUploadedLength() アップロードされた全てのファイル(フォームデータを含む)のサイズを求めます。
void	setAutoMakeFolder(boolean bAutoMake) [DefaultPath][SaveAs]などに指定されたフォルダが存在しない場合はフォルダを自動的に生成します。
void	setCharacterEncoding(java.lang.String strCharSet) フォームデータ処理時に使用するエンコーディングの値を設定します。
void	setLicenseFilePath(java.lang.String strLicenseFilePath) 認証情報を有する[dextuploadj.config]ファイルの位置を設定します。
void	setMaxFileLength(int nByteLength) アップロードが可能な最大ファイルサイズを制限します。
void	setMaxTotalLength(int nByteLength) アップロードが可能なファイルの総サイズの値を制限します。
void	SetProgress(int nID) [Progress]オブジェクトの[GetProgressID()]が返す値を設定します。
void	UploadStart() ユーザーがアップロードする[multipart/ form-data]を処理します。
void	UploadStart(java.lang.String DefaultPath) ユーザーがアップロードする[multipart/ form-data]を処理します。

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUpload

public FileUpload(javax.servlet.http.HttpServletRequest Request,
                  javax.servlet.http.HttpServletResponse Response)

Parameters:

Request - JSPの[HttpServletRequest]オブジェクト

Response - JSPの[HttpServletResponse]オブジェクト

FileUpload

public FileUpload(javax.servlet.http.HttpServletRequest Request,
                  javax.servlet.http.HttpServletResponse Response,
                  java.lang.String strCharSet)

Parameters:

Request - JSPの[HttpServletRequest]オブジェクト

Response - JSPの[HttpServletResponse]オブジェクト

strCharSet - エンコーディング文字セット

Method Detail

dispose

public void dispose()
             throws java.io.IOException,
                    DEXTUploadException

割り当てられた全てのリソースを解除します。 終了時にこのメソッドを呼び出さないと、[UploadStart()]メソッドの実行時に指定した[DefaultPath]の一時ファイルが削除されない場合があります。

Throws:

java.io.IOException

DEXTUploadException

UploadStart

public void UploadStart()
                 throws DEXTUploadException,
                        java.io.IOException

ユーザーがアップロードする[multipart/ form-data]を処理します。

Throws:

DEXTUploadException

java.io.IOException

UploadStart

public void UploadStart(java.lang.String DefaultPath)
                 throws DEXTUploadException,
                        java.io.IOException

ユーザーがアップロードする[multipart/ form-data]を処理します。

Parameters:

DefaultPath - 一時ファイル及びアップロードされたファイルを保存するデフォルトパスの値。このフォルダにおけるファイルの書き込み･削除の権限がなければなりません。

Throws:

DEXTUploadException

java.io.IOException

Flush

public void Flush()
           throws DEXTUploadException,
                  java.io.IOException

サーバーにファイル(一時ファイルを含む)を保存せず、ウェブブラウザから送られて来るあらゆるデータを無視して破棄します。

Throws:

DEXTUploadException

java.io.IOException

getParameter

public java.lang.String getParameter(java.lang.String _Name)

ユーザーが転送したフォームデータを取得します。重複した名前が使用されている場合は一番目のフォームデータを取得します。

Parameters:

_Name - フォーム名

Returns:

_Nameに該当する一番目のフォームデータ

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String _Name)

ユーザーが転送した_Nameに該当する全てのフォームデータを配列形式で取得します。

Parameters:

_Name - フォーム名

Returns:

_Nameに該当する全てのフォームデータ

getParameterMap

public java.util.Map getParameterMap()

ユーザーが転送した全てのフォームアイテムをMap形式で取得します。

Returns:

ユーザーが転送した全てのフォームデータ

getParameterNames

public java.util.Enumeration getParameterNames()

ユーザーが転送した全てのフォーム名を取得します。

Returns:

ユーザーが転送した全てのフォームデータの名前

getFileItem

public FileItem getFileItem(java.lang.String _Name)

ユーザーが転送した_Nameに該当するファイルアイテムを取得します。 重複した名前が使用されている場合は一番目のファイルアイテムを取得します。

Parameters:

_Name - フォーム名

Returns:

_Nameに該当する一番目の[FileItem]

getFileItemValues

public FileItem[] getFileItemValues(java.lang.String _Name)

ユーザーが転送した_Nameに該当する全てのファイルアイテムを配列形式で取得します。

Parameters:

_Name - フォーム名

Returns:

_Nameに該当する全てのフォームデータ

getFileItemMap

public java.util.Map getFileItemMap()

ユーザーが転送した全てのファイルアイテムをMap形式で取得します。

Returns:

ユーザーが転送した全ての[FileItem]

getFileItemNames

public java.util.Enumeration getFileItemNames()

ユーザーが転送した全てのファイルアイテムの名前を取得します。

Returns:

ユーザーが転送した全てのファイルアイテムの名前

setAutoMakeFolder

public void setAutoMakeFolder(boolean bAutoMake)

[DefaultPath][SaveAs]などに指定されたフォルダが存在しない場合はフォルダを自動的に生成します。

Parameters:

bAutoMake - True=フォルダが存在しない場合は自動的に生成します。/　False=フォルダが存在しなくても生成しません。

getAutoMakeFolder

public boolean getAutoMakeFolder()

[AutoMakeFolder]機能の設定を求めます。

Returns:

True=フォルダを自動的に生成するように設定します。/　False=フォルダを自動的に生成しません。

setMaxFileLength

public void setMaxFileLength(int nByteLength)
                      throws DEXTUploadException

アップロードが可能な最大ファイルサイズを制限します。 指定されたサイズより大きなファイルをアップロードしようとするとエラーが発生します。デフォルトは[2GB]です。最大2*1024*1024*1024-1(2GB)まで保存することができます。

Parameters:

nByteLength - - ファイルのサイズ(byte)

Throws:

DEXTUploadException

getMaxFileLength

public int getMaxFileLength()

アップロード可能な最大ファイルサイズを求めます。

Returns:

アップロード可能な最大ファイルサイズ

setMaxTotalLength

public void setMaxTotalLength(int nByteLength)
                       throws DEXTUploadException

アップロードされたファイルの総サイズの値を制限します。(例:多重ファイルアップロード時) デフォルトは[2GB]です。 最大2*1024*1024*1024-1(2GB)まで保存することができます。

Parameters:

nByteLength - - ファイルのサイズ(byte)

Throws:

DEXTUploadException

getMaxTotalLength

public int getMaxTotalLength()

アップロード可能なファイルの総サイズを求めます。

Returns:

アップロード可能なファイルの総サイズ

getUploadedLength

public int getUploadedLength()
                      throws DEXTUploadException

アップロードされた全てのファイル(フォームデータを含む)のサイズを求めます。

Returns:

アップロードされた全てのファイル(フォームデータを含む)のサイズ

Throws:

DEXTUploadException

setCharacterEncoding

public void setCharacterEncoding(java.lang.String strCharSet)
                          throws DEXTUploadException

フォームデータ処理時に使用するエンコーディング値を設定します。(デフォルトはUTF-8)

Parameters:

strCharSet - エンコーディング文字

Throws:

DEXTUploadException

getCharacterEncoding

public java.lang.String getCharacterEncoding()

現在設定されたCharacter Encodingの値を求めます。

Returns:

現在設定されているCharacter Encodingの値

setLicenseFilePath

public void setLicenseFilePath(java.lang.String strLicenseFilePath)

認証情報を有する[dextuploadj.config]ファイルの位置を設定します。 [dextuploadj.config]ファイルが保存されているフォルダにファイルの書き込み及び削除の権限がなければなりません。

Parameters:

strLicenseFilePath - [dextuploadj.config]ファイルの物理的パス

DeleteSavedFiles

public void DeleteSavedFiles()
                      throws DEXTUploadException

アップロードを通じてサーバーに保存した全てのファイルを削除します。

Throws:

DEXTUploadException

SetProgress

public void SetProgress(int nID)
                 throws DEXTUploadException

[Progress]オブジェクトの[GetProgressID()]が返す値を設定します。

Parameters:

nID - - [Progress]オブジェクトの[GetProgressID()]が返す値

Throws:

DEXTUploadException

See Also:

Progress.GetProgressID()