public class HttpResponse extends java.lang.Object implements Result
setContentPath(String)
の値を設定することで後者の方式がとられるようになる。修飾子とタイプ | クラスと説明 |
---|---|
static class |
HttpResponse.Status
HTTPレスポンスステータス。
|
Result.ClientError, Result.Error, Result.MultiStatus, Result.NotFound, Result.Success
修飾子とタイプ | フィールドと説明 |
---|---|
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 オブジェクトを生成する。 |
修飾子とタイプ | メソッドと説明 |
---|---|
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レスポンスボディに文字列を書き込む。
|
public static final java.lang.String LS
protected static final java.lang.String CONTENT_DISPOSITION
@Published public HttpResponse()
HttpResponse
オブジェクトを生成する。
以下のHTTPレスポンスメッセージに相当するHttpResponse
オブジェクトを生成する。
HTTP/1.1 200 OK Content-Type: text/plain;charset=UTF-8
@Published public HttpResponse(int statusCode)
HttpResponse
オブジェクトを生成する。
このメソッドの処理は以下のソースコードと等価である。
new HttpResponse().setStatusCode(statusCode);
statusCode
- HTTPステータスコード@Published public HttpResponse(int statusCode, java.lang.String contentPath)
HttpResponse
オブジェクトを生成する。
このメソッドの処理は以下のソースコードと等価である。
new HttpResponse().setStatusCode(statusCode)
.setContentPath(contentPath);
statusCode
- HTTPステータスコードcontentPath
- コンテンツパス@Published public HttpResponse(java.lang.String contentPath)
HttpResponse
オブジェクトを生成する。
このメソッドの処理は以下のソースコードと等価である。
new HttpResponse().setStatusCode(200)
.setContentPath(contentPath);
contentPath
- コンテンツパスpublic static HttpResponse parse(java.lang.String message)
HttpResponse
オブジェクトを生成する。message
- HTTPレスポンスメッセージHttpResponse
オブジェクトpublic static HttpResponse parse(byte[] message)
HttpResponse
オブジェクトを生成する。message
- HTTPレスポンスメッセージHttpResponse
オブジェクト@Published public int getStatusCode()
302
を返す。getStatusCode
インタフェース内 Result
setStatusCode(int)
@Published public HttpResponse setStatusCode(int code)
200
である。code
- HTTPステータスコードjava.lang.IllegalArgumentException
- 指定されたステータスコードが無効な場合@Published public java.lang.String getReasonPhrase()
@Published public java.lang.String getMessage()
(ステータスコード): (ステータスフレーズ)
getMessage
インタフェース内 Result
@Published public java.lang.String getHttpVersion()
public HttpResponse setHttpVersion(java.lang.String httpVersion)
httpVersion
- HTTPバージョン名java.lang.IllegalArgumentException
- HTTPバージョンの書式が無効な場合@Published public java.util.Map<java.lang.String,java.lang.String> getHeaderMap()
@Published public java.lang.String getHeader(java.lang.String headerName)
headerName
- ヘッダー名@Published public void setHeader(java.lang.String headerName, java.lang.String value)
headerName
- ヘッダー名value
- ヘッダーの値@Published public java.lang.String getContentType()
this.headers().get("Content-Type")
public java.nio.charset.Charset getCharset()
@Published public HttpResponse setContentType(java.lang.String contentType)
contentType
- Content-Typeの値getContentType()
@Published public java.lang.String getLocation()
this.headers().get("Location")
@Published public HttpResponse setLocation(java.lang.String location)
location
- 遷移先URIHttpResponse.Status.SEE_OTHER
@Published public HttpResponse setContentDisposition(java.lang.String fileName)
fileName
- ファイル名@Published public HttpResponse setContentDisposition(java.lang.String fileName, boolean inline)
inline
にtrue
を指定した場合、ダウンロードされたファイルは
クライアントアプリで自動的に開かれる。fileName
- ファイル名inline
- インライン表示する場合はtrue
@Published(tag="architect") public java.lang.String getContentDisposition()
public java.lang.String getTransferEncoding()
this.headers().get("Transfer-Encoding")
public HttpResponse setTransferEncoding(java.lang.String encoding)
encoding
- Transfer-Encodingの値HttpResponse.Status.SEE_OTHER
@Published @Deprecated public HttpCookie getCookie()
getCookieList()
を使用してください。null
public java.util.List<javax.servlet.http.Cookie> getCookieList()
@Published @Deprecated public HttpResponse setCookie(HttpCookie cookie)
addCookie(HttpCookie)
に置き換わりました。cookie
- クッキー情報オブジェクト@Published public HttpResponse addCookie(HttpCookie cookie)
cookie
- クッキー情報オブジェクト@Published public HttpResponse setContentPath(java.lang.String path)
setContentPath(ResourceLocator)
に委譲する。path
- コンテンツパス@Published public HttpResponse setContentPath(ResourceLocator resource)
ResourceLocator
オブジェクトがnull
でない場合は、
リソース名からContent-Typeを自動的に設定した後、コンテンツパスを設定する。ResourceLocator
オブジェクトがnull
の場合は、コンテンツパスのみ設定する。resource
- コンテンツパスsetContentPath(String)
@Published public ResourceLocator getContentPath()
@Published public java.lang.String getContentLength()
null
を返す。public HttpResponse cleanup()
@Published(tag="architect") public boolean isBodyEmpty()
true
を返す。true
@Published(tag="architect") public java.lang.String getBodyString()
@Published(tag="architect") public java.io.InputStream getBodyStream()
@Published(tag="architect") public HttpResponse setBodyStream(java.io.InputStream bodyStream)
bodyStream
- HTTPレスポンスボディの内容を保持するストリーム@Published public HttpResponse write(java.lang.CharSequence text) throws HttpErrorResponse
HttpResponseHandler
にレスポンスオブジェクトが戻された後である。
また、このオブジェクトにコンテンツパスが設定されている場合、
このライタに書き込まれた内容は単に無視される。text
- 書き込む文字列HttpErrorResponse
- バッファの上限を越えてデータが書き込まれた場合@Published public HttpResponse write(byte[] bytes) throws HttpErrorResponse
HttpResponseHandler
にレスポンスオブジェクトが戻された後である。
また、このオブジェクトにコンテンツパスが設定されている場合、
このライタに書き込まれた内容は単に無視される。bytes
- 書き込むバイト配列HttpErrorResponse
- バッファの上限を越えてデータが書き込まれた場合@Published public HttpResponse write(java.nio.ByteBuffer bytes) throws HttpErrorResponse
HttpResponseHandler
にレスポンスオブジェクトが戻された後である。
また、このオブジェクトにコンテンツパスが設定されている場合、
このライタに書き込まれた内容は単に無視される。bytes
- 書き込むバイト列を格納したバッファHttpErrorResponse
- バッファの上限を越えてデータが書き込まれた場合public java.lang.String toString()
toString
クラス内 java.lang.Object