dextuploadjk.support.spring
Class JKStreamDownloadView

最小サポートバージョン

1.0.0

最小サポート環境

Java 17, Spring Framework 6.0.14, Spring Boot 3.0.12

説明

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

物理ファイルではなく、メモリ上のデータをダウンロードしたい場合に使用します。

@RequestMapping(value = "download-stream", method = RequestMethod.GET)
public ModelAndView downloadStream() throws IOException {
  
    // '0123456789'で記録されたテキストデータをファイルにダウンロードする。
    StringBuffer sb = new StringBuffer();
    for (int i = 0; i < 1000; i++) {
        sb.append("0123456789\r\n");
    }

    InputStream is = new ByteArrayInputStream(sb.toString().getBytes("UTF-8"));
      
	//ストリーム形式でダウンロードするためにJKStreamDownloadViewオブジェクトを作成します。.
    JKStreamDownloadView view = new JKStreamDownloadView();
      
    //入力ストリームを設定します。
    view.setInputStream(is);
    view.setFilename("ダウンロードするファイル名");
    view.setMime("text/plain");
    view.setCharsetName("UTF-8");
    // ストリームが自動的に閉じるように設定します。
    view.setAutoClosingStream(true);
      
    return new ModelAndView(view);
}

When using a JKStreamDownloadView object to perform a download, the client cache is disabled and features such as downloading partial content are not available.

コンストラクタ

JKStreamDownloadView

Create an object of class JKStreamDownloadView.

形式

public JKStreamDownloadView()
public JKStreamDownloadView(InputStream inputStream)
public JKStreamDownloadView(InputStream inputStream, String filename)
public JKStreamDownloadView(InputStream inputStream, String filename, String mime)
public JKStreamDownloadView(InputStream inputStream, String filename, String mime, boolean inline)
public JKStreamDownloadView(InputStream inputStream, String filename, String mime, boolean inline, int downloadStreamBufferSize)
public JKStreamDownloadView(InputStream inputStream, String filename, String mime, boolean inline, int downloadStreamBufferSize, boolean autoClosingStream)
public JKStreamDownloadView(InputStream inputStream, String filename, String mime, FileResponseContentDisposition contentDisposition, int downloadStreamBufferSize, boolean autoClosingStream)

パラメータ

名前	形式	説明
inputStream	java.io.InputStream	データを提供する InputStream オブジェクト
filename	java.lang.String	クライアントがダウンロードするファイル名
mime	java.lang.String	Content-Type ヘッダ設定値。デフォルトはapplication / octet-streamです。
inline	boolean	パラメータ値をtrueに設定すると、ファイルはダウンロードされず、ブラウザで直接開くことができます。
downloadStreamBufferSize	int	ダウンロードを行うときに、応答ストリームに一度に書き込むバッファーのサイズ。デフォルト値は32768バイトです。
autoClosingStream	boolean	データをすべて応答ストリームに書き込むと、InputStreamオブジェクトを閉じるかどうかを設定します。デフォルト値はfalseです。
contentDisposition	dextuploadjk.FileResponseContentDisposition	ファイルコンテンツがブラウザに配信される方法

メソッド

getInputStream

データを提供する java.io.InputStream オブジェクトを返します。
形式
```
public InputStream getInputStream()
```
リターン

データを提供する java.io.InputStream オブジェクト

setInputStream

データを提供するjava.io.InputStreamオブジェクトを設定します。

形式

public void setInputStream(InputStream inputStream)

パラメータ

名前	形式	説明
inputStream	java.io.InputStream	データを提供する InputStream オブジェクト

isAutoClosingStream

データをダウンロードすると、自動的にInputStreamオブジェクトを閉じるかどうかを返します。
形式
```
public boolean isAutoClosingStream()
```
リターン

true, false

setAutoClosingStream

データをダウンロードするときに、自動的にInputStreamオブジェクトを閉じるかどうかを設定します。

形式

public void setAutoClosingStream(boolean autoClosingStream)

パラメータ

名前	形式	説明
autoClosingStream	boolean	パラメータ値が true の場合、応答データを応答バッファに書き込み、InputStream オブジェクトを閉じます。