nablarch.common.web.download

Class FileResponse

java.lang.Object

nablarch.fw.web.HttpResponse

nablarch.common.web.download.FileResponse

All Implemented Interfaces:

Result

public class FileResponse
extends HttpResponse

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

Author:

Naoki Yamamoto

Nested Class Summary

Nested classes/interfaces inherited from class nablarch.fw.web.HttpResponse

HttpResponse.Status

Nested classes/interfaces inherited from interface nablarch.fw.Result

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

Constructor Summary

Constructors

Constructor and Description
FileResponse(java.io.File file) コンストラクタ。 本コンストラクタを使用してインスタンスを生成した場合、 リクエスト処理の終了時に自動的にファイルは削除されない。
FileResponse(java.io.File file, boolean deleteOnCleanup) コンストラクタ。

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	getBodyStream() HTTPレスポンスボディの内容を保持するストリームを取得する。
boolean	isBodyEmpty() HTTPレスポンスボディの内容が設定されていなければtrueを返す。

Methods inherited from class nablarch.fw.web.HttpResponse

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

Methods inherited from interface nablarch.fw.Result

isSuccess

Constructor Detail

FileResponse

@Published
public FileResponse(java.io.File file)

コンストラクタ。

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

Parameters:

file - ファイル

FileResponse

@Published
public FileResponse(java.io.File file,
                               boolean deleteOnCleanup)

コンストラクタ。

Parameters:

file - ファイル

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

Method Detail

isBodyEmpty

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

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

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

Overrides:

isBodyEmpty in class HttpResponse

Returns:

必ずfalseを返す

getBodyStream

@Published(tag="architect")
public java.io.InputStream getBodyStream()

Description copied from class: HttpResponse

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

Overrides:

getBodyStream in class HttpResponse

Returns:

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