javax.servlet

インタフェース FilterConfig

既知の実装クラスのリスト:

GenericFilter, HttpFilter

public interface FilterConfig

サーブレットコンテナがフィルターの初期化中に情報を渡すために使用するフィルター設定オブジェクトです。

導入されたバージョン:

Servlet 2.3

関連項目:

Filter

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	getFilterName() デプロイメントディスクリプタに定義されたfilter-nameを返します。
String	getInitParameter(String name) 初期化パラメーターに含まれるStringを返します。
Enumeration<String>	getInitParameterNames() フィルターの初期化パラメーターに含まれる名前をStringのEnumerationとして返します。
ServletContext	getServletContext() 呼び出し元が実行中のServletContextへの参照を返します。

メソッドの詳細

getFilterName

String getFilterName()

デプロイメントディスクリプタに定義されたfilter-nameを返します。

戻り値:

このフィルターの名前

getServletContext

ServletContext getServletContext()

呼び出し元が実行中のServletContextへの参照を返します。

戻り値:

呼び出し元がサーブレットコンテナと対話するために使用する ServletContext のオブジェクト

関連項目:

ServletContext

getInitParameter

String getInitParameter(String name)

初期化パラメーターに含まれるStringを返します。nullの場合は初期化パラメーターが存在しません。

パラメータ:

name - 初期化パラメーターで指定された名称のString

戻り値:

初期化パラメーターに含まれるString、nullの場合は初期化パラメーターが存在しない

getInitParameterNames

Enumeration<String> getInitParameterNames()

フィルターの初期化パラメーターに含まれる名前をStringのEnumerationとして返します。空のEnumerationの場合、初期化パラメーターは存在しません。

戻り値:

フィルターの初期化パラメーターに含まれる名前のStringのEnumeration