|
intra-mart(R) 5.0 |
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object jp.co.intra_mart.common.aid.jsdk.javax.servlet.filter.AbstractFilter
フィルタを実装するための抽象クラスです。
コンストラクタの概要 | |
protected |
AbstractFilter()
フィルタオブジェクトを作成します。 |
メソッドの概要 | |
void |
destroy()
フィルタの終了処理。 |
abstract void |
doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
フィルタとして動作するロジック。 |
FilterConfig |
getFilterConfig()
このフィルタの設定オブジェクトを返します。 |
ServletContext |
getServletContext()
この Filter を実行している ServletContext への参照を返します。 |
protected void |
handleDestroy()
フィルタの破棄処理。 |
protected void |
handleInit()
フィルタの初期化をします。 |
void |
init(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 |
コンストラクタの詳細 |
protected AbstractFilter()
メソッドの詳細 |
public final void init(FilterConfig config) throws ServletException
このメソッドは、この抽象クラスの初期化を実行後に、
handleInit()
を実行します。
サブクラスが独自の初期化処理を必要とする場合は、
handleInit()
をオーバーライドして初期化処理を実装してください。
Filter
内の init
config
- フィルタ設定オブジェクト
ServletException
- 初期化エラーFilter.init(FilterConfig)
protected void handleInit() throws ServletException
このメソッドは、フィルタ初期化時に init(FilterConfig)
に
呼び出されます。
このメソッドは何もしません。ただリターンするだけです。
サブクラスが初期化処理を必要とする場合は、 このメソッドをオーバーライドして初期化処理を実装してください。
ServletException
- 初期化エラーinit(FilterConfig)
public FilterConfig getFilterConfig()
このメソッドは、コンストラクタでは利用できません。
public ServletContext getServletContext()
このメソッドは、コンストラクタでは利用できません。
NullPointerException
- コンストラクタで呼び出した場合protected void log(String msg)
このメソッドの呼び出しは、下記と同等です。
this.getFilterConfig().getServletContext().log(msg);
このメソッドは、コンストラクタでは利用できません。
msg
- ログファイルに出力するメッセージ
NullPointerException
- コンストラクタで呼び出した場合ServletContext.log(String)
protected void log(String msg, Throwable throwable)
このメソッドの呼び出しは、下記と同等です。
this.getFilterConfig().getServletContext().log(msg, throwable);
このメソッドは、コンストラクタでは利用できません。
msg
- ログファイルに出力するメッセージthrowable
- エラーや例外
NullPointerException
- コンストラクタで呼び出した場合ServletContext.log(String, Throwable)
public abstract void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException
Filter
内の doFilter
request
- リクエストresponse
- レスポンスchain
- チェーンの次のエンティティ
ServletException
- 実行時エラー
IOException
- 入出力エラーFilter.doFilter(ServletRequest, ServletResponse, FilterChain)
public final void destroy()
このメソッドは、handleDestroy()
を呼び出します。
handleDestroy()
から正常に制御が返ってきた場合も、
また handleDestroy()
が例外をスローした場合も、
このメソッドが終了する直前に、この抽象クラスの破棄処理が行われます。
サブクラスが独自の初期化処理を必要とする場合は、
handleDestroy()
をオーバーライドして
初期化処理を実装してください。
Filter
内の destroy
Filter.destroy()
protected void handleDestroy()
このメソッドは、フィルタ破棄時に destroy()
に
呼び出されます。
このメソッドは何もしません。ただリターンするだけです。
サブクラスが破棄処理を必要とする場合は、 このメソッドをオーバーライドして破棄処理を実装してください。
destroy()
|
intra-mart(R) 5.0 |
||||||||||
前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |