ResponseBody (Nablarch-API)

java.lang.Object
- nablarch.fw.web.ResponseBody

public class ResponseBody
extends java.lang.Object

HTTPレスポンスのボディ内容を格納するオブジェクト。

 レスポンスボディの内容を以下の3つの方式のいずれかによって指定する。
 (排他利用)
 1. コンテンツパスによる静的リソースの指定。
     HttpResponse.setContentPath(ResourceLocator)
 2. 入力ストリームによる指定。
     HttpResponse.setBodyStream(InputStream)
 3. 内部バッファへの書き込み。
     HttpResponse.write(byte[])
     HttpResponse.write(CharSequence)

内部バッファは一定サイズまではヒープ領域上に置かれるが、それを超えた場合は一時ファイルに出力される。入力ストリーム一時ファイルは、レスポンス処理終了後に HttpResponseHandler が cleanup() を呼ぶことで自動的に削除される。

関連項目:: HttpResponse, HttpResponseHandler

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

コンストラクタ
コンストラクタと説明

ResponseBody(HttpResponse response)
コンストラクタ

コンストラクタ
コンストラクタと説明
`ResponseBody(HttpResponse response)` コンストラクタ

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static void`	`addTempFileToDelete(java.io.File file)` 削除しなければならない一時ファイルに追加する。
`static void`	`cleanup()` カレントスレッドがIO用に確保しているリソースを全て開放する。
`ResourceLocator`	`getContentPath()` コンテンツパスを取得する。
`java.io.InputStream`	`getInputStream()` ボディの内容を格納した入力ストリームを返す。
`boolean`	`isEmpty()` ボディの内容が設定されていなければtrueを返す。
`java.lang.Long`	`length()` ボディの内容をヒープバッファに保持している場合、そのサイズを返す。
`ResponseBody`	`setContentPath(ResourceLocator path)` ボディのコンテンツパスを設定する。
`ResponseBody`	`setInputStream(java.io.InputStream input)` ボディの内容を格納した入力ストリームを設定する。
`java.lang.String`	`toString()` この実装ではボディの内容を表す文字列を返す。
`ResponseBody`	`write(byte[] bytes)` 内部バッファにバイナリデータを書き込む。
`ResponseBody`	`write(java.nio.ByteBuffer bytes)` 内部バッファにバイナリデータを書き込む。
`ResponseBody`	`write(java.lang.CharSequence text)` 内部バッファにキャラクタデータを書き込む。

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

- コンストラクタの詳細
  - ResponseBody
```
public ResponseBody(HttpResponse response)
```
    コンストラクタ
    
    パラメータ:
    
    response - HTTPレスポンス本体
- メソッドの詳細
  - isEmpty
```
public boolean isEmpty()
```
    ボディの内容が設定されていなければtrueを返す。
    
    戻り値:
    
    ボディの内容が設定されていなければtrue
  - length
```
public java.lang.Long length()
```
    ボディの内容をヒープバッファに保持している場合、そのサイズを返す。
```
 内部バッファを使用していない場合、もしくは、
 内部バッファとして一時ファイルを使用している場合は null を返す。
 
```
    戻り値:
    
    ヒープバッファのサイズ
  - setContentPath
```
public ResponseBody setContentPath(ResourceLocator path)
```
    ボディのコンテンツパスを設定する。
    
    パラメータ:
    
    path - コンテンツパス
    
    戻り値:
    
    このオブジェクト自体
  - getContentPath
```
public ResourceLocator getContentPath()
```
    コンテンツパスを取得する。
    
    戻り値:
    
    コンテンツパス
  - write
```
public ResponseBody write(byte[] bytes)
```
    内部バッファにバイナリデータを書き込む。
    
    パラメータ:
    
    bytes - バイナリデータ
    
    戻り値:
    
    このオブジェクト自体
  - write
```
public ResponseBody write(java.lang.CharSequence text)
```
    内部バッファにキャラクタデータを書き込む。
    
    パラメータ:
    
    text - キャラクタデータ
    
    戻り値:
    
    このオブジェクト自体
  - write
```
public ResponseBody write(java.nio.ByteBuffer bytes)
```
    内部バッファにバイナリデータを書き込む。
```
 要求サイズがヒープバッファの上限値を超過した場合、
 一時ファイルへの書き出しが許可されていれば、
 ヒープバッファを破棄し、以降は一時ファイルをバッファとして使用する。
 (ヒープバッファは直近のGCにより開放される。)
 一時ファイルへの書き出しが許可されていないばあい、
 レスポンスコード400に相当するHTTPエラーを送出する。
 
```
    パラメータ:
    
    bytes - バイナリデータ
    
    戻り値:
    
    このオブジェクト自体
  - toString
```
public java.lang.String toString()
```
    この実装ではボディの内容を表す文字列を返す。
```
 1. コンテンツパスが指定されている場合。
     パス文字列を返す。

 2. 入力ストリームもしくは一時ファイル上にバッファリングしている場合。
     先頭16KBの内容をデコードした文字列を返す。

 3. ヒープ上にバッファリングしている場合。
     バッファの内容をデコードした文字列を返す。
 
```
    オーバーライド:
    
    toString クラス内 java.lang.Object
    
    関連項目:
    
    デコードに使用するコンバータ
  - getInputStream
```
public java.io.InputStream getInputStream()
```
    ボディの内容を格納した入力ストリームを返す。なお、コンテントパスを使用している場合、以下のケースではnullを返却する。
```
 1. コンテントパスのスキームが file:// もしくは classpath:// のいずれでもない場合
 2. コンテントパスのスキームが file:// もしくは classpath:// だが、その参照先のファイルが存在しない場合。
 
```
    戻り値:
    
    入力ストリーム
  - setInputStream
```
public ResponseBody setInputStream(java.io.InputStream input)
```
    ボディの内容を格納した入力ストリームを設定する。
    
    パラメータ:
    
    input - 入力ストリーム
    
    戻り値:
    
    このオブジェクト自体
  - addTempFileToDelete
```
public static void addTempFileToDelete(java.io.File file)
```
    削除しなければならない一時ファイルに追加する。
    cleanup()メソッドが呼ばれた際に指定された一時ファイルが削除される。
    
    パラメータ:
    
    file - 一時ファイル
  - cleanup
```
public static void cleanup()
```
    カレントスレッドがIO用に確保しているリソースを全て開放する。

クラス ResponseBody

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

メソッドのサマリー

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

コンストラクタの詳細

ResponseBody

メソッドの詳細

isEmpty

length

setContentPath

getContentPath

write

write

write

toString

getInputStream

setInputStream

addTempFileToDelete

cleanup