HttpResponse (NablarchApi)

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

All Implemented Interfaces:

Result

Direct Known Subclasses:

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

Iwauo Tajima , Masato Inoue

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HttpResponse.Status
HTTPレスポンスステータス。
- Nested classes/interfaces inherited from interface nablarch.fw.Result
  Result.Success

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpResponse.Status` HTTPレスポンスステータス。

Constructor Summary

Constructors
Constructor and Description
`HttpResponse()` `HttpResponse`オブジェクトを生成する。以下のHTTPレスポンスメッセージに相当する`HttpResponse`オブジェクトを生成する。
`HttpResponse(int statusCode)` 指定されたステータスコードの`HttpResponse`オブジェクトを生成する。このメソッドの処理は以下のソースコードと等価である。
`HttpResponse(int statusCode, java.lang.String contentPath)` 指定されたHTTPステータスコードとコンテンツパスの`HttpResponse`オブジェクトを生成する。このメソッドの処理は以下のソースコードと等価である。
`HttpResponse(java.lang.String contentPath)` 指定されたコンテンツパスの`HttpResponse`オブジェクトを生成する。このメソッドの処理は以下のソースコードと等価である。

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`HttpResponse`	`addCookie(nablarch.fw.web.HttpCookie cookie)` サーバ側から送信されたクッキー情報を設定する。
`java.lang.String`	`getContentLength()` Content-Lengthの値を取得する。 HTTPレスポンスボディの内容がこのオブジェクト自体に保持されている場合に限り、そのバイト数を返す。それ以外は`null`を返す。
`ResourceLocator`	`getContentPath()` コンテンツパスを取得する。 HTTPレスポンスボディに書き込むコンテンツパスを取得する。
`java.lang.String`	`getContentType()` Content-Typeの値を取得する。 Content-Typeが設定されている場合は、以下のソースコードと等価である。
`nablarch.fw.web.HttpCookie`	`getCookie()` Deprecated. 本メソッドは、複数のクッキー情報のうち先頭のクッキーを返すことしかできません。複数のクッキー情報を返すことができる`#getCookieList()`を使用してください。
`java.lang.String`	`getHeader(java.lang.String headerName)` HTTPレスポンスヘッダの値を返す。
`java.util.Map`	`getHeaderMap()` HTTPレスポンスヘッダを格納するMapを返す。このMapに対する変更はレスポンスヘッダの内容に直接反映される。
`java.util.List`	`getHttpCookies()` サーバ側から送信されたクッキーのリストを`HttpCookie`として取得する。 `HttpCookie`は同じ属性を持つ複数のクッキーを保持する仕様であるため、クッキーの属性が各々異なることを考慮し、リストとして返却する。
`java.lang.String`	`getHttpVersion()` HTTPバージョンを表す文字列を返す。
`java.lang.String`	`getLocation()` Locationの値を取得する。このメソッドの処理は以下のソースコードと等価である。
`java.lang.String`	`getMessage()` 処理結果に対する詳細情報を返す。返される詳細情報は以下の通りである。
`java.lang.String`	`getReasonPhrase()` HTTPレスポンスのステータスフレーズを返す。
`int`	`getStatusCode()` HTTPレスポンスのステータスコードの値を返す。 HTTPレスポンスがリダイレクトである場合は`302`を返す。
`HttpResponse`	`setContentDisposition(java.lang.String fileName)` Content-Dispositionの値を設定する。 Content-Typeが明示的に設定されていない場合、設定されたファイル名の拡張子に応じたContent-Typeを自動的に設定する。本メソッドではattachment属性を指定するため、ダウンロード時にダイアログが必ず表示される。
`HttpResponse`	`setContentDisposition(java.lang.String fileName, boolean inline)` Content-Dispositionの値を設定する。 Content-Typeが明示的に設定されていない場合、設定されたファイル名の拡張子に応じたContent-Typeを自動的に設定する。 `inline`に`true`を指定した場合、ダウンロードされたファイルはクライアントアプリで自動的に開かれる。ただし、実際にそのような挙動となるかどうかは、クライアントの設定およびOSのセキュリティ設定に依存する。
`HttpResponse`	`setContentPath(ResourceLocator resource)` コンテンツパスを設定する。指定した`ResourceLocator`オブジェクトが`null`でない場合は、リソース名からContent-Typeを自動的に設定した後、コンテンツパスを設定する。 `ResourceLocator`オブジェクトが`null`の場合は、コンテンツパスのみ設定する。
`HttpResponse`	`setContentPath(java.lang.String path)` コンテンツパスを設定する。本処理は`HttpResponse.setContentPath(ResourceLocator)`に委譲する。
`HttpResponse`	`setContentType(java.lang.String contentType)` Content-Typeを設定する。 Content-Typeのデフォルト値は、"text/plain;charset=UTF-8" である。ボディに書き込む内容をコンテンツパスで指定する場合、 Content-Typeはコンテンツパスの拡張子から自動的に決定される為、このメソッドを明示的に使用する必要は無い。
`HttpResponse`	`setCookie(nablarch.fw.web.HttpCookie cookie)` Deprecated. 本メソッドは、複数のクッキー情報を設定することを意図したメソッド名を持つ `HttpResponse.addCookie(HttpCookie)`に置き換わりました。
`void`	`setHeader(java.lang.String headerName, java.lang.String value)` HTTPレスポンスヘッダの値を設定する。
`HttpResponse`	`setLocation(java.lang.String location)` Locationの値を設定する。リダイレクト時のHTTPクライアントの遷移先URIを設定する。デフォルトでは設定されない。
`HttpResponse`	`setStatusCode(int code)` HTTPレスポンスのステータスコードを設定する。デフォルトのステータスコードは`200`である。
`HttpResponse`	`write(byte[] bytes)` HTTPレスポンスボディにバイト配列を書き込む。このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。) 実際にソケットに対するレスポンス処理が行われるのは、 `nablarch.fw.web.handler.HttpResponseHandler`にレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
`HttpResponse`	`write(java.nio.ByteBuffer bytes)` HTTPレスポンスボディにバイト配列を書き込む。このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。) 実際にソケットに対するレスポンス処理が行われるのは、 `nablarch.fw.web.handler.HttpResponseHandler`にレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。
`HttpResponse`	`write(java.lang.CharSequence text)` HTTPレスポンスボディに文字列を書き込む。このメソッドで書き込まれたデータは、本オブジェクトが保持するバッファに保持され、クライアントソケットに対する書き込みは一切発生しない。 (このライタに対するflush()は単に無視される。) 実際にソケットに対するレスポンス処理が行われるのは、 `nablarch.fw.web.handler.HttpResponseHandler`にレスポンスオブジェクトが戻された後である。また、このオブジェクトにコンテンツパスが設定されている場合、このライタに書き込まれた内容は単に無視される。

Methods inherited from interface nablarch.fw.Result
isSuccess

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

Class HttpResponse

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from interface nablarch.fw.Result

Constructor Detail

HttpResponse

HttpResponse

HttpResponse

HttpResponse

Method Detail

getStatusCode

setStatusCode

getReasonPhrase

getMessage

getHttpVersion

getHeaderMap

getHeader

setHeader

getContentType

setContentType

getLocation

setLocation

setContentDisposition

setContentDisposition

getCookie

getHttpCookies

setCookie

addCookie

setContentPath

setContentPath

getContentPath

getContentLength

write

write

write