public abstract class GenericFilter extends ObjectSE implements Filter, FilterConfig, SerializableSE
汎用の、プロトコルに依存しないフィルターを定義します。Web で使用する HTTP フィルターを作成するには、代わりに HttpFilter を継承します。
GenericFilter は、Filter および FilterConfig インターフェースを実装します。GenericFilter はフィルターによって直接拡張できますが、HttpFilter などのプロトコル固有のサブクラスを継承する方が一般的です。
GenericFilter により、フィルターの作成が容易になります。ライフサイクルメソッド init および destroy および FilterConfig インターフェースのメソッドの単純なバージョンを提供します。
汎用フィルターを作成するには、抽象 doFilter メソッドをオーバーライドするだけです。
| コンストラクターと説明 |
|---|
GenericFilter() 何もしません。 |
| 修飾子と型 | メソッドと説明 |
|---|---|
FilterConfig | getFilterConfig() このサーブレットの ServletConfig オブジェクトを返します。 |
StringSE | getFilterName() このフィルターインスタンスの名前を返します。 |
StringSE | getInitParameter(StringSE name) 指定された初期化パラメーターの値を含む String を返します。パラメーターが存在しない場合は null を返します。 |
EnumerationSE<StringSE> | getInitParameterNames()String オブジェクトの Enumeration としてフィルターの初期化パラメーターの名前を返します。フィルターに初期化パラメーターがない場合は空の Enumeration を返します。 |
ServletContext | getServletContext() このフィルターが実行されている ServletContext への参照を返します。 |
void | init()super.init(config) を呼び出す必要がないようにオーバーライドできる便利なメソッド。 |
void | init(FilterConfig config) サーブレットコンテナーによって呼び出され、サービスに配置されていることをフィルターに示します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSEpublic GenericFilter()
何もしません。フィルターの初期化はすべて、init メソッドの 1 つによって行われます。
public StringSE getInitParameter(StringSE name)
指定された初期化パラメーターの値を含む String を返します。パラメーターが存在しない場合は null を返します。FilterConfig.getInitParameter(java.lang.String) を参照してください。
このメソッドは便宜上提供されています。サーブレットの ServletConfig オブジェクトから名前付きパラメーターの値を取得します。
FilterConfig の getInitParameter name - 初期化パラメーターの名前を指定する String String をストリング化する public EnumerationSE<StringSE> getInitParameterNames()
String オブジェクトの Enumeration としてフィルターの初期化パラメーターの名前を返します。フィルターに初期化パラメーターがない場合は空の Enumeration を返します。FilterConfig.getInitParameterNames() を参照してください。
このメソッドは便宜上提供されています。フィルターの FilterConfig オブジェクトからパラメーター名を取得します。
FilterConfig の getInitParameterNames String オブジェクトの列挙 public FilterConfig getFilterConfig()
このサーブレットの ServletConfig オブジェクトを返します。
FilterConfig オブジェクト public ServletContext getServletContext()
このフィルターが実行されている ServletContext への参照を返します。FilterConfig.getServletContext() を参照してください。
このメソッドは便宜上提供されています。フィルターの FilterConfig オブジェクトからコンテキストを取得します。
FilterConfig の getServletContext init メソッドによってこのフィルターに渡された ServletContext オブジェクト ServletContextpublic void init(FilterConfig config) throws ServletException
サーブレットコンテナーによって呼び出され、サービスに配置されていることをフィルターに示します。Filter.init(jakarta.servlet.FilterConfig) を参照してください。
この実装は、後で使用するためにサーブレットコンテナーから受け取った FilterConfig オブジェクトを格納します。この形式のメソッドをオーバーライドするときは、super.init(config) を呼び出します。
Filter の init config - このフィルターの構成情報を含む FilterConfig オブジェクト ServletException - サーブレットの通常の操作を中断する例外が発生した場合 UnavailableExceptionpublic void init()
throws ServletExceptionsuper.init(config) を呼び出す必要がないようにオーバーライドできる便利なメソッド。
init(FilterConfig) をオーバーライドする代わりに、このメソッドをオーバーライドするだけで、GenericFilter.init(FilterConfig config) によって呼び出されます。FilterConfig オブジェクトは、getFilterConfig() を介して引き続き取得できます。
ServletException - サーブレットの通常の操作を中断する例外が発生した場合 public StringSE getFilterName()
このフィルターインスタンスの名前を返します。FilterConfig.getFilterName() を参照してください。
FilterConfig の getFilterName Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.