javax.servlet

インタフェース Filter

既知の実装クラスのリスト:

GenericFilter, HttpFilter

public interface Filter

フィルターはリソース(サーブレットもしくは静的コンテンツ)へのリクエストやレスポンス、もしくはその両方をフィルタリングするタスクを処理するためのオブジェクトです。

フィルターはdoFilterメソッドによりフィルタリングを行います。 それぞれのフィルターはフィルタリングタスクのために必要なリソースをロードしたりするために、初期化パラメーターをもつFilterConfigオブジェクトや使用できるServletContextへの参照を持ちます。

フィルターはWebアプリケーションのデプロイメントディスクリプタにより構成されます。

以下のような用途のために使用できます。

1. 認証フィルター
2. ロギングと監査フィルター
3. イメージ変換フィルター
4. データ圧縮フィルター
5. 暗号化フィルター
6. トークン分割フィルター
7. リソースへのアクセスイベントを引き起こすフィルター
8. XSL/Tフィルター
9. Mime-typeチェーンフィルター

導入されたバージョン:

Servlet 2.3

メソッドのサマリー

修飾子とタイプ	メソッドと説明
default void	destroy() フィルターがサービスから取り除かれるときにサーブレットコンテナにより呼び出されます。
void	doFilter(ServletRequest request, ServletResponse response, FilterChain chain) フィルターのdoFilterメソッドはチェーンの最後にあるリソースへのクライアントからの要求により、リクエスト/レスポンスのペアがチェーンを通過するたびにコンテナによって呼び出されます。
default void	init(FilterConfig filterConfig) フィルターがサービスに組み込まれるときにサーブレットコンテナにより呼び出されます。

メソッドの詳細

init

default void init(FilterConfig filterConfig)
           throws ServletException

フィルターがサービスに組み込まれるときにサーブレットコンテナにより呼び出されます。

サーブレットコンテナはフィルターのインスタンスを生成した後にinitメソッドを一回だけ呼び出します。initメソッドはフィルタリング動作を行う前に正常に完了しなければいけません。

以下の場合にはサーブレットコンテナはフィルターを実行状態にすることができません。

1. ServletExceptionが投げられた
2. サーブレットコンテナで定義した時間内に処理を終了しない

Implementation Requirements:

デフォルト実装では何も行いません。

パラメータ:

filterConfig - フィルターの設定や初期化パラメーターが含まれるFilterConfigオブジェクト

例外:

ServletException - フィルターの通常の処理で例外が発生した

doFilter

void doFilter(ServletRequest request,
              ServletResponse response,
              FilterChain chain)
       throws IOException,
              ServletException

フィルターのdoFilterメソッドはチェーンの最後にあるリソースへのクライアントからの要求により、リクエスト/レスポンスのペアがチェーンを通過するたびにコンテナによって呼び出されます。 このメソッドに渡されたFilterChainは、フィルターがチェーンの次のエンティティへリクエストとレスポンスを渡せるようにします。

このメソッドの典型的な実装は以下のようなものになるでしょう。

1. リクエストを検査する。
2. 必要に応じて入力フィルタリングのためにコンテンツやヘッダーをフィルターするカスタム実装でリクエストをラップする。
3. 必要に応じて出力フィルタリングのためにコンテンツやヘッダーをフィルターするカスタム実装でレスポンスをラップする。
4. FilterChainオブジェクトを利用(chain.doFilter())して次のエンティティをチェーン実行する、しないのどちらかを選択する。
5. 次のフィルターチェーンのエンティティが実行された後に直接レスポンスのヘッダーに値をセットする。

パラメータ:

request - クライアントのリクエストが含まれるServletRequestのオブジェクト

response - フィルターのレスポンスが含まれるServletResponseのオブジェクト

chain - the 次のフィルターやリソースの実行に使用されるFilterChain

例外:

IOException - 処理中にI/O関係のエラーが発生した

ServletException - フィルターの通常の処理で例外が発生した

関連項目:

UnavailableException

destroy

default void destroy()

フィルターがサービスから取り除かれるときにサーブレットコンテナにより呼び出されます。

このメソッドはすべてのスレッドでフィルターのdoFilterメソッドが終了したかタイムアウトした後に一度だけ呼び出されます。 サーブレットコンテナはこのメソッドを呼出した後に同じインスタンスでdoFilterメソッドを再度呼び出すことはありません。

このメソッドは保持されているすべてのリソース（メモリ、ファイルハンドル、スレッドなど）をクリーンアップする機会を与えます。 また、フィルターのメモリ上の状態とあらゆる永続状態が同期されるように注意してください。

Implementation Requirements:

デフォルト実装では何も行いません。