FileResponse (Nablarch-API)

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

All Implemented Interfaces:

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

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

Field Summary
- Fields inherited from class nablarch.fw.web.HttpResponse
  CONTENT_DISPOSITION, LS

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpResponse`	`cleanup()` リソースを開放する。
`java.io.InputStream`	`getBodyStream()` HTTPレスポンスボディの内容を保持するストリームを取得する。
`java.lang.String`	`getBodyString()` HTTPレスポンスボディの内容を表す文字列を返す。
`java.lang.String`	`getContentLength()` Content-Lengthの値を取得する。 HTTPレスポンスボディの内容がこのオブジェクト自体に保持されている場合に限り、そのバイト数を返す。それ以外は`null`を返す。
`ResourceLocator`	`getContentPath()` コンテンツパスを取得する。 HTTPレスポンスボディに書き込むコンテンツパスを取得する。
`boolean`	`isBodyEmpty()` HTTPレスポンスボディの内容が設定されていなければ`true`を返す。
`HttpResponse`	`setBodyStream(java.io.InputStream bodyStream)` HTTPレスポンスボディの内容を保持するストリームを設定する。
`HttpResponse`	`setContentPath(ResourceLocator resource)` コンテンツパスを設定する。指定した`ResourceLocator`オブジェクトが`null`でない場合は、リソース名からContent-Typeを自動的に設定した後、コンテンツパスを設定する。 `ResourceLocator`オブジェクトが`null`の場合は、コンテンツパスのみ設定する。
`HttpResponse`	`setContentPath(java.lang.String path)` コンテンツパスを設定する。本処理は`HttpResponse.setContentPath(ResourceLocator)`に委譲する。
`java.lang.String`	`toString()` オブジェクトの内容と等価なHTTPレスポンスメッセージを返す。
`HttpResponse`	`write(byte[] bytes)` HTTPレスポンスボディにバイト配列を書き込む。このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。) 実際にソケットに対するレスポンス処理が行われるのは、 `HttpResponseHandler`にレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
`HttpResponse`	`write(java.nio.ByteBuffer bytes)` HTTPレスポンスボディにバイト配列を書き込む。このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。) 実際にソケットに対するレスポンス処理が行われるのは、 `HttpResponseHandler`にレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
`HttpResponse`	`write(java.lang.CharSequence text)` HTTPレスポンスボディに文字列を書き込む。このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。) 実際にソケットに対するレスポンス処理が行われるのは、 `HttpResponseHandler`にレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。

Methods inherited from class 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Class FileResponse

Nested Class Summary

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

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

Field Summary

Fields inherited from class nablarch.fw.web.HttpResponse

Constructor Summary

Method Summary

Methods inherited from class nablarch.fw.web.HttpResponse

Methods inherited from class java.lang.Object

Constructor Detail

FileResponse

FileResponse

Method Detail

getContentLength

isBodyEmpty

getBodyString

getBodyStream

toString

cleanup

getContentPath

setBodyStream

setContentPath

setContentPath

write

write

write