パッケージ jakarta.servlet

クラス GenericFilter

  • 実装されたすべてのインターフェース:
    Filter、FilterConfig、SerializableSE
    既知の直属サブクラス
    HttpFilter
    public abstract class GenericFilter
extends ObjectSE
implements Filter, FilterConfig, SerializableSE

    汎用の、プロトコルに依存しないフィルターを定義します。Web で使用する HTTP フィルターを作成するには、代わりに HttpFilter を継承します。

    GenericFilter は、Filter および FilterConfig インターフェースを実装します。GenericFilter はフィルターによって直接拡張できますが、HttpFilter などのプロトコル固有のサブクラスを継承する方が一般的です。

    GenericFilter により、フィルターの作成が容易になります。ライフサイクルメソッド init および destroy および FilterConfig インターフェースのメソッドの単純なバージョンを提供します。

    汎用フィルターを作成するには、抽象 doFilter メソッドをオーバーライドするだけです。

    導入:
    Servlet 4.0
    作成者:
    Various
    関連事項:
    直列化された形式

    • コンストラクターの詳細

      • GenericFilter

        public GenericFilter()

        何もしません。フィルターの初期化はすべて、init メソッドの 1 つによって行われます。

        導入:
        Servlet 4.0

    • メソッドの詳細

      • getInitParameter

        public StringSE getInitParameter​(StringSE name)

        指定された初期化パラメーターの値を含む String を返します。パラメーターが存在しない場合は null を返します。FilterConfig.getInitParameter(java.lang.String) を参照してください。

        このメソッドは便宜上提供されています。サーブレットの ServletConfig オブジェクトから名前付きパラメーターの値を取得します。

        次で指定:
        インターフェース FilterConfig の getInitParameter 
        パラメーター:
        name - 初期化パラメーターの名前を指定する String 
        戻り値:
        初期化パラメーターの値を含む String をストリング化する
        導入:
        Servlet 4.0

      • getInitParameterNames

        public EnumerationSE<StringSE> getInitParameterNames()

        String オブジェクトの Enumeration としてフィルターの初期化パラメーターの名前を返します。フィルターに初期化パラメーターがない場合は空の Enumeration を返します。FilterConfig.getInitParameterNames() を参照してください。

        このメソッドは便宜上提供されています。フィルターの FilterConfig オブジェクトからパラメーター名を取得します。

        次で指定:
        インターフェース FilterConfig の getInitParameterNames 
        戻り値:
        フィルターの初期化パラメーターの名前を含む String オブジェクトの列挙
        導入:
        Servlet 4.0

      • getFilterConfig

        public FilterConfig getFilterConfig()

        このサーブレットの ServletConfig オブジェクトを返します。

        戻り値:
        FilterConfig このフィルターを初期化した FilterConfig オブジェクト
        導入:
        Servlet 4.0

      • getServletContext

        public ServletContext getServletContext()

        このフィルターが実行されている ServletContext への参照を返します。FilterConfig.getServletContext() を参照してください。

        このメソッドは便宜上提供されています。フィルターの FilterConfig オブジェクトからコンテキストを取得します。

        次で指定:
        インターフェース FilterConfig の getServletContext 
        戻り値:
        ServletContext init メソッドによってこのフィルターに渡された ServletContext オブジェクト
        導入:
        Servlet 4.0
        関連事項:
        ServletContext

      • init

        public void init​(FilterConfig config)
          throws ServletException

        サーブレットコンテナーによって呼び出され、サービスに配置されていることをフィルターに示します。Filter.init(jakarta.servlet.FilterConfig) を参照してください。

        この実装は、後で使用するためにサーブレットコンテナーから受け取った FilterConfig オブジェクトを格納します。この形式のメソッドをオーバーライドするときは、super.init(config) を呼び出します。

        次で指定:
        インターフェース Filter の init 
        パラメーター:
        config - このフィルターの構成情報を含む FilterConfig オブジェクト
        例外:
        ServletException - サーブレットの通常の操作を中断する例外が発生した場合
        導入:
        Servlet 4.0
        関連事項:
        UnavailableException

      • init

        public void init()
          throws ServletException

        super.init(config) を呼び出す必要がないようにオーバーライドできる便利なメソッド。

        init(FilterConfig) をオーバーライドする代わりに、このメソッドをオーバーライドするだけで、GenericFilter.init(FilterConfig config) によって呼び出されます。FilterConfig オブジェクトは、getFilterConfig() を介して引き続き取得できます。

        例外:
        ServletException - サーブレットの通常の操作を中断する例外が発生した場合
        導入:
        Servlet 4.0

      • getFilterName

        public StringSE getFilterName()

        このフィルターインスタンスの名前を返します。FilterConfig.getFilterName() を参照してください。

        次で指定:
        インターフェース FilterConfig の getFilterName 
        戻り値:
        このフィルターインスタンスの名前
        導入:
        Servlet 4.0