dextuploadjk.support.spring
Class JKFileDownloadView

最小サポートバージョン

1.0.0

最小サポート環境

Java 17, Spring Framework 6.0.14, Spring Boot 3.0.12

説明

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

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

@RequestMapping(value = "download-file", method = RequestMethod.GET)
public ModelAndView download(...) {
    
  // ファイルをダウンロードするためにJKFileDownloadViewオブジェクトを生成する。 
  JKFileDownloadView view = new JKFileDownloadView();
    
  view.setFile(new File("ファイルパス"));
  view.setFilename("ダウンロード時に使用するファイル名");
  view.setMime("text/plain");
  view.setCharsetName("UTF-8");
    
  return new ModelAndView(view);
}

コンストラクタ

JKFileDownloadView

JKFileDownloadView クラスのオブジェクトを作成します。

形式

public JKFileDownloadView()
public JKFileDownloadView(File file)
public JKFileDownloadView(File file, String filename)
public JKFileDownloadView(File file, String filename, String mime)
public JKFileDownloadView(File file, String filename, String mime, boolean inline)
public JKFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache)
public JKFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache, boolean removeAfterDownloading)
public JKFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache, boolean removeAfterDownloading, int downloadStreamBufferSize)
public JKFileDownloadView(File file, String filename, String mime, boolean inline, boolean useClientCache, boolean removeAfterDownloading, int downloadStreamBufferSize, long expiringTime)
public JKFileDownloadView(File file, String filename, String mime, FileResponseContentDisposition contentDisposition, boolean useClientCache, boolean removeAfterDownloading, int downloadStreamBufferSize, long expiringTime)
public JKFileDownloadView(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	boolean	パラメータの値がtrueの場合、ダウンロード処理が完了した後で、対象のファイルを削除する。
downloadStreamBufferSize	int	ダウンロードをするとき、応答ストリームに一度に記録するバッファの大きさ。デフォルトは32768バイトです。
expiringTime	long	キャッシュの有効期限を決定するための時間値。デフォルト値は31536000秒です。
contentDisposition	dextuploadjk.engine.FileResponseContentDisposition	ファイルコンテンツがブラウザに配信される方法
useTomcatSendFile (1.2.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

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

形式

public boolean isRemoveAfterDownloading()

リターン

true, false

setRemoveAfterDownloading

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

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

形式

public void setRemoveAfterDownloading(boolean removeAfterDownloading)

パラメータ

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

getExpiringTime

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

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

setExpiringTime

キャッシュの有効期限応答ヘッダーの設定に必要な時間の値を設定する。
形式
```
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

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

getFilename

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

setFilename

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

getMime

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

setMime

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

isInline

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

setInline

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

getCharsetName

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

setCharsetName

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

getDownloadStreamBufferSize

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

setDownloadStreamBufferSize

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

getContentDisposition

JKAbstractDownloadableView抽象クラスのgetContentDispositionメソッドを参照してください。

setContentDisposition

JKAbstractDownloadableView抽象クラスのsetContentDispositionメソッドを参照してください。

dextuploadjk.support.springClass JKFileDownloadView

dextuploadjk.support.spring
Class JKFileDownloadView