devpia.dextuploadnj.support.spring
Class DEXTUploadNJFileDownloadView

サポートされる最小バージョン

1.0.0

最小サポート環境

JRE 1.6, Spring Framework

説明

Springフレームワーク環境でファイル形式の応答をサポートするDEXTUploadNJAbstractDownloadableView抽象クラスの具体（Concrete）クラスである。

物理ファイルのデータをダウンロードしようとするときに使用するビュークラスである。

@RequestMapping(value = "マッピングURL", method = RequestMethod.GET)
public ModelAndView メソッド(...) {
    
  // ファイルをダウンロードするためにDEXTUploadNJFileDownloadViewオブジェクトを生成する。
  DEXTUploadNJFileDownloadView view = new DEXTUploadNJFileDownloadView();
    
  view.setFile(new File("ファイルのパス"));
  view.setFilename("ダウンロードするファイル名");
  view.setMime("text/plain");
  view.setCharsetName("UTF-8");
    
  // ダウンロードが開始される。
  return new ModelAndView(view);
}

コンストラクタ

DEXTUploadNJFileDownloadView

DEXTUploadNJFileDownloadViewクラスのオブジェクトを生成する。

形式

public DEXTUploadNJFileDownloadView()
public DEXTUploadNJFileDownloadView(File file)
public DEXTUploadNJFileDownloadView(File file, String filename)
public DEXTUploadNJFileDownloadView(File file, String filename, String mime)
public DEXTUploadNJFileDownloadView(File file, String filename, String mime, boolean inline)
public DEXTUploadNJFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache)
public DEXTUploadNJFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache, boolean removeAfterDownloading)
public DEXTUploadNJFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache, boolean removeAfterDownloading, int downloadStreamBufferSize)
public DEXTUploadNJFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache, boolean removeAfterDownloading, int downloadStreamBufferSize, long expiringTime)

# 2.7.0バージョンからサポート
public DEXTUploadNJFileDownloadView(File file, String filename, String mime, FileResponseContentDisposition contentDisposition, boolean useClientCache, boolean removeAfterDownloading, int downloadStreamBufferSize, long expiringTime)

# 2.14.0バージョンからサポート
public DEXTUploadNJFileDownloadView(File file, String filename, String mime, FileResponseContentDisposition contentDisposition, boolean useClientCache, boolean removeAfterDownloading, int downloadStreamBufferSize, long expiringTime, boolean useTomcatSendFile)

パラメータ

名前	形式	説明
file	java.io.File	ダウンロードする対象Fileオブジェクト
filename	java.lang.String	クライアントがダウンロードファイル名
mime	java.lang.String	Content-Typeヘッダの設定値です。デフォルトでは、application / octet-streamである。
inline	boolean	パラメータの値をtrueに設定すると、ファイルがダウンロードされず、ブラウザから直接開くこともできる。
useClientCache	boolean	クライアントキャッシュポリシーを使用するかどうか
removeAfterDownloading (バージョン1.2.0からサポート)	boolean	パラメータの値がtrueの場合、ダウンロード処理が完了した後で、対象のファイルを削除する。
downloadStreamBufferSize (1.2.2バージョンからサポート)	int	ダウンロードをするとき、応答ストリームに一度に記録するバッファの大きさ。デフォルトは32768バイトです。
expiringTime (2.2.0バージョンからサポート)	long	キャッシュの有効期限を定めるための時間値。デフォルトは31536000秒である。
contentDisposition (2.7.0バージョンからサポート)	devpia.dextuploadnj.FileResponseContentDisposition	ファイルコンテンツがブラウザに渡される方式
useTomcatSendFile (2.14.0以上)	boolean	TomcatのsendFileを使用するかどうか

メソッド

getFile

ダウンロードする対象java.io.Fileオブジェクトを返します。
形式
```
public File getFile()
```
リターン

ダウンロードする対象java.io.Fileオブジェクト

setFile

ダウンロードする対象java.io.Fileオブジェクトを設定する。
形式
```
public void setFile(File file)
```

パラメータ

名前	形式	説明
file	java.io.File	ダウンロードする対象Fileオブジェクト

isAllowingWeakRange

RangeリクエストヘッダのみPartial Contentダウンロードを実行するかどうかを返します。

（Partial Contentダウンロードとは、データの一部のみを応答データにリターンするものである。）
形式
```
public boolean isAllowingWeakRange()
```
リターン

trueの場合Rangeヘッダだけで処理、falseの場合は、If-Rangeヘッダを検査する。

setAllowingWeakRange

RangeリクエストヘッダのみPartial Contentダウンロードを実行するかどうかを設定する。

（Partial Contentダウンロードとは、データの一部のみを応答データにリターンするものである。）

形式

public void setAllowingWeakRange(boolean allowingWeakRange)

パラメータ

名前	形式	説明
allowingWeakRange	boolean	trueの場合Rangeヘッダだけで処理、falseの場合は、If-Rangeヘッダを検査する。

isUseClientCache

クライアントのキャッシュを使用するかどうかを返します。
形式
```
public boolean isUseClientCache()
```
リターン

trueの場合、キャッシュポリシーを使用しているものであり、falseの場合は使用しない。

setUseClientCache

クライアントのキャッシュを使用するかどうかを設定する。

ストリームのダウンロードの場合にtrueに設定しても、キャッシュポリシーを使用していない。

形式

public void setUseClientCache(boolean useClientCache)

パラメータ

名前	形式	説明
useClientCache	boolean	trueの場合、キャッシュポリシーを使用しているものであり、falseの場合は使用しない。

isRemoveAfterDownloading (バージョン1.2.0からサポート)

ファイルをダウンロードした後、対象のファイルを削除するかどうかを返します。

形式

public boolean isRemoveAfterDownloading()

リターン

true, false

setRemoveAfterDownloading (バージョン1.2.0からサポート)

ファイルをダウンロードした後、対象のファイルを削除するかどうかを設定する。

ファイルの削除機能は、添付形式でファイルの全体をダウンロードする状態でのみ動作し、他のシステムが対象のファイルを先取りした場合、ファイルの削除が失敗することができる。

形式

public void setRemoveAfterDownloading(boolean removeAfterDownloading)

パラメータ

名前	形式	説明
removeAfterDownloading	boolean	ファイルを削除するには、trueに設定します。

getExpiringTime (2.2.0バージョンからサポート)

キャッシュの有効期限応答ヘッダーの設定に必要な時間の値を返します。
形式
```
public long getExpiringTime()
```
リターン

キャッシュの有効期限応答ヘッダーの設定に必要な秒単位の時間値

setExpiringTime (2.2.0バージョンからサポート)

キャッシュの有効期限応答ヘッダーの設定に必要な時間の値を設定する。
形式
```
public void setExpiringTime(long time)
```

パラメータ

名前	形式	説明
time	long	秒単位の設定値

getUseTomcatSendFile (1.2.0バージョンからサポート)

ファイルダウンロードにTomcatのsendFileを使用するかどうかを返す。
形式
```
public boolean getUseTomcatSendFile()
```
戻り値

trueまたはfalse、デフォルト値はfalseである。

setUseTomcatSendFile (1.2.0バージョンからサポート)

ファイルダウンロードにTomcatのsendFileを使用するかどうかを設定する。

（注意）この設定は、HTTP圧縮が設定されている場合や、サーブレットフィルターを通して応答データを制御する構造では使用できないため、エラーが発生した場合はこの値をfalseに設定し、基本で提供されるダウンロード方式を使用するようにする。

形式

public void setUseTomcatSendFile(boolean useTomatSendFile)

パラメータ

名前	形式	説明
useTomatSendFile	boolean	sendFileを使用する場合はtrue、使用しない場合はfalse

doRenderImpl

DEXTUploadNJAbstractDownloadableView抽象クラスのdoRenderImplメソッドを参照すること。

getFilename

DEXTUploadNJAbstractDownloadableView抽象クラスのgetFilenameメソッドを参照すること。

setFilename

DEXTUploadNJAbstractDownloadableView抽象クラスのsetFilenameメソッドを参照すること。

getMime

DEXTUploadNJAbstractDownloadableView抽象クラスのgetMimeメソッドを参照すること。

setMime

DEXTUploadNJAbstractDownloadableView抽象クラスのsetMimeメソッドを参照すること。

isInline

DEXTUploadNJAbstractDownloadableView抽象クラスのisInlineメソッドを参照すること。

setInline

DEXTUploadNJAbstractDownloadableView抽象クラスのsetInlineメソッドを参照すること。

getCharsetName

DEXTUploadNJAbstractDownloadableView抽象クラスのgetCharsetNameメソッドを参照すること。

setCharsetName

DEXTUploadNJAbstractDownloadableView抽象クラスのsetCharsetNameメソッドを参照すること。

getDownloadStreamBufferSize

DEXTUploadNJAbstractDownloadableView抽象クラスのgetDownloadStreamBufferSizeメソッドを参照すること。

setDownloadStreamBufferSize

DEXTUploadNJAbstractDownloadableView抽象クラスのsetDownloadStreamBufferSizeメソッドを参照すること。

getContentDisposition

See the getContentDisposition method of the DEXTUploadNJAbstractDownloadableView class.

setContentDisposition

See the setContentDisposition method of the DEXTUploadNJAbstractDownloadableView class

devpia.dextuploadnj.support.springClass DEXTUploadNJFileDownloadView

devpia.dextuploadnj.support.spring
Class DEXTUploadNJFileDownloadView