nablarch.fw.jaxrs

クラス JaxRsResponseHandler

java.lang.Object

nablarch.fw.jaxrs.JaxRsResponseHandler

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

Handler<HttpRequest,HttpResponse>, HttpRequestHandler

public class JaxRsResponseHandler
extends java.lang.Object
implements HttpRequestHandler

JAX-RS用のレスポンスを返却するハンドラ。

このハンドラでは、後続のハンドラから戻されたHttpResponseの内容を、クライアントへのレスポンスとして書き込む。 後続のハンドラで例外が発生した場合には、ErrorResponseBuilderを使用してエラー用のレスポンスを作成し、クライアントへのレスポンスとして書き込む。

後続のハンドラ及びErrorResponseBuilderでHttpResponseを生成する際には、レスポンスヘッダーも含めて設定する必要がある。 このハンドラでは、レスポンスヘッダーを自動的に設定するようなことはしない。

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
HttpResponse	handle(HttpRequest request, ExecutionContext context) HTTPリクエストに対する処理を実行する。
void	setErrorLogWriter(JaxRsErrorLogWriter errorLogWriter) エラーログライターを設定する。
void	setErrorResponseBuilder(ErrorResponseBuilder errorResponseBuilder) エラーレスポンスビルダーを設定する。
protected static void	writeBody(java.io.InputStream in, javax.servlet.http.HttpServletResponse nativeRes) メッセージボディの内容をクライアントに送信する。
protected void	writeHeaders(HttpResponse response, javax.servlet.http.HttpServletResponse nativeResponse) レスポンスヘッダーを書き込む。
protected void	writeResponse(HttpResponse response, ServletExecutionContext context) レスポンスを書き込む。

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

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

コンストラクタの詳細

JaxRsResponseHandler

public JaxRsResponseHandler()

メソッドの詳細

handle

public HttpResponse handle(HttpRequest request,
                           ExecutionContext context)

インタフェースからコピーされた説明: HttpRequestHandler

HTTPリクエストに対する処理を実行する。

定義:

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

定義:

handle インタフェース内 HttpRequestHandler

パラメータ:

request - HTTPリクエストオブジェクト

context - サーバサイド実行コンテキストオブジェクト

戻り値:

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

writeResponse

protected void writeResponse(HttpResponse response,
                             ServletExecutionContext context)

レスポンスを書き込む。

パラメータ:

response - HttpResponse

context - ServletExecutionContext

writeHeaders

protected void writeHeaders(HttpResponse response,
                            javax.servlet.http.HttpServletResponse nativeResponse)

レスポンスヘッダーを書き込む。

HttpResponse内のヘッダー情報を、HttpServletResponseに対して書き込む。

パラメータ:

response - HttpResponse

nativeResponse - HttpServletResponse

writeBody

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

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

パラメータ:

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

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

例外:

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

setErrorResponseBuilder

public void setErrorResponseBuilder(ErrorResponseBuilder errorResponseBuilder)

エラーレスポンスビルダーを設定する。

デフォルト実装であるErrorResponseBuilderを差し替えたい場合に拡張クラスを設定する。

パラメータ:

errorResponseBuilder - エラーレスポンスビルダー

setErrorLogWriter

public void setErrorLogWriter(JaxRsErrorLogWriter errorLogWriter)

エラーログライターを設定する。

デフォルト実装であるJaxRsErrorLogWriterを差し替えたい場合に拡張クラスを設定する。

パラメータ:

errorLogWriter - エラーログライター