FileResponse (Nablarch-API)

java.lang.Object
- nablarch.fw.web.HttpResponse
- - nablarch.common.web.download.FileResponse

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

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

ネストされたクラスのサマリー
- クラスから継承されたネストされたクラス/インタフェース nablarch.fw.web.HttpResponse
  HttpResponse.Status
- インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.Result
  Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success

フィールドのサマリー
- クラスから継承されたフィールド nablarch.fw.web.HttpResponse
  CONTENT_DISPOSITION, LS

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

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`HttpResponse`	`cleanup()` リソースを開放する。
`java.io.InputStream`	`getBodyStream()` HTTPレスポンスボディの内容を保持するストリームを取得する。
`java.lang.String`	`getBodyString()` HTTPレスポンスボディの内容を表す文字列を返す。
`java.lang.String`	`getContentLength()` Content-Lengthの値を取得する。
`ResourceLocator`	`getContentPath()` コンテンツパスを取得する。
`boolean`	`isBodyEmpty()` HTTPレスポンスボディの内容が設定されていなければ`true`を返す。
`HttpResponse`	`setBodyStream(java.io.InputStream bodyStream)` HTTPレスポンスボディの内容を保持するストリームを設定する。
`HttpResponse`	`setContentPath(ResourceLocator resource)` コンテンツパスを設定する。
`HttpResponse`	`setContentPath(java.lang.String path)` コンテンツパスを設定する。
`java.lang.String`	`toString()` オブジェクトの内容と等価なHTTPレスポンスメッセージを返す。
`HttpResponse`	`write(byte[] bytes)` HTTPレスポンスボディにバイト配列を書き込む。
`HttpResponse`	`write(java.nio.ByteBuffer bytes)` HTTPレスポンスボディにバイト配列を書き込む。
`HttpResponse`	`write(java.lang.CharSequence text)` HTTPレスポンスボディに文字列を書き込む。

クラスから継承されたメソッド nablarch.fw.web.HttpResponse
addCookie, getCharset, getContentDisposition, getContentType, getCookie, getCookieList, getHeader, getHeaderMap, getHttpVersion, getLocation, getMessage, getReasonPhrase, getStatusCode, getTransferEncoding, isSuccess, parse, parse, setContentDisposition, setContentDisposition, setContentType, setCookie, setHeader, setHttpVersion, setLocation, setStatusCode, setTransferEncoding

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - FileResponse
```
@Published
public FileResponse(java.io.File file)
```
    コンストラクタ。
    本コンストラクタを使用してインスタンスを生成した場合、リクエスト処理の終了時に自動的にファイルは削除されない。
    
    パラメータ:
    
    file - ファイル
  - FileResponse
```
@Published
public FileResponse(java.io.File file,
                               boolean deleteOnCleanup)
```
    コンストラクタ。
    
    パラメータ:
    
    file - ファイル
    
    deleteOnCleanup - リクエスト処理の終了時に自動的にファイルを削除する場合はtrue
- メソッドの詳細
  - getContentLength
```
public java.lang.String getContentLength()
```
    クラスからコピーされた説明: HttpResponse
    
    Content-Lengthの値を取得する。
    HTTPレスポンスボディの内容がこのオブジェクト自体に保持されている場合に限り、そのバイト数を返す。
    それ以外はnullを返す。
    
    オーバーライド:
    
    getContentLength クラス内 HttpResponse
    
    戻り値:
    
    Content-Lengthの値
  - isBodyEmpty
```
@Published(tag="architect")
public boolean isBodyEmpty()
```
    HTTPレスポンスボディの内容が設定されていなければtrueを返す。
    本クラスをインスタンス化する際にはボディを表すFileオブジェクトの指定が必須なため、本メソッドは必ずfalseを返す。
    
    オーバーライド:
    
    isBodyEmpty クラス内 HttpResponse
    
    戻り値:
    
    必ずfalseを返す
  - getBodyString
```
public java.lang.String getBodyString()
```
    クラスからコピーされた説明: HttpResponse
    
    HTTPレスポンスボディの内容を表す文字列を返す。
    
    オーバーライド:
    
    getBodyString クラス内 HttpResponse
    
    戻り値:
    
    ボディの内容を表す文字列を返す
  - getBodyStream
```
@Published(tag="architect")
public java.io.InputStream getBodyStream()
```
    クラスからコピーされた説明: HttpResponse
    
    HTTPレスポンスボディの内容を保持するストリームを取得する。
    
    オーバーライド:
    
    getBodyStream クラス内 HttpResponse
    
    戻り値:
    
    HTTPレスポンスボディの内容を保持するストリーム
  - toString
```
public java.lang.String toString()
```
    クラスからコピーされた説明: HttpResponse
    
    オブジェクトの内容と等価なHTTPレスポンスメッセージを返す。
    
    オーバーライド:
    
    toString クラス内 HttpResponse
  - cleanup
```
public HttpResponse cleanup()
```
    クラスからコピーされた説明: HttpResponse
    
    リソースを開放する。
    
    オーバーライド:
    
    cleanup クラス内 HttpResponse
    
    戻り値:
    
    本オブジェクト
  - getContentPath
```
public ResourceLocator getContentPath()
```
    コンテンツパスを取得する。
    HTTPレスポンスボディに書き込むコンテンツパスを取得する。
    本クラスではコンテンツパスを設定できないため、本メソッドは必ずnullを返す。
    
    オーバーライド:
    
    getContentPath クラス内 HttpResponse
    
    戻り値:
    
    必ずnullを返す。
  - setBodyStream
```
public HttpResponse setBodyStream(java.io.InputStream bodyStream)
```
    クラスからコピーされた説明: HttpResponse
    
    HTTPレスポンスボディの内容を保持するストリームを設定する。
    
    オーバーライド:
    
    setBodyStream クラス内 HttpResponse
    
    パラメータ:
    
    bodyStream - HTTPレスポンスボディの内容を保持するストリーム
    
    戻り値:
    
    本オブジェクト
  - setContentPath
```
public HttpResponse setContentPath(java.lang.String path)
```
    クラスからコピーされた説明: HttpResponse
    
    コンテンツパスを設定する。
    本処理はHttpResponse.setContentPath(ResourceLocator)に委譲する。
    
    オーバーライド:
    
    setContentPath クラス内 HttpResponse
    
    パラメータ:
    
    path - コンテンツパス
    
    戻り値:
    
    本オブジェクト
  - setContentPath
```
public HttpResponse setContentPath(ResourceLocator resource)
```
    クラスからコピーされた説明: HttpResponse
    
    コンテンツパスを設定する。
    指定したResourceLocatorオブジェクトがnullでない場合は、リソース名からContent-Typeを自動的に設定した後、コンテンツパスを設定する。
    ResourceLocatorオブジェクトがnullの場合は、コンテンツパスのみ設定する。
    
    オーバーライド:
    
    setContentPath クラス内 HttpResponse
    
    パラメータ:
    
    resource - コンテンツパス
    
    戻り値:
    
    本オブジェクト
    
    関連項目:
    
    HttpResponse.setContentPath(String)
  - write
```
public HttpResponse write(java.lang.CharSequence text)
```
    クラスからコピーされた説明: HttpResponse
    
    HTTPレスポンスボディに文字列を書き込む。
    このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。)
    実際にソケットに対するレスポンス処理が行われるのは、 HttpResponseHandlerにレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
    
    オーバーライド:
    
    write クラス内 HttpResponse
    
    パラメータ:
    
    text - 書き込む文字列
    
    戻り値:
    
    本オブジェクト
  - write
```
public HttpResponse write(byte[] bytes)
```
    クラスからコピーされた説明: HttpResponse
    
    HTTPレスポンスボディにバイト配列を書き込む。
    このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。)
    実際にソケットに対するレスポンス処理が行われるのは、 HttpResponseHandlerにレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
    
    オーバーライド:
    
    write クラス内 HttpResponse
    
    パラメータ:
    
    bytes - 書き込むバイト配列
    
    戻り値:
    
    本オブジェクト
  - write
```
public HttpResponse write(java.nio.ByteBuffer bytes)
```
    クラスからコピーされた説明: HttpResponse
    
    HTTPレスポンスボディにバイト配列を書き込む。
    このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。)
    実際にソケットに対するレスポンス処理が行われるのは、 HttpResponseHandlerにレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
    
    オーバーライド:
    
    write クラス内 HttpResponse
    
    パラメータ:
    
    bytes - 書き込むバイト列を格納したバッファ
    
    戻り値:
    
    本オブジェクト

クラス FileResponse

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

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

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

フィールドのサマリー

クラスから継承されたフィールド nablarch.fw.web.HttpResponse

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

メソッドのサマリー

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

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

FileResponse

FileResponse

メソッドの詳細

getContentLength

isBodyEmpty

getBodyString

getBodyStream

toString

cleanup

getContentPath

setBodyStream

setContentPath

setContentPath

write

write

write