jp.terasoluna.fw.web.rich
クラス RequestContextHandlingFilter

java.lang.Object
  上位を拡張 jp.terasoluna.fw.web.rich.RequestContextHandlingFilter
すべての実装されたインタフェース:
javax.servlet.Filter

public class RequestContextHandlingFilter
extends java.lang.Object
implements javax.servlet.Filter

制御情報の生成・破棄を行うサーブレットフィルタ。

リクエスト処理開始時に制御情報を生成し、リクエスト処理終了時に破棄する。 制御情報の生成処理後チェインされた処理の実行中に例外が発生しても、必ず制御情報は破棄される。 制御情報の詳細は、RequestContextSupportを参照のこと。

本サーブレットフィルタを利用するには、web.xmlの設定が必要である。

【デプロイメントディスクリプタ(web.xml)の設定例】

  <filter>
   <filter-name>requestContextHandlingFilter</filter-name>
   <filter-class>
     jp.terasoluna.fw.web.rich.RequestContextHandlingFilter
   </filter-class>
  </filter>
  <filter-mapping>
    <filter-name>requestContextHandlingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
 

制御情報の取得のため、DIコンテナから制御情報サポートクラスを取得する。 取得するBeanIDは”ctxSupport”とする。 ただしRequestContextSupportを取得する際に利用するBeanIDをカスタマイズしたい場合は、 フィルタの初期化パラメータ「ctxSupportBeanID」に RequestContextSupportを取得するためのBean名を記述することで直接指定することができる。 通常は、初期化パラメータの指定は不要である。

【initParameterを利用したデプロイメントディスクリプタ(web.xml)の設定例】

  <filter>
     <filter-name>requestContextHandlingFilter</filter-name>
     <filter-class>
       jp.terasoluna.fw.web.rich.RequestContextHandlingFilter
     </filter-class>
     <init-param>
       <param-name>ctxSupportBeanID</param-name>
       <param-value>newCtxSupport</param-value>
     </init-param>
   </filter>
   <filter-mapping>
     <filter-name>requestContextHandlingFilter</filter-name>
     <url-pattern>/*</url-pattern>
   </filter-mapping>
 

関連項目:
RequestContextSupport

フィールドの概要
private  RequestContextSupport ctxSupport
          RequestContextSupport。
private static java.lang.String DEFAULT_CTXSUPPORT_BEANID
          DIコンテナからRequestContextSupportを取得する際のBeanIDのデフォルト値。
private static java.lang.String INITPARAM_KEY_CTXSUPPORT_BEANID
          初期化パラメータからRequestContextSupportのBeanIDを取得するためのキー。
 
コンストラクタの概要
RequestContextHandlingFilter()
           
 
メソッドの概要
 void destroy()
          フィルタの破棄処理を行う。
 void doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
          フィルタ処理する。
 void init(javax.servlet.FilterConfig config)
          フィルタの初期化を行う。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEFAULT_CTXSUPPORT_BEANID

private static final java.lang.String DEFAULT_CTXSUPPORT_BEANID
DIコンテナからRequestContextSupportを取得する際のBeanIDのデフォルト値。

関連項目:
定数フィールド値

INITPARAM_KEY_CTXSUPPORT_BEANID

private static final java.lang.String INITPARAM_KEY_CTXSUPPORT_BEANID
初期化パラメータからRequestContextSupportのBeanIDを取得するためのキー。

関連項目:
定数フィールド値

ctxSupport

private RequestContextSupport ctxSupport
RequestContextSupport。

コンストラクタの詳細

RequestContextHandlingFilter

public RequestContextHandlingFilter()
メソッドの詳細

init

public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException
フィルタの初期化を行う。 RequestContextSupportをDIコンテナより取得する。

定義:
インタフェース javax.servlet.Filter 内の init
パラメータ:
config - フィルタ設定
例外:
javax.servlet.ServletException - サーブレット例外

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException
フィルタ処理する。 制御情報の登録・破棄を行う。

定義:
インタフェース javax.servlet.Filter 内の doFilter
パラメータ:
request - HTTPリクエスト
response - HTTPレスポンス
chain - チェインされたフィルタ
例外:
java.io.IOException - 入出力例外
javax.servlet.ServletException - サーブレット例外

destroy

public void destroy()
フィルタの破棄処理を行う。 なにもしない。

定義:
インタフェース javax.servlet.Filter 内の destroy