jp.co.intra_mart.common.aid.jsdk.javax.servlet.filter

クラス AbstractFilter

java.lang.Object

jp.co.intra_mart.common.aid.jsdk.javax.servlet.filter.AbstractFilter

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

javax.servlet.Filter

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

AbsoluteLinkFilter, ExceptionHandlingFilter, HTTPContextHandlingFilter, HttpServletResponseEventFilter, HttpSessionMonitoringFilter, LuxuryResponseWriterFilter, NoCacheFilter, RequestCharacterEncodingFilter, RequestMessageBodyFilter, ResponseCharacterEncodingFilter, ResponseContentTypeManagementFilter, ResponseHeaderSanitizeFilter, SecuredCookieResponseFilter

public abstract class AbstractFilter
extends Object
implements javax.servlet.Filter

フィルタを実装するための抽象クラスです。

導入されたバージョン:

version 5.0

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

コンストラクタ

修飾子	コンストラクタと説明
protected	AbstractFilter() フィルタオブジェクトを作成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	destroy() フィルタの終了処理。
abstract void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain) フィルタとして動作するロジック。
javax.servlet.FilterConfig	getFilterConfig() このフィルタの設定オブジェクトを返します。
javax.servlet.ServletContext	getServletContext() この Filter を実行している ServletContext への参照を返します。
protected void	handleDestroy() フィルタの破棄処理。
protected void	handleInit() フィルタの初期化をします。
void	init(javax.servlet.FilterConfig config) フィルタを初期化します。
protected void	log(String msg) Servlet ログファイルに指定されたメッセージを出力します。
protected void	log(String msg, Throwable throwable) 与えられた Throwable 例外の説明となるメッセージとスタックトレースを Servlet のログファイルに出力します。

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

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

コンストラクタの詳細

AbstractFilter

protected AbstractFilter()

フィルタオブジェクトを作成します。

メソッドの詳細

init

public final void init(javax.servlet.FilterConfig config)
                throws javax.servlet.ServletException

フィルタを初期化します。

このメソッドは、この抽象クラスの初期化を実行後に、 handleInit() を実行します。 サブクラスが独自の初期化処理を必要とする場合は、 handleInit() をオーバーライドして初期化処理を実装してください。

定義:

init インタフェース内 javax.servlet.Filter

パラメータ:

config - フィルタ設定オブジェクト

例外:

javax.servlet.ServletException - 初期化エラー

関連項目:

Filter.init(FilterConfig)

handleInit

protected void handleInit()
                   throws javax.servlet.ServletException

フィルタの初期化をします。

このメソッドは、フィルタ初期化時に init(FilterConfig) に 呼び出されます。
このメソッドは何もしません。ただリターンするだけです。

サブクラスが初期化処理を必要とする場合は、 このメソッドをオーバーライドして初期化処理を実装してください。

例外:

javax.servlet.ServletException - 初期化エラー

関連項目:

init(FilterConfig)

getFilterConfig

public javax.servlet.FilterConfig getFilterConfig()

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

このメソッドは、コンストラクタでは利用できません。

戻り値:

フィルタ設定オブジェクト。コンストラクタで呼び出した場合は null を返します。

getServletContext

public javax.servlet.ServletContext getServletContext()

この Filter を実行している ServletContext への参照を返します。

このメソッドは、コンストラクタでは利用できません。

戻り値:

このフィルタが Servlet コンテナとの対話に使っている ServletContext オブジェクト

例外:

NullPointerException - コンストラクタで呼び出した場合

log

protected void log(String msg)

Servlet ログファイルに指定されたメッセージを出力します。
通常は event ログです。 Servlet ログファイルの名前やタイプは Servlet コンテナによって違います。

このメソッドの呼び出しは、下記と同等です。
this.getFilterConfig().getServletContext().log(msg);

このメソッドは、コンストラクタでは利用できません。

パラメータ:

msg - ログファイルに出力するメッセージ

例外:

NullPointerException - コンストラクタで呼び出した場合

関連項目:

ServletContext.log(String)

log

protected void log(String msg,
                   Throwable throwable)

与えられた Throwable 例外の説明となるメッセージとスタックトレースを Servlet のログファイルに出力します。
Servlet ログファイルは通常は event ログですが、 名前やタイプは Servlet コンテナによって違います。

このメソッドの呼び出しは、下記と同等です。
this.getFilterConfig().getServletContext().log(msg, throwable);

このメソッドは、コンストラクタでは利用できません。

パラメータ:

msg - ログファイルに出力するメッセージ

throwable - エラーや例外

例外:

NullPointerException - コンストラクタで呼び出した場合

関連項目:

ServletContext.log(String, Throwable)

doFilter

public abstract void doFilter(javax.servlet.ServletRequest request,
                              javax.servlet.ServletResponse response,
                              javax.servlet.FilterChain chain)
                       throws javax.servlet.ServletException,
                              IOException

フィルタとして動作するロジック。

定義:

doFilter インタフェース内 javax.servlet.Filter

パラメータ:

request - リクエスト

response - レスポンス

chain - チェーンの次のエンティティ

例外:

javax.servlet.ServletException - 実行時エラー

IOException - 入出力エラー

関連項目:

Filter.doFilter(ServletRequest, ServletResponse, FilterChain)

destroy

public final void destroy()

フィルタの終了処理。

このメソッドは、handleDestroy() を呼び出します。 handleDestroy() から正常に制御が返ってきた場合も、 また handleDestroy() が例外をスローした場合も、 このメソッドが終了する直前に、この抽象クラスの破棄処理が行われます。

サブクラスが独自の初期化処理を必要とする場合は、 handleDestroy() をオーバーライドして 初期化処理を実装してください。

定義:

destroy インタフェース内 javax.servlet.Filter

関連項目:

Filter.destroy()

handleDestroy

protected void handleDestroy()

フィルタの破棄処理。

このメソッドは、フィルタ破棄時に destroy() に 呼び出されます。
このメソッドは何もしません。ただリターンするだけです。

サブクラスが破棄処理を必要とする場合は、 このメソッドをオーバーライドして破棄処理を実装してください。

関連項目:

destroy()