HttpResponse (NablarchApi)

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

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

Result

直系の既知のサブクラス:

DataRecordResponse, FileResponse, StreamResponse
```
public class HttpResponse
extends Object
implements Result
```
HTTPレスポンスメッセージを生成する際に必要な情報を格納したクラス。
HTTPクライアントに対するレスポンス処理をフレームワークが行うために必要な以下の情報を保持する。
- レスポンスステータスコード
- レスポンスヘッダ
- レスポンスボディ
レスポンスボディの内容は、以下のいずれかの方式によって保持する。
1. 内容をこのオブジェクトに直接保持する方式(バッファ方式)
2. ボディに書き込むコンテンツファイルのパスのみを指定する方式(コンテンツパス方式)
HttpResponse.setContentPath(String) の値を設定することで後者の方式がとられるようになる。
メモリ消費の観点や、コンテンツファイル管理の容易さから、通常はコンテンツパスによる方式を使用すべきである。
作成者:

Iwauo Tajima , Masato Inoue

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

ネストされたクラス
修飾子とタイプクラスと説明

static class HttpResponse.Status
HTTPレスポンスステータス。
- インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.Result
  Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`HttpResponse.Status` HTTPレスポンスステータス。

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

コンストラクタ
コンストラクタと説明
`HttpResponse()` `HttpResponse`オブジェクトを生成する。
`HttpResponse(int statusCode)` 指定されたステータスコードの`HttpResponse`オブジェクトを生成する。
`HttpResponse(int statusCode, String contentPath)` 指定されたHTTPステータスコードとコンテンツパスの`HttpResponse`オブジェクトを生成する。
`HttpResponse(String contentPath)` 指定されたコンテンツパスの`HttpResponse`オブジェクトを生成する。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`HttpResponse`	`addCookie(HttpCookie cookie)` サーバ側から送信されたクッキー情報を設定する。
`InputStream`	`getBodyStream()` HTTPレスポンスボディの内容を保持するストリームを取得する。
`String`	`getBodyString()` HTTPレスポンスボディの内容を表す文字列を返す。
`String`	`getContentDisposition()` Content-Dispositionの値を取得する。
`String`	`getContentLength()` Content-Lengthの値を取得する。
`ResourceLocator`	`getContentPath()` コンテンツパスを取得する。
`String`	`getContentType()` Content-Typeの値を取得する。
`HttpCookie`	`getCookie()` 非推奨です。本メソッドは、複数のクッキー情報のうち先頭のクッキーを返すことしかできません。複数のクッキー情報を返すことができる`#getCookieList()`を使用してください。
`String`	`getHeader(String headerName)` HTTPレスポンスヘッダの値を返す。
`Map`	`getHeaderMap()` HTTPレスポンスヘッダを格納するMapを返す。
`String`	`getHttpVersion()` HTTPバージョンを表す文字列を返す。
`String`	`getLocation()` Locationの値を取得する。
`String`	`getMessage()` 処理結果に対する詳細情報を返す。
`String`	`getReasonPhrase()` HTTPレスポンスのステータスフレーズを返す。
`int`	`getStatusCode()` HTTPレスポンスのステータスコードの値を返す。
`boolean`	`isBodyEmpty()` HTTPレスポンスボディの内容が設定されていなければ`true`を返す。
`HttpResponse`	`setBodyStream(InputStream bodyStream)` HTTPレスポンスボディの内容を保持するストリームを設定する。
`HttpResponse`	`setContentDisposition(String fileName)` Content-Dispositionの値を設定する。
`HttpResponse`	`setContentDisposition(String fileName, boolean inline)` Content-Dispositionの値を設定する。
`HttpResponse`	`setContentPath(ResourceLocator resource)` コンテンツパスを設定する。
`HttpResponse`	`setContentPath(String path)` コンテンツパスを設定する。
`HttpResponse`	`setContentType(String contentType)` Content-Typeを設定する。
`HttpResponse`	`setCookie(HttpCookie cookie)` 非推奨です。本メソッドは、複数のクッキー情報を設定することを意図したメソッド名を持つ `HttpResponse.addCookie(HttpCookie)`に置き換わりました。
`void`	`setHeader(String headerName, String value)` HTTPレスポンスヘッダの値を設定する。
`HttpResponse`	`setLocation(String location)` Locationの値を設定する。
`HttpResponse`	`setStatusCode(int code)` HTTPレスポンスのステータスコードを設定する。
`HttpResponse`	`write(byte[] bytes)` HTTPレスポンスボディにバイト配列を書き込む。
`HttpResponse`	`write(ByteBuffer bytes)` HTTPレスポンスボディにバイト配列を書き込む。
`HttpResponse`	`write(CharSequence text)` HTTPレスポンスボディに文字列を書き込む。

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

- コンストラクタの詳細
  - HttpResponse
```
@Published
public HttpResponse()
```
    HttpResponseオブジェクトを生成する。
    以下のHTTPレスポンスメッセージに相当するHttpResponseオブジェクトを生成する。
```
     HTTP/1.1 200 OK
     Content-Type: text/plain;charset=UTF-8
 
```
  - HttpResponse
```
@Published
public HttpResponse(int statusCode)
```
    指定されたステータスコードのHttpResponseオブジェクトを生成する。
    このメソッドの処理は以下のソースコードと等価である。
```
     new HttpResponse().setStatusCode(statusCode);
 
```
    パラメータ:
    
    statusCode - HTTPステータスコード
  - HttpResponse
```
@Published
public HttpResponse(int statusCode,
                               String contentPath)
```
    指定されたHTTPステータスコードとコンテンツパスのHttpResponseオブジェクトを生成する。
    このメソッドの処理は以下のソースコードと等価である。
```
     new HttpResponse().setStatusCode(statusCode)
                       .setContentPath(contentPath);
 
```
    パラメータ:
    
    statusCode - HTTPステータスコード
    
    contentPath - コンテンツパス
  - HttpResponse
```
@Published
public HttpResponse(String contentPath)
```
    指定されたコンテンツパスのHttpResponseオブジェクトを生成する。
    このメソッドの処理は以下のソースコードと等価である。
```
     new HttpResponse().setStatusCode(200)
                       .setContentPath(contentPath);
 
```
    パラメータ:
    
    contentPath - コンテンツパス
- メソッドの詳細
  - getStatusCode
```
@Published
public int getStatusCode()
```
    HTTPレスポンスのステータスコードの値を返す。
    HTTPレスポンスがリダイレクトである場合は302を返す。
    
    定義:
    
    getStatusCode インタフェース内 Result
    
    戻り値:
    
    HTTPステータスコード
    
    関連項目:
    
    HttpResponse.setStatusCode(int)
  - setStatusCode
```
@Published
public HttpResponse setStatusCode(int code)
```
    HTTPレスポンスのステータスコードを設定する。
    デフォルトのステータスコードは200である。
    
    パラメータ:
    
    code - HTTPステータスコード
    
    戻り値:
    
    本オブジェクト
    
    例外:
    
    IllegalArgumentException - 指定されたステータスコードが無効な場合
  - getReasonPhrase
```
@Published
public String getReasonPhrase()
```
    HTTPレスポンスのステータスフレーズを返す。
    
    戻り値:
    
    ステータスフレーズ
  - getMessage
```
@Published
public String getMessage()
```
    処理結果に対する詳細情報を返す。
    返される詳細情報は以下の通りである。
```
   (ステータスコード): (ステータスフレーズ)
 
```
    定義:
    
    getMessage インタフェース内 Result
    
    戻り値:
    
    詳細情報
  - getHttpVersion
```
@Published
public String getHttpVersion()
```
    HTTPバージョンを表す文字列を返す。
    
    戻り値:
    
    HTTPバージョン名
  - getHeaderMap
```
@Published
public Map getHeaderMap()
```
    HTTPレスポンスヘッダを格納するMapを返す。
    このMapに対する変更はレスポンスヘッダの内容に直接反映される。
    
    戻り値:
    
    HTTPレスポンスヘッダを格納するMap
  - getHeader
```
@Published
public String getHeader(String headerName)
```
    HTTPレスポンスヘッダの値を返す。
    
    パラメータ:
    
    headerName - ヘッダー名
    
    戻り値:
    
    ヘッダーの値
  - setHeader
```
@Published
public void setHeader(String headerName,
                                 String value)
```
    HTTPレスポンスヘッダの値を設定する。
    
    パラメータ:
    
    headerName - ヘッダー名
    
    value - ヘッダーの値
  - getContentType
```
@Published
public String getContentType()
```
    Content-Typeの値を取得する。
    Content-Typeが設定されていない場合は、"text/plain;charset=UTF-8"を設定して返す。このメソッドの処理は以下のソースコードと等価である。
```
   this.headers().get("Content-Type")
 
```
    戻り値:
    
    Contents-Typeの値
  - setContentType
```
@Published
public HttpResponse setContentType(String contentType)
```
    Content-Typeを設定する。
    Content-Typeのデフォルト値は、"text/plain;charset=UTF-8" である。
    ボディに書き込む内容をコンテンツパスで指定する場合、 Content-Typeはコンテンツパスの拡張子から自動的に決定される為、このメソッドを明示的に使用する必要は無い。
    
    パラメータ:
    
    contentType - Content-Typeの値
    
    戻り値:
    
    本オブジェクト
    
    関連項目:
    
    HttpResponse.getContentType()
  - getLocation
```
@Published
public String getLocation()
```
    Locationの値を取得する。
    このメソッドの処理は以下のソースコードと等価である。
```
   this.headers().get("Location")
 
```
    戻り値:
    
    Locationの値
  - setLocation
```
@Published
public HttpResponse setLocation(String location)
```
    Locationの値を設定する。
    リダイレクト時のHTTPクライアントの遷移先URIを設定する。
    デフォルトでは設定されない。
    
    パラメータ:
    
    location - 遷移先URI
    
    戻り値:
    
    本オブジェクト
    
    関連項目:
    
    HttpResponse.Status.SEE_OTHER
  - setContentDisposition
```
@Published
public HttpResponse setContentDisposition(String fileName)
```
    Content-Dispositionの値を設定する。
    Content-Typeが明示的に設定されていない場合、設定されたファイル名の拡張子に応じたContent-Typeを自動的に設定する。
    本メソッドではattachment属性を指定するため、ダウンロード時にダイアログが必ず表示される。
    
    パラメータ:
    
    fileName - ファイル名
    
    戻り値:
    
    本オブジェクト
  - setContentDisposition
```
@Published
public HttpResponse setContentDisposition(String fileName,
                                                     boolean inline)
```
    Content-Dispositionの値を設定する。
    Content-Typeが明示的に設定されていない場合、設定されたファイル名の拡張子に応じたContent-Typeを自動的に設定する。
    inlineにtrueを指定した場合、ダウンロードされたファイルはクライアントアプリで自動的に開かれる。
    ただし、実際にそのような挙動となるかどうかは、クライアントの設定およびOSのセキュリティ設定に依存する。
    
    パラメータ:
    
    fileName - ファイル名
    
    inline - インライン表示する場合はtrue
    
    戻り値:
    
    本オブジェクト
  - getContentDisposition
```
@Published(tag="architect")
public String getContentDisposition()
```
    Content-Dispositionの値を取得する。
    
    戻り値:
    
    Content-Dispositionの値
  - getCookie
```
@Published
 @Deprecated
public HttpCookie getCookie()
```
    非推奨です。本メソッドは、複数のクッキー情報のうち先頭のクッキーを返すことしかできません。複数のクッキー情報を返すことができる#getCookieList()を使用してください。
    
    サーバ側から送信されたクッキー情報のうち先頭のクッキーをを取得する。
    
    戻り値:
    
    サーバ側から送信されたクッキー情報のうち先頭のクッキー。クッキーが存在しない場合はnull
  - setCookie
```
@Published
 @Deprecated
public HttpResponse setCookie(HttpCookie cookie)
```
    非推奨です。本メソッドは、複数のクッキー情報を設定することを意図したメソッド名を持つ HttpResponse.addCookie(HttpCookie)に置き換わりました。
    
    サーバ側から送信されたクッキー情報を設定する。
    
    パラメータ:
    
    cookie - クッキー情報オブジェクト
    
    戻り値:
    
    本オブジェクト
  - addCookie
```
@Published
public HttpResponse addCookie(HttpCookie cookie)
```
    サーバ側から送信されたクッキー情報を設定する。
    
    パラメータ:
    
    cookie - クッキー情報オブジェクト
    
    戻り値:
    
    本オブジェクト
  - setContentPath
```
@Published
public HttpResponse setContentPath(String path)
```
    コンテンツパスを設定する。
    本処理はHttpResponse.setContentPath(ResourceLocator)に委譲する。
    
    パラメータ:
    
    path - コンテンツパス
    
    戻り値:
    
    本オブジェクト
  - setContentPath
```
@Published
public HttpResponse setContentPath(ResourceLocator resource)
```
    コンテンツパスを設定する。
    指定したResourceLocatorオブジェクトがnullでない場合は、リソース名からContent-Typeを自動的に設定した後、コンテンツパスを設定する。
    ResourceLocatorオブジェクトがnullの場合は、コンテンツパスのみ設定する。
    
    パラメータ:
    
    resource - コンテンツパス
    
    戻り値:
    
    本オブジェクト
    
    関連項目:
    
    HttpResponse.setContentPath(String)
  - getContentPath
```
@Published
public ResourceLocator getContentPath()
```
    コンテンツパスを取得する。
    HTTPレスポンスボディに書き込むコンテンツパスを取得する。
    
    戻り値:
    
    コンテンツパス
  - getContentLength
```
@Published
public String getContentLength()
```
    Content-Lengthの値を取得する。
    HTTPレスポンスボディの内容がこのオブジェクト自体に保持されている場合に限り、そのバイト数を返す。
    それ以外はnullを返す。
    
    戻り値:
    
    Content-Lengthの値
  - isBodyEmpty
```
@Published(tag="architect")
public boolean isBodyEmpty()
```
    HTTPレスポンスボディの内容が設定されていなければtrueを返す。
    
    戻り値:
    
    ボディの内容が設定されていなければtrue
  - getBodyString
```
@Published(tag="architect")
public String getBodyString()
```
    HTTPレスポンスボディの内容を表す文字列を返す。
    
    戻り値:
    
    ボディの内容を表す文字列を返す
  - getBodyStream
```
@Published(tag="architect")
public InputStream getBodyStream()
```
    HTTPレスポンスボディの内容を保持するストリームを取得する。
    
    戻り値:
    
    HTTPレスポンスボディの内容を保持するストリーム
  - setBodyStream
```
@Published(tag="architect")
public HttpResponse setBodyStream(InputStream bodyStream)
```
    HTTPレスポンスボディの内容を保持するストリームを設定する。
    
    パラメータ:
    
    bodyStream - HTTPレスポンスボディの内容を保持するストリーム
    
    戻り値:
    
    本オブジェクト
  - write
```
@Published
public HttpResponse write(CharSequence text)
                              throws HttpErrorResponse
```
    HTTPレスポンスボディに文字列を書き込む。
    このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。)
    実際にソケットに対するレスポンス処理が行われるのは、 nablarch.fw.web.handler.HttpResponseHandlerにレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
    
    パラメータ:
    
    text - 書き込む文字列
    
    戻り値:
    
    本オブジェクト
    
    例外:
    
    HttpErrorResponse - バッファの上限を越えてデータが書き込まれた場合
  - write
```
@Published
public HttpResponse write(byte[] bytes)
                              throws HttpErrorResponse
```
    HTTPレスポンスボディにバイト配列を書き込む。
    このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。)
    実際にソケットに対するレスポンス処理が行われるのは、 nablarch.fw.web.handler.HttpResponseHandlerにレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
    
    パラメータ:
    
    bytes - 書き込むバイト配列
    
    戻り値:
    
    本オブジェクト
    
    例外:
    
    HttpErrorResponse - バッファの上限を越えてデータが書き込まれた場合
  - write
```
@Published
public HttpResponse write(ByteBuffer bytes)
                              throws HttpErrorResponse
```
    HTTPレスポンスボディにバイト配列を書き込む。
    このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。)
    実際にソケットに対するレスポンス処理が行われるのは、 nablarch.fw.web.handler.HttpResponseHandlerにレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
    
    パラメータ:
    
    bytes - 書き込むバイト列を格納したバッファ
    
    戻り値:
    
    本オブジェクト
    
    例外:
    
    HttpErrorResponse - バッファの上限を越えてデータが書き込まれた場合

クラス HttpResponse

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

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

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

メソッドのサマリー

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

コンストラクタの詳細

HttpResponse

HttpResponse

HttpResponse

HttpResponse

メソッドの詳細

getStatusCode

setStatusCode

getReasonPhrase

getMessage

getHttpVersion

getHeaderMap

getHeader

setHeader

getContentType

setContentType

getLocation

setLocation

setContentDisposition

setContentDisposition

getContentDisposition

getCookie

setCookie

addCookie

setContentPath

setContentPath

getContentPath

getContentLength

isBodyEmpty

getBodyString

getBodyStream

setBodyStream

write

write

write