HttpResponse (Nablarch-API)

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

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

Result

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

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

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

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

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

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

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected static java.lang.String`	`CONTENT_DISPOSITION` Content-Dispositionヘッダ。
`static java.lang.String`	`LS` HTTP行終端文字(CRLF)

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

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

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`HttpResponse`	`addCookie(HttpCookie cookie)` サーバ側から送信されたクッキー情報を設定する。
`HttpResponse`	`cleanup()` リソースを開放する。
`java.io.InputStream`	`getBodyStream()` HTTPレスポンスボディの内容を保持するストリームを取得する。
`java.lang.String`	`getBodyString()` HTTPレスポンスボディの内容を表す文字列を返す。
`java.nio.charset.Charset`	`getCharset()` Content-Typeに指定された文字エンコーディングを取得する。
`java.lang.String`	`getContentDisposition()` Content-Dispositionの値を取得する。
`java.lang.String`	`getContentLength()` Content-Lengthの値を取得する。
`ResourceLocator`	`getContentPath()` コンテンツパスを取得する。
`java.lang.String`	`getContentType()` Content-Typeの値を取得する。
`HttpCookie`	`getCookie()` 非推奨です。本メソッドは、複数のクッキー情報のうち先頭のクッキーを返すことしかできません。複数のクッキー情報を返すことができる`getCookieList()`を使用してください。
`java.util.List<javax.servlet.http.Cookie>`	`getCookieList()` サーバ側から送信されたクッキー情報のリストを取得する。
`java.lang.String`	`getHeader(java.lang.String headerName)` HTTPレスポンスヘッダの値を返す。
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaderMap()` HTTPレスポンスヘッダを格納するMapを返す。
`java.lang.String`	`getHttpVersion()` HTTPバージョンを表す文字列を返す。
`java.lang.String`	`getLocation()` Locationの値を取得する。
`java.lang.String`	`getMessage()` 処理結果に対する詳細情報を返す。
`java.lang.String`	`getReasonPhrase()` HTTPレスポンスのステータスフレーズを返す。
`int`	`getStatusCode()` HTTPレスポンスのステータスコードの値を返す。
`java.lang.String`	`getTransferEncoding()` Transfer-Encodingの値を取得する。
`boolean`	`isBodyEmpty()` HTTPレスポンスボディの内容が設定されていなければ`true`を返す。
`boolean`	`isSuccess()` 処理が正常終了したかどうかを返す。
`static HttpResponse`	`parse(byte[] message)` HTTPレスポンスメッセージの内容から`HttpResponse`オブジェクトを生成する。
`static HttpResponse`	`parse(java.lang.String message)` HTTPレスポンスメッセージの内容から`HttpResponse`オブジェクトを生成する。
`HttpResponse`	`setBodyStream(java.io.InputStream bodyStream)` HTTPレスポンスボディの内容を保持するストリームを設定する。
`HttpResponse`	`setContentDisposition(java.lang.String fileName)` Content-Dispositionの値を設定する。
`HttpResponse`	`setContentDisposition(java.lang.String fileName, boolean inline)` Content-Dispositionの値を設定する。
`HttpResponse`	`setContentPath(ResourceLocator resource)` コンテンツパスを設定する。
`HttpResponse`	`setContentPath(java.lang.String path)` コンテンツパスを設定する。
`HttpResponse`	`setContentType(java.lang.String contentType)` Content-Typeを設定する。
`HttpResponse`	`setCookie(HttpCookie cookie)` 非推奨です。本メソッドは、複数のクッキー情報を設定することを意図したメソッド名を持つ `addCookie(HttpCookie)`に置き換わりました。
`void`	`setHeader(java.lang.String headerName, java.lang.String value)` HTTPレスポンスヘッダの値を設定する。
`HttpResponse`	`setHttpVersion(java.lang.String httpVersion)` HTTPバージョンを設定する。
`HttpResponse`	`setLocation(java.lang.String location)` Locationの値を設定する。
`HttpResponse`	`setStatusCode(int code)` HTTPレスポンスのステータスコードを設定する。
`HttpResponse`	`setTransferEncoding(java.lang.String encoding)` Transfer-Encodingの値を設定する。
`java.lang.String`	`toString()` オブジェクトの内容と等価なHTTPレスポンスメッセージを返す。
`HttpResponse`	`write(byte[] bytes)` HTTPレスポンスボディにバイト配列を書き込む。
`HttpResponse`	`write(java.nio.ByteBuffer bytes)` HTTPレスポンスボディにバイト配列を書き込む。
`HttpResponse`	`write(java.lang.CharSequence text)` HTTPレスポンスボディに文字列を書き込む。

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

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

クラス HttpResponse

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

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

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

LS

CONTENT_DISPOSITION

コンストラクタの詳細

HttpResponse

HttpResponse

HttpResponse

HttpResponse

メソッドの詳細

parse

parse

getStatusCode

setStatusCode

getReasonPhrase

getMessage

getHttpVersion

setHttpVersion

getHeaderMap

getHeader

setHeader

getContentType

getCharset

setContentType

getLocation

setLocation

setContentDisposition

setContentDisposition

getContentDisposition

getTransferEncoding

setTransferEncoding

getCookie

getCookieList

setCookie

addCookie

setContentPath

setContentPath

getContentPath

getContentLength

cleanup

isBodyEmpty

getBodyString

getBodyStream

setBodyStream

write

write

write

toString

isSuccess