nablarch.fw.web.handler

クラス HttpErrorHandler

java.lang.Object

nablarch.fw.web.handler.HttpErrorHandler

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

Handler<HttpRequest,HttpResponse>, HttpRequestHandler

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

HttpMessagingErrorHandler

public class HttpErrorHandler
extends java.lang.Object
implements HttpRequestHandler

共通エラーハンドラー。

 HttpResponse/HttpErrorResponse のHTTPエラーコードに対応した
 エラー画面に遷移させる。
 また、実行時例外を捕捉し、システムエラー画面に遷移させる。
 

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected java.util.regex.Pattern	writeFailureLogPattern Result.Errorの中で障害通知ログを出力する対象を表すステータスコード

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ResourceLocator	getDefaultPageFor(int statusCode) 指定されたステータスコードに対するデフォルトページのコンテンツパスを返す。
HttpResponse	handle(HttpRequest req, ExecutionContext ctx) HTTPリクエストに対する処理を実行する。
HttpErrorHandler	setDefaultPage(java.lang.String statusCode, java.lang.String contentPath) レスポンスステータスコードごとのデフォルトページを設定する。
HttpErrorHandler	setDefaultPages(java.util.Map<java.lang.String,java.lang.String> defaultPages) レスポンスステータスコードごとのデフォルトページを設定する。
void	setWriteFailureLogPattern(java.lang.String writeFailureLogPattern) handle(nablarch.fw.web.HttpRequest, nablarch.fw.ExecutionContext)で、Result.Errorを補足した際に、 障害通知ログを出力する必要のあるステータスコードを正規表現で設定する。

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

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

フィールドの詳細

writeFailureLogPattern

protected java.util.regex.Pattern writeFailureLogPattern

Result.Errorの中で障害通知ログを出力する対象を表すステータスコード

コンストラクタの詳細

HttpErrorHandler

public HttpErrorHandler()

メソッドの詳細

handle

public HttpResponse handle(HttpRequest req,
                           ExecutionContext ctx)

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

定義:

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

定義:

handle インタフェース内 HttpRequestHandler

パラメータ:

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

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

戻り値:

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

setDefaultPage

public HttpErrorHandler setDefaultPage(java.lang.String statusCode,
                                       java.lang.String contentPath)

レスポンスステータスコードごとのデフォルトページを設定する。 HttpResponseオブジェクトのボディ内容(contentPath/contentBody)が設定されていない場合、 ここでステータスコード毎に設定したデフォルトページがボディとしてレスポンスされる。 設定は後から設定した内容ほど優先される。 ステータスコードには1桁分のワイルドカードとして "." を使用することができる。 設定例::

   // デフォルトページ定義
   setDefaultPage("303", "file:///www/docroot/redirecting.html");
   setDefaultPage("4..", "servlet://jsp/errors/userError.jsp");
   setDefaultPage("5..", "servlet://jsp/errors/systemError.jsp");
 

デフォルトページの設定を行わない場合、 web.xmlに定義されているエラーページに遷移する。

パラメータ:

statusCode - ステータスコードのパターン

contentPath - デフォルトページのコンテンツパス

戻り値:

このオブジェクト自体

setDefaultPages

public HttpErrorHandler setDefaultPages(java.util.Map<java.lang.String,java.lang.String> defaultPages)

レスポンスステータスコードごとのデフォルトページを設定する。

パラメータ:

defaultPages - デフォルトページ設定

戻り値:

このオブジェクト自体

getDefaultPageFor

public ResourceLocator getDefaultPageFor(int statusCode)

指定されたステータスコードに対するデフォルトページのコンテンツパスを返す。

パラメータ:

statusCode - ステータスコード

戻り値:

デフォルト画面のコンテンツパス

setWriteFailureLogPattern

public void setWriteFailureLogPattern(java.lang.String writeFailureLogPattern)

handle(nablarch.fw.web.HttpRequest, nablarch.fw.ExecutionContext)で、Result.Errorを補足した際に、 障害通知ログを出力する必要のあるステータスコードを正規表現で設定する。 ここで設定した正規表現が、Result.Error.getStatusCode()にマッチした場合のみ、 障害通知ログが出力され障害として検知される。 なお、本設定を省略した場合のデフォルト動作では、5([1-9][0-9]|0[012456789])に一致するステータスコードが障害通知ログの出力対象となる。

パラメータ:

writeFailureLogPattern - 障害通知対象のステータスコードを表す正規表現