javax.servlet

クラス GenericFilter

java.lang.Object

javax.servlet.GenericFilter

すべての実装されたインタフェース:

Serializable, Filter, FilterConfig

直系の既知のサブクラス:

HttpFilter

public abstract class GenericFilter
extends Object
implements Filter, FilterConfig, Serializable

総称的なプロトコルに依存しないフィルターを定義します。 Webで使用するHTTPのフィルターを作成したい場合は HttpFilter を継承してください。

GenericFilter は Filter と FilterConfig の二つのインターフェースを実装します。 GenericFilter を直接継承してもよいですが、HttpFilter などのプロトコルに依存したサブクラスを継承するのがより一般的です。

GenericFilter はフィルターを簡単に作成できるようにします。 これはライフサイクルメソッドのうち init と destroy の単純な(何もしない)バージョンと、 FilterConfig インターフェースのメソッドを提供します。

GenericFilter を継承してフィルターを作成する場合はabstractなdoFilterメソッドだけを実装する必要があります。

作成者:

Various

導入されたバージョン:

Servlet 4.0

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
GenericFilter() 何もしません。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
FilterConfig	getFilterConfig() このフィルターの FilterConfig のオブジェクトを返します。
String	getFilterName() このフィルターのインスタンスの名前を返します。
String	getInitParameter(String name) 名前付き初期化パラメーターに含まれる値のStringを返します。
Enumeration<String>	getInitParameterNames() フィルターの初期化パラメーターの名前をStringオブジェクトのEnumerationとして返します。
ServletContext	getServletContext() このサーブレットが動いているServletContextを返します。
void	init() super.init(config)を呼ばなくてもオーバーライドできるようにするための便利メソッドです。
void	init(FilterConfig config) サーブレットがサービスに組込まれるときにサーブレットコンテナに呼出されます。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インタフェースから継承されたメソッド javax.servlet.Filter

destroy, doFilter

コンストラクタの詳細

GenericFilter

public GenericFilter()

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

導入されたバージョン:

Servlet 4.0

メソッドの詳細

getInitParameter

public String getInitParameter(String name)

名前付き初期化パラメーターに含まれる値のStringを返します。 存在しない場合はnullを返します。 FilterConfig.getInitParameter(java.lang.String)を参照してください。

このメソッドは簡便さのために提供されています。 これはフィルターの

FilterConfig

のオブジェクトから名前付きパラメーターを取得します。

定義:

getInitParameter インタフェース内 FilterConfig

パラメータ:

name - 初期化パラメータの名前を指定するString

戻り値:

String 初期化パラメータの値のString

導入されたバージョン:

Servlet 4.0

getInitParameterNames

public Enumeration<String> getInitParameterNames()

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

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

定義:

getInitParameterNames インタフェース内 FilterConfig

戻り値:

Enumeration フィルターの初期化パラメータの名前を含んだStringオブジェクトのEnumeration

導入されたバージョン:

Servlet 4.0

getFilterConfig

public FilterConfig getFilterConfig()

このフィルターの FilterConfig のオブジェクトを返します。

戻り値:

FilterConfig このフィルターが初期化された FilterConfig のオブジェクト

導入されたバージョン:

Servlet 4.0

getServletContext

public ServletContext getServletContext()

このサーブレットが動いているServletContextを返します。 ServletConfig.getServletContext()を参照してください。

このメソッドは簡便さのために提供されています。 これはサーブレットの FilterConfigのオブジェクトからコンテキストを取得します。

定義:

getServletContext インタフェース内 FilterConfig

戻り値:

ServletContext initでこのフィルターに渡された ServletContext のオブジェクト

導入されたバージョン:

Servlet 4.0

関連項目:

ServletContext

init

public void init(FilterConfig config)
          throws ServletException

サーブレットがサービスに組込まれるときにサーブレットコンテナに呼出されます。 Filter.init(javax.servlet.FilterConfig)を参照してください。

この実装はサーブレットコンテナから受け取ったFilterConfigオブジェクトをあとで使用するために格納します。 このメソッドの振る舞いをオーバーライドする場合は super.init(config) を呼び出してください。

定義:

init インタフェース内 Filter

パラメータ:

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 String getFilterName()

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

定義:

getFilterName インタフェース内 FilterConfig

戻り値:

このフィルターのインスタンスの名前

導入されたバージョン:

Servlet 4.0