パッケージ jakarta.servlet

インターフェース FilterConfig

すべての既知の実装クラス:
GenericFilter, HttpFilter
public interface FilterConfig
初期化中に情報をフィルターに渡すためにサーブレットコンテナーが使用するフィルター構成オブジェクト。
導入:
Servlet 2.3
関連事項:

  • 方法の概要

    修飾子と型
    メソッド
    説明
    StringSE
    getFilterName()
    デプロイ記述子で定義されているこのフィルターのフィルター名を返します。
    StringSE
    getInitParameter(StringSE name)
    指定された初期化パラメーターの値を含む String を返します。初期化パラメーターが存在しない場合は null を返します。
    EnumerationSE<StringSE>
    getInitParameterNames()
    String オブジェクトの Enumeration としてフィルターの初期化パラメーターの名前を返します。フィルターに初期化パラメーターがない場合は空の Enumeration を返します。
    ServletContext
    getServletContext()
    呼び出し元が実行されている ServletContext への参照を返します。

  • 方法の詳細

    • getFilterName

      StringSE getFilterName()
      デプロイ記述子で定義されているこのフィルターのフィルター名を返します。
      戻り値:
      このフィルターのフィルター名

    • getServletContext

      ServletContext getServletContext()
      呼び出し元が実行されている ServletContext への参照を返します。
      戻り値:
      呼び出し元がサーブレットコンテナーと対話するために使用する ServletContext オブジェクト
      関連事項:

    • getInitParameter

      StringSE getInitParameter(StringSE name)
      指定された初期化パラメーターの値を含む String を返します。初期化パラメーターが存在しない場合は null を返します。
      パラメーター:
      name - 初期化パラメーターの名前を指定する String 
      戻り値:
      初期化パラメーターの値を含む String、または初期化パラメーターが存在しない場合は null 

    • getInitParameterNames

      EnumerationSE<StringSE> getInitParameterNames()
      String オブジェクトの Enumeration としてフィルターの初期化パラメーターの名前を返します。フィルターに初期化パラメーターがない場合は空の Enumeration を返します。
      戻り値:
      フィルターの初期化パラメーターの名前を含む String オブジェクトの Enumeration