クラス HttpFilter
- java.lang.ObjectSE
-
- jakarta.servlet.GenericFilter
-
- jakarta.servlet.http.HttpFilter
- 実装されたすべてのインターフェース:
Filter
、FilterConfig
、SerializableSE
public abstract class HttpFilter extends GenericFilter
サブクラス化する抽象クラスを提供して、Web サイトに適した HTTP フィルターを作成します。
HttpFilter
のサブクラスはdoFilter(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, jakarta.servlet.FilterChain)
をオーバーライドする必要があります。通常、フィルターはマルチスレッドサーバーで実行されるため、フィルターは同時リクエストを処理する必要があることに注意し、共有リソースへのアクセスを同期するように注意してください。共有リソースには、インスタンス変数やクラス変数などのメモリ内データと、ファイル、データベース接続、ネットワーク接続などの外部オブジェクトが含まれます。Java プログラムでの複数のスレッドの処理の詳細については、マルチスレッドプログラミングに関する Java チュートリアルSEを参照してください。
- 導入:
- Servlet 4.0
- 作成者:
- Various
- 関連事項:
- 直列化された形式
コンストラクターのサマリー
コンストラクター コンストラクター 説明 HttpFilter()
これは抽象クラスであるため、何もしません。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 protected void
doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain)
Filter のdoFilter
メソッドは、チェーンの終わりにあるリソースに対するクライアントリクエストのために、リクエスト / レスポンスペアがチェーンを通過するたびにコンテナーによって呼び出されます。void
doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
Filter のdoFilter
メソッドは、チェーンの終わりにあるリソースに対するクライアントリクエストのために、リクエスト / レスポンスペアがチェーンを通過するたびにコンテナーによって呼び出されます。クラス jakarta.servlet.GenericFilter から継承されたメソッド
getFilterConfig, getFilterName, getInitParameter, getInitParameterNames, getServletContext, init, init
メソッドの詳細
doFilter
public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) throws IOExceptionSE, ServletException
Filter の
doFilter
メソッドは、チェーンの終わりにあるリソースに対するクライアントリクエストのために、リクエスト / レスポンスペアがチェーンを通過するたびにコンテナーによって呼び出されます。このメソッドに渡された FilterChain により、フィルターはリクエストとレスポンスをチェーンの次のエンティティに渡すことができます。このメソッドをオーバーライドする必要はありません。デフォルトの実装では、受信
req
およびres
オブジェクトをインスペクションして、それぞれHttpServletRequest
およびHttpServletResponse
のインスタンスであるかどうかを判別します。そうでない場合、ServletException
がスローされます。それ以外の場合、保護されたdoFilter(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, jakarta.servlet.FilterChain)
メソッドが呼び出されます。- パラメーター:
req
- クライアントがフィルターに対して行ったリクエストを含むServletRequest
オブジェクトres
- フィルターがクライアントに送信するレスポンスを含むServletResponse
オブジェクトchain
- 次のフィルターまたはリソースを呼び出すためのFilterChain
- 例外:
IOExceptionSE
- フィルターがリクエストを処理するときに入力または出力エラーが検出された場合ServletException
- リクエストを処理できなかった場合、またはいずれかのパラメーターがそれぞれのHttpServletRequest
またはHttpServletResponse
のインスタンスではない場合- 導入:
- Servlet 4.0
- 関連事項:
UnavailableException
doFilter
protected void doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain) throws IOExceptionSE, ServletException
Filter の
doFilter
メソッドは、チェーンの終わりにあるリソースに対するクライアントリクエストのために、リクエスト / レスポンスペアがチェーンを通過するたびにコンテナーによって呼び出されます。このメソッドに渡された FilterChain により、フィルターはチェーンの次のエンティティにリクエストとレスポンスを渡すことができます。デフォルトの実装は、単に
FilterChain.doFilter(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)
を呼び出します- パラメーター:
req
- クライアントがフィルターに対して行ったリクエストを含むHttpServletRequest
オブジェクトres
- フィルターがクライアントに送信するレスポンスを含むHttpServletResponse
オブジェクトchain
- 次のフィルターまたはリソースを呼び出すためのFilterChain
- 例外:
IOExceptionSE
- フィルターがリクエストを処理するときに入力または出力エラーが検出された場合ServletException
- リクエストを処理できなかった場合- 導入:
- Servlet 4.0