devpia.dextuploadnj.support.spring
Class DEXTUploadNJStreamDownloadView

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

1.0.0

最小サポート環境

JRE 1.6, Spring Framework

説明

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

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

@RequestMapping(value = "マッピングURL", method = RequestMethod.GET)
public ModelAndView メソッド() 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"));
      
    // ストリーム形式でダウンロードするためにDEXTUploadNJStreamDownloadViewオブジェクトを生成する。
    DEXTUploadNJStreamDownloadView view = new DEXTUploadNJStreamDownloadView();
      
    // 入力ストリームを設定する。
    view.setInputStream(is);
    view.setFilename("ダウンロードするファイル名");
    view.setMime("text/plain");
    view.setCharsetName("UTF-8");
    // ストリームが自動的に閉じられるように設定する。（バージョン1.3.0から）
    view.setAutoClosingStream(true);
      
    return new ModelAndView(view);
}

DEXTUploadNJStreamDownloadViewオブジェクトを使用してダウンロードを実行する場合、クライアントCacheは使用しないように処理され、Partial Contentダウンロードなどの機能は提供されない。

コンストラクタ

DEXTUploadNJStreamDownloadView

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

形式

public DEXTUploadNJStreamDownloadView()
public DEXTUploadNJStreamDownloadView(InputStream inputStream)
public DEXTUploadNJStreamDownloadView(InputStream inputStream, String filename)
public DEXTUploadNJStreamDownloadView(InputStream inputStream, String filename, String mime)
public DEXTUploadNJStreamDownloadView(InputStream inputStream, String filename, String mime, boolean inline)
public DEXTUploadNJStreamDownloadView(InputStream inputStream, String filename, String mime, boolean inline, int downloadStreamBufferSize)
public DEXTUploadNJStreamDownloadView(InputStream inputStream, String filename, String mime, boolean inline, 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 (1.2.2バージョンからサポート)	int	ダウンロードをするとき、応答ストリームに一度に記録するバッファの大きさ。デフォルトは32768バイトです。
autoClosingStream (バージョン1.3.0からサポート)	boolean	データを応答ストリームの両方に記録すれば、InputStreamオブジェクトを閉じるかどうかを設定する。デフォルト値はfalseである。

メソッド

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 (バージョン1.3.0からサポート)

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

true, false

setAutoClosingStream (バージョン1.3.0からサポート)

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

形式

public void setAutoClosingStream(boolean autoClosingStream)

パラメータ

名前	形式	説明
autoClosingStream	boolean	パラメータの値がtrueの場合、応答データを応答バッファーに書いた後、InputStreamオブジェクトを閉める。