javax.servlet.http

クラス HttpFilter

java.lang.Object

javax.servlet.GenericFilter

javax.servlet.http.HttpFilter

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

Serializable, Filter, FilterConfig

public abstract class HttpFilter
extends GenericFilter

Webサイトに適したHTTPフィルターを作成するためにサブクラスが作成される抽象クラスを提供します。 HttpFilterのサブクラスはdoFilter(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.FilterChain)メソッドをオーバーライドする必要があります。

フィルタは通常、サーバー上でマルチスレッドで実行されるため、フィルタは同時に行われるリクエストを処理し、共有リソースへのアクセスを同期するよう注意しなければなりません。 共有リソースにはインスタンス変数、クラス変数などのインメモリデータや、ファイル、データベース接続、ネットワーク接続などの外部オブジェクトが含まれます。 Javaプログラムで複数のスレッドを処理する方法の詳細は、Java Tutorial on Multithreaded Programmingを参照してください。

作成者:

Various

導入されたバージョン:

Servlet 4.0

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
HttpFilter() このクラスはabstractクラスなので何もしません。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain) フィルターのdoFilterメソッドはチェーンの最後にあるリソースへのクライアントからの要求により、リクエスト/レスポンスのペアがチェーンを通過するたびにコンテナによって呼び出されます。
void	doFilter(ServletRequest req, ServletResponse res, FilterChain chain) フィルターのdoFilterメソッドはチェーンの最後にあるリソースへのクライアントからの要求により、リクエスト/レスポンスのペアがチェーンを通過するたびにコンテナによって呼び出されます。

クラスから継承されたメソッド javax.servlet.GenericFilter

getFilterConfig, getFilterName, getInitParameter, getInitParameterNames, getServletContext, init, init

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

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

インタフェースから継承されたメソッド javax.servlet.Filter

destroy

コンストラクタの詳細

HttpFilter

public HttpFilter()

このクラスはabstractクラスなので何もしません。

訳注：理由になってない・・・・・

導入されたバージョン:

4.0

メソッドの詳細

doFilter

public void doFilter(ServletRequest req,
                     ServletResponse res,
                     FilterChain chain)
              throws IOException,
                     ServletException

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

デフォルトの実装では渡されたreqオブジェクトとresオブジェクトがそれぞれHttpServletRequestとHttpServletResponseインスタンスであるかどうかを調べ、 そうでない場合はServletExceptionがスローされます。 それ以外の場合はprotected doFilter(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, javax.servlet.FilterChain)メソッドが呼び出されます。

パラメータ:

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

res - フィルターがクライアントに送るレスポンスが含まれるServletResponseのオブジェクト

chain - 次のフィルターもしくはリソースを実行するための FilterChain

例外:

IOException - フィルターがリクエストを処理する中でI/Oエラーが発生した

ServletException - リクエストを処理できなかったか、いずれかのパラメータがそれぞれHttpServletRequestもしくはHttpServletResponseのインスタンスでない場合

導入されたバージョン:

Servlet 4.0

関連項目:

UnavailableException

doFilter

protected void doFilter(HttpServletRequest req,
                        HttpServletResponse res,
                        FilterChain chain)
                 throws IOException,
                        ServletException

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

デフォルト実装では単純にFilterChain.doFilter(javax.servlet.ServletRequest, javax.servlet.ServletResponse)が呼び出されます。

パラメータ:

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

res - フィルターがクライアントに送るレスポンスが含まれるHttpServletResponseのオブジェクト

chain - the FilterChain for invoking the next filter or the resource

例外:

IOException - フィルターがリクエストを処理する中でI/Oエラーが発生した

ServletException - リクエストが処理できなかった場合

導入されたバージョン:

Servlet 4.0