nablarch.fw.web.handler

クラス HttpResponseHandler

java.lang.Object

nablarch.fw.web.handler.HttpResponseHandler

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

Handler<HttpRequest,HttpResponse>

public class HttpResponseHandler
extends java.lang.Object
implements Handler<HttpRequest,HttpResponse>

ServletAPIを通じてHTTPレスポンス処理を行うハンドラ。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected static java.lang.String	USER_AGENT User-Agentヘッダ。

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

コンストラクタ

コンストラクタと説明
HttpResponseHandler()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
HttpResponse	handle(HttpRequest req, ExecutionContext ctx) 入力データに対する処理を実行する。
protected boolean	isErrorResponse(HttpResponse res) レスポンスがエラーか否かを判定する。
void	setContentPathRule(ResourcePathRule contentPathRule) 言語対応コンテンツパスのルールを設定する。
void	setConvertMode(java.lang.String convertMode) HTTPレスポンスコードの変換モードを設定する。
HttpResponseHandler	setDownloadFileNameEncoderFactory(DownloadFileNameEncoderFactory factory) ダウンロードファイル名のエンコーダを取得するクラスを設定する
void	setForceFlushAfterWritingHeaders(boolean usesFlush) HTTPヘッダーをwriteした直後にFlushするかどうかの設定 デフォルト値はtrueである。
protected static void	setStatusCode(HttpResponse res, ServletExecutionContext ctx) クライアントに送信するステータスコードを設定する。
static void	writeBody(java.io.InputStream in, javax.servlet.http.HttpServletResponse nativeRes) メッセージボディの内容をクライアントに送信する。
void	writeResponse(HttpResponse res, ServletExecutionContext ctx) HTTPレスポンスオブジェクトの内容をもとに、 クライアントにレスポンスを返す。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

USER_AGENT

protected static final java.lang.String USER_AGENT

User-Agentヘッダ。

関連項目:

定数フィールド値

コンストラクタの詳細

HttpResponseHandler

public HttpResponseHandler()

メソッドの詳細

setForceFlushAfterWritingHeaders

public void setForceFlushAfterWritingHeaders(boolean usesFlush)

HTTPヘッダーをwriteした直後にFlushするかどうかの設定 デフォルト値はtrueである。

パラメータ:

usesFlush - Flushの有無

setDownloadFileNameEncoderFactory

public HttpResponseHandler setDownloadFileNameEncoderFactory(DownloadFileNameEncoderFactory factory)

ダウンロードファイル名のエンコーダを取得するクラスを設定する

パラメータ:

factory - ダウンロードファイル名のエンコーダを取得するクラス

戻り値:

このオブジェクト自体。

setConvertMode

public void setConvertMode(java.lang.String convertMode)

HTTPレスポンスコードの変換モードを設定する。

HTTPレスポンスコードの変換モードは以下のいずれかである。

• CONVERT_ONLY_400_TO_200
• CONVERT_ALL_TO_200

デフォルトは、CONVERT_ONLY_400_TO_200である。

設定した値は、HttpResponseUtil.chooseResponseStatusCode(HttpResponse, ServletExecutionContext)で使用される。
変換の仕様については、HttpResponseUtil.chooseResponseStatusCode(HttpResponse, ServletExecutionContext)を参照。

パラメータ:

convertMode - HTTPレスポンスコードの変換モード。

handle

public HttpResponse handle(HttpRequest req,
                           ExecutionContext ctx)
                    throws java.lang.ClassCastException

入力データに対する処理を実行する。

この実装では、後続ハンドラの処理結果(HttpResponse)の内容をもとに、 クライアントに対するレスポンス処理を行う。

定義:

handle インタフェース内 Handler<HttpRequest,HttpResponse>

パラメータ:

req - 入力データ

ctx - 実行コンテキスト

戻り値:

処理結果データ

例外:

java.lang.ClassCastException - 引数 ctx の実際の型が ServletExecutionContext でない場合。

writeResponse

public void writeResponse(HttpResponse res,
                          ServletExecutionContext ctx)

HTTPレスポンスオブジェクトの内容をもとに、 クライアントにレスポンスを返す。

パラメータ:

res - HTTPレスポンスオブジェクト

ctx - 実行コンテキスト

isErrorResponse

protected boolean isErrorResponse(HttpResponse res)

レスポンスがエラーか否かを判定する。

ステータスコードが200～300系以外であればtrue、 それ以外であればfalseを返す。

パラメータ:

res - HTTPレスポンス

戻り値:

判定結果

setContentPathRule

public void setContentPathRule(ResourcePathRule contentPathRule)

言語対応コンテンツパスのルールを設定する。

パラメータ:

contentPathRule - 言語対応コンテンツパスのルール

setStatusCode

protected static void setStatusCode(HttpResponse res,
                                    ServletExecutionContext ctx)

クライアントに送信するステータスコードを設定する。

パラメータ:

res - HTTPレスポンスオブジェクト

ctx - 実行コンテキスト

writeBody

public static void writeBody(java.io.InputStream in,
                             javax.servlet.http.HttpServletResponse nativeRes)
                      throws java.io.IOException

メッセージボディの内容をクライアントに送信する。

パラメータ:

in - 入力ストリームの内容

nativeRes - サーブレットレスポンス

例外:

java.io.IOException - ソケットI/Oにおけるエラー