nablarch.common.web.download

クラス FileResponse

java.lang.Object

nablarch.fw.web.HttpResponse

nablarch.common.web.download.FileResponse

すべての実装されたインタフェース:

Result

public class FileResponse
extends HttpResponse

FileオブジェクトからHTTPレスポンスを生成するHttpResponse継承クラス。

作成者:

Naoki Yamamoto

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース nablarch.fw.web.HttpResponse

HttpResponse.Status

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.Result

Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileResponse(File file) コンストラクタ。
FileResponse(File file, boolean deleteOnCleanup) コンストラクタ。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
InputStream	getBodyStream() HTTPレスポンスボディの内容を保持するストリームを取得する。
boolean	isBodyEmpty() HTTPレスポンスボディの内容が設定されていなければtrueを返す。

クラスから継承されたメソッド nablarch.fw.web.HttpResponse

addCookie, getBodyString, getContentDisposition, getContentLength, getContentPath, getContentType, getCookie, getHeader, getHeaderMap, getHttpVersion, getLocation, getMessage, getReasonPhrase, getStatusCode, setBodyStream, setContentDisposition, setContentDisposition, setContentPath, setContentPath, setContentType, setCookie, setHeader, setLocation, setStatusCode, write, write, write

インタフェースから継承されたメソッド nablarch.fw.Result

isSuccess

コンストラクタの詳細

FileResponse

@Published
public FileResponse(File file)

コンストラクタ。

本コンストラクタを使用してインスタンスを生成した場合、 リクエスト処理の終了時に自動的にファイルは削除されない。

パラメータ:

file - ファイル

FileResponse

@Published
public FileResponse(File file,
                               boolean deleteOnCleanup)

コンストラクタ。

パラメータ:

file - ファイル

deleteOnCleanup - リクエスト処理の終了時に自動的にファイルを削除する場合はtrue

メソッドの詳細

isBodyEmpty

@Published(tag="architect")
public boolean isBodyEmpty()

HTTPレスポンスボディの内容が設定されていなければtrueを返す。

本クラスをインスタンス化する際にはボディを表すFileオブジェクトの指定が必須なため、 本メソッドは必ずfalseを返す。

オーバーライド:

isBodyEmpty クラス内 HttpResponse

戻り値:

必ずfalseを返す

getBodyStream

@Published(tag="architect")
public InputStream getBodyStream()

クラスからコピーされた説明: HttpResponse

HTTPレスポンスボディの内容を保持するストリームを取得する。

オーバーライド:

getBodyStream クラス内 HttpResponse

戻り値:

HTTPレスポンスボディの内容を保持するストリーム